All promise and body types
Table of contents
All promise types
Common attributes
action: bodyactionclasses: bodyclassescomment:stringdepends_on:slisthandle:stringif:stringifvarclass:stringmeta:slistunless:stringwith:string
access
admit:slistadmit_hostnames:slistadmit_ips:slistadmit_keys:slistdeny:slistdeny_hostnames:slistdeny_ips:slistdeny_keys:slistifencrypted:booleanmaproot:slistreport_data_select: bodyreport_data_selectresource_type: one ofpath,literal,context,query,variable,bundleshortcut:string
build_xpath
classes
and:clistin range[a-zA-Z0-9_!&@@$|.()\[\]{}:]+dist:rlistin range-9.99999E100,9.99999E100expression: class expression in range[a-zA-Z0-9_!&@@$|.()\[\]{}:]+not: class expression in range[a-zA-Z0-9_!&@@$|.()\[\]{}:]+or:clistin range[a-zA-Z0-9_!&@@$|.()\[\]{}:]+persistence:intin range0,99999999999scope: one ofnamespace,bundleselect_class:clistin range[a-zA-Z0-9_!&@@$|.()\[\]{}:]+xor:clistin range[a-zA-Z0-9_!&@@$|.()\[\]{}:]+
commands
databases
database_columns:slistin range.*database_operation: one ofcreate,delete,drop,cache,verify,restoredatabase_rows:slistin range.*,.*database_server: bodydatabase_serverdatabase_type: one ofsql,ms_registryregistry_exclude:slist
defaults
delete_attribute
delete_lines
delete_select: bodydelete_selectnot_matching:booleanselect_region: bodyselect_region
delete_text
delete_tree
field_edits
edit_field: bodyedit_fieldselect_region: bodyselect_region
files
acl: bodyaclchanges: bodychangescontent:stringin range.*copy_from: bodycopy_fromcreate:booleandelete: bodydeletedepth_search: bodydepth_searchedit_defaults: bodyedit_defaultsedit_line:bundleedit_template:stringin range"?(/.*)edit_template_string:stringin range.*edit_xml:bundlefile_select: bodyfile_selectfile_type: one ofregular,fifolink_from: bodylink_frommove_obstructions:booleanpathtype: one ofliteral,regex,guessperms: bodypermsrename: bodyrenamerepository:stringin range"?(/.*)template_data:datatemplate_method: one ofcfengine,inline_mustache,mustachetouch:booleantransformer:stringin range"?(/.*)
guest_environments
environment_host:stringin range[a-zA-Z0-9_]+environment_interface: bodyenvironment_interfaceenvironment_resources: bodyenvironment_resourcesenvironment_state: one ofcreate,delete,running,suspended,downenvironment_type: one ofxen,kvm,esx,vbox,test,xen_net,kvm_net,esx_net,test_net,zone,ec2,eucalyptus
insert_lines
expand_scalars:booleaninsert_select: bodyinsert_selectinsert_type: one ofliteral,string,file,file_preserve_block,preserve_block,preserve_all_lineslocation: bodylocationselect_region: bodyselect_regionwhitespace_policy:olistin rangeignore_leading,ignore_trailing,ignore_embedded,exact_match
insert_text
insert_tree
measurements
data_type: one ofcounter,int,real,string,slisthistory_type: one ofweekly,scalar,static,logmatch_value: bodymatch_valuestream_type: one ofpipe,fileunits:string
meta
methods
packages
additional_packages:slistarchitecture:stringoptions:slistpackage_architectures:slistpackage_method: bodypackage_methodpackage_module: bodypackage_modulepackage_policy: one ofadd,delete,reinstall,update,addupdate,patch,verifypackage_select: one of>,<,==,!=,>=,<=package_version:stringpolicy: one ofabsent,presentversion:string
processes
process_count: bodyprocess_countprocess_select: bodyprocess_selectprocess_stop:stringin range"?(/.*)restart_class:stringin range[a-zA-Z0-9_$(){}\[\].:]+signals:slistin range(hup|int|trap|kill|pipe|cont|abrt|stop|quit|term|child|usr1|usr2|bus|segv|[0-9]+s?)
replace_patterns
replace_with: bodyreplace_withselect_region: bodyselect_region
reports
bundle_return_value_index:stringin range[a-zA-Z0-9_$(){}\[\].:]+friend_pattern:stringintermittency:realin range0,1lastseen:intin range0,99999999999printfile: bodyprintfilereport_to_file:stringin range"?(/.*)showstate:slist
roles
services
service_dependencies:slistin range[a-zA-Z0-9_$(){}\[\].:]+service_method: bodyservice_methodservice_policy:string
set_attribute
set_text
storage
users
description:stringgroup_primary:stringgroups_secondary:slistin range.*home_bundle:bundlehome_bundle_inherit:booleanhome_dir:stringin range"?(/.*)password: bodypasswordpolicy: one ofpresent,absent,lockedshell:stringin range"?(/.*)uid:intin range-99999999999,99999999999
vars
data:datailist:ilistin range-99999999999,99999999999int:intin range-99999999999,99999999999policy: one offree,overridable,constant,ifdefinedreal:realin range-9.99999E100,9.99999E100rlist:rlistin range-9.99999E100,9.99999E100slist:sliststring:string
All body Types
acl
aces:slistin range((user|group):[^:]+:[-=+,rwx()dtTabBpcoD]*(:(allow|deny))?)|((all|mask):[-=+,rwx()]*(:(allow|deny))?)acl_default: one ofnochange,access,specify,clearacl_directory_inheritdeprecated: one ofnochange,parent,specify,clearacl_inherit: one oftrue,false,yes,no,on,off,nochangeacl_method: one ofappend,overwriteacl_type: one ofgeneric,posix,ntfsinherit_from: bodyinherit_frommeta:slistspecify_default_aces:slistin range((user|group):[^:]+:[-=+,rwx()dtTabBpcoD]*(:(allow|deny))?)|((all|mask):[-=+,rwx()]*(:(allow|deny))?)specify_inherit_acesdeprecated:slistin range((user|group):[^:]+:[-=+,rwx()dtTabBpcoD]*(:(allow|deny))?)|((all|mask):[-=+,rwx()]*(:(allow|deny))?)
action
action_policy: one offix,warn,nopaudit:booleanbackground:booleanexpireafter:intin range0,99999999999ifelapsed:intin range0,99999999999inherit_from: bodyinherit_fromlog_failed:stringin rangestdout|udp_syslog|("?[a-zA-Z]:\\.*)|(/.*)log_kept:stringin rangestdout|udp_syslog|("?[a-zA-Z]:\\.*)|(/.*)log_level: one ofinform,verbose,error,loglog_priority: one ofemergency,alert,critical,error,warning,notice,info,debuglog_repaired:stringin rangestdout|udp_syslog|("?[a-zA-Z]:\\.*)|(/.*)log_string:stringmeasurement_class:stringmeta:slistreport_level: one ofinform,verbose,error,log
agent
abortbundleclasses:slistin range.*abortclasses:slistin range.*addclasses:slistin range.*agentaccess:slistin range.*agentfacility: one ofLOG_USER,LOG_DAEMON,LOG_LOCAL0,LOG_LOCAL1,LOG_LOCAL2,LOG_LOCAL3,LOG_LOCAL4,LOG_LOCAL5,LOG_LOCAL6,LOG_LOCAL7allclassesreport:booleanalwaysvalidate:booleanbindtointerface:stringin range.*checksum_alert_time:intin range0,60childlibpath:stringin range.*copyfrom_restrict_keys:slistin range.*default_repository:stringin range"?(/.*)default_timeout:intin range0,99999999999defaultcopytype: one ofmtime,atime,ctime,digest,hash,binarydryrun:booleaneditbinaryfilesize:intin range0,99999999999editfilesize:intin range0,99999999999environment:slistin range[A-Za-z0-9_]+=.*expireafter:intin range0,99999999999files_auto_define:slistfiles_single_copy:slisthashupdates:booleanhostnamekeys:booleanifelapsed:intin range0,99999999999inform:booleanintermittency:booleanmax_children:intin range0,99999999999maxconnections:intin range0,99999999999mountfilesystems:booleannonalphanumfiles:booleanrefresh_processes:slistin range[a-zA-Z0-9_$(){}\[\].:]+repchar:stringin range.report_class_log:booleansecureinput:booleanselect_end_match_eof:booleansensiblecount:intin range0,99999999999sensiblesize:intin range0,99999999999skipidentify:booleansuspiciousnames:slisttimezone:slistverbose:boolean
changes
hash: one ofmd5,sha1,sha224,sha256,sha384,sha512,bestinherit_from: bodyinherit_frommeta:slistreport_changes: one ofall,stats,content,nonereport_diffs:booleanupdate_hashes:boolean
classes
cancel_kept:slistin range[a-zA-Z0-9_$(){}\[\].:]+cancel_notkept:slistin range[a-zA-Z0-9_$(){}\[\].:]+cancel_repaired:slistin range[a-zA-Z0-9_$(){}\[\].:]+failed_returncodes:slistin range[-0-9_$(){}\[\].]+inherit_from: bodyinherit_fromkept_returncodes:slistin range[-0-9_$(){}\[\].]+meta:slistpersist_time:intin range0,99999999999promise_kept:slistin range[a-zA-Z0-9_$(){}\[\].:]+promise_repaired:slistin range[a-zA-Z0-9_$(){}\[\].:]+repair_denied:slistin range[a-zA-Z0-9_$(){}\[\].:]+repair_failed:slistin range[a-zA-Z0-9_$(){}\[\].:]+repair_timeout:slistin range[a-zA-Z0-9_$(){}\[\].:]+repaired_returncodes:slistin range[-0-9_$(){}\[\].]+scope: one ofnamespace,bundletimer_policy: one ofabsolute,reset
common
bundlesequence:slistin range.*bwlimit:realin range0,99999999999cache_system_functions:booleandomain:stringin range.*fips_mode:booleangoal_patterns:slistignore_missing_bundles:booleanignore_missing_inputs:booleaninputs:slistin range.*lastseenexpireafter:intin range0,99999999999output_prefix:stringpackage_inventory:slistin range.*package_module:stringin range.*protocol_version: one of1,classic,2,tls,3,cookie,4,filestream,latestrequire_comments:booleansite_classes:clistin range[a-zA-Z0-9_!&@@$|.()\[\]{}:]+syslog_host:stringin range[a-zA-Z0-9_$(){}.:-]+syslog_port:intin range0,99999999999system_log_level:stringin range(critical|error|warning|notice|info)tls_ciphers:stringtls_min_version:stringversion:string
contain
chdir:stringin range"?(/.*)chroot:stringin range"?(/.*)exec_group:stringexec_owner:stringexec_timeout:intin range1,3600inherit_from: bodyinherit_frommeta:slistno_output:booleanpreview:booleanumask:stringuseshell: one ofnoshell,useshell,powershell,true,false,yes,no,on,off
copy_from
check_root:booleancollapse_destination_dir:booleancompare: one ofatime,mtime,ctime,digest,hash,exists,binarycopy_backup: one oftrue,false,timestampcopy_size:irangein range0,infcopylink_patterns:slistencrypt:booleanfindertype: one ofMacOSXforce_ipv4:booleanforce_update:booleaninherit_from: bodyinherit_fromlink_type: one ofsymlink,hardlink,relative,absolutelinkcopy_patterns:slistmeta:slistmissing_ok:booleanportnumber:stringpreserve:booleanprotocol_version: one of1,classic,2,tls,3,cookie,4,filestream,latestpurge:booleanservers:slistin range[A-Za-z0-9_.:\-\[\]]+source:stringin range.+stealth:booleantimeout:intin range1,3600trustkey:booleantype_check:booleanverify:boolean
database_server
db_server_connection_db:stringdb_server_host:stringdb_server_owner:stringdb_server_password:stringdb_server_type: one ofpostgres,mysqlinherit_from: bodyinherit_frommeta:slist
delete
dirlinks: one ofdelete,tidy,keepinherit_from: bodyinherit_frommeta:slistrmdirs:boolean
delete_select
delete_if_contains_from_list:slistin range.*delete_if_match_from_list:slistin range.*delete_if_not_contains_from_list:slistin range.*delete_if_not_match_from_list:slistin range.*delete_if_not_startwith_from_list:slistin range.*delete_if_startwith_from_list:slistin range.*inherit_from: bodyinherit_frommeta:slist
depth_search
depth:intin range0,99999999999exclude_dirs:slistin range.*include_basedir:booleaninclude_dirs:slistin range.*inherit_from: bodyinherit_frommeta:slistrmdeadlinks:booleantraverse_links:booleanxdev:boolean
edit_defaults
edit_backup: one oftrue,false,timestamp,rotateempty_file_before_editing:booleaninherit:booleaninherit_from: bodyinherit_frommax_file_size:intin range0,99999999999meta:slistrecognize_join:booleanrotate:intin range0,99
edit_field
allow_blank_fields:booleanextend_fields:booleanfield_operation: one ofprepend,append,alphanum,delete,setfield_separator:stringin range.*field_value:stringin range.*inherit_from: bodyinherit_frommeta:slistselect_field:intin range0,99999999start_fields_from_zero:booleanvalue_separator:stringin range^.$
environment_interface
env_addresses:slistenv_name:stringenv_network:stringinherit_from: bodyinherit_frommeta:slist
environment_resources
env_baseline:stringin range"?(/.*)env_cpus:intin range0,99999999999env_disk:intin range0,99999999999env_memory:intin range0,99999999999env_spec:stringin range.*inherit_from: bodyinherit_frommeta:slist
executor
agent_expireafter:intin range0,10080exec_command:stringin range"?(/.*)executorfacility: one ofLOG_USER,LOG_DAEMON,LOG_LOCAL0,LOG_LOCAL1,LOG_LOCAL2,LOG_LOCAL3,LOG_LOCAL4,LOG_LOCAL5,LOG_LOCAL6,LOG_LOCAL7mailfilter_exclude:slistmailfilter_include:slistmailfrom:stringin range.*@.*mailmaxlines:intin range0,1000mailsubject:stringmailto:stringin range.*@.*runagent_socket_allow_users:slistschedule:slistsmtpserver:stringin range.*splaytime:intin range0,99999999999
file
file_select
atime:irangein range0,2147483647ctime:irangein range0,2147483647exec_program:stringin range"?(/.*)exec_regex:stringin range.*file_result:stringin range[!*(leaf_name|path_name|file_types|mode|size|owner|group|atime|ctime|mtime|issymlinkto|exec_regex|exec_program|bsdflags)[|&.]*]*file_types:olistin rangeplain,reg,symlink,dir,socket,fifo,door,char,blockinherit_from: bodyinherit_fromissymlinkto:slistleaf_name:slistmeta:slistmtime:irangein range0,2147483647path_name:slistin range"?(/.*)search_bsdflags:slistin range[+-]*[(arch|archived|nodump|opaque|sappnd|sappend|schg|schange|simmutable|sunlnk|sunlink|uappnd|uappend|uchg|uchange|uimmutable|uunlnk|uunlink)]+search_groups:slistsearch_mode:slistin range[0-7augorwxst,+-=]+search_owners:slistsearch_size:irangein range0,inf
hub
client_history_timeout:intin range1,65535exclude_hosts:slisthub_schedule:slistport:intin range1,65535query_timeout:intin range0,300
insert_select
inherit_from: bodyinherit_frominsert_if_contains_from_list:slistin range.*insert_if_match_from_list:slistin range.*insert_if_not_contains_from_list:slistin range.*insert_if_not_match_from_list:slistin range.*insert_if_not_startwith_from_list:slistin range.*insert_if_startwith_from_list:slistin range.*meta:slist
link_from
copy_patterns:slistinherit_from: bodyinherit_fromlink_children:booleanlink_type: one ofsymlink,hardlink,relative,absolutemeta:slistsource:stringin range.+when_linking_children: one ofoverride_file,if_no_such_filewhen_no_source: one offorce,delete,nop
location
before_after: one ofbefore,afterfirst_last: one offirst,lastinherit_from: bodyinherit_frommeta:slistselect_line_matching:stringin range.*
match_value
extraction_regex:stringinherit_from: bodyinherit_frommeta:slistselect_line_matching:stringin range.*select_line_number:intin range0,99999999999select_multiline_policy: one ofaverage,sum,first,lasttrack_growing_file:boolean
monitor
forgetrate:realin range0,1histograms:booleanmonitorfacility: one ofLOG_USER,LOG_DAEMON,LOG_LOCAL0,LOG_LOCAL1,LOG_LOCAL2,LOG_LOCAL3,LOG_LOCAL4,LOG_LOCAL5,LOG_LOCAL6,LOG_LOCAL7tcpdump:booleantcpdumpcommand:stringin range"?(/.*)
mount
edit_fstab:booleaninherit_from: bodyinherit_frommeta:slistmount_options:slistmount_server:stringmount_source:stringin range"?(/.*)mount_type: one ofnfs,nfs2,nfs3,nfs4,panfs,cifsunmount:boolean
package_method
inherit_from: bodyinherit_frommeta:slistpackage_add_command:stringin range.+package_arch_regex:stringpackage_changes: one ofindividual,bulkpackage_commands_useshell:booleanpackage_default_arch_command:stringin range"?(/.*)package_delete_command:stringin range.+package_delete_convention:stringpackage_file_repositories:slistpackage_installed_regex:stringpackage_list_arch_regex:stringpackage_list_command:stringin range.+package_list_name_regex:stringpackage_list_update_command:stringpackage_list_update_ifelapsed:intin range-99999999999,99999999999package_list_version_regex:stringpackage_multiline_start:stringpackage_name_convention:stringpackage_name_regex:stringpackage_noverify_regex:stringpackage_noverify_returncode:intin range-99999999999,99999999999package_patch_arch_regex:stringpackage_patch_command:stringin range.+package_patch_installed_regex:stringpackage_patch_list_command:stringin range.+package_patch_name_regex:stringpackage_patch_version_regex:stringpackage_update_command:stringin range.+package_verify_command:stringin range.+package_version_equal_command:stringin range.+package_version_less_command:stringin range.+package_version_regex:string
package_module
default_options:slistinterpreter:stringmodule_path:stringquery_installed_ifelapsed:intin range-99999999999,99999999999query_updates_ifelapsed:intin range-99999999999,99999999999
password
data:stringformat: one ofplaintext,hashinherit_from: bodyinherit_frommeta:slist
perms
bsdflags:slistin range[+-]*[(arch|archived|nodump|opaque|sappnd|sappend|schg|schange|simmutable|sunlnk|sunlink|uappnd|uappend|uchg|uchange|uimmutable|uunlnk|uunlink)]+groups:slistin range[a-zA-Z0-9_$.-]+inherit_from: bodyinherit_frommeta:slistmode:stringin range[0-7augorwxst,+-=]+owners:slistin range[a-zA-Z0-9_$.-]+rxdirs:boolean
printfile
file_to_print:stringin range"?(/.*)inherit_from: bodyinherit_frommeta:slistnumber_of_lines:intin range-99999999999,99999999999
process_count
in_range_define:slistinherit_from: bodyinherit_frommatch_range:irangein range0,99999999999meta:slistout_of_range_define:slist
process_select
command:stringinherit_from: bodyinherit_frommeta:slistpgid:irangein range0,99999999999pid:irangein range0,99999999999ppid:irangein range0,99999999999priority:irangein range-20,+20process_owner:slistprocess_result:stringin range[(process_owner|pid|ppid||pgid|rsize|vsize|status|command|ttime|stime|tty|priority|threads)[|&!.]*]*rsize:irangein range0,99999999999status:stringstime_range:irangein range0,2147483647threads:irangein range0,99999999999ttime_range:irangein range0,99999999999tty:stringvsize:irangein range0,99999999999
rename
disable:booleandisable_mode:stringin range[0-7augorwxst,+-=]+disable_suffix:stringinherit_from: bodyinherit_frommeta:slistnewname:stringrotate:intin range0,99
replace_with
inherit_from: bodyinherit_frommeta:slistoccurrences: one ofall,firstreplace_value:stringin range.*
report_data_select
inherit_from: bodyinherit_frommeta:slistmetatags_exclude:slistin range.*metatags_include:slistin range.*monitoring_exclude:slistin range.*monitoring_include:slistin range.*promise_handle_exclude:slistin range.*promise_handle_include:slistin range.*
runagent
background_children:booleanencrypt:booleanforce_ipv4:booleanhosts:slistmax_children:intin range0,99999999999output_directory:stringin range"?(/.*)output_to_file:booleanport:intin range1,65535timeout:intin range1,9999trustkey:boolean
select_region
include_end_delimiter:booleaninclude_start_delimiter:booleaninherit_from: bodyinherit_frommeta:slistselect_end:stringin range.*select_end_match_eof:booleanselect_start:stringin range.*
server
allowallconnects:slistallowciphers:stringallowconnects:slistallowlegacyconnects:slistallowtlsversion:stringallowusers:slistauditing:booleanbindtointerface:stringcall_collect_interval:intin range0,99999999999cfruncommand:stringin range.+collect_window:intin range0,99999999999denybadclocks:booleandenyconnects:slistdynamicaddresses:slisthostnamekeys:booleanlisten:booleanlogallconnections:booleanlogencryptedtransfers:booleanmaxconnections:intin range0,99999999999port:intin range1,65535serverfacility: one ofLOG_USER,LOG_DAEMON,LOG_LOCAL0,LOG_LOCAL1,LOG_LOCAL2,LOG_LOCAL3,LOG_LOCAL4,LOG_LOCAL5,LOG_LOCAL6,LOG_LOCAL7skipverifydeprecated:slisttrustkeysfrom:slist
service_method
inherit_from: bodyinherit_frommeta:slistservice_args:stringservice_autostart_policy: one ofnone,boot_time,on_demandservice_bundle:bundleservice_dependence_chain: one ofignore,start_parent_services,stop_child_services,all_relatedservice_type: one ofwindows,generic
volume
check_foreign:booleanfreespace:stringin range[0-9]+[MBkKgGmb%]inherit_from: bodyinherit_frommeta:slistscan_arrivals:booleansensible_count:intin range0,99999999999sensible_size:intin range0,99999999999