Ansible Rulebook

Ansible rulebook files

Type ruleset[]
File match **/rulebooks/*.yml **/rulebooks/*.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/ansible-rulebook/latest.json
Source https://raw.githubusercontent.com/ansible/ansible-rulebook/main/ansible_rulebook/schema/ruleset_schema.json

Validate with Lintel

npx @lintel/lintel check
Type: ruleset[]

See https://docs.ansible.com/projects/rulebook/en/latest/rulebooks.html

Items

object
hosts string required
name string required
sources source[] required
rules rule[] required
default_events_ttl string
pattern=^\d+\s(seconds?|minutes?|hours?|days?)$
gather_facts boolean
Default: false
match_multiple_rules boolean
Default: false
execution_strategy string
Default: "sequential"
Values: "parallel" "sequential"

Definitions

ruleset object
hosts string required
name string required
sources source[] required
rules rule[] required
default_events_ttl string
pattern=^\d+\s(seconds?|minutes?|hours?|days?)$
gather_facts boolean
Default: false
match_multiple_rules boolean
Default: false
execution_strategy string
Default: "sequential"
Values: "parallel" "sequential"
source Record<string, object | null>
name string
filters object[]
throttle object
once_within string
pattern=^\d+\s(milliseconds?|seconds?|minutes?|hours?|days?)$
once_after string
pattern=^\d+\s(milliseconds?|seconds?|minutes?|hours?|days?)$
accumulate_within string
pattern=^\d+\s(milliseconds?|seconds?|minutes?|hours?|days?)$
threshold integer
min=1
group_by_attributes string[]
rule object
name string
minLength=1pattern=\S
enabled boolean
throttle object
One of: variant, variant, variant
5 nested properties
once_within string
pattern=^\d+\s(milliseconds?|seconds?|minutes?|hours?|days?)$
once_after string
pattern=^\d+\s(milliseconds?|seconds?|minutes?|hours?|days?)$
accumulate_within string
pattern=^\d+\s(milliseconds?|seconds?|minutes?|hours?|days?)$
threshold integer
min=1
group_by_attributes string[]
condition string | boolean | all-condition | any-condition | not-all-condition
actions run-playbook-action | run-module-action | run-job-template-action | run-workflow-template-action | post-event-action | set-fact-action | retract-fact-action | print-event-action | debug-action | none-action | shutdown-action | pg-notify-action[]
action run-playbook-action | run-module-action | run-job-template-action | run-workflow-template-action | post-event-action | set-fact-action | retract-fact-action | print-event-action | debug-action | none-action | shutdown-action | pg-notify-action
all-condition object
all string[]
timeout string
pattern=^\d+\s(milliseconds?|seconds?|minutes?|hours?|days?)$
not-all-condition object
not_all string[] required
timeout string required
pattern=^\d+\s(milliseconds?|seconds?|minutes?|hours?|days?)$
any-condition object
any string[]
run-playbook-action object
run_playbook object required
13 nested properties
name string required
copy_files boolean
post_events boolean
set_facts boolean
ruleset string
verbosity integer
var_root string | object
json_mode boolean
retry boolean
retries integer
delay number
extra_vars object
lock string
run-module-action object
run_module object required
12 nested properties
name string required
post_events boolean
set_facts boolean
verbosity integer
var_root string | object
json_mode boolean
retry boolean
retries integer
delay number
module_args object | string
extra_vars object
lock string
run-job-template-action object
run_job_template object required
14 nested properties
name string required
organization string required
job_args object
post_events boolean
set_facts boolean
ruleset string
var_root string
retry boolean
retries integer
delay integer
include_events boolean
Default: true
lock string
labels string[]
add_event_uuid_label boolean
Default: false
run-workflow-template-action object
run_workflow_template object required
14 nested properties
name string required
organization string required
job_args object
post_events boolean
set_facts boolean
ruleset string
var_root string
retry boolean
retries integer
delay integer
include_events boolean
Default: true
lock string
labels string[]
add_event_uuid_label boolean
Default: false
pg-notify-action object
pg_notify object required
4 nested properties
dsn string required
channel string required
event string | object required
remove_meta boolean
Default: false
post-event-action object
post_event object required
2 nested properties
event object required
ruleset string
set-fact-action object
set_fact object required
2 nested properties
fact object required
ruleset string
retract-fact-action object
retract_fact object required
3 nested properties
fact object required
ruleset string
partial boolean
Default: true
print-event-action object
print_event object | null required
2 nested properties
var_root string | object
pretty boolean
debug-msg object
msg string | string[]
debug-var object
var string
debug-action object
debug debug-msg | debug-var | null required
none-action object
none object | null required
shutdown-action object
shutdown object | null required
3 nested properties
delay number
message string
kind string
Values: "graceful" "now"

Examples

"rulebooks/*.yml" "rulebooks/*.yaml"