• All Promise Types
• All Body Types

All Promise Types

[Common Attributes][Promise Types and Attributes#Common Attributes]

• action: body action
• classes: body classes
• 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: body report_data_select
• resource_type: one of path, literal, context, query, variable, bundle
• shortcut: string

build_xpath

• build_xpath: string
• select_xpath: string

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 range 0,99999999999
• scope: one of namespace, bundle
• select_class: clist in range [a-zA-Z0-9_!&@@$|.()\[\]{}:]+
• xor: clist in range [a-zA-Z0-9_!&@@$|.()\[\]{}:]+

commands

• arglist: slist in range .*
• args: string
• contain: body contain
• inform: boolean
• module: boolean

databases

• database_columns: slist in range .*
• database_operation: one of create, delete, drop, cache, verify, restore
• database_rows: slist in range .*,.*
• database_server: body database_server
• database_type: one of sql, ms_registry
• registry_exclude: slist

defaults

• if_match_regex: string
• slist: slist
• string: string

delete_attribute

• build_xpath: string
• select_xpath: string

delete_lines

• delete_select: body delete_select
• not_matching: boolean
• select_region: body select_region

delete_text

• build_xpath: string
• select_xpath: string

delete_tree

• build_xpath: string
• select_xpath: string

field_edits

• edit_field: body edit_field
• select_region: body select_region

files

• acl: body acl
• changes: body changes
• copy_from: body copy_from
• create: boolean
• delete: body delete
• depth_search: body depth_search
• edit_defaults: body edit_defaults
• edit_line: bundle
• edit_template: string in range "?(/.*)
• edit_template_string: string in range .*
• edit_xml: bundle
• file_select: body file_select
• file_type: one of regular, fifo
• link_from: body link_from
• move_obstructions: boolean
• pathtype: one of literal, regex, guess
• perms: body perms
• rename: body rename
• repository: string in range "?(/.*)
• template_data: data
• template_method: one of cfengine, inline_mustache, mustache
• touch: boolean
• transformer: string in range "?(/.*)

guest_environments

• environment_host: string in range [a-zA-Z0-9_]+
• environment_interface: body environment_interface
• environment_resources: body environment_resources
• environment_state: one of create, delete, running, suspended, down
• environment_type: one of xen, kvm, esx, vbox, test, xen_net, kvm_net, esx_net, test_net, zone, ec2, eucalyptus

insert_lines

• expand_scalars: boolean
• insert_select: body insert_select
• insert_type: one of literal, string, file, file_preserve_block, preserve_block, preserve_all_lines
• location: body location
• select_region: body select_region
• whitespace_policy: olist in range ignore_leading,ignore_trailing,ignore_embedded,exact_match

insert_text

• build_xpath: string
• select_xpath: string

insert_tree

• build_xpath: string
• select_xpath: string

measurements

• data_type: one of counter, int, real, string, slist
• history_type: one of weekly, scalar, static, log
• match_value: body match_value
• stream_type: one of pipe, file
• units: string

meta

• data: data
• slist: slist
• string: string

methods

• inherit: boolean
• usebundle: bundle
• useresult: string in range [a-zA-Z0-9_$(){}\[\].:]+

packages

• additional_packages: slist
• architecture: string
• options: slist
• package_architectures: slist
• package_method: body package_method
• package_module: body package_module
• package_policy: one of add, delete, reinstall, update, addupdate, patch, verify
• package_select: one of >, <, ==, !=, >=, <=
• package_version: string
• policy: one of absent, present
• version: string

processes

• process_count: body process_count
• process_select: body process_select
• process_stop: string in range "?(/.*)
• restart_class: string in range [a-zA-Z0-9_$(){}\[\].:]+
• signals: olist in range hup,int,trap,kill,pipe,cont,abrt,stop,quit,term,child,usr1,usr2,bus,segv

replace_patterns

• replace_with: body replace_with
• select_region: body select_region

reports

• bundle_return_value_index: string in range [a-zA-Z0-9_$(){}\[\].:]+
• friend_pattern: string
• intermittency: real in range 0,1
• lastseen: int in range 0,99999999999
• printfile: body printfile
• report_to_file: string in range "?(/.*)
• showstate: slist

roles

• authorize: slist

services

• service_dependencies: slist in range [a-zA-Z0-9_$(){}\[\].:]+
• service_method: body service_method
• service_policy: string

set_attribute

• attribute_value: string
• build_xpath: string
• select_xpath: string

set_text

• build_xpath: string
• select_xpath: string

storage

• mount: body mount
• volume: body volume

users

• description: string
• group_primary: string
• groups_secondary: slist in range .*
• home_bundle: bundle
• home_bundle_inherit: boolean
• home_dir: string in range "?(/.*)
• password: body password
• policy: one of present, 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 of free, 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 of nochange, access, specify, clear
• acl_directory_inherit^deprecated: one of nochange, parent, specify, clear
• acl_inherit: one of true, false, yes, no, on, off, nochange
• acl_method: one of append, overwrite
• acl_type: one of generic, posix, ntfs
• inherit_from: body inherit_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 of fix, warn, nop
• audit: boolean
• background: boolean
• expireafter: int in range 0,99999999999
• ifelapsed: int in range 0,99999999999
• inherit_from: body inherit_from
• log_failed: string in range stdout|udp_syslog|("?[a-zA-Z]:\\.*)|(/.*)
• log_kept: string in range stdout|udp_syslog|("?[a-zA-Z]:\\.*)|(/.*)
• log_level: one of inform, verbose, error, log
• log_priority: one of emergency, alert, critical, error, warning, notice, info, debug
• log_repaired: string in range stdout|udp_syslog|("?[a-zA-Z]:\\.*)|(/.*)
• log_string: string
• measurement_class: string
• meta: slist
• report_level: one of inform, verbose, error, log

agent

• abortbundleclasses: slist in range .*
• abortclasses: slist in range .*
• addclasses: slist in range .*
• agentaccess: slist in range .*
• agentfacility: one of LOG_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 range 0,60
• childlibpath: string in range .*
• default_repository: string in range "?(/.*)
• default_timeout: int in range 0,99999999999
• defaultcopytype: one of mtime, atime, ctime, digest, hash, binary
• dryrun: boolean
• editbinaryfilesize: int in range 0,99999999999
• editfilesize: int in range 0,99999999999
• environment: slist in range [A-Za-z0-9_]+=.*
• expireafter: int in range 0,99999999999
• files_auto_define: slist
• files_single_copy: slist
• hashupdates: boolean
• hostnamekeys: boolean
• ifelapsed: int in range 0,99999999999
• inform: boolean
• intermittency: boolean
• max_children: int in range 0,99999999999
• maxconnections: int in range 0,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 range 0,99999999999
• sensiblesize: int in range 0,99999999999
• skipidentify: boolean
• suspiciousnames: slist
• timezone: slist
• verbose: boolean

changes

• hash: one of md5, sha1, sha224, sha256, sha384, sha512, best
• inherit_from: body inherit_from
• meta: slist
• report_changes: one of all, 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: body inherit_from
• kept_returncodes: slist in range [-0-9_$(){}\[\].]+
• meta: slist
• persist_time: int in range 0,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 of namespace, bundle
• timer_policy: one of absolute, reset

common

• bundlesequence: slist in range .*
• bwlimit: real in range 0,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 range 0,99999999999
• output_prefix: string
• package_inventory: slist in range .*
• package_module: string in range .*
• protocol_version: one of 1, classic, 2, tls, 3, cookie, 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 range 0,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 range 1,3600
• inherit_from: body inherit_from
• meta: slist
• no_output: boolean
• preview: boolean
• umask: string
• useshell: one of noshell, useshell, powershell, true, false, yes, no, on, off

copy_from

• check_root: boolean
• collapse_destination_dir: boolean
• compare: one of atime, mtime, ctime, digest, hash, exists, binary
• copy_backup: one of true, false, timestamp
• copy_size: irange in range 0,inf
• copylink_patterns: slist
• encrypt: boolean
• findertype: one of MacOSX
• force_ipv4: boolean
• force_update: boolean
• inherit_from: body inherit_from
• link_type: one of symlink, hardlink, relative, absolute
• linkcopy_patterns: slist
• meta: slist
• missing_ok: boolean
• portnumber: string
• preserve: boolean
• protocol_version: one of 1, classic, 2, tls, 3, cookie, latest
• purge: boolean
• servers: slist in range [A-Za-z0-9_.:\-\[\]]+
• source: string in range .+
• stealth: boolean
• timeout: int in range 1,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 of postgres, mysql
• inherit_from: body inherit_from
• meta: slist

delete

• dirlinks: one of delete, tidy, keep
• inherit_from: body inherit_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: body inherit_from
• meta: slist

depth_search

• depth: int in range 0,99999999999
• exclude_dirs: slist in range .*
• include_basedir: boolean
• include_dirs: slist in range .*
• inherit_from: body inherit_from
• meta: slist
• rmdeadlinks: boolean
• traverse_links: boolean
• xdev: boolean

edit_defaults

• edit_backup: one of true, false, timestamp, rotate
• empty_file_before_editing: boolean
• inherit: boolean
• inherit_from: body inherit_from
• max_file_size: int in range 0,99999999999
• meta: slist
• recognize_join: boolean
• rotate: int in range 0,99

edit_field

• allow_blank_fields: boolean
• extend_fields: boolean
• field_operation: one of prepend, append, alphanum, delete, set
• field_separator: string in range .*
• field_value: string in range .*
• inherit_from: body inherit_from
• meta: slist
• select_field: int in range 0,99999999
• start_fields_from_zero: boolean
• value_separator: string in range ^.$

environment_interface

• env_addresses: slist
• env_name: string
• env_network: string
• inherit_from: body inherit_from
• meta: slist

environment_resources

• env_baseline: string in range "?(/.*)
• env_cpus: int in range 0,99999999999
• env_disk: int in range 0,99999999999
• env_memory: int in range 0,99999999999
• env_spec: string in range .*
• inherit_from: body inherit_from
• meta: slist

executor

• agent_expireafter: int in range 0,10080
• exec_command: string in range "?(/.*)
• executorfacility: one of LOG_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 range 0,1000
• mailsubject: string
• mailto: string in range .*@.*
• schedule: slist
• smtpserver: string in range .*
• splaytime: int in range 0,99999999999

file

• inputs: slist in range .*
• namespace: string in range [a-zA-Z_][a-zA-Z0-9_]*

file_select

• atime: irange in range 0,2147483647
• ctime: irange in range 0,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 range plain,reg,symlink,dir,socket,fifo,door,char,block
• inherit_from: body inherit_from
• issymlinkto: slist
• leaf_name: slist
• meta: slist
• mtime: irange in range 0,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 range 0,inf

hub

• client_history_timeout: int in range 1,65535
• exclude_hosts: slist
• hub_schedule: slist
• port: int in range 1,65535
• query_timeout: int in range 0,300

insert_select

• inherit_from: body inherit_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: body inherit_from
• link_children: boolean
• link_type: one of symlink, hardlink, relative, absolute
• meta: slist
• source: string in range .+
• when_linking_children: one of override_file, if_no_such_file
• when_no_source: one of force, delete, nop

location

• before_after: one of before, after
• first_last: one of first, last
• inherit_from: body inherit_from
• meta: slist
• select_line_matching: string in range .*

match_value

• extraction_regex: string
• inherit_from: body inherit_from
• meta: slist
• select_line_matching: string in range .*
• select_line_number: int in range 0,99999999999
• select_multiline_policy: one of average, sum, first, last
• track_growing_file: boolean

monitor

• forgetrate: real in range 0,1
• histograms: boolean
• monitorfacility: one of LOG_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: body inherit_from
• meta: slist
• mount_options: slist
• mount_server: string
• mount_source: string in range "?(/.*)
• mount_type: one of nfs, nfs2, nfs3, nfs4, panfs, cifs
• unmount: boolean

package_method

• inherit_from: body inherit_from
• meta: slist
• package_add_command: string in range .+
• package_arch_regex: string
• package_changes: one of individual, 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 of plaintext, hash
• inherit_from: body inherit_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: body inherit_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: body inherit_from
• meta: slist
• number_of_lines: int in range 0,99999999999

process_count

• in_range_define: slist
• inherit_from: body inherit_from
• match_range: irange in range 0,99999999999
• meta: slist
• out_of_range_define: slist

process_select

• command: string
• inherit_from: body inherit_from
• meta: slist
• pgid: irange in range 0,99999999999
• pid: irange in range 0,99999999999
• ppid: irange in range 0,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 range 0,99999999999
• status: string
• stime_range: irange in range 0,2147483647
• threads: irange in range 0,99999999999
• ttime_range: irange in range 0,99999999999
• tty: string
• vsize: irange in range 0,99999999999

rename

• disable: boolean
• disable_mode: string in range [0-7augorwxst,+-=]+
• disable_suffix: string
• inherit_from: body inherit_from
• meta: slist
• newname: string
• rotate: int in range 0,99

replace_with

• inherit_from: body inherit_from
• meta: slist
• occurrences: one of all, first
• replace_value: string in range .*

report_data_select

• inherit_from: body inherit_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 range 0,99999999999
• output_directory: string in range "?(/.*)
• output_to_file: boolean
• port: int in range 1,65535
• timeout: int in range 1,9999
• trustkey: boolean

select_region

• include_end_delimiter: boolean
• include_start_delimiter: boolean
• inherit_from: body inherit_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 range 0,99999999999
• cfruncommand: string in range .+
• collect_window: int in range 0,99999999999
• denybadclocks: boolean
• denyconnects: slist
• dynamicaddresses: slist
• hostnamekeys: boolean
• listen: boolean
• logallconnections: boolean
• logencryptedtransfers: boolean
• maxconnections: int in range 0,99999999999
• port: int in range 1,65535
• serverfacility: one of LOG_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: body inherit_from
• meta: slist
• service_args: string
• service_autostart_policy: one of none, boot_time, on_demand
• service_bundle: bundle
• service_dependence_chain: one of ignore, start_parent_services, stop_child_services, all_related
• service_type: one of windows, generic

volume

• check_foreign: boolean
• freespace: string in range [0-9]+[MBkKgGmb%]
• inherit_from: body inherit_from
• meta: slist
• scan_arrivals: boolean
• sensible_count: int in range 0,99999999999
• sensible_size: int in range 0,99999999999