Table of Contents
All Promise and Body Types
Table of Contents
All Promise Types
Common Attributes
action
: bodyaction
classes
: bodyclasses
comment
:string
depends_on
:slist
handle
:string
if
:string
ifvarclass
:string
meta
:slist
unless
:string
with
:string
access
admit
:slist
admit_hostnames
:slist
admit_ips
:slist
admit_keys
:slist
deny
:slist
deny_hostnames
:slist
deny_ips
:slist
deny_keys
:slist
ifencrypted
:boolean
maproot
:slist
report_data_select
: bodyreport_data_select
resource_type
: one ofpath
,literal
,context
,query
,variable
,bundle
shortcut
:string
build_xpath
classes
and
:clist
in range[a-zA-Z0-9_!&@@$|.()\[\]{}:]+
dist
:rlist
in range-9.99999E100,9.99999E100
expression
: class expression in range[a-zA-Z0-9_!&@@$|.()\[\]{}:]+
not
: class expression in range[a-zA-Z0-9_!&@@$|.()\[\]{}:]+
or
:clist
in range[a-zA-Z0-9_!&@@$|.()\[\]{}:]+
persistence
:int
in range0,99999999999
scope
: one ofnamespace
,bundle
select_class
:clist
in range[a-zA-Z0-9_!&@@$|.()\[\]{}:]+
xor
:clist
in range[a-zA-Z0-9_!&@@$|.()\[\]{}:]+
commands
databases
database_columns
:slist
in range.*
database_operation
: one ofcreate
,delete
,drop
,cache
,verify
,restore
database_rows
:slist
in range.*,.*
database_server
: bodydatabase_server
database_type
: one ofsql
,ms_registry
registry_exclude
:slist
defaults
delete_attribute
delete_lines
delete_select
: bodydelete_select
not_matching
:boolean
select_region
: bodyselect_region
delete_text
delete_tree
field_edits
edit_field
: bodyedit_field
select_region
: bodyselect_region
files
acl
: bodyacl
changes
: bodychanges
content
:string
in range.*
copy_from
: bodycopy_from
create
:boolean
delete
: bodydelete
depth_search
: bodydepth_search
edit_defaults
: bodyedit_defaults
edit_line
:bundle
edit_template
:string
in range"?(/.*)
edit_template_string
:string
in range.*
edit_xml
:bundle
file_select
: bodyfile_select
file_type
: one ofregular
,fifo
link_from
: bodylink_from
move_obstructions
:boolean
pathtype
: one ofliteral
,regex
,guess
perms
: bodyperms
rename
: bodyrename
repository
:string
in range"?(/.*)
template_data
:data
template_method
: one ofcfengine
,inline_mustache
,mustache
touch
:boolean
transformer
:string
in range"?(/.*)
guest_environments
environment_host
:string
in range[a-zA-Z0-9_]+
environment_interface
: bodyenvironment_interface
environment_resources
: bodyenvironment_resources
environment_state
: one ofcreate
,delete
,running
,suspended
,down
environment_type
: one ofxen
,kvm
,esx
,vbox
,test
,xen_net
,kvm_net
,esx_net
,test_net
,zone
,ec2
,eucalyptus
insert_lines
expand_scalars
:boolean
insert_select
: bodyinsert_select
insert_type
: one ofliteral
,string
,file
,file_preserve_block
,preserve_block
,preserve_all_lines
location
: bodylocation
select_region
: bodyselect_region
whitespace_policy
:olist
in rangeignore_leading,ignore_trailing,ignore_embedded,exact_match
insert_text
insert_tree
measurements
data_type
: one ofcounter
,int
,real
,string
,slist
history_type
: one ofweekly
,scalar
,static
,log
match_value
: bodymatch_value
stream_type
: one ofpipe
,file
units
:string
meta
methods
packages
additional_packages
:slist
architecture
:string
options
:slist
package_architectures
:slist
package_method
: bodypackage_method
package_module
: bodypackage_module
package_policy
: one ofadd
,delete
,reinstall
,update
,addupdate
,patch
,verify
package_select
: one of>
,<
,==
,!=
,>=
,<=
package_version
:string
policy
: one ofabsent
,present
version
:string
processes
process_count
: bodyprocess_count
process_select
: bodyprocess_select
process_stop
:string
in range"?(/.*)
restart_class
:string
in range[a-zA-Z0-9_$(){}\[\].:]+
signals
:olist
in rangehup,int,trap,kill,pipe,cont,abrt,stop,quit,term,child,usr1,usr2,bus,segv
replace_patterns
replace_with
: bodyreplace_with
select_region
: bodyselect_region
reports
bundle_return_value_index
:string
in range[a-zA-Z0-9_$(){}\[\].:]+
friend_pattern
:string
intermittency
:real
in range0,1
lastseen
:int
in range0,99999999999
printfile
: bodyprintfile
report_to_file
:string
in range"?(/.*)
showstate
:slist
roles
services
service_dependencies
:slist
in range[a-zA-Z0-9_$(){}\[\].:]+
service_method
: bodyservice_method
service_policy
:string
set_attribute
set_text
storage
users
description
:string
group_primary
:string
groups_secondary
:slist
in range.*
home_bundle
:bundle
home_bundle_inherit
:boolean
home_dir
:string
in range"?(/.*)
password
: bodypassword
policy
: one ofpresent
,absent
,locked
shell
:string
in range"?(/.*)
uid
:int
in range-99999999999,99999999999
vars
data
:data
ilist
:ilist
in range-99999999999,99999999999
int
:int
in range-99999999999,99999999999
policy
: one offree
,overridable
,constant
,ifdefined
real
:real
in range-9.99999E100,9.99999E100
rlist
:rlist
in range-9.99999E100,9.99999E100
slist
:slist
string
:string
All Body Types
acl
aces
:slist
in range((user|group):[^:]+:[-=+,rwx()dtTabBpcoD]*(:(allow|deny))?)|((all|mask):[-=+,rwx()]*(:(allow|deny))?)
acl_default
: one ofnochange
,access
,specify
,clear
acl_directory_inherit
deprecated: one ofnochange
,parent
,specify
,clear
acl_inherit
: one oftrue
,false
,yes
,no
,on
,off
,nochange
acl_method
: one ofappend
,overwrite
acl_type
: one ofgeneric
,posix
,ntfs
inherit_from
: bodyinherit_from
meta
:slist
specify_default_aces
:slist
in range((user|group):[^:]+:[-=+,rwx()dtTabBpcoD]*(:(allow|deny))?)|((all|mask):[-=+,rwx()]*(:(allow|deny))?)
specify_inherit_aces
deprecated:slist
in range((user|group):[^:]+:[-=+,rwx()dtTabBpcoD]*(:(allow|deny))?)|((all|mask):[-=+,rwx()]*(:(allow|deny))?)
action
action_policy
: one offix
,warn
,nop
audit
:boolean
background
:boolean
expireafter
:int
in range0,99999999999
ifelapsed
:int
in range0,99999999999
inherit_from
: bodyinherit_from
log_failed
:string
in rangestdout|udp_syslog|("?[a-zA-Z]:\\.*)|(/.*)
log_kept
:string
in rangestdout|udp_syslog|("?[a-zA-Z]:\\.*)|(/.*)
log_level
: one ofinform
,verbose
,error
,log
log_priority
: one ofemergency
,alert
,critical
,error
,warning
,notice
,info
,debug
log_repaired
:string
in rangestdout|udp_syslog|("?[a-zA-Z]:\\.*)|(/.*)
log_string
:string
measurement_class
:string
meta
:slist
report_level
: one ofinform
,verbose
,error
,log
agent
abortbundleclasses
:slist
in range.*
abortclasses
:slist
in range.*
addclasses
:slist
in range.*
agentaccess
:slist
in range.*
agentfacility
: one ofLOG_USER
,LOG_DAEMON
,LOG_LOCAL0
,LOG_LOCAL1
,LOG_LOCAL2
,LOG_LOCAL3
,LOG_LOCAL4
,LOG_LOCAL5
,LOG_LOCAL6
,LOG_LOCAL7
allclassesreport
:boolean
alwaysvalidate
:boolean
bindtointerface
:string
in range.*
checksum_alert_time
:int
in range0,60
childlibpath
:string
in range.*
default_repository
:string
in range"?(/.*)
default_timeout
:int
in range0,99999999999
defaultcopytype
: one ofmtime
,atime
,ctime
,digest
,hash
,binary
dryrun
:boolean
editbinaryfilesize
:int
in range0,99999999999
editfilesize
:int
in range0,99999999999
environment
:slist
in range[A-Za-z0-9_]+=.*
expireafter
:int
in range0,99999999999
files_auto_define
:slist
files_single_copy
:slist
hashupdates
:boolean
hostnamekeys
:boolean
ifelapsed
:int
in range0,99999999999
inform
:boolean
intermittency
:boolean
max_children
:int
in range0,99999999999
maxconnections
:int
in range0,99999999999
mountfilesystems
:boolean
nonalphanumfiles
:boolean
refresh_processes
:slist
in range[a-zA-Z0-9_$(){}\[\].:]+
repchar
:string
in range.
report_class_log
:boolean
secureinput
:boolean
select_end_match_eof
:boolean
sensiblecount
:int
in range0,99999999999
sensiblesize
:int
in range0,99999999999
skipidentify
:boolean
suspiciousnames
:slist
timezone
:slist
verbose
:boolean
changes
hash
: one ofmd5
,sha1
,sha224
,sha256
,sha384
,sha512
,best
inherit_from
: bodyinherit_from
meta
:slist
report_changes
: one ofall
,stats
,content
,none
report_diffs
:boolean
update_hashes
:boolean
classes
cancel_kept
:slist
in range[a-zA-Z0-9_$(){}\[\].:]+
cancel_notkept
:slist
in range[a-zA-Z0-9_$(){}\[\].:]+
cancel_repaired
:slist
in range[a-zA-Z0-9_$(){}\[\].:]+
failed_returncodes
:slist
in range[-0-9_$(){}\[\].]+
inherit_from
: bodyinherit_from
kept_returncodes
:slist
in range[-0-9_$(){}\[\].]+
meta
:slist
persist_time
:int
in range0,99999999999
promise_kept
:slist
in range[a-zA-Z0-9_$(){}\[\].:]+
promise_repaired
:slist
in range[a-zA-Z0-9_$(){}\[\].:]+
repair_denied
:slist
in range[a-zA-Z0-9_$(){}\[\].:]+
repair_failed
:slist
in range[a-zA-Z0-9_$(){}\[\].:]+
repair_timeout
:slist
in range[a-zA-Z0-9_$(){}\[\].:]+
repaired_returncodes
:slist
in range[-0-9_$(){}\[\].]+
scope
: one ofnamespace
,bundle
timer_policy
: one ofabsolute
,reset
common
bundlesequence
:slist
in range.*
bwlimit
:real
in range0,99999999999
cache_system_functions
:boolean
domain
:string
in range.*
fips_mode
:boolean
goal_patterns
:slist
ignore_missing_bundles
:boolean
ignore_missing_inputs
:boolean
inputs
:slist
in range.*
lastseenexpireafter
:int
in range0,99999999999
output_prefix
:string
package_inventory
:slist
in range.*
package_module
:string
in range.*
protocol_version
: one of0
,undefined
,1
,classic
,2
,latest
require_comments
:boolean
site_classes
:clist
in range[a-zA-Z0-9_!&@@$|.()\[\]{}:]+
syslog_host
:string
in range[a-zA-Z0-9_$(){}.:-]+
syslog_port
:int
in range0,99999999999
tls_ciphers
:string
tls_min_version
:string
version
:string
contain
chdir
:string
in range"?(/.*)
chroot
:string
in range"?(/.*)
exec_group
:string
exec_owner
:string
exec_timeout
:int
in range1,3600
inherit_from
: bodyinherit_from
meta
:slist
no_output
:boolean
preview
:boolean
umask
:string
useshell
: one ofnoshell
,useshell
,powershell
,true
,false
,yes
,no
,on
,off
copy_from
check_root
:boolean
collapse_destination_dir
:boolean
compare
: one ofatime
,mtime
,ctime
,digest
,hash
,exists
,binary
copy_backup
: one oftrue
,false
,timestamp
copy_size
:irange
in range0,inf
copylink_patterns
:slist
encrypt
:boolean
findertype
: one ofMacOSX
force_ipv4
:boolean
force_update
:boolean
inherit_from
: bodyinherit_from
link_type
: one ofsymlink
,hardlink
,relative
,absolute
linkcopy_patterns
:slist
meta
:slist
missing_ok
:boolean
portnumber
:string
preserve
:boolean
protocol_version
: one of0
,undefined
,1
,classic
,2
,latest
purge
:boolean
servers
:slist
in range[A-Za-z0-9_.:\-\[\]]+
source
:string
in range.+
stealth
:boolean
timeout
:int
in range1,3600
trustkey
:boolean
type_check
:boolean
verify
:boolean
database_server
db_server_connection_db
:string
db_server_host
:string
db_server_owner
:string
db_server_password
:string
db_server_type
: one ofpostgres
,mysql
inherit_from
: bodyinherit_from
meta
:slist
delete
dirlinks
: one ofdelete
,tidy
,keep
inherit_from
: bodyinherit_from
meta
:slist
rmdirs
:boolean
delete_select
delete_if_contains_from_list
:slist
in range.*
delete_if_match_from_list
:slist
in range.*
delete_if_not_contains_from_list
:slist
in range.*
delete_if_not_match_from_list
:slist
in range.*
delete_if_not_startwith_from_list
:slist
in range.*
delete_if_startwith_from_list
:slist
in range.*
inherit_from
: bodyinherit_from
meta
:slist
depth_search
depth
:int
in range0,99999999999
exclude_dirs
:slist
in range.*
include_basedir
:boolean
include_dirs
:slist
in range.*
inherit_from
: bodyinherit_from
meta
:slist
rmdeadlinks
:boolean
traverse_links
:boolean
xdev
:boolean
edit_defaults
edit_backup
: one oftrue
,false
,timestamp
,rotate
empty_file_before_editing
:boolean
inherit
:boolean
inherit_from
: bodyinherit_from
max_file_size
:int
in range0,99999999999
meta
:slist
recognize_join
:boolean
rotate
:int
in range0,99
edit_field
allow_blank_fields
:boolean
extend_fields
:boolean
field_operation
: one ofprepend
,append
,alphanum
,delete
,set
field_separator
:string
in range.*
field_value
:string
in range.*
inherit_from
: bodyinherit_from
meta
:slist
select_field
:int
in range0,99999999
start_fields_from_zero
:boolean
value_separator
:string
in range^.$
environment_interface
env_addresses
:slist
env_name
:string
env_network
:string
inherit_from
: bodyinherit_from
meta
:slist
environment_resources
env_baseline
:string
in range"?(/.*)
env_cpus
:int
in range0,99999999999
env_disk
:int
in range0,99999999999
env_memory
:int
in range0,99999999999
env_spec
:string
in range.*
inherit_from
: bodyinherit_from
meta
:slist
executor
agent_expireafter
:int
in range0,10080
exec_command
:string
in range"?(/.*)
executorfacility
: one ofLOG_USER
,LOG_DAEMON
,LOG_LOCAL0
,LOG_LOCAL1
,LOG_LOCAL2
,LOG_LOCAL3
,LOG_LOCAL4
,LOG_LOCAL5
,LOG_LOCAL6
,LOG_LOCAL7
mailfilter_exclude
:slist
mailfilter_include
:slist
mailfrom
:string
in range.*@.*
mailmaxlines
:int
in range0,1000
mailsubject
:string
mailto
:string
in range.*@.*
schedule
:slist
smtpserver
:string
in range.*
splaytime
:int
in range0,99999999999
file
file_select
atime
:irange
in range0,2147483647
ctime
:irange
in range0,2147483647
exec_program
:string
in range"?(/.*)
exec_regex
:string
in range.*
file_result
:string
in range[!*(leaf_name|path_name|file_types|mode|size|owner|group|atime|ctime|mtime|issymlinkto|exec_regex|exec_program|bsdflags)[|&.]*]*
file_types
:olist
in rangeplain,reg,symlink,dir,socket,fifo,door,char,block
inherit_from
: bodyinherit_from
issymlinkto
:slist
leaf_name
:slist
meta
:slist
mtime
:irange
in range0,2147483647
path_name
:slist
in range"?(/.*)
search_bsdflags
:slist
in range[+-]*[(arch|archived|nodump|opaque|sappnd|sappend|schg|schange|simmutable|sunlnk|sunlink|uappnd|uappend|uchg|uchange|uimmutable|uunlnk|uunlink)]+
search_groups
:slist
search_mode
:slist
in range[0-7augorwxst,+-=]+
search_owners
:slist
search_size
:irange
in range0,inf
hub
client_history_timeout
:int
in range1,65535
exclude_hosts
:slist
hub_schedule
:slist
port
:int
in range1,65535
query_timeout
:int
in range0,300
insert_select
inherit_from
: bodyinherit_from
insert_if_contains_from_list
:slist
in range.*
insert_if_match_from_list
:slist
in range.*
insert_if_not_contains_from_list
:slist
in range.*
insert_if_not_match_from_list
:slist
in range.*
insert_if_not_startwith_from_list
:slist
in range.*
insert_if_startwith_from_list
:slist
in range.*
meta
:slist
link_from
copy_patterns
:slist
inherit_from
: bodyinherit_from
link_children
:boolean
link_type
: one ofsymlink
,hardlink
,relative
,absolute
meta
:slist
source
:string
in range.+
when_linking_children
: one ofoverride_file
,if_no_such_file
when_no_source
: one offorce
,delete
,nop
location
before_after
: one ofbefore
,after
first_last
: one offirst
,last
inherit_from
: bodyinherit_from
meta
:slist
select_line_matching
:string
in range.*
match_value
extraction_regex
:string
inherit_from
: bodyinherit_from
meta
:slist
select_line_matching
:string
in range.*
select_line_number
:int
in range0,99999999999
select_multiline_policy
: one ofaverage
,sum
,first
,last
track_growing_file
:boolean
monitor
forgetrate
:real
in range0,1
histograms
:boolean
monitorfacility
: one ofLOG_USER
,LOG_DAEMON
,LOG_LOCAL0
,LOG_LOCAL1
,LOG_LOCAL2
,LOG_LOCAL3
,LOG_LOCAL4
,LOG_LOCAL5
,LOG_LOCAL6
,LOG_LOCAL7
tcpdump
:boolean
tcpdumpcommand
:string
in range"?(/.*)
mount
edit_fstab
:boolean
inherit_from
: bodyinherit_from
meta
:slist
mount_options
:slist
mount_server
:string
mount_source
:string
in range"?(/.*)
mount_type
: one ofnfs
,nfs2
,nfs3
,nfs4
,panfs
,cifs
unmount
:boolean
package_method
inherit_from
: bodyinherit_from
meta
:slist
package_add_command
:string
in range.+
package_arch_regex
:string
package_changes
: one ofindividual
,bulk
package_commands_useshell
:boolean
package_default_arch_command
:string
in range"?(/.*)
package_delete_command
:string
in range.+
package_delete_convention
:string
package_file_repositories
:slist
package_installed_regex
:string
package_list_arch_regex
:string
package_list_command
:string
in range.+
package_list_name_regex
:string
package_list_update_command
:string
package_list_update_ifelapsed
:int
in range-99999999999,99999999999
package_list_version_regex
:string
package_multiline_start
:string
package_name_convention
:string
package_name_regex
:string
package_noverify_regex
:string
package_noverify_returncode
:int
in range-99999999999,99999999999
package_patch_arch_regex
:string
package_patch_command
:string
in range.+
package_patch_installed_regex
:string
package_patch_list_command
:string
in range.+
package_patch_name_regex
:string
package_patch_version_regex
:string
package_update_command
:string
in range.+
package_verify_command
:string
in range.+
package_version_equal_command
:string
in range.+
package_version_less_command
:string
in range.+
package_version_regex
:string
package_module
default_options
:slist
interpreter
:string
module_path
:string
query_installed_ifelapsed
:int
in range-99999999999,99999999999
query_updates_ifelapsed
:int
in range-99999999999,99999999999
password
data
:string
format
: one ofplaintext
,hash
inherit_from
: bodyinherit_from
meta
:slist
perms
bsdflags
:slist
in range[+-]*[(arch|archived|nodump|opaque|sappnd|sappend|schg|schange|simmutable|sunlnk|sunlink|uappnd|uappend|uchg|uchange|uimmutable|uunlnk|uunlink)]+
groups
:slist
in range[a-zA-Z0-9_$.-]+
inherit_from
: bodyinherit_from
meta
:slist
mode
:string
in range[0-7augorwxst,+-=]+
owners
:slist
in range[a-zA-Z0-9_$.-]+
rxdirs
:boolean
printfile
file_to_print
:string
in range"?(/.*)
inherit_from
: bodyinherit_from
meta
:slist
number_of_lines
:int
in range0,99999999999
process_count
in_range_define
:slist
inherit_from
: bodyinherit_from
match_range
:irange
in range0,99999999999
meta
:slist
out_of_range_define
:slist
process_select
command
:string
inherit_from
: bodyinherit_from
meta
:slist
pgid
:irange
in range0,99999999999
pid
:irange
in range0,99999999999
ppid
:irange
in range0,99999999999
priority
:irange
in range-20,+20
process_owner
:slist
process_result
:string
in range[(process_owner|pid|ppid||pgid|rsize|vsize|status|command|ttime|stime|tty|priority|threads)[|&!.]*]*
rsize
:irange
in range0,99999999999
status
:string
stime_range
:irange
in range0,2147483647
threads
:irange
in range0,99999999999
ttime_range
:irange
in range0,99999999999
tty
:string
vsize
:irange
in range0,99999999999
rename
disable
:boolean
disable_mode
:string
in range[0-7augorwxst,+-=]+
disable_suffix
:string
inherit_from
: bodyinherit_from
meta
:slist
newname
:string
rotate
:int
in range0,99
replace_with
inherit_from
: bodyinherit_from
meta
:slist
occurrences
: one ofall
,first
replace_value
:string
in range.*
report_data_select
inherit_from
: bodyinherit_from
meta
:slist
metatags_exclude
:slist
in range.*
metatags_include
:slist
in range.*
monitoring_exclude
:slist
in range.*
monitoring_include
:slist
in range.*
promise_handle_exclude
:slist
in range.*
promise_handle_include
:slist
in range.*
runagent
background_children
:boolean
encrypt
:boolean
force_ipv4
:boolean
hosts
:slist
max_children
:int
in range0,99999999999
output_directory
:string
in range"?(/.*)
output_to_file
:boolean
port
:int
in range1,65535
timeout
:int
in range1,9999
trustkey
:boolean
select_region
include_end_delimiter
:boolean
include_start_delimiter
:boolean
inherit_from
: bodyinherit_from
meta
:slist
select_end
:string
in range.*
select_end_match_eof
:boolean
select_start
:string
in range.*
server
allowallconnects
:slist
allowciphers
:string
allowconnects
:slist
allowlegacyconnects
:slist
allowtlsversion
:string
allowusers
:slist
auditing
:boolean
bindtointerface
:string
call_collect_interval
:int
in range0,99999999999
cfruncommand
:string
in range.+
collect_window
:int
in range0,99999999999
denybadclocks
:boolean
denyconnects
:slist
dynamicaddresses
:slist
hostnamekeys
:boolean
listen
:boolean
logallconnections
:boolean
logencryptedtransfers
:boolean
maxconnections
:int
in range0,99999999999
port
:int
in range1,65535
serverfacility
: one ofLOG_USER
,LOG_DAEMON
,LOG_LOCAL0
,LOG_LOCAL1
,LOG_LOCAL2
,LOG_LOCAL3
,LOG_LOCAL4
,LOG_LOCAL5
,LOG_LOCAL6
,LOG_LOCAL7
skipverify
deprecated:slist
trustkeysfrom
:slist
service_method
inherit_from
: bodyinherit_from
meta
:slist
service_args
:string
service_autostart_policy
: one ofnone
,boot_time
,on_demand
service_bundle
:bundle
service_dependence_chain
: one ofignore
,start_parent_services
,stop_child_services
,all_related
service_type
: one ofwindows
,generic
volume
check_foreign
:boolean
freespace
:string
in range[0-9]+[MBkKgGmb%]
inherit_from
: bodyinherit_from
meta
:slist
scan_arrivals
:boolean
sensible_count
:int
in range0,99999999999
sensible_size
:int
in range0,99999999999