Actions
Bug #20238
closed
cannot install openscap plugin in rudder 7.0
Added by Nicolas CHARLES about 3 years ago. Updated over 1 year ago.
Pull Request:
Severity:
UX impact:
User visibility:
Effort required:
Priority:
0
Name check:
To do
Fix check:
To do
Regression:
Description
technique is not available on system
a surprising run.log file exists in /var/rudder/configuration-repository
2021-11-03 16:54:04,749 - DEBUG - Starting new HTTPS connection (1): localhost:443 2021-11-03 16:54:05,488 - DEBUG - https://localhost:443 "GET /rudder/api/internal/methods HTTP/1.1" 200 287826 2021-11-03 16:54:05,502 - DEBUG - Starting new HTTPS connection (1): localhost:443 2021-11-03 16:54:06,226 - DEBUG - https://localhost:443 "PUT /rudder/api/internal/techniques HTTP/1.1" 500 177 2021-11-03 16:54:06,227 - ERROR - ESC[91mError while importing technique plugin_openscap_policies: None Rudder returned code 500Could not create ncf technique <- parameter bundle_name cannot be empty <- parameter 'bundle_name' cannot be emptyESC[0m
only the file techniques/OpenSCAP_Policies_plugin/category.xml exists
Updated by Nicolas CHARLES about 3 years ago
what is sent to the webapp is
{'path': '/var/rudder/configuration-repository/ncf', 'technique': {'bundle_name': 'plugin_openscap_policies', 'description': '## Summary\n\nThis technique triggers an OpenSCAP audit every day, between 2:00 and 8:00 by default, and sends the report to the Rudder Server to be displayed on the Node Details.\n\n## Usage\n\nThis Technique takes 2 parameters:\n\n* *profile*: name of the profile to check (e.g. RHEL6-Default)\n* *scap_file*: XCCDF Checklist file (e.g XCCDF Checklist)\n\nWhen a Directive based on this Technique is applied on a Node, a new tab _OpenSCAP_ is available for this node, displaying a sanitized (no JS, no CSS) version of the reports, plus a link to download the raw version.\n\n## Resource\n\nAn introduction to OpenSCAP is available [here](https://www.open-scap.org/getting-started/) that explains the concepts of profile, and checklist file', 'name': 'plugin_openscap_policies', 'version': '1.0', 'parameter': [{'id': '0bad6c1e-59c9-44ca-a935-210af4188643', 'name': 'profile', 'description': 'name of the profile to check (e.g. RHEL7-Default)'}, {'id': '182dffe7-4310-4e01-bdd0-3f7db8272e2f', 'name': 'scap_file', 'description': 'XCCDF Checklist file (e.g. /path/to//U_RHEL_7_V2R7_STIG_SCAP_1-2_Benchmark.xml)'}], 'method_calls': [{'args': ['openscap', '${system_common.agent_run_interval}', '0', '6', '0', '2', '0', '0', '0', '1', 'nodups'], 'class_context': 'any', 'method_name': 'schedule_simple', 'component': 'Schedule Simple'}, {'args': ['openscap', 'packages', 'ssg-base,ssg-debderived,ssg-debian,ssg-nondebian,ssg-applications', ','], 'class_context': 'debian_10', 'method_name': 'variable_iterator', 'component': 'OpenSCAP packages'}, {'args': ['openscap', 'packages', 'libopenscap8', ','], 'class_context': 'debian_9', 'method_name': 'variable_iterator', 'component': 'OpenSCAP packages'}, {'args': ['openscap', 'packages', 'ssg-base,ssg-debderived,ssg-debian,ssg-nondebian,ssg-applications', ','], 'class_context': 'ubuntu_18', 'method_name': 'variable_iterator', 'component': 'OpenSCAP packages'}, {'args': ['openscap', 'packages', 'scap-security-guide,openscap-scanner', ','], 'class_context': 'redhat', 'method_name': 'variable_iterator', 'component': 'OpenSCAP packages'}, {'args': ['openscap', 'packages', 'openscap', ','], 'class_context': 'SUSE.(!sles_10)', 'method_name': 'variable_iterator', 'component': 'OpenSCAP packages'}, {'args': ['${openscap.packages}', '', '', ''], 'class_context': 'any', 'method_name': 'package_present', 'component': 'Package present'}, {'args': ['oscap xccdf eval --profile ${profile} --report /var/rudder/tmp/openscap_report.html ${scap_file}', '0,2', '254'], 'class_context': 'any.(schedule_simple_openscap_repaired)', 'method_name': 'command_execution_result', 'component': 'run scan Openscap'}, {'args': ['root', 'openscap_report.html', '/var/rudder/tmp/openscap_report.html', '1d'], 'class_context': 'any.(schedule_simple_openscap_repaired)', 'method_name': 'sharedfile_to_node', 'component': 'send report to server'}]}, 'methods': [{'bundle_name': 'audit_from_osquery', 'name': 'Audit from osquery', 'description': 'Audit a system property through osquery', 'class_prefix': 'audit_from_osquery', 'class_parameter': 'query', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'query', 'description': 'The query to execute (ending with a semicolon)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'comparator', 'description': "The comparator to use ('=', '!=' or '~', default is '=')", 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384, 'select': ['', '=', '!=', '~']}, 'type': 'string'}, {'name': 'value', 'description': 'The expected value', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This method uses osquery to fetch information about the system,\nand compares the value with the given one, using the provided comparator.\n\n#### Parameters\n\n* `query` is an osquery query returning exactly one result\n* `comparator` is the comparator to use: "=" for equality, "!=" for non-equality, "~" for regex comparison\n* `value` is the expected value, can be a string or a regex depending on the comparator\n\n#### Setup\n\nThis method requires the presence of [osquery](https://osquery.io/) on the target nodes.\nIt won\'t install it automatically. Check the correct way of doing so for your OS.\n\n#### Building queries\n\nTo learn about the possible queries, read the [osquery schema](https://osquery.io/schema/) for your\nosquery version.\n\nYou can test the queries before using them with the `osqueryi` command, see the example below.\n\n```\nosqueryi "select cpu_logical_cores from system_info;"\n```\n\nYou need to provide a query that returns exactly one value. If it\'s not the case, the method\nwill fail as it does not know what to check.\n\n#### Examples\n\n```\n# To check the number of cpus on the machine\naudit_from_osquery("select cpu_logical_cores from system_info;", "2");\n```\n\nWill report a compliant report if the machine has 3 cores, and a non compliant one if not.', 'parameter_rename': []}, {'bundle_name': 'command_execution', 'name': 'Command execution', 'description': 'Execute a command', 'class_prefix': 'command_execution', 'class_parameter': 'command', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'command', 'description': 'Command to run', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Execute the **Command** in shell.\nOn DSC agent, the **Command** in executed through the Powershell `&` operator.\n\nThe method status will report:\n\n* a **Repaired** if the return code is "0",\n* an **Error** if the return code is not "0"', 'parameter_rename': []}, {'bundle_name': 'command_execution_once', 'name': 'Command execution once', 'description': 'Execute a command only once on a node', 'class_prefix': 'command_execution_once', 'class_parameter': 'command', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'command', 'description': 'Command to run', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'ok_codes', 'description': 'List of codes that produce a repaired status separated with commas (ex: 1,2,5). Defaults to 0.', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'until', 'description': "Try to execute the command until a particular state: 'ok', 'any' (defaults to 'any')", 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384, 'select': ['', 'any', 'ok']}, 'type': 'string'}, {'name': 'unique_id', 'description': "To identify the action without losing track if the command changes. Defaults to the command if you don't need it.", 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This method is useful for specific commands that should only be executed once per node.\n\nIf you can spot a condition for the command execution by testing the state of its target,\nit is better to use the `condition_from_command` method to test the state coupled with\nthe `command_execution_result` method to run the command if necessary.\n\n##### The method will:\n\n**Define** the `command_execution_once_${command}_kept` condition and do nothing if\na `command_execution_once` has already been executed on this machine with the same\n**Unique id**.\n\n**Execute** the command if it is the first occurrence and:\n* If the parameter **Until** is `*any*`, it will consider the command as executed on the machine and define\n either:\n * `command_execution_once_${command}_repaired` if the return code is in **ok_codes**,\n * `command_execution_once_${command}_error` otherwise.\n* If the parameter **Until** is *ok* and:\n * If the return code is in the **Ok codes** list, define the\n `command_execution_once_${command}_repaired` condition\n * If the return code is not in **Ok codes** it define the\n `command_execution_once_${command}_error` condition and **retry at next agent run**.\n\nIf an exit code is not in the list it will lead to an error status.\nIf you want "0" to be a success you have to list it in the **Ok codes** list\n\n##### Example:\n\nIf you use:\n\n```\n command_execution_once("command -a -t", "0", "ok", "my_program_setup")\n```\n\nIt will retry to run `command -a -t` until it returns "0". Then it will\nnot execute it again.', 'parameter_rename': []}, {'bundle_name': 'command_execution_result', 'name': 'Command execution result', 'description': 'Execute a command and create result conditions depending on its exit code', 'class_prefix': 'command_execution_result', 'class_parameter': 'command', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'command', 'description': 'Command to run', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'kept_codes', 'description': 'List of codes that produce a kept status separated with commas (ex: 1,2,5)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'repaired_codes', 'description': 'List of codes that produce a repaired status separated with commas (ex: 3,4,6)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Execute a command and create result conditions\ndepending on the exit codes given in parameters.\nIf an exit code is not in the list it will lead to an error status.\nIf you want 0 to be a success you have to list it in the **kept_codes** list', 'parameter_rename': []}, {'bundle_name': 'condition_from_command', 'name': 'Condition from command', 'description': 'Execute a command and create result conditions depending on its exit code', 'class_prefix': 'condition_from_command', 'class_parameter': 'condition', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'condition', 'description': 'The condition name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'command', 'description': 'The command to run', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'true_codes', 'description': 'List of codes that produce a true status separated with commas (ex: 1,2,5)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'false_codes', 'description': 'List of codes that produce a false status separated with commas (ex: 3,4,6)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This method executes a command, and defines a `${condition}_true` or a\n `${condition}_false` condition depending on the result of the command:\n\n* If the exit code **is in the "True codes"** list, this will produce a\n kept outcome and a\n `${condition}_true` condition,\n* If the exit code **is in the "False codes"** list, this will produce a\n kept outcome and a\n `${condition}_false` condition,\n* If the exit code **is not in "True codes" nor in "False codes"**, or if\n the command can not be found, it will produce an\n error outcome and\n and no condition from `${condition}`\n\n\nThe created condition is global to the agent.\n\n##### Example:\n\nIf you run a command `/bin/check_network_status` that output code 0, 1 or 2 in\ncase of correct configuration, and 18 or 52 in case of invalid configuration,\nand you want to define a condition based on its execution result,\nyou can use:\n\n```\ncondition_from_command("network_correctly_defined", "/bin/check_network_status", "0,1,2", "18,52")\n```\n\n* If the command exits with 0, 1 or 2, then it will define the conditions\n * `network_correctly_defined_true`,\n * `condition_from_command_network_correctly_defined_kept`,\n * `condition_from_command_network_correctly_defined_reached`,\n\n* If the command exits 18, 52, then it will define the conditions\n * `network_correctly_defined_false`,\n * `condition_from_command_network_correctly_defined_kept`,\n * `condition_from_command_network_correctly_defined_reached`\n\n* If the command exits any other code or is not found, then it will define the conditions\n * `condition_from_command_network_correctly_defined_error`,\n * `condition_from_command_network_correctly_defined_reached`\n\n##### Notes:\n\n* In audit mode, this method will still execute the command passed in parameter.\n Which means that you should only pass non system-impacting commands to this method.\n\n* Rudder will automatically "canonify" the given **Condition prefix** at execution time,\n which means that all non `[a-zA-Z0-9_]` characters will be replaced by an underscore.', 'parameter_rename': [{'old': 'condition_prefix', 'new': 'condition'}]}, {'bundle_name': 'condition_from_expression', 'name': 'Condition from expression', 'description': 'Create a new condition', 'class_prefix': 'condition_from_expression', 'class_parameter': 'condition', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'condition', 'description': 'The condition prefix', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'expression', 'description': "The expression evaluated to create the condition (use 'any' to always evaluate to true)", 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This method evaluates an expression, and produces a `${condition}_true`\nor a `${condition}_false` condition depending on the result of the\nexpression evaluation:\n\n* This method always result with a *success* outcome status\n* If the evaluation results in a "defined" state, this will define a\n `${condition}_true` condition,\n* If the evaluation results in an "undefined" state, this will produce a\n `${condition}_false` condition.\n\n\nCalling this method with a condition expression transforms a complex expression into a single condition.\n\nThe created condition is global to the agent.\n\n##### Example\n\nIf you want to check if a condition evaluates to true, like checking that you\nare on Monday, 2am, on RedHat systems, you can use the following policy\n\n```\ncondition_from_expression("backup_time", "Monday.redhat.Hr02")\n```\n\nThe method will define:\n* In any case:\n * `condition_from_expression_backup_time_kept`\n * `condition_from_expression_backup_time_reached`\n* And:\n * `backup_time_true` if the system is a RedHat like system, on Monday, at 2am.\n * `backup_time_false` if the system not a RedHat like system, or it\'s not Monday, or it\'s not 2am\n * no extra condition if the expression is invalid (cannot be parsed)\n\n##### Notes:\n\nRudder will automatically "canonify" the given **Condition prefix** at execution time,\nwhich means that all non `[a-zA-Z0-9_]` characters will be replaced by an underscore.', 'parameter_rename': [{'old': 'condition_prefix', 'new': 'condition'}, {'old': 'condition_expression', 'new': 'expression'}]}, {'bundle_name': 'condition_from_expression_persistent', 'name': 'Condition from expression persistent', 'description': 'Create a new condition that persists across runs', 'class_prefix': 'condition_from_expression_persistent', 'class_parameter': 'condition', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'condition', 'description': 'The condition prefix', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'expression', 'description': "The expression evaluated to create the condition (use 'any' to always evaluate to true)", 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'duration', 'description': 'The persistence suffix in minutes', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This method evaluates an expression (=condition combination), and produces a `${condition}_true`\nor a `${condition}_false` condition depending on the result on the expression,\nwhich will lasts for the **Duration** time:\n\n* This method always result with a *success* outcome status\n* If the expression evaluation results in a "defined" state, this will define a `${condition}_true` condition,\n* If the expression evaluation results in an "undefined" state, this will produce a `${condition}_false` condition.\n\n\nCalling this method with a condition expression transforms a complex expression into a single class condition.\n\nThe created condition is global to the agent and is persisted across runs.\nThe persistence duration is controlled using the parameter **Duration** which defines for how long the target\ncondition will be defined (in minutes). Note that there is no way to persist indefinitely.\n\n##### Example:\n\nIf you want to check if a condition evaluates to true, like checking that you\nare on Monday, 2am, on RedHat systems, and make it last one hour you can use the following policy\n\n```\ncondition_from_expression_persistent_("backup_time", "Monday.redhat.Hr02", "60")\n```\nThe method will define:\n* In any case:\n * `condition_from_expression_persistent_backup_time_kept`\n * `condition_from_expression_persistent_backup_time_reached`\n* And:\n * `backup_time_true` if the system is a RedHat like system, on Monday,\n at 2am, and will persist for **Duration** minutes,\n * `backup_time_false` if the system not a RedHat like system, or it\'s not Monday, or it\'s not 2am\n * no extra condition if the expression is invalid (cannot be parsed)\n\n##### Notes:\n\nRudder will automatically "canonify" the given **Condition prefix** at execution time,\nwhich means that all non `[a-zA-Z0-9_]` characters will be replaced by an underscore.', 'parameter_rename': [{'old': 'condition_prefix', 'new': 'condition'}, {'old': 'condition_expression', 'new': 'expression'}]}, {'bundle_name': 'condition_from_variable_existence', 'name': 'Condition from variable existence', 'description': 'Create a condition from the existence of a variable', 'class_prefix': 'condition_from_variable_existence', 'class_parameter': 'condition', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'condition', 'description': 'Prefix of the condition', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'variable_name', 'description': 'Complete name of the variable being tested, like my_prefix.my_variable', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This method define a condition:\n* `{condition}_true` if the variable named from\n the parameter **Variable name** is defined\n* `{condition}_false` if the variable named from\n the parameter **Variable name** is not defined\n\nAlso, this method always result with a *success* outcome status.', 'parameter_rename': [{'old': 'condition_prefix', 'new': 'condition'}]}, {'bundle_name': 'condition_from_variable_match', 'name': 'Condition from variable match', 'description': 'Test the content of a string variable', 'class_prefix': 'condition_from_variable_match', 'class_parameter': 'condition', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'condition', 'description': 'Prefix of the class (condition) generated', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'variable_name', 'description': 'Complete name of the variable being tested, like my_prefix.my_variable', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'expected_match', 'description': 'Regex to use to test if the variable content is compliant', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Test a variable content and create conditions depending on its value:\n* If the variable **is found and its content matches** the given regex:\n * a `${condition}_true` condition,\n * and **kept outcome** status\n* If the variable **is found but its content does not match** the given regex:\n * a `${condition}_false` condition,\n * and a **kept outcome** status\n* If the variable **can not be found**:\n * a `${condition}_false` condition\n * and an **error outcome** status\n\n/!\\ Regex for unix machine must be PCRE compatible and those for Windows agent must respect the .Net regex format.\n\n* If you want to test a technique parameter, use the `technique_id` of the technique\n as variable prefix and the`parameter_name` as variable name.', 'parameter_rename': [{'old': 'condition_prefix', 'new': 'condition'}]}, {'bundle_name': 'condition_once', 'name': 'Condition once', 'description': 'Create a new condition only once', 'class_prefix': 'condition_once', 'class_parameter': 'condition', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'condition', 'description': 'The condition to define', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This method define a condition named from the parameter **Condition** when it is\ncalled for the first time. Following agent execution will not define the\ncondition.\n\nThis allows executing actions only once on a given machine.\nThe created condition is global to the agent.\n\n##### Example:\n\nIf you use:\n\n```\ncondition_once("my_condition")\n```\n\nThe first agent run will have the condition `my_condition` defined, contrary to subsequent runs\nfor which no condition will be defined.\n\nSee also : [command\\_execution\\_once](#_command_execution_once)', 'parameter_rename': []}, {'bundle_name': 'directory_absent', 'name': 'Directory absent', 'description': "Ensure a directory's absence", 'class_prefix': 'directory_absent', 'class_parameter': 'path', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'Directory to remove', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'recursive', 'description': 'Should deletion be recursive, "true" or "false" (defaults to "false")', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'If `recursive` is false, only an empty directory can be deleted.', 'parameter_rename': [{'old': 'target', 'new': 'path'}]}, {'bundle_name': 'directory_check_exists', 'name': 'Directory check exists', 'description': 'Checks if a directory exists', 'class_prefix': 'directory_check_exists', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'Full path of the directory to check', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': "This bundle will define a condition `directory_check_exists_${path}_{ok, reached, kept}` if the\ndirectory exists, or `directory_check_exists_${path}_{not_ok, reached, not_kept, failed}` if\nthe directory doesn't exists", 'parameter_rename': [{'old': 'directory_name', 'new': 'path'}]}, {'bundle_name': 'directory_create', 'name': 'Directory create', 'description': "Create a directory if it doesn't exist", 'class_prefix': 'directory_create', 'class_parameter': 'path', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': "Full path of directory to create (trailing '/' is optional)", 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'deprecated': 'Use [directory_present](#_directory_present) instead.', 'rename': 'directory_present', 'parameter_rename': [{'old': 'target', 'new': 'path'}]}, {'bundle_name': 'directory_present', 'name': 'Directory present', 'description': "Create a directory if it doesn't exist", 'class_prefix': 'directory_present', 'class_parameter': 'path', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': "Full path of directory to create (trailing '/' is optional)", 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': "Create a directory if it doesn't exist.", 'parameter_rename': [{'old': 'target', 'new': 'path'}]}, {'bundle_name': 'dsc_apply', 'name': 'DSC Apply', 'description': 'Ensure that all MOF files under MOFFile are applied via DSC.', 'class_prefix': 'dsc_apply', 'class_parameter': 'MOFFile', 'agent_support': ['dsc'], 'parameter': [{'name': 'MOFFile', 'description': 'Path to the mof that need to be applied', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Ensure that all MOF files contained under the target folder are applied via DSC\non the target node.', 'rename': 'dsc_mof_file_apply', 'parameter_rename': []}, {'bundle_name': 'dsc_built_in_resource', 'name': 'DSC built-in resource', 'description': 'This generic method defines if service should run or be stopped', 'class_prefix': 'dsc_built_in_resource', 'class_parameter': 'tag', 'agent_support': ['dsc'], 'parameter': [{'name': 'tag', 'description': 'Informative name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'resourceName', 'description': 'resourceName', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'scriptBlock', 'description': 'Desired state for the resource', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'HereString'}], 'documentation': 'Apply a given DSC resource to the node.\n\n#### Parameters\n\n* `tag` parameter is purely informative and has no impact on the resource.\n* `ResourceName` must be the explicit name of the DSC resource you wish to apply\n* `ScriptBlock` must be a powershell script in plain text, returning an Hashtable containing\n the parameters to pass to the resource.\n\nNote that this method can only apply built-in Windows resources.\nIt will not be able to apply an external resource.\n\n#### Example\n\nIf we want to apply a [Registry resource](https://docs.microsoft.com/en-us/powershell/scripting/dsc/reference/resources/windows/registryresource?view=powershell-7).\nThe `resourceName` used will be `Registry`\nAnd a potential ScriptBlock could be:\n\n~~~\n $HKLM_SOFT="HKEY_LOCAL_MACHINE\\SOFTWARE"\n $Ensure = "Present"\n $Key = $HKLM_SOFT + "\\ExampleKey"\n\n $table = @{}\n $table.Add("Ensure", $Ensure)\n $table.Add("Key", $Key)\n $table.Add("ValueName", "RudderTest")\n $table.Add("ValueData", "TestData")\n $table\n~~~\n\nNote that all the ScriptBlock will be readable on the Rudder logs or in the policy files.', 'parameter_rename': []}, {'bundle_name': 'dsc_from_configuration', 'name': 'DSC from configuration', 'description': 'Compile and apply a given DSC configuration defined by a ps1 file', 'class_prefix': 'dsc_from_configuration', 'class_parameter': 'tag', 'agent_support': ['dsc'], 'parameter': [{'name': 'tag', 'description': 'Name of the configuration, for information purposes', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'config_file', 'description': 'Absolute path of the .ps1 configuration file', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Compile and apply a given DSC configuration.\nThe DSC configuration must be defined within a .ps1 file, and is expected to be\n"self compilable".\nA configuration data file (.psd1) containing variables can also be referenced by the ps1 script,\nby referring to it in the Configuration call.\n\nThe method will try to compile the configuration whenever the policies of the nodes are updated\nof if the previous compilation did not succeed.\n\nAll the Rudder variables are usable in your configuration.\n\nAlso the current method only allows DSC configurations to be run on the localhost target node,\nand when using a DSC push setup. Note that it may conflict with already existing DSC configurations\nnot handled by Rudder.\n\n### Example 1 - without external data\n\nHere is a configuration named `EnsureWebServer.ps1` with simple Windows feature management:\n\n```\nConfiguration EnsureWebServer {\n Node \'localhost\' {\n # Install the IIS role\n WindowsFeature IIS {\n Ensure = \'Present\'\n Name = \'Web-Server\'\n }\n\n # Install the ASP .NET 4.5 role\n WindowsFeature AspNet45 {\n Ensure = \'Present\'\n Name = \'Web-Asp-Net45\'\n }\n }\n}\n\nEnsureWebServer\n```\n\n### Example 2 with external data\n\nDsc configurations can be fed with external data, here is an example\nusing a datafile `Data.psd1` containing:\n\n```\n @{\n AllNodes = @();\n NonNodeData =\n @{\n ConfigFileContents = "Hello World! This file is managed by Rudder"\n }\n }\n```\n\nUsed to feed the `HelloWorld.ps1` Contents key:\n\n```\nConfiguration HelloWorld {\n Import-DscResource -ModuleName \'PSDesiredStateConfiguration\'\n\n Node \'localhost\' {\n File HelloWorld {\n DestinationPath = "${RudderBase}\\HelloWorld.txt"\n Ensure = "Present"\n Contents = $ConfigurationData.NonNodeData.ConfigFileContents\n }\n }\n}\n\nHelloWorld -ConfigurationData /path/to/Data.psd1\n```\n\nPlease note that the reference to the data file is done inside the configuration file.', 'parameter_rename': []}, {'bundle_name': 'dsc_mof_file_apply', 'name': 'DSC MOF File Apply', 'description': 'Ensure that all MOF files under MOFFile are applied via DSC.', 'class_prefix': 'dsc_mof_file_apply', 'class_parameter': 'MOFFile', 'agent_support': ['dsc'], 'parameter': [{'name': 'MOFFile', 'description': 'Path to the mof that need to be applied', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Ensure that all MOF files contained under the target folder are applied via DSC\non the target node.', 'parameter_rename': []}, {'bundle_name': 'environment_variable_present', 'name': 'Define environment variable', 'description': 'Enforce an environment variable value.', 'class_prefix': 'environment_variable_present', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Name of the environment variable', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'value', 'description': 'Value of the environment variable', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Force the value of a shell environment variable.\nThe variable will be written in `/etc/environment`. A newly created environment variable\nwill not be usable by the agent until it is restarted.', 'parameter_rename': []}, {'bundle_name': 'file_absent', 'name': 'File absent', 'description': 'Remove a file if it exists', 'class_prefix': 'file_absent', 'class_parameter': 'path', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File to remove (absolute path on the path node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'parameter_rename': [{'old': 'target', 'new': 'path'}]}, {'bundle_name': 'file_augeas_commands', 'name': 'File Augeas commands', 'description': 'Use Augeas binaries to execute augtool commands and options directly on the agent.', 'class_prefix': 'file_augeas_commands', 'class_parameter': 'variable_name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'variable_prefix', 'description': 'The prefix of the variable name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'variable_name', 'description': 'The variable to define, the full name will be variable_prefix.variable_name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'commands', 'description': 'The augeas command(s)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'autoload', 'description': "Deactivate the `autoload` option if you don't want augeas to load all the files/lens, it's `true` by default.", 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384, 'select': ['', 'true', 'false']}, 'type': 'string'}], 'documentation': 'Augeas is a tool that provides an abstraction layer for all the complexities that turn around editing files with regular expressions.\n\nThis method defines a rudder variable from the output of a `augtool` command. The method has in total 4 parameters:\n\n* **variable_prefix**: target variable prefix\n* **variable_name**: target variable name\n* **commands**: augtool script to run\n* **autoload**: boolean to load or not the common augeas lens, default to `true`\n\nAugtool provides bunch of other commands and options that you can use in this generic method such as `match` to print the matches for a specific\npath expression, `span` to print position in input file corresponding to tree, `retrieve` to transform tree into text and `save` to save all pending changes.\nIf Augeas isn\'t installed on the agent, it will produces an error.\n\nThis method will execute the **commands** via `augtool`.\nThe particular thing you may want to do with this method is using it depending on you needs and in two cases.\n\n#### With autoload\n\nAugeas will accordingly load all files and lenses before executing the commands you have specified since **autoload** is active.\n\n```\nfile_augeas_commands("label","value","print /files/etc/hosts/*/ipaddr[../canonical="server.rudder.local"]","")\n# The variable label.value will be defined as such:\n${label.value} -> /files/etc/hosts/2/ipaddr = "192.168.2.2"\n```\n\n```\nfile_augeas_commands("label","value","ls files/etc/ \\n print /files/etc/ssh/sshd_config","true")\n# Will define the variable label.value with the list of files availables in /etc and already parsable with augeas,\n# followed by the dump of the sshd_config file, parsed by augeas.\n```\n\n#### Without autoload\n\nThe second case is when you deactivate that option which means that you are specifying **autoload** to `false` and in this case you have to\nload manually your files and lenses in the **commands** parameter by using the `set` augeas command.\nBelow is a second example where the lens and file are explicitly set:\n\n```\nfile_augeas_commands("label","value","set /augeas/load/Sshd/lens "Sshd.lns \\n set /augeas/load/Sshd/incl "/etc/ssh/sshd_config" \\n load \\n print /augeas/load/Sshd \\n print /augeas/load/Sshd \\n print /files/etc/ssh/sshd_config","false")\n```', 'parameter_rename': []}, {'bundle_name': 'file_augeas_set', 'name': 'File Augeas set', 'description': "Use augeas commands and options to set a node label's value.", 'class_prefix': 'file_augeas_set', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'The path to the file and node label', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'value', 'description': 'The value to set', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'lens', 'description': 'Load a specific lens (optional)', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'file', 'description': 'Load a specific file (optional)', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Augeas is a tool that provides an abstraction layer for all the complexities that turn around editing files with regular expressions.\nIt\'s a tree based hierarchy tool, that handles system configuration files where you can securely modify your files and to do so you have to provide\nthe path to the node label\'s value.\n\nAugeas uses lenses which are like sort of modules that are in charge of identifying and converting files into tree and back.\n\nThis method uses `augtool` to force the value of an augeas node\'s label.\n\nActually there are two ways to use this method:\n\n* Either by providing the augeas **path** to the node\'s label and let **lens** and **file** empty.\n** this way augeas will load the common files and lens automatically\n* Or by using a given **file** path and a specific **lens**.\n** better performances since only one lens is loaded\n** support custom lens, custom paths (for instance to apply the Hosts lens to another file than `/etc/hosts`)\n* Either by simply providing an augeas **path** to the node\'s label\n\n*Warning*: When you don\'t specify the file and lens to use, no backup of the file will be made before\nediting it.\n\n#### Two uses cases examples:\n\nIn the first case, let\'s suppose that you want to set the value of the ip address of the first line in the `/etc/hosts` file to `192.168.1.5`,\nto do so you need to provide the augeas **path** and **value** parameters.\n\n```\nfile_augeas_set("/etc/hosts/1/ipaddr", "192.168.1.5", "", "");\n```\n\nThe second case is more efficient, and forces the `Hosts` lens to parse the `/etc/hosts` file and set the value for the given **path** node:\n\n```\nfile_augeas_set("/etc/hosts/1/ipaddr", "192.168.1.5", "Hosts", "/etc/hosts");\n```', 'parameter_rename': []}, {'bundle_name': 'file_block_present', 'name': 'File block present', 'description': 'Ensure that a text block is present in a specific location', 'class_prefix': 'file_block_present', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name to edit (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'block', 'description': 'Block(s) to add in the file', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Ensure that a text block is present in the target file.\nIf the block is not found, it will be added at the end of the file.\n\n#### Examples:\n\nGiven a file with the following content:\n```\napple\npear\nbanana\n```\nApplying the method with the block:\n```\npear\norange\n```\n\nWill result in the following content:\n```\napple\npear\nbanana\npear\norange\n```', 'parameter_rename': [{'old': 'file', 'new': 'path'}]}, {'bundle_name': 'file_block_present_in_section', 'name': 'File block in section', 'description': 'Ensure that a section contains exactly a text block', 'class_prefix': 'file_block_present_in_section', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name to edit (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'section_start', 'description': 'Start of the section', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'section_end', 'description': 'End of the section', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'block', 'description': 'Block representing the content of the section', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Ensure that a section contains exactly a text block.\nA section is delimited by a header and a footer.\n* If the section exists, its content will be replaced if needed\n* Otherwise it will be created at the end of the file', 'parameter_rename': [{'old': 'file', 'new': 'path'}]}, {'bundle_name': 'file_check_FIFO_pipe', 'name': 'File check is FIFO/Pipe', 'description': 'Checks if a file exists and is a FIFO/Pipe', 'class_prefix': 'file_check_FIFO_pipe', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This bundle will define a condition `file_check_FIFO_pipe_${path}_{ok, reached, kept}` if the\nfile is a FIFO, or `file_check_FIFO_pipe_${path}_{not_ok, reached, not_kept, failed}` if\nthe file is not a fifo or does not exist', 'parameter_rename': [{'old': 'file_name', 'new': 'path'}]}, {'bundle_name': 'file_check_block_device', 'name': 'File check if block device', 'description': 'Checks if a file exists and is a block device', 'class_prefix': 'file_check_block_device', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This bundle will define a condition `file_check_block_device_${path}_{ok, reached, kept}` if the\nfile is a block_device, or `file_check_block_device_${path}_{not_ok, reached, not_kept, failed}` if\nthe file is not a block device or does not exist', 'parameter_rename': [{'old': 'file_name', 'new': 'path'}]}, {'bundle_name': 'file_check_character_device', 'name': 'File check if character device', 'description': 'Checks if a file exists and is a character device', 'class_prefix': 'file_check_character_device', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This bundle will define a condition `file_check_character_device_${path}_{ok, reached, kept}` if the\nfile is a character device, or `file_check_character_device_${path}_{not_ok, reached, not_kept, failed}` if\nthe file is not a character device or does not exist', 'parameter_rename': [{'old': 'file_name', 'new': 'path'}]}, {'bundle_name': 'file_check_exists', 'name': 'File check exists', 'description': 'Checks if a file exists', 'class_prefix': 'file_check_exists', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': "This bundle will define a condition `file_check_exists_${path}_{ok, reached, kept}` if the\nfile exists, or `file_check_exists_${path}_{not_ok, reached, not_kept, failed}` if\nthe file doesn't exists", 'parameter_rename': [{'old': 'file_name', 'new': 'path'}]}, {'bundle_name': 'file_check_hardlink', 'name': 'File check is hardlink', 'description': 'Checks if two files are the same (hard links)', 'class_prefix': 'file_check_hardlink', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name #1 (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'path_2', 'description': 'File name #2 (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This bundle will define a condition `file_check_hardlink_${path}_{ok, reached, kept}` if the\ntwo files `${path}` and `${path_2}` are hard links of each other, or `file_check_hardlink_${path}_{not_ok, reached, not_kept, failed}` if\nif the files are not hard links.', 'parameter_rename': [{'old': 'file_name_1', 'new': 'path'}, {'old': 'file_name_2', 'new': 'path_2'}]}, {'bundle_name': 'file_check_regular', 'name': 'File check if regular', 'description': 'Checks if a file exists and is a regular file', 'class_prefix': 'file_check_regular', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This bundle will define a condition `file_check_regular_${path}_{ok, reached, kept}` if the\nfile is a regular_file, or `file_check_regular_${path}_{not_ok, reached, not_kept, failed}` if\nthe file is not a regular file or does not exist', 'parameter_rename': [{'old': 'file_name', 'new': 'path'}]}, {'bundle_name': 'file_check_socket', 'name': 'File check if socket', 'description': 'Checks if a file exists and is a socket', 'class_prefix': 'file_check_socket', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This bundle will define a condition `file_check_socket_${path}_{ok, reached, kept}` if the\nfile is a socket, or `file_check_socket_${path}_{not_ok, reached, not_kept, failed}` if\nthe file is not a socket or does not exist', 'parameter_rename': [{'old': 'file_name', 'new': 'path'}]}, {'bundle_name': 'file_check_symlink', 'name': 'File check if symlink', 'description': 'Checks if a file exists and is a symlink', 'class_prefix': 'file_check_symlink', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This bundle will define a condition `file_check_symlink_${path}_{ok, reached, kept}` if the\nfile is a symlink, or `file_check_symlink_${path}_{not_ok, reached, not_kept, failed}` if\nthe file is not a symlink or does not exist', 'parameter_rename': [{'old': 'file_name', 'new': 'path'}]}, {'bundle_name': 'file_check_symlinkto', 'name': 'File check is symlink to', 'description': 'Checks if first file is symlink to second file', 'class_prefix': 'file_check_symlinkto', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'Symbolic link (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'target', 'description': 'Target file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': "This bundle will define a condition `file_check_symlinkto_${target}_{ok, reached, kept}` if the file `${path}`\nis a symbolic link to `${target}`, or `file_check_symlinkto_${target}_{not_ok, reached, not_kept, failed}` if\nif it is not a symbolic link, or any of the files does not exist. The symlink's path is resolved to the \nabsolute path and checked against the target file's path, which must also be an absolute path.", 'parameter_rename': [{'old': 'symlink', 'new': 'path'}]}, {'bundle_name': 'file_content', 'name': 'File content', 'description': 'Enforce the content of a file', 'class_prefix': 'file_lines_present', 'class_parameter': 'path', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name to edit (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'lines', 'description': 'Line(s) to add in the file - if lines is a list, please use @{lines} to pass the iterator rather than iterating over each values', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'enforce', 'description': 'Enforce the file to contain only line(s) defined (true or false)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Enforce the content of a file.\nThe enforce parameter changes the edition method:\n\n* If *enforce* is set to *true* the file content will be forced\n* If *enforce* is set to *false* the file content will be forced line by line.\n Which means that each line managed can not be duplicated and the order will\n not be guaranteed.\n\nIn most cases, the *enforce* parameter should be set to *true*.\nWhen *enforce* is set to *false*, and the managed lines are:\n\n```\nBob\nAlice\nCharly\n```\n\nWill be compliant with the following file contents:\n\n```\nBob\nAlice\nCharly\n```\n\n```\nCharly\nBob\nAlice\nCharly\n```\n\n```\nBob\nCharly\nAlice\n```', 'parameter_rename': [{'old': 'file', 'new': 'path'}]}, {'bundle_name': 'file_copy_from_local_source', 'name': 'File copy from local source', 'description': 'Ensure that a file or directory is copied from a local source', 'class_prefix': 'file_copy_from_local_source', 'class_parameter': 'path', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'source', 'description': 'Source file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'path', 'description': 'Destination file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'deprecated': 'Use [file_from_local_source](#_file_from_local_source) instead.', 'rename': 'file_from_local_source', 'parameter_rename': [{'old': 'destination', 'new': 'path'}]}, {'bundle_name': 'file_copy_from_local_source_recursion', 'name': 'File copy from local source recurse', 'description': 'Ensure that a file or directory is copied from a local source', 'class_prefix': 'file_copy_from_local_source', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'source', 'description': 'Source file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'path', 'description': 'Destination file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'recursion', 'description': 'Recursion depth to enforce for this path (0, 1, 2, ..., inf)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'deprecated': 'Use [file_from_local_source_recursion](#_file_from_local_source_recursion) instead.', 'rename': 'file_from_local_source_recursion', 'parameter_rename': [{'old': 'destination', 'new': 'path'}]}, {'bundle_name': 'file_copy_from_local_source_with_check', 'name': 'File copy from local source with check', 'description': 'Ensure that a file or directory is copied from a local source if a check command succeeds', 'class_prefix': 'file_copy_from_local_source_with_check', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'source', 'description': 'Source file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'path', 'description': 'Destination file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'check_command', 'description': 'Command to run, it will get the source path as argument', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'rc_ok', 'description': 'Return codes to be considered as valid, separated by a comma (default is 0)', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This method is a conditional file copy.', 'deprecated': 'Use [file_from_local_source_with_check](#_file_from_local_source_with_check) instead.', 'rename': 'file_from_local_source_with_check', 'parameter_rename': [{'old': 'destination', 'new': 'path'}]}, {'bundle_name': 'file_copy_from_remote_source', 'name': 'File copy from remote source', 'description': 'Ensure that a file or directory is copied from a policy server', 'class_prefix': 'file_copy_from_remote_source', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'source', 'description': 'Source file (absolute path on the policy server)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'path', 'description': 'Destination file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': '*Note*: This method uses the native agent copy protocol, and can only download files from\nthe policy server. To download a file from an external source, you can use\nHTTP with the [file_download](#_file_download) method.\n\nThis method requires that the policy server is configured to accept\ncopy of the source file from the agents it will be applied to.\n\nYou can download a file from the shared files with:\n\n```\n/var/rudder/configuration-repository/shared-files/PATH_TO_YOUR_FILE\n```', 'deprecated': 'Use [file_from_remote_source](#_file_from_remote_source) instead.', 'rename': 'file_from_remote_source', 'parameter_rename': [{'old': 'destination', 'new': 'path'}]}, {'bundle_name': 'file_copy_from_remote_source_recursion', 'name': 'File copy from remote source recurse', 'description': 'Ensure that a file or directory is copied from a policy server', 'class_prefix': 'file_copy_from_remote_source', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'source', 'description': 'Source file (absolute path on the policy server)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'path', 'description': 'Destination file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'recursion', 'description': 'Recursion depth to enforce for this path (0, 1, 2, ..., inf)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This method requires that the policy server is configured to accept\ncopy of the source file or directory from the agents it will be applied to.\n\nYou can download a file from the shared files with:\n\n```\n/var/rudder/configuration-repository/shared-files/PATH_TO_YOUR_DIRECTORY_OR_FILE\n```', 'deprecated': 'Use [file_from_remote_source_recursion](#_file_from_remote_source_recursion) instead.', 'rename': 'file_from_remote_source_recursion', 'parameter_rename': [{'old': 'destination', 'new': 'path'}]}, {'bundle_name': 'file_create', 'name': 'File create', 'description': "Create a file if it doesn't exist", 'class_prefix': 'file_create', 'class_parameter': 'path', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File to create (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'deprecated': 'Use [file_present](#_file_present) instead.', 'rename': 'file_present', 'parameter_rename': [{'old': 'target', 'new': 'path'}]}, {'bundle_name': 'file_create_symlink', 'name': 'Create symlink', 'description': 'Create a symlink at a destination path and pointing to a source target except if a file or directory already exists.', 'class_prefix': 'file_create_symlink', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'source', 'description': 'Source file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'path', 'description': 'Destination file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'deprecated': 'Use [file_symlink_present](#_file_symlink_present) instead.', 'rename': 'file_symlink_present', 'parameter_rename': [{'old': 'destination', 'new': 'path'}]}, {'bundle_name': 'file_create_symlink_enforce', 'name': 'Create symlink (optional overwriting)', 'description': 'Create a symlink at a destination path and pointing to a source target. This is also possible to enforce its creation', 'class_prefix': 'file_create_symlink', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'source', 'description': 'Source file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'path', 'description': 'Destination file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'enforce', 'description': 'Force symlink if file already exist (true or false)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'deprecated': 'Use [file_symlink_present_option](#_file_symlink_present_option) instead.', 'rename': 'file_symlink_present_option', 'parameter_rename': [{'old': 'destination', 'new': 'path'}]}, {'bundle_name': 'file_create_symlink_force', 'name': 'Create symlink (force overwrite)', 'description': 'Create a symlink at a destination path and pointing to a source target even if a file or directory already exists.', 'class_prefix': 'file_create_symlink', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'source', 'description': 'Source file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'path', 'description': 'Destination file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'deprecated': 'Use [file_symlink_present_force](#_file_symlink_present_force) instead.', 'rename': 'file_symlink_present_force', 'parameter_rename': [{'old': 'destination', 'new': 'path'}]}, {'bundle_name': 'file_download', 'name': 'File download', 'description': 'Download a file if it does not exist, using curl with a fallback on wget', 'class_prefix': 'file_download', 'class_parameter': 'path', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'source', 'description': 'URL to download from', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'path', 'description': 'File destination (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This method finds a HTTP command-line tool and downloads the given source\ninto the destination.\n\nIt tries `curl` first, and `wget` as fallback.', 'deprecated': 'Use [file_from_http_server](#_file_from_http_server) instead.', 'rename': 'file_from_http_server', 'parameter_rename': [{'old': 'destination', 'new': 'path'}]}, {'bundle_name': 'file_enforce_content', 'name': 'File enforce content', 'description': 'Enforce the content of a file', 'class_prefix': 'file_ensure_lines_present', 'class_parameter': 'path', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name to edit (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'lines', 'description': 'Line(s) to add in the file - if lines is a list, please use @{lines} to pass the iterator rather than iterating over each values', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'enforce', 'description': 'Enforce the file to contain only line(s) defined (true or false)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'deprecated': 'Use [file_content](#_file_content) instead.', 'rename': 'file_content', 'parameter_rename': [{'old': 'file', 'new': 'path'}]}, {'bundle_name': 'file_ensure_block_in_section', 'name': 'File ensure block in section', 'description': 'Ensure that a section contains exactly a text block', 'class_prefix': 'file_ensure_block_in_section', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name to edit (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'section_start', 'description': 'Start of the section', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'section_end', 'description': 'End of the section', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'block', 'description': 'Block representing the content of the section', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'deprecated': 'Use [file_block_present_in_section](#_file_block_present_in_section) instead.', 'rename': 'file_block_present_in_section', 'parameter_rename': [{'old': 'file', 'new': 'path'}]}, {'bundle_name': 'file_ensure_block_present', 'name': 'File ensure block present', 'description': 'Ensure that a text block is present in a specific location', 'class_prefix': 'file_ensure_block_present', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name to edit (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'block', 'description': 'Block(s) to add in the file', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'deprecated': 'Use [file_block_present](#_file_block_present) instead.', 'rename': 'file_block_present', 'parameter_rename': [{'old': 'file', 'new': 'path'}]}, {'bundle_name': 'file_ensure_key_value', 'name': 'File ensure key -> value present', 'description': 'Ensure that the file contains a pair of "key separator value"', 'class_prefix': 'file_ensure_key_value', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name to edit (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'key', 'description': 'Key to define', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'value', 'description': 'Value to define', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'separator', 'description': 'Separator between key and value, for example "=" or " " (without the quotes)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': True, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Edit (or create) the file, and ensure it contains an entry key -> value with arbitrary separator between the key and its value.\nIf the key is already present, the method will change the value associated with this key.', 'deprecated': 'Use [file_key_value_present](#_file_key_value_present) instead.', 'rename': 'file_key_value_present', 'parameter_rename': [{'old': 'file', 'new': 'path'}]}, {'bundle_name': 'file_ensure_key_value_option', 'name': 'File ensure key -> value present with option', 'description': 'Ensure that the file contains a pair of "key separator value", with options on the spacing around the separator', 'class_prefix': 'file_ensure_key_value', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name to edit (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'key', 'description': 'Key to define', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'value', 'description': 'Value to define', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'option', 'description': 'Option for the spacing around the separator: strict, which prevent spacing (space or tabs) around separators, or lax which accepts any number of spaces around separators', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384, 'select': ['strict', 'lax']}, 'type': 'string'}, {'name': 'separator', 'description': 'Separator between key and value, for example "=" or " " (without the quotes)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': True, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Edit (or create) the file, and ensure it contains an entry key -> value with arbitrary separator between the key and its value.\nIf the key is already present, the method will change the value associated with this key.', 'deprecated': 'Use [file_key_value_present_option](#_file_key_value_present_option) instead.', 'rename': 'file_key_value_present_option', 'parameter_rename': [{'old': 'file', 'new': 'path'}]}, {'bundle_name': 'file_ensure_key_value_parameter_in_list', 'name': 'File ensure key value parameter in list', 'description': 'Ensure that one parameter exists in a list of parameters, on one single line, in the right hand side of a key->values line', 'class_prefix': 'file_ensure_key_value_parameter_in_list', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name to edit (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'key', 'description': 'Full key name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'key_value_separator', 'description': 'character used to separate key and value in a key-value line', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': True, 'max_length': 16384}, 'type': 'string'}, {'name': 'parameter', 'description': 'String representing the sub-value to ensure is present in the list of parameters that form the value part of that line', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'parameter_separator', 'description': 'Character used to separate parameters in the list', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': True, 'max_length': 16384}, 'type': 'string'}, {'name': 'leading_char_separator', 'description': 'leading character of the parameters', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'closing_char_separator', 'description': 'closing character of the parameters', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Edit the file, and ensure it contains the defined parameter in the list of values on the right hand side of a key->values line.\nIf the parameter is not there, it will be added at the end, separated by parameter_separator.\nOptionally, you can define leading and closing character to enclose the parameters\nIf the key does not exist in the file, it will be added in the file, along with the parameter\n\n#### Example\n\nIf you have an initial file (`/etc/default/grub`) containing\n\n```\nGRUB_CMDLINE_XEN="dom0_mem=16G"\n```\n\nTo add parameter `dom0_max_vcpus=32` in the right hand side of the line, you\'ll need the following policy\n\n```\nfile_ensure_key_value_parameter_in_list("/etc/default/grub", "GRUB_CMDLINE", "=", "dom0_max_vcpus=32", " ", "\\"", "\\"");\n```', 'deprecated': 'Use [file_key_value_parameter_present_in_list](#_file_key_value_parameter_present_in_list) instead.', 'rename': 'file_key_value_parameter_present_in_list', 'parameter_rename': [{'old': 'file', 'new': 'path'}]}, {'bundle_name': 'file_ensure_key_value_parameter_not_in_list', 'name': 'File ensure key-value parameter not in list', 'description': "Ensure that a parameter doesn't exist in a list of parameters, on one single line, in the right hand side of a key->values line", 'class_prefix': 'file_ensure_key_value_parameter_not_in_list', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name to edit (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'key', 'description': 'Full key name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'key_value_separator', 'description': 'character used to separate key and value in a key-value line', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': True, 'max_length': 16384}, 'type': 'string'}, {'name': 'parameter_regex', 'description': 'Regular expression matching the sub-value to ensure is not present in the list of parameters that form the value part of that line', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'parameter_separator', 'description': 'Character used to separate parameters in the list', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': True, 'max_length': 16384}, 'type': 'string'}, {'name': 'leading_char_separator', 'description': 'leading character of the parameters', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'closing_char_separator', 'description': 'closing character of the parameters', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Edit the file, and ensure it does not contain the defined parameter in the list of values on the right hand side of a key->values line.\nIf the parameter is there, it will be removed. Please note that the parameter can be a regular expression. It will also remove any whitespace character between the `parameter` and `parameter_separator`\nOptionally, you can define leading and closing character to enclose the parameters\n\n#### Example\n\nIf you have an initial file (`/etc/default/grub`) containing\n\n```\nGRUB_CMDLINE_XEN="dom0_mem=16G dom0_max_vcpus=32"\n```\n\nTo remove parameter `dom0_max_vcpus=32` in the right hand side of the line, you\'ll need the following policy\n\n```\nfile_ensure_key_value_parameter_not_in_list("/etc/default/grub", "GRUB_CMDLINE", "=", "dom0_max_vcpus=32", " ", "\\"", "\\"");\n```', 'deprecated': 'Use [file_key_value_parameter_absent_in_list](#_file_key_value_parameter_absent_in_list) instead.', 'rename': 'file_key_value_parameter_absent_in_list', 'parameter_rename': [{'old': 'file', 'new': 'path'}]}, {'bundle_name': 'file_ensure_key_value_present_in_ini_section', 'name': 'File ensure key-value in INI section', 'description': 'Ensure that a key-value pair is present in a section in a specific location. The objective of this method is to handle INI-style files.', 'class_prefix': 'file_ensure_key_value_present_in_ini_section', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name to edit (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'section', 'description': 'Name of the INI-style section under which the line should be added or modified (not including the [] brackets)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'name', 'description': 'Name of the key to add or edit', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'value', 'description': 'Value of the key to add or edit', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'deprecated': 'Use [file_key_value_present_in_ini_section](#_file_key_value_present_in_ini_section) instead.', 'rename': 'file_key_value_present_in_ini_section', 'parameter_rename': [{'old': 'file', 'new': 'path'}]}, {'bundle_name': 'file_ensure_keys_values', 'name': 'File ensure keys -> values present', 'description': 'Ensure that the file contains all pairs of "key separator value", with arbitrary separator between each key and its value', 'class_prefix': 'file_ensure_keys_values', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name to edit (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'keys', 'description': 'Name of the dict structure (without "${}") containing the keys (keys of the dict), and values to define (values of the dict)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'separator', 'description': 'Separator between key and value, for example "=" or " " (without the quotes)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': True, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This method ensures key-value pairs are present in a file.\n\n#### Usage\n\nThis method will iterate over the key-value pairs in the dict, and:\n\n* If the key is not defined in the destination, add the *key* + *separator* + *value* line.\n* If the key is already present in the file, replace the *key* + *separator* + anything by *key* + *separator* + *value*\n\nThis method always ignores spaces and tabs when replacing (which means for example that `key = value` will match the `=` separator).\n\nKeys are considered unique (to allow replacing the value), so you should use [file_ensure_lines_present](#_file_ensure_lines_present)\nif you want to have multiple lines with the same key.\n\n#### Example\n\nIf you have an initial file (`/etc/myfile.conf`) containing:\n\n```\nkey1 = something\nkey3 = value3\n```\n\nTo define key-value pairs, use the [variable_dict](#_variable_dict) or\n[variable_dict_from_file](#_variable_dict_from_file) methods.\n\nFor example, if you use the following content (stored in `/tmp/data.json`):\n\n```json\n{\n "key1": "value1",\n "key2": "value2"\n}\n```\n\nWith the following policy:\n\n```\n# Define the `content` variable in the `configuration` prefix from the json file\nvariable_dict_from_file("configuration", "content", "/tmp/data.json")\n# Enforce the presence of the key-value pairs\nfile_ensure_keys_values("/etc/myfile.conf", "configuration.content", " = ")\n\n```\n\nThe destination file (`/etc/myfile.conf`) will contain:\n\n```\nkey1 = value1\nkey3 = value3\nkey2 = value2\n```', 'deprecated': 'Use [file_keys_values_present](#_file_keys_values_present) instead.', 'rename': 'file_keys_values_present', 'parameter_rename': [{'old': 'file', 'new': 'path'}]}, {'bundle_name': 'file_ensure_line_present_in_ini_section', 'name': 'File ensure line in INI section', 'description': 'Ensure that a line is present in a section in a specific location. The objective of this method is to handle INI-style files.', 'class_prefix': 'file_ensure_line_present_in_ini_section', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name to edit (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'section', 'description': 'Name of the INI-style section under which lines should be added (not including the [] brackets)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'line', 'description': 'Line to ensure is present inside the section', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'deprecated': 'Use [file_line_present_in_ini_section](#_file_line_present_in_ini_section) instead.', 'rename': 'file_line_present_in_ini_section', 'parameter_rename': [{'old': 'file', 'new': 'path'}]}, {'bundle_name': 'file_ensure_line_present_in_xml_tag', 'name': 'File ensure line in XML section', 'description': "Ensure that a line is present in a tag in a specific location. The objective of this method is to handle XML-style files. Note that if the tag is not present in the file, it won't be added, and the edition will fail.", 'class_prefix': 'file_ensure_line_present_in_xml_tag', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name to edit (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'tag', 'description': 'Name of the XML tag under which lines should be added (not including the <> brackets)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'line', 'description': 'Line to ensure is present inside the section', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'deprecated': 'Use [file_line_present_in_xml_tag](#_file_line_present_in_xml_tag) instead.', 'rename': 'file_line_present_in_xml_tag', 'parameter_rename': [{'old': 'file', 'new': 'path'}]}, {'bundle_name': 'file_ensure_lines_absent', 'name': 'File ensure lines absent', 'description': 'Ensure that a line is absent in a specific location', 'class_prefix': 'file_ensure_lines_absent', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name to edit (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'lines', 'description': 'Line(s) to remove in the file', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'deprecated': 'Use [file_lines_absent](#_file_lines_absent) instead.', 'rename': 'file_lines_absent', 'parameter_rename': [{'old': 'file', 'new': 'path'}]}, {'bundle_name': 'file_ensure_lines_present', 'name': 'File ensure lines present', 'description': 'Ensure that one or more lines are present in a file', 'class_prefix': 'file_ensure_lines_present', 'class_parameter': 'path', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name to edit (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'lines', 'description': 'Line(s) to add in the file', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'deprecated': 'Use [file_lines_present](#_file_lines_present) instead.', 'rename': 'file_lines_present', 'parameter_rename': [{'old': 'file', 'new': 'path'}]}, {'bundle_name': 'file_from_http_server', 'name': 'File from HTTP server', 'description': 'Download a file if it does not exist, using curl with a fallback on wget', 'class_prefix': 'file_from_http_server', 'class_parameter': 'path', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'source', 'description': 'URL to download from', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'path', 'description': 'File destination (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This method finds a HTTP command-line tool and downloads the given source\ninto the destination.\n\nThis method **will NOT update the file after the first download** until its removal.\n\nIt tries `curl` first, and `wget` as fallback.', 'parameter_rename': [{'old': 'destination', 'new': 'path'}]}, {'bundle_name': 'file_from_local_source', 'name': 'File from local source', 'description': 'Ensure that a file or directory is copied from a local source', 'class_prefix': 'file_from_local_source', 'class_parameter': 'path', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'source', 'description': 'Source file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'path', 'description': 'Destination file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Ensure that a file or directory is copied from a local source on and from the target node.\nThe copy is not recursive if the target is a directory. To copy recursively a folder from a local\nsource, use the *File from local source recursion* method.', 'parameter_rename': [{'old': 'destination', 'new': 'path'}]}, {'bundle_name': 'file_from_local_source_recursion', 'name': 'File from local source recursion', 'description': 'Ensure that a file or directory is copied from a local source', 'class_prefix': 'file_from_local_source', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'source', 'description': 'Source file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'path', 'description': 'Destination file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'recursion', 'description': 'Recursion depth to enforce for this path (0, 1, 2, ..., inf)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Ensure that a file or directory is copied from a local source.\nIf the source is a directory, you can force a maximum level of copy recursion.\n\n* *0* being no recursion, which will only create an empty folder\n* *inf* being a complete recursive copy of the folder\n* *1,2,3,...* will force the maximal level of recursion to copy', 'parameter_rename': [{'old': 'destination', 'new': 'path'}]}, {'bundle_name': 'file_from_local_source_with_check', 'name': 'File from local source with check', 'description': 'Ensure that a file or directory is copied from a local source if a check command succeeds', 'class_prefix': 'file_from_local_source_with_check', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'source', 'description': 'Source file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'path', 'description': 'Destination file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'check_command', 'description': 'Command to run, it will get the source path as argument', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'rc_ok', 'description': 'Return codes to be considered as valid, separated by a comma (default is 0)', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This method is a conditional file copy.\n\nIt allows comparing the source and destination, and if they are different, call a command\nwith the source file path as argument, and only update the destination if the commands succeeds\n(i.e. returns a code included in rc_ok).\n\n#### Examples\n\n```\n# To copy a configuration file only if it passes a config test:\nfile_from_local_source_with_check("/tmp/program.conf", "/etc/program.conf", "program --config-test", "0");\n```\n\nThis will:\n\n* Compare `/tmp/program.conf` and `/etc/program.conf`, and return `kept` if files are the same\n* If not, it will execute `program --config-test "/tmp/program.conf"` and check the return code\n* If it is one of the `rc_ok` codes, it will copy `/tmp/program.conf` into `/etc/program.conf` and return a repaired\n* If not, it will return an error', 'parameter_rename': [{'old': 'destination', 'new': 'path'}]}, {'bundle_name': 'file_from_remote_source', 'name': 'File from remote source', 'description': 'Ensure that a file or directory is copied from a policy server', 'class_prefix': 'file_from_remote_source', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'source', 'description': 'Source file (absolute path on the policy server)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'path', 'description': 'Destination file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': '*Note*: This method uses the agent native file copy protocol, and can only download files from\nthe policy server. To download a file from an external source, you can use\nHTTP with the [file_download](#_file_download) method.\n\nThis method requires that the policy server is configured to accept\ncopy of the source file from the agents it will be applied to.\n\nYou can download a file from the shared files with:\n```\n/var/rudder/configuration-repository/shared-files/PATH_TO_YOUR_FILE\n```', 'parameter_rename': [{'old': 'destination', 'new': 'path'}]}, {'bundle_name': 'file_from_remote_source_recursion', 'name': 'File from remote source recursion', 'description': 'Ensure that a file or directory is copied from a policy server', 'class_prefix': 'file_from_remote_source', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'source', 'description': 'Source file (absolute path on the policy server)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'path', 'description': 'Destination file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'recursion', 'description': 'Recursion depth to enforce for this path (0, 1, 2, ..., inf)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This method requires that the policy server is configured to accept\ncopy of the source file or directory from the agents it will be applied to.\n\nYou can download a file from the shared files with:\n```\n/var/rudder/configuration-repository/shared-files/PATH_TO_YOUR_DIRECTORY_OR_FILE\n```', 'parameter_rename': [{'old': 'destination', 'new': 'path'}]}, {'bundle_name': 'file_from_remote_template', 'name': 'File from remote template', 'description': 'Build a file from a template on the Rudder server', 'class_prefix': 'file_from_remote_template', 'class_parameter': 'destination', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'source_template', 'description': 'Source file containing a template to be expanded (absolute path on the server)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'destination', 'description': 'Destination file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'template_type', 'description': 'Template type (jinja2 or mustache)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384, 'select': ['jinja2', 'mustache']}, 'type': 'string'}], 'documentation': "Write a file based on a template on the Rudder server and data available on the node\n\n#### Usage\n\nTo use this method, you need to have:\n\n* a template on the Rudder server shared folder\n* data to fill this template\n\nThe template needs to be located in the shared-files folder and can be accessed with:\n\n```\n/var/rudder/configuration-repository/shared-files/PATH_TO_YOUR_FILE\n```\n\nThe data that will be used while expanding the template is the data available in\nthe agent at the time of expansion. That means:\n\n* Agent's system variables (`${sys.*}`, ...) and conditions (`linux`, ...)\n* data defined during execution (result conditions of generic methods, ...)\n* conditions based on `condition_` generic methods\n* data defined using `variable_*` generic methods, which allow for example\n to load data from local json or yaml files.\n\n#### Template types\n\nSupported templating languages:\n\n* *mustache* templates, which are documented in [file_from_template_mustache](#_file_from_template_mustache)\n* *jinja2* templates, which are documented in [file_from_template_jinja2](#_file_from_template_jinja2)\n\n#### Reporting\n\nThis method will provide extra `log_warning` message if the template was not updated, but the destination\nfile is modified.", 'parameter_rename': []}, {'bundle_name': 'file_from_shared_folder', 'name': 'File copy from Rudder shared folder', 'description': 'Ensure that a file or directory is copied from the Rudder shared folder.', 'class_prefix': 'file_from_shared_folder', 'class_parameter': 'path', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'source', 'description': 'Source file (path, relative to /var/rudder/configuration-repository/shared-files)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'path', 'description': 'Destination file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'hash_type', 'description': 'Hash algorithm used to check if file is updated (sha256, sha512). Only used on Windows, ignored on Unix. default is sha256', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384, 'select': ['', 'sha256', 'sha512', 'md5', 'sha1']}, 'type': 'string'}], 'documentation': 'Ensure that a file or directory is copied from the Rudder shared folder.\nThe Rudder shared folder is located on the Rudder server under `/var/rudder/configuration-repository/shared-files`.\nEvery file/folder in the shared folder will be available for every managed node.\nThis method will download and update the destination file from a source taken from this shared folder.\nA file in the shared folder will be updated on the node side at agent run.', 'parameter_rename': [{'old': 'destination', 'new': 'path'}]}, {'bundle_name': 'file_from_string_mustache', 'name': 'File from a mustache string', 'description': 'Build a file from a mustache string', 'class_prefix': 'file_from_string_mustache', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'template', 'description': 'String containing a template to be expanded', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'path', 'description': 'Destination file (absolute path on the target node', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Build a file from a mustache string.\nComplete mustache documentation is available in the *file\\_from\\_template\\_mustache* method documentation.', 'parameter_rename': [{'old': 'destination', 'new': 'path'}]}, {'bundle_name': 'file_from_template', 'name': 'File from template', 'description': 'Build a file from a legacy CFEngine template', 'class_prefix': 'file_from_template', 'class_parameter': 'path', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'source_template', 'description': 'Source file containing a template to be expanded (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'path', 'description': 'Destination file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'See [file_from_template_type](#_file_from_template_type) for general documentation about\ntemplates usage.', 'deprecated': "This method uses CFEngine's templating which is deprecated and not portable across agents.\nPlease use [file_from_template_mustache](#_file_from_template_mustache) or [file_from_template_jinja2](#_file_from_template_jinja2) instead.", 'parameter_rename': [{'old': 'destination', 'new': 'path'}]}, {'bundle_name': 'file_from_template_jinja2', 'name': 'File from a jinja2 template', 'description': 'Build a file from a jinja2 template', 'class_prefix': 'file_from_template', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'source_template', 'description': 'Source file containing a template to be expanded (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'path', 'description': 'Destination file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'See [file_from_template_type](#_file_from_template_type) for general documentation about\ntemplates usage.\n\nThis generic method will build a file from a jinja2 template\nusing data (conditions and variables) found in the execution context.\n\n\n#### Setup\n\nIt requires to have the jinja2 python module installed on the node, it can usually be done in ncf with\n`package_present("python-jinja2", "", "", "")`.\n\nWARNING: If you are using a jinja2 version older than 2.7\n trailing newlines will not be preserved in the destination file.\n\n#### Syntax\n\nJinja2 is a powerful templating language, running in Python.\nThe Jinja2 syntax reference documentation is [http://jinja.pocoo.org/docs/dev/templates/](http://jinja.pocoo.org/docs/dev/templates/)\nwhich will likely be useful, as Jinja2 is very rich and allows a lot more\nthat what is explained here.\n\nThis section presents some simple cases that cover what can be done with mustache templating,\nand the way the agent data is provided to the templating engine.\n\nThe main specificity of jinja2 templating is the use of two root containers:\n\n* `classes` to access currently defined conditions\n* `vars` to access all currently defined variables\n\nNote: You can add comments in the template, that will not be rendered in the output file with\n`{# ... #}`.\n\nYou can extend the Jinja2 templating engine by adding custom FILTERS and TESTS in the script\n`/var/rudder/configuration-repository/ncf/10_ncf_internals/modules/extensions/jinja2_custom.py`\n\nFor instance, to add a filter to uppercase a string and a test if a number is odd, you can create\nthe file `/var/rudder/configuration-repository/ncf/10_ncf_internals/modules/extensions/jinja2_custom.py`\non your Rudder server with the following content:\n\n```\ndef uppercase(input):\n return input.upper()\n\ndef odd(value):\n return True if (value % 2) else False\n\nFILTERS = {\'uppercase\': uppercase}\nTESTS = {\'odd\': odd}\n```\n\nThese filters and tests will be usable in your jinja2 templates automatically.\n\n##### Conditions\n\nTo display content based on conditions definition:\n\n```jinja2\n{% if classes.my_condition is defined %}\n display this if defined\n{% endif %}\n{% if not classes.my_condition is defined %}\n display this if not defined\n{% endif %}\n```\n\nNote: You cannot use condition expressions here.\n\nYou can also use other tests, for example other built-in ones or\nthose defined in `jinja2_custom.py`:\n\n```jinja2\n{% if vars.variable_prefix.my_number is odd %}\n display if my_number is odd\n{% endif %}\n```\n\n##### Scalar variables\n\nHere is how to display a scalar variable value (integer, string, ...),\nif you have defined `variable_string("variable_prefix", "my_variable", "my_value")`:\n\n```jinja2\n{{ vars.variable_prefix.my_variable }}\n```\n\nYou can also modify what is displayed by using filters. The built-in filters\ncan be extended in `jinja2_custom.py`:\n\n```jinja2\n{{ vars.variable_prefix.my_variable | uppercase }}\n```\n\nWill display the variable in uppercase.\n\n##### Iteration\n\nTo iterate over a list, for example defined with:\n\n```\nvariable_iterator("variable_prefix", "iterator_name", "a,b,c", ",")\n```\n\nUse the following file:\n\n```jinja2\n{% for item in vars.variable_prefix.iterator_name %}\n{{ item }} is the current iterator_name value\n{% endfor %}\n```\n\nWhich will be expanded as:\n\n```\na is the current iterator_name value\nb is the current iterator_name value\nc is the current iterator_name value\n```\n\nTo iterate over a container defined by the following json file, loaded with\n`variable_dict_from_file("variable_prefix", "dict_name", "path")`:\n\n```json\n{\n "hosts": [\n "host1",\n "host2"\n ],\n "files": [\n {"name": "file1", "path": "/path1", "users": [ "user1", "user11" ] },\n {"name": "file2", "path": "/path2", "users": [ "user2" ] }\n ],\n "properties": {\n "prop1": "value1",\n "prop2": "value2"\n }\n}\n```\n\nUse the following template:\n\n```jinja2\n{% for item in vars.variable_prefix.dict_name.hosts %}\n{{ item }} is the current hosts value\n{% endfor %}\n\n# will display the name and path of the current file\n{% for file in vars.variable_prefix.dict_name.files %}\n{{ file.name }}: {{ file.path }}\n{% endfor %}\n\n# will display the users list of each file\n{% for file in vars.variable_prefix.dict_name.files %}\n{{ file.name }}: {{ file.users|join(\' \') }}\n{% endfor %}\n\n\n# will display the current properties key/value pair\n{% for key, value in vars.variable_prefix.dict_name.properties.items() %}\n{{ key }} -> {{ value }}\n{% endfor %}\n\n```\n\nWhich will be expanded as:\n\n```\nhost1 is the current hosts value\nhost2 is the current hosts value\n\n# will display the name and path of the current file\nfile1: /path1\nfile2: /path2\n\n# will display the users list of each file\nfile1: user1 user11\nfile2: user2\n\n# will display the current properties key/value pair\nprop1 -> value1\nprop2 -> value2\n```\n\n##### System variables\n\nSome `sys` dict variables (like `sys.ipv4`) are also accessible as string, for example:\n\n* `${sys.ipv4}` gives `54.32.12.4`\n* `$[sys.ipv4[ethO]}` gives `54.32.12.4`\n* `$[sys.ipv4[eth1]}` gives `10.45.3.2`\n\nThese variables are not accessible as dict in the templating data, but are represented as\nstring:\n\n* `ipv4` is a string variable in the `sys` dict with value `54.32.12.4`\n* `ipv4[ethO]` is a string variable in the `sys` dict with value `54.32.12.4`\n* `ipv4` is not accessible as a dict in the template\n\nTo access these value, use the following syntax in your jinja2 templates:\n\n```\nvars.sys[\'ipv4[eth0]\']\n```', 'parameter_rename': [{'old': 'destination', 'new': 'path'}]}, {'bundle_name': 'file_from_template_mustache', 'name': 'File from a mustache template', 'description': 'Build a file from a mustache template', 'class_prefix': 'file_from_template', 'class_parameter': 'path', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'source_template', 'description': 'Source file containing a template to be expanded (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'path', 'description': 'Destination file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'See [file_from_template_type](#_file_from_template_type) for general documentation about\ntemplates usage.\n\n#### Syntax\n\nMustache is a logic-less templating language, available in a lot of languages, and\nused for file templating in Rudder.\nThe mustache syntax reference is [https://mustache.github.io/mustache.5.html](https://mustache.github.io/mustache.5.html).\n\nWe will here describe the way to get agent data into a template. Ass explained in the general templating\ndocumentation, we can access various data in a mustache template.\n\nThe main specificity compared to standard mustache syntax of prefixes in all expanded values:\n\n* `classes` to access conditions\n* `vars` to access all variables\n\n##### Classes\n\nHere is how to display content depending on conditions definition:\n\n```mustache\n{{#classes.my_condition}}\n content when my_condition is defined\n{{/classes.my_condition}}\n\n{{^classes.my_condition}}\n content when my_condition is *not* defined\n{{/classes.my_condition}}\n```\n\nNote: You cannot use condition expressions here.\n\n##### Scalar variable\n\nHere is how to display a scalar variable value (integer, string, ...),\nif you have defined `variable_string("variable_prefix", "my_variable", "my_value")`:\n\n```\n{{{vars.variable_prefix.my_variable}}}\n```\n\nWe use the triple `{{{ }}}` to avoid escaping html entities.\n\n##### Iteration\n\nIteration is done using a syntax similar to scalar variables, but applied\non container variables.\n\n* Use `{{#vars.container}} content {{/vars.container}}` to iterate\n* Use `{{{.}}}` for the current element value in iteration\n* Use `{{{key}}}` for the `key` value in current element\n* Use `{{{.key}}}` for the `key` value in current element (Linux only)\n* Use `{{{@}}}` for the current element key in iteration (Linux only)\n\nTo iterate over a list, for example defined with:\n\n```\nvariable_iterator("variable_prefix", "iterator_name", "a,b,c", ",")\n```\n\nUse the following file:\n\n```mustache\n{{#vars.variable_prefix.iterator_name}}\n{{{.}}} is the current iterator_name value\n{{/vars.variable_prefix.iterator_name}}\n```\n\nWhich will be expanded as:\n\n```\na is the current iterator_name value\nb is the current iterator_name value\nc is the current iterator_name value\n```\n\nTo iterate over a container defined by the following json file, loaded with \n`variable_dict_from_file("variable_prefix", "dict_name", "path")`:\n\n```json\n{\n "hosts": [\n "host1",\n "host2"\n ],\n "files": [\n {"name": "file1", "path": "/path1", "users": [ "user1", "user11" ] },\n {"name": "file2", "path": "/path2", "users": [ "user2" ] }\n ],\n "properties": {\n "prop1": "value1",\n "prop2": "value2"\n }\n}\n```\n\nUse the following template:\n\n```mustache\n{{#vars.variable_prefix.dict_name.hosts}}\n{{{.}}} is the current hosts value\n{{/vars.variable_prefix.dict_name.hosts}}\n\n# will display the name and path of the current file\n{{#vars.variable_prefix.dict_name.files}}\n{{{.name}}}: {{{.path}}}\n{{/vars.variable_prefix.dict_name.files}}\n\n# will display the users list of each file\n{{#vars.variable_prefix.dict_name.files}}\n{{{.name}}}:{{#users}} {{{.}}}{{/users}}\n{{/vars.variable_prefix.dict_name.files}}\n\n\n# will display the current properties key/value pair\n{{#vars.variable_prefix.dict_name.properties}}\n{{{@}}} -> {{{.}}}\n{{/vars.variable_prefix.dict_name.properties}}\n\n```\n\nWhich will be expanded as:\n\n```\nhost1 is the current hosts value\nhost2 is the current hosts value\n\n# will display the name and path of the current file\nfile1: /path1\nfile2: /path2\n\n# will display the users list of each file\nfile1: user1 user11\nfile2: user2\n\n# will display the current properties key/value pair\nprop1 -> value1\nprop2 -> value2\n```\n\nNote: You can use `{{#-top-}} ... {{/-top-}}`\nto iterate over the top level container.\n\n##### System variables\n\nSome `sys` dict variables (like `sys.ipv4`) are also accessible as string, for example:\n\n* `${sys.ipv4}` gives `54.32.12.4`\n* `$[sys.ipv4[ethO]}` gives `54.32.12.4`\n* `$[sys.ipv4[eth1]}` gives `10.45.3.2`\n\nThese variables are not accessible as dict in the templating data, but are represented as\nstring:\n\n* `ipv4` is a string variable in the `sys` dict with value `54.32.12.4`\n* `ipv4[ethO]` is a string variable in the `sys` dict with value `54.32.12.4`\n* `ipv4` is not accessible as a dict in the template\n\nTo access these value, use the following syntax in your mustache templates:\n\n```\n{{{vars.sys.ipv4[eth0]}}}\n```', 'parameter_rename': [{'old': 'destination', 'new': 'path'}]}, {'bundle_name': 'file_from_template_type', 'name': 'File from template with type', 'description': 'Build a file from a template', 'class_prefix': 'file_from_template', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'source_template', 'description': 'Source file containing a template to be expanded (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'path', 'description': 'Destination file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'template_type', 'description': 'Template type (cfengine, jinja2 or mustache)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'These methods write a file based on a provided template and the\ndata available to the agent.\n\n#### Usage\n\nTo use these methods (`file_from_template_*`), you need to have:\n\n* a template file\n* data to fill this template\n\nThe template file should be somewhere on the local file system, so\nif you want to use a file shared from the policy server, you need to copy \nit first (using [file_copy_from_remote_source](#_file_copy_from_remote_source)).\n\nIt is common to use a specific folder to store those templates after copy,\nfor example in `${sys.workdir}/tmp/templates/`.\n\nThe data that will be used while expanding the template is the data available in\nthe agent at the time of expansion. That means:\n\n* Agent\'s system variables (`${sys.*}`, ...) and conditions (`linux`, ...)\n* data defined during execution (result conditions of generic methods, ...)\n* conditions based on `condition_` generic methods\n* data defined in ncf using `variable_*` generic methods, which allow for example\n to load data from local json or yaml files.\n\n#### Template types\n\nncf currently supports three templating languages:\n\n* *mustache* templates, which are documented in [file_from_template_mustache](#_file_from_template_mustache)\n* *jinja2* templates, which are documented in [file_from_template_jinja2](#_file_from_template_jinja2)\n* CFEngine templates, which are a legacy implementation that is here for compatibility,\nand should not be used for new templates.\n\n#### Example\n\nHere is a complete example of templating usage:\n\nThe (basic) template file, present on the server in `/PATH_TO_MY_FILE/ntp.conf.mustache`\n(for syntax reference, see [file_from_template_mustache](#_file_from_template_mustache)):\n\n```mustache\n{{#classes.linux}}\nserver {{{vars.configuration.ntp.hostname}}}\n{{/classes.linux}}\n{{^classes.linux}}\nserver hardcoded.server.example\n{{/classes.linux}}\n\n```\n\nAnd on your local node in `/tmp/ntp.json`, the following json file:\n\n```json\n{ "hostname": "my.hostname.example" }\n```\n\nAnd the following policy:\n\n```\n# Copy the file from the policy server\nfile_copy_from_remote_source("/PATH_TO_MY_FILE/ntp.conf.mustache", "${sys.workdir}/tmp/templates/ntp.conf.mustache")\n# Define the `ntp` variable in the `configuration` prefix from the json file\nvariable_dict_from_file("configuration", "ntp", "/tmp/ntp.json")\n# Expand yout template\nfile_from_template_type("${sys.workdir}/tmp/templates/ntp.conf.mustache", "/etc/ntp.conf", "mustache")\n# or\n# file_from_template_mustache("${sys.workdir}/tmp/templates/ntp.conf.mustache", "/etc/ntp.conf")\n```\n\nThe destination file will contain the expanded content, for example on a Linux node:\n\n```\nserver my.hostname.example\n```', 'parameter_rename': [{'old': 'destination', 'new': 'path'}]}, {'bundle_name': 'file_key_value_parameter_absent_in_list', 'name': 'File key-value parameter not in list', 'description': "Ensure that a parameter doesn't exist in a list of parameters, on one single line, in the right hand side of a key->values line", 'class_prefix': 'file_key_value_parameter_absent_in_list', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name to edit (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'key', 'description': 'Full key name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'key_value_separator', 'description': 'character used to separate key and value in a key-value line', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': True, 'max_length': 16384}, 'type': 'string'}, {'name': 'parameter_regex', 'description': 'Regular expression matching the sub-value to ensure is not present in the list of parameters that form the value part of that line', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'parameter_separator', 'description': 'Character used to separate parameters in the list', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': True, 'max_length': 16384}, 'type': 'string'}, {'name': 'leading_char_separator', 'description': 'leading character of the parameters', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'closing_char_separator', 'description': 'closing character of the parameters', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Edit the file, and ensure it does not contain the defined parameter in the list of values on the right hand side of a key->values line.\nIf the parameter is there, it will be removed. Please note that the parameter can be a regular expression. It will also remove any whitespace character between the parameter and parameter_separator\nOptionally, you can define leading and closing character to enclose the parameters\n\n#### Example\n\nIf you have an initial file (`/etc/default/grub`) containing\n\n```\nGRUB_CMDLINE_XEN="dom0_mem=16G dom0_max_vcpus=32"\n```\n\nTo remove parameter `dom0_max_vcpus=32` in the right hand side of the line, you\'ll need the following policy\n\n```\nfile_ensure_key_value_parameter_not_in_list("/etc/default/grub", "GRUB_CMDLINE", "=", "dom0_max_vcpus=32", " ", "\\"", "\\"");\n```', 'parameter_rename': [{'old': 'file', 'new': 'path'}]}, {'bundle_name': 'file_key_value_parameter_present_in_list', 'name': 'File key-value parameter in list', 'description': 'Ensure that one parameter exists in a list of parameters, on one single line, in the right hand side of a key->values line', 'class_prefix': 'file_key_value_parameter_present_in_list', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name to edit (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'key', 'description': 'Full key name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'key_value_separator', 'description': 'character used to separate key and value in a key-value line', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': True, 'max_length': 16384}, 'type': 'string'}, {'name': 'parameter', 'description': 'String representing the sub-value to ensure is present in the list of parameters that form the value part of that line', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'parameter_separator', 'description': 'Character used to separate parameters in the list', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': True, 'max_length': 16384}, 'type': 'string'}, {'name': 'leading_char_separator', 'description': 'leading character of the parameters', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'closing_char_separator', 'description': 'closing character of the parameters', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Edit the file, and ensure it contains the defined parameter in the list of values on the right hand side of a key->values line.\nIf the parameter is not there, it will be added at the end, separated by parameter_separator.\nOptionnaly, you can define leading and closing character to enclose the parameters\nIf the key does not exist in the file, it will be added in the file, along with the parameter\n\n#### Example\n\nIf you have an initial file (`/etc/default/grub`) containing\n\n```\nGRUB_CMDLINE_XEN="dom0_mem=16G"\n```\n\nTo add parameter `dom0_max_vcpus=32` in the right hand side of the line, you\'ll need the following policy\n\n```\nfile_ensure_key_value_parameter_in_list("/etc/default/grub", "GRUB_CMDLINE", "=", "dom0_max_vcpus=32", " ", "\\"", "\\"");\n```', 'parameter_rename': [{'old': 'file', 'new': 'path'}]}, {'bundle_name': 'file_key_value_present', 'name': 'File key-value present', 'description': 'Ensure that the file contains a pair of "key separator value"', 'class_prefix': 'file_key_value_present', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name to edit (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'key', 'description': 'Key to define', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'value', 'description': 'Value to define', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'separator', 'description': 'Separator between key and value, for example "=" or " " (without the quotes)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': True, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Edit (or create) the file, and ensure it contains an entry key -> value with arbitrary separator between the key and its value.\nIf the key is already present, the method will change the value associated with this key.', 'parameter_rename': [{'old': 'file', 'new': 'path'}]}, {'bundle_name': 'file_key_value_present_in_ini_section', 'name': 'File key-value in INI section', 'description': 'Ensure that a key-value pair is present in a section in a specific location. The objective of this method is to handle INI-style files.', 'class_prefix': 'file_key_value_present_in_ini_section', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name to edit (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'section', 'description': 'Name of the INI-style section under which the line should be added or modified (not including the [] brackets)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'name', 'description': 'Name of the key to add or edit', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'value', 'description': 'Value of the key to add or edit', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'parameter_rename': [{'old': 'file', 'new': 'path'}]}, {'bundle_name': 'file_key_value_present_option', 'name': 'File key-value present with option', 'description': 'Ensure that the file contains a pair of "key separator value", with options on the spacing around the separator', 'class_prefix': 'file_key_value_present', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name to edit (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'key', 'description': 'Key to define', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'value', 'description': 'Value to define', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'separator', 'description': 'Separator between key and value, for example "=" or " " (without the quotes)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': True, 'max_length': 16384}, 'type': 'string'}, {'name': 'option', 'description': 'Option for the spacing around the separator: strict, which prevent spacing (space or tabs) around separators, or lax which accepts any number of spaces around separators', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384, 'select': ['strict', 'lax']}, 'type': 'string'}], 'documentation': 'Edit (or create) the file, and ensure it contains an entry key -> value with arbitrary separator between the key and its value.\nIf the key is already present, the method will change the value associated with this key.', 'parameter_rename': [{'old': 'file', 'new': 'path'}]}, {'bundle_name': 'file_keys_values_present', 'name': 'File keys-values present', 'description': 'Ensure that the file contains all pairs of "key separator value", with arbitrary separator between each key and its value', 'class_prefix': 'file_keys_values_present', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name to edit (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'keys', 'description': 'Name of the dict structure (without "${}") containing the keys (keys of the dict), and values to define (values of the dict)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'separator', 'description': 'Separator between key and value, for example "=" or " " (without the quotes)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': True, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This method ensures key-value pairs are present in a file.\n\n#### Usage\n\nThis method will iterate over the key-value pairs in the dict, and:\n\n* If the key is not defined in the destination, add the *key* + *separator* + *value* line.\n* If the key is already present in the file, replace the *key* + *separator* + anything by *key* + *separator* + *value*\n\nThis method always ignores spaces and tabs when replacing (which means for example that `key = value` will match the `=` separator).\n\nKeys are considered unique (to allow replacing the value), so you should use [file_ensure_lines_present](#_file_ensure_lines_present)\nif you want to have multiple lines with the same key.\n\n#### Example\n\nIf you have an initial file (`/etc/myfile.conf`) containing:\n\n```\nkey1 = something\nkey3 = value3\n```\n\nTo define key-value pairs, use the [variable_dict](#_variable_dict) or\n[variable_dict_from_file](#_variable_dict_from_file) methods.\n\nFor example, if you use the following content (stored in `/tmp/data.json`):\n\n```json\n{\n "key1": "value1",\n "key2": "value2"\n}\n```\n\nWith the following policy:\n\n```\n# Define the `content` variable in the `configuration` prefix from the json file\nvariable_dict_from_file("configuration", "content", "/tmp/data.json")\n# Enforce the presence of the key-value pairs\nfile_ensure_keys_values("/etc/myfile.conf", "configuration.content", " = ")\n\n```\n\nThe destination file (`/etc/myfile.conf`) will contain:\n\n```\nkey1 = value1\nkey3 = value3\nkey2 = value2\n```', 'parameter_rename': [{'old': 'file', 'new': 'path'}]}, {'bundle_name': 'file_line_present_in_ini_section', 'name': 'File line in INI section', 'description': 'Ensure that a line is present in a section in a specific location. The objective of this method is to handle INI-style files.', 'class_prefix': 'file_line_present_in_ini_section', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name to edit (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'section', 'description': 'Name of the INI-style section under which lines should be added (not including the [] brackets)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'line', 'description': 'Line to ensure is present inside the section', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'parameter_rename': [{'old': 'file', 'new': 'path'}]}, {'bundle_name': 'file_line_present_in_xml_tag', 'name': 'File line in XML section', 'description': "Ensure that a line is present in a tag in a specific location. The objective of this method is to handle XML-style files. Note that if the tag is not present in the file, it won't be added, and the edition will fail.", 'class_prefix': 'file_line_present_in_xml_tag', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name to edit (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'tag', 'description': 'Name of the XML tag under which lines should be added (not including the <> brackets)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'line', 'description': 'Line to ensure is present inside the section', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'parameter_rename': [{'old': 'file', 'new': 'path'}]}, {'bundle_name': 'file_lines_absent', 'name': 'File lines absent', 'description': 'Ensure that a line is absent in a specific location', 'class_prefix': 'file_lines_absent', 'class_parameter': 'path', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name to edit (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'lines', 'description': 'Line(s) to remove in the file', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'parameter_rename': [{'old': 'file', 'new': 'path'}]}, {'bundle_name': 'file_lines_present', 'name': 'File lines present', 'description': 'Ensure that one or more lines are present in a file', 'class_prefix': 'file_lines_present', 'class_parameter': 'path', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name to edit (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'lines', 'description': 'Line(s) to add in the file', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'parameter_rename': [{'old': 'file', 'new': 'path'}]}, {'bundle_name': 'file_present', 'name': 'File present', 'description': "Create a file if it doesn't exist", 'class_prefix': 'file_present', 'class_parameter': 'path', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File to create (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'parameter_rename': [{'old': 'target', 'new': 'path'}]}, {'bundle_name': 'file_remove', 'name': 'File remove', 'description': 'Remove a file if it exists', 'class_prefix': 'file_remove', 'class_parameter': 'path', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File to remove (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'deprecated': 'Use [file_absent](#_file_absent) instead.', 'rename': 'file_absent', 'parameter_rename': [{'old': 'target', 'new': 'path'}]}, {'bundle_name': 'file_replace_lines', 'name': 'File replace lines', 'description': 'Ensure that a line in a file is replaced by another one', 'class_prefix': 'file_replace_lines', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File name to edit (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'line', 'description': 'Line to match in the file', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'replacement', 'description': 'Line to add in the file as a replacement', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'You can replace lines in a files, based on regular expression and captured pattern\n\n#### Syntax\n\nThe content to match in the file is a PCRE regular expression, unanchored\nthat you can replace with the content of replacement.\n\nContent can be captured in regular expression, and be reused with the notation `${match.1}` (for first matched\ncontent), `${match.2}` for second, etc, and the special captured group `${match.0}` for the whole text.\n\n#### Example\n\nHere is an example to remove enclosing specific tags\n\n```\nfile_replace_lines("/PATH_TO_MY_FILE/file", "<my>(.*)<pattern>", "my ${match.1} pattern")\n```', 'parameter_rename': [{'old': 'file', 'new': 'path'}]}, {'bundle_name': 'file_report_content', 'name': 'File report content', 'description': 'Report the content of a file', 'class_prefix': 'file_report_content', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File to report content from', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'regex', 'description': 'Regex to search in the file (empty for whole file)', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'context', 'description': 'Number of context lines when matching regex (default is 0)', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384, 'regex': '^\\d*$'}, 'type': 'string'}], 'documentation': 'Report the content of a file.\n\nThis method does nothing on the system, but only reports a complete or partial content\nfrom a given file. This allows centralizing this information on the server, and avoid\nhaving to connect on each node to get this information.\n\nNOTE: This method only works in "Full Compliance" reporting mode.\n\n#### Parameters\n\n##### Target\n\nThis is the file you want to report content from. The method will return an error if it\ndoes not exist.\n\n##### Regex\n\nIf empty, the method will report the whole file content.\nIf set, the method will grep the file for the given regular expression, and\nreport the result.\n\n##### Context\n\nWhen specifying a regex, will add the number of lines of context around matches\n(default is 0, i.e. no context).\n\nWhen reporting the whole file, this parameter is ignored.\n\n#### Examples\n\n```\n# To get the whole /etc/hosts content\nfile_report_content("/etc/hosts", "", "");\n# To get lines starting by "nameserver" in /etc/resolv.conf\nfile_report_content("/etc/resolv.conf", "^nameserver", "");\n# To get lines containing "rudder" from /etc/hosts with 3 lines of context\nfile_report_content("/etc/hosts", "rudder", "3");\n```', 'parameter_rename': [{'old': 'target', 'new': 'path'}]}, {'bundle_name': 'file_report_content_head', 'name': 'File report content head', 'description': 'Report the head of a file', 'class_prefix': 'file_report_content_head', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File to report content from', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'limit', 'description': 'Number of lines to report (default is 10)', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384, 'regex': '^\\d*$'}, 'type': 'string'}], 'documentation': 'Report the head of a file.\n\nThis method does nothing on the system, but only reports a partial content\nfrom a given file. This allows centralizing this information on the server, and avoid\nhaving to connect on each node to get this information.\n\nNOTE: This method only works in "Full Compliance" reporting mode.\n\n#### Parameters\n\n##### Target\n\nThis is the file you want to report content from. The method will return an error if it\ndoes not exist.\n\n##### Limit\n\nThe number of line to report.\n\n#### Examples\n\n```\n# To get the 3 first line of /etc/hosts\nfile_report_content("/etc/hosts", "3");\n```', 'parameter_rename': [{'old': 'target', 'new': 'path'}]}, {'bundle_name': 'file_report_content_tail', 'name': 'File report content tail', 'description': 'Report the tail of a file', 'class_prefix': 'file_report_content_tail', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'File to report content from', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'limit', 'description': 'Number of lines to report (default is 10)', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384, 'regex': '^\\d*$'}, 'type': 'string'}], 'documentation': 'Report the tail of a file.\n\nThis method does nothing on the system, but only reports a partial content\nfrom a given file. This allows centralizing this information on the server, and avoid\nhaving to connect on each node to get this information.\n\nNOTE: This method only works in "Full Compliance" reporting mode.\n\n#### Parameters\n\n##### Target\n\nThis is the file you want to report content from. The method will return an error if it\ndoes not exist.\n\n##### Limit\n\nThe number of line to report.\n\n#### Examples\n\n```\n# To get the 3 first line of /etc/hosts\nfile_report_content("/etc/hosts", "3");\n```', 'parameter_rename': [{'old': 'target', 'new': 'path'}]}, {'bundle_name': 'file_symlink_present', 'name': 'Symlink present', 'description': 'Create a symlink at a destination path and pointing to a source target except if a file or directory already exists.', 'class_prefix': 'file_symlink_present', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'source', 'description': 'Source file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'path', 'description': 'Destination file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'parameter_rename': [{'old': 'destination', 'new': 'path'}]}, {'bundle_name': 'file_symlink_present_force', 'name': 'Symlink present (force overwrite)', 'description': 'Create a symlink at a destination path and pointing to a source target even if a file or directory already exists.', 'class_prefix': 'file_symlink_present', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'source', 'description': 'Source file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'path', 'description': 'Destination file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'parameter_rename': [{'old': 'destination', 'new': 'path'}]}, {'bundle_name': 'file_symlink_present_option', 'name': 'Symlink present (optional overwriting)', 'description': 'Create a symlink at a destination path and pointing to a source target. This is also possible to enforce its creation', 'class_prefix': 'file_symlink_present', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'source', 'description': 'Source file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'path', 'description': 'Destination file (absolute path on the target node)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'enforce', 'description': 'Force symlink if file already exist (true or false)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'parameter_rename': [{'old': 'destination', 'new': 'path'}]}, {'bundle_name': 'file_template_expand', 'name': 'File template expand', 'description': 'This is a bundle to expand a template in a specific location', 'class_prefix': 'file_template_expand', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'tml_file', 'description': 'File name (with full path within the framework) of the template file', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'path', 'description': 'File name (with full path) where to expand the template', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'mode', 'description': 'Mode of destination file', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'owner', 'description': 'Owner of destination file', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'group', 'description': 'Group of destination file', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'deprecated': "This method uses CFEngine's templating which is deprecated and not portable across agents.\nPlease use [file_from_template_mustache](#_file_from_template_mustache) or [file_from_template_jinja2](#_file_from_template_jinja2) instead.", 'parameter_rename': [{'old': 'target_file', 'new': 'path'}]}, {'bundle_name': 'group_absent', 'name': 'Group absent', 'description': 'Make sure a group is absent', 'class_prefix': 'group_absent', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Group name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'parameter_rename': [{'old': 'group', 'new': 'name'}]}, {'bundle_name': 'group_present', 'name': 'Group present', 'description': 'Create a group', 'class_prefix': 'group_present', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Group name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'parameter_rename': [{'old': 'group', 'new': 'name'}]}, {'bundle_name': 'http_request_check_status_headers', 'name': 'HTTP request check status with headers', 'description': 'Checks status of an HTTP URL', 'class_prefix': 'http_request_check_status_headers', 'class_parameter': 'url', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'method', 'description': 'Method to call the URL (GET, POST, PUT, DELETE)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'url', 'description': 'URL to query', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'expected_status', 'description': 'Expected status code of the HTTP response', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'headers', 'description': "Headers to include in the HTTP request (as a string, without ')", 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Perform a HTTP request on the URL, method and headers provided and check that the response has the expected status code (ie 200, 404, 503, etc)', 'parameter_rename': []}, {'bundle_name': 'http_request_content_headers', 'name': 'HTTP request sending content with headers', 'description': 'Make an HTTP request with a specific header', 'class_prefix': 'http_request_content_headers', 'class_parameter': 'url', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'method', 'description': 'Method to call the URL (POST, PUT)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'url', 'description': 'URL to send content to', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'content', 'description': 'Content to send', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'headers', 'description': 'Headers to include in the HTTP request', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Perform a HTTP request on the URL, method and headers provided\nand send the content provided. Will return an error if the request failed.', 'parameter_rename': []}, {'bundle_name': 'kernel_module_configuration', 'name': 'Kernel module configuration', 'description': 'Ensure that the modprobe configuration of a given kernel module is correct', 'class_prefix': 'kernel_module_configuration', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Complete name of the kernel module, as seen by lsmod or listed in /proc/modules', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'configuration', 'description': 'Complete configuration block to put in /etc/modprobe.d/', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384, 'regex': '^(alias|blacklist|install|options|remove|softdeps) +.*$'}, 'type': 'string'}], 'documentation': 'Ensure that the modprobe configuration of a given kernel module is correct.\n Rudder will search for the module configuration in a per-module dedicated section in /etc/modprobe.d/managed\\_by\\_rudder.conf.\n\n * If the module configuration is not found or incorrect, Rudder will (re-)create its configuration.\n * If the module is configured but with a different option file than used by Rudder, it will add the\n expected one in /etc/modprobe.d/managed\\_by\\_rudder.conf but will leave intact the already present one.\n\n The configuration syntax must respect the one used by /etc/modprobe.d defined in the modprobe.d manual page.\n ```\n # To pass a parameter to a module:\n options module_name parameter_name=parameter_value\n # To blacklist a module\n blacklist modulename\n # etc...\n ```\n\n#### Notes:\n If you want to force the module to be loaded at boot, use instead the method `kernel_module_enabled_at_boot` which\n uses other Rudder dedicated files.\n\n#### Example:\n\n To pass options to a broadcom module\n * `name` = b43\n * `configuration` = options b43 nohwcrypt=1 qos=0\n\n Will produce the resulting block in /etc/modprobe.d/managed\\_by\\_rudder.conf:\n ```\n ### b43 start section\n options b43 nohwcrypt=1 qos=0\n ### b43 end section\n ```', 'parameter_rename': [{'old': 'module_name', 'new': 'name'}]}, {'bundle_name': 'kernel_module_enabled_at_boot', 'name': 'Kernel module enabled at boot', 'description': 'Ensure that a given kernel module will be loaded at system boot', 'class_prefix': 'kernel_module_enabled_at_boot', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Complete name of the kernel module, as seen by lsmod or listed in /proc/modules', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Ensure that a given kernel module is enabled at boot on the system.\n This method only works on systemd systems.\n Rudder will look for a line matching the module name in a given section in the file:\n\n * `/etc/modules-load.d/enabled_by_rudder.conf` on systemd systems\n\n If the module is already enabled by a different option file than used by Rudder, it will add\n an entry in the file managed by Rudder listed above, and leave intact the already present one.\n The modifications are persistent and made line per line, meaning that\n this Generic Method will never remove lines in the configuration file but only add it if needed.\n\n Please note that this method will not load the module nor configure it, it will only enable its loading at system boot.\n If you want to force the module to be loaded, use instead the method `kernel_module_loaded`.\n If you want to configure the module, use instead the method `kernel_module_configuration`.', 'parameter_rename': [{'old': 'module_name', 'new': 'name'}]}, {'bundle_name': 'kernel_module_loaded', 'name': 'Kernel module loaded', 'description': 'Ensure that a given kernel module is loaded on the system', 'class_prefix': 'kernel_module_loaded', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Complete name of the kernel module, as seen by lsmod or listed in /proc/modules', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Ensure that a given kernel module is loaded on the system.\n If the module is not loaded, it will try to load it via modprobe.', 'parameter_rename': [{'old': 'module_name', 'new': 'name'}]}, {'bundle_name': 'kernel_module_not_loaded', 'name': 'Kernel module not loaded', 'description': 'Ensure that a given kernel module is not loaded on the system', 'class_prefix': 'kernel_module_not_loaded', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Complete name of the kernel module, as seen by lsmod or listed in /proc/modules', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Ensure that a given kernel module is not loaded on the system.\n If the module is loaded, it will try to unload it using modprobe.', 'parameter_rename': [{'old': 'module_name', 'new': 'name'}]}, {'bundle_name': 'monitoring_parameter', 'name': 'Monitoring parameter', 'description': 'Add a monitoring parameter to a node (requires a monitoring plugin)', 'class_prefix': 'monitoring_parameter', 'class_parameter': 'key', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'key', 'description': 'Name of the parameter', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'value', 'description': 'Value of the parameter', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This method adds monitoring parameters to rudder nodes. The monitoring parameters are used to\npass configuration to the monitoring plugins running with Rudder. Expected keys and parameters\nare specific to each plugin and can be found in their respective documentation.', 'parameter_rename': []}, {'bundle_name': 'monitoring_template', 'name': 'Monitoring template', 'description': 'Add a monitoring template to a node (requires a monitoring plugin)', 'class_prefix': 'monitoring_template', 'class_parameter': 'template', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'template', 'description': 'Name of the monitoring template', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This method assigns monitoring templates to a Rudder node. The Rudder plugin respective to\neach monitoring platform will apply those templates to the node.', 'parameter_rename': []}, {'bundle_name': 'package_absent', 'name': 'Package absent', 'description': 'Enforce the absence of a package', 'class_prefix': 'package_absent', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Name of the package', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'version', 'description': 'Version of the package or "any" for any version (defaults to "any")', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'architecture', 'description': 'Architecture of the package, can be an architecture name or "default" (defaults to "default")', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'provider', 'description': 'Package provider to use, can be "yum", "apt", "zypper", "zypper_pattern", "slackpkg", "pkg", "ips", "nimclient" or "default" for system default package manager (defaults to "default")', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384, 'select': ['', 'default', 'yum', 'apt', 'zypper', 'zypper_pattern', 'slackpkg', 'pkg', 'ips', 'nimclient']}, 'type': 'string'}], 'documentation': 'See [package_state](#_package_state) for documentation.', 'parameter_rename': []}, {'bundle_name': 'package_check_installed', 'name': 'Package check installed', 'description': 'Verify if a package is installed in any version', 'class_prefix': 'package_check_installed', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Name of the package to check', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This bundle will define a condition `package_check_installed_${file_name}_{ok, reached, kept}` if the\npackage is installed, or `package_check_installed_${file_name}_{not_ok, reached, not_kept, failed}` if\nthe package is not installed', 'parameter_rename': [{'old': 'package_name', 'new': 'name'}]}, {'bundle_name': 'package_install', 'name': 'Package install', 'description': 'Install or update a package in its latest version available', 'class_prefix': 'package_install', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Name of the package to install', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'deprecated': 'Use [package_present](#_package_present) instead.', 'parameter_rename': [{'old': 'package_name', 'new': 'name'}]}, {'bundle_name': 'package_install_version', 'name': 'Package install version', 'description': 'Install or update a package in a specific version', 'class_prefix': 'package_install', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Name of the package to install', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'package_version', 'description': 'Version of the package to install (can be "latest" to install it in its latest version)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'deprecated': 'Use [package_present](#_package_present) instead.', 'parameter_rename': [{'old': 'package_name', 'new': 'name'}]}, {'bundle_name': 'package_install_version_cmp', 'name': 'Package install version compare', 'description': 'Install a package or verify if it is installed in a specific version, or higher or lower version than a version specified', 'class_prefix': 'package_install', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Name of the package to install or verify', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'version_comparator', 'description': 'Comparator between installed version and defined version, can be ==,<=,>=,<,>,!=', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384, 'select': ['==', '<=', '>=', '<', '>', '!=']}, 'type': 'string'}, {'name': 'package_version', 'description': 'The version of the package to verify (can be "latest" for latest version)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'action', 'description': 'Action to perform, can be add, verify (defaults to verify)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': '*Example*:\n```\nmethods:\n "any" usebundle => package_install_version_cmp("postgresql", ">=", "9.1", "verify");\n```', 'deprecated': 'Use [package_present](#_package_present) instead.', 'parameter_rename': [{'old': 'package_name', 'new': 'name'}]}, {'bundle_name': 'package_install_version_cmp_update', 'name': 'Package install version compare (update optional)', 'description': 'Install a package or verify if it is installed in a specific version, or higher or lower version than a version specified, optionally test update or not (Debian-, Red Hat- or SUSE-like systems only)', 'class_prefix': 'package_install', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Name of the package to install or verify', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'version_comparator', 'description': 'Comparator between installed version and defined version, can be ==,<=,>=,<,>,!=', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384, 'select': ['==', '<=', '>=', '<', '>', '!=']}, 'type': 'string'}, {'name': 'package_version', 'description': 'The version of the package to verify (can be "latest" for latest version)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'action', 'description': 'Action to perform, can be add, verify (defaults to verify)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'update_policy', 'description': 'While verifying packages, check against latest version ("true") or just installed ("false")', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': '*Example*:\n```\nmethods:\n "any" usebundle => package_install_version_cmp_update("postgresql", ">=", "9.1", "verify", "false");\n```', 'deprecated': 'Use [package_present](#_package_present) instead.', 'parameter_rename': [{'old': 'package_name', 'new': 'name'}]}, {'bundle_name': 'package_present', 'name': 'Package present', 'description': 'Enforce the presence of a package', 'class_prefix': 'package_present', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Name of the package, or path to a local package', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'version', 'description': 'Version of the package, can be "latest" for latest version or "any" for any version (defaults to "any")', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'architecture', 'description': 'Architecture of the package, can be an architecture name or "default" (defaults to "default")', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'provider', 'description': 'Package provider to use, can be "yum", "apt", "zypper", "zypper_pattern", "slackpkg", "pkg", "ips", "nimclient" or "default" for system default package manager (defaults to "default")', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384, 'select': ['', 'default', 'yum', 'apt', 'zypper', 'zypper_pattern', 'slackpkg', 'pkg', 'ips', 'nimclient']}, 'type': 'string'}], 'documentation': 'See [package_state](#_package_state) for documentation.', 'parameter_rename': []}, {'bundle_name': 'package_remove', 'name': 'Package remove', 'description': 'Remove a package', 'class_prefix': 'package_remove', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Name of the package to remove', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': '*Example*:\n```\nmethods:\n "any" usebundle => package_remove("htop");\n```', 'deprecated': 'Use [package_absent](#_package_absent) instead.', 'parameter_rename': [{'old': 'package_name', 'new': 'name'}]}, {'bundle_name': 'package_state', 'name': 'Package state', 'description': 'Enforce the state of a package', 'class_prefix': 'package_state', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Name of the package, or path to a local package if state is present', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'version', 'description': 'Version of the package, can be "latest" for latest version or "any" for any version (defaults to "any")', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'architecture', 'description': 'Architecture of the package, can be an architecture name or "default" (defaults to "default")', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'provider', 'description': 'Package provider to use, can be "yum", "apt", "zypper", "zypper_pattern", "slackpkg", "pkg", "ips", "nimclient" or "default" for system default package manager (defaults to "default")', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384, 'select': ['', 'default', 'yum', 'apt', 'zypper', 'zypper_pattern', 'slackpkg', 'pkg', 'ips', 'nimclient']}, 'type': 'string'}, {'name': 'state', 'description': 'State of the package, can be "present" or "absent" (defaults to "present")', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384, 'select': ['', 'present', 'absent']}, 'type': 'string'}], 'documentation': 'These methods manage packages using a package manager on the system.\n\n`package_present` and `package_absent` use a new package implementation, different from `package_install_*`,\n`package_remove_*` and `package_verify_*`. It should be more reliable, and handle upgrades better.\nIt is compatible though, and you can call generic methods from both implementations on the same host.\nThe only drawback is that the agent will have to maintain double caches for package lists, which\nmay cause a little unneeded overhead.\n\n#### Package parameters\n\nThere is only one mandatory parameter, which is the package name to install.\nWhen it should be installed from a local package, you need to specify the full path to the package as name.\n\nThe version parameter allows specifying a version you want installed.\nIt should be the complete versions string as used by the used package manager.\nThis parameter allows two special values:\n\n* *any* which is the default value, and is satisfied by any version of the given package\n* *latest* which will ensure, at each run, that the package is at the latest available version.\n\nThe last parameter is the provider, which is documented in the next section.\n\nYou can use [package_state_options](#_package_state_options) to pass options to the underlying package manager\n(currently only with *apt* package manager).\n\n#### Package providers\n\nThis method supports several package managers. You can specify the package manager\nyou want to use or let the method choose the default for the local system.\n\nThe package providers include a caching system for package information.\nThe package lists (installed, available and available updates) are only updated\nwhen the cache expires, or when an operation is made by the agent on packages.\n\n*Note*: The implementation of package operations is done in scripts called modules,\nwhich you can find in `${sys.workdir}/modules/packages/`.\n\n##### apt\n\nThis package provider uses *apt*/*dpkg* to manage packages on the system.\n*dpkg* will be used for all local actions, and *apt* is only needed to manage update and\ninstallation from a repository.\n\n##### rpm\n\nThis package provider uses *yum*/*rpm* to manage packages on the system. *rpm* will \nbe used for all local actions, and *yum* is only needed to manage update and\ninstallation from a repository.\n\nIt is able to downgrade packages when specifying an older version.\n\n##### zypper\n\nThis package provider uses *zypper*/*rpm* to manage packages on the system.\n*rpm* will be used for all local actions, and *zypper* is only needed to manage update and\ninstallation from a repository.\n\nNote: If the package version you want to install contains an epoch, you have to specify it\nin the version in the `epoch:version` form, like reported by `zypper info`.\n\n##### zypper_pattern\n\nThis package provider uses zypper with the `-t pattern` option to manage zypper patterns or\nmeta-packages on the system.\n\nSince a zypper pattern can be named differently than the rpm package name providing it, please\nalways use the exact pattern name (as listed in the output of `zypper patterns`)\nwhen using this provider.\n\nNote: When installing a pattern from a local rpm file, Rudder assumes that the pattern is built\nfollowing the \n[official zypper documentation](https://doc.opensuse.org/projects/libzypp/HEAD/zypp-pattern-packages.html).\n\nOlder implementations of zypper patterns may not be supported by this module.\n\nThis provider doesn\'t support installation from a file.\n\n##### slackpkg\n\nThis package provider uses Slackware\'s `installpkg` and `upgradepkg` tools to manage \npackages on the system\n\n##### pkg\n\nThis package provider uses FreeBSD\'s *pkg* to manage packages on the system.\nThis provider doesn\'t support installation from a file.\n\n#### ips\n\nThis package provider uses Solaris\'s pkg command to manage packages from IPS repositories on the system.\nThis provider doesn\'t support installation from a file.\n\n#### nimclient\n\nThis package provider uses AIX\'s nim client to manage packages from nim\nThis provider doesn\'t support installation from a file.\n\n#### Examples\n\n```\n# To install postgresql in version 9.1 for x86_64 architecture\npackage_present("postgresql", "9.1", "x86_64", "");\n# To ensure postgresql is always in the latest available version\npackage_present("postgresql", "latest", "", "");\n# To ensure installing postgresql in any version\npackage_present("postgresql", "", "", "");\n# To ensure installing postgresql in any version, forcing the yum provider\npackage_present("postgresql", "", "", "yum");\n# To ensure installing postgresql from a local package\npackage_present("/tmp/postgresql-9.1-1.x86_64.rpm", "", "", "");\n# To remove postgresql\npackage_absent("postgresql", "", "", "");\n```\n\nSee also : [package_present](#_package_present), [package_absent](#_package_absent), [package_state_options](#_package_state_options)', 'parameter_rename': []}, {'bundle_name': 'package_state_options', 'name': 'Package state with options', 'description': 'Enforce the state of a package with options', 'class_prefix': 'package_state_options', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Name of the package, or path to a local package if state is present', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'version', 'description': 'Version of the package, can be "latest" for latest version or "any" for any version (defaults to "any")', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'architecture', 'description': 'Architecture of the package, can be an architecture name or "default" (defaults to "default")', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'provider', 'description': 'Package provider to use, can be "yum", "apt", "zypper", "zypper_pattern", "slackpkg", "pkg", "ips", "nimclient" or "default" for system default package manager (defaults to "default")', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384, 'select': ['', 'default', 'yum', 'apt', 'zypper', 'zypper_pattern', 'slackpkg', 'pkg', 'ips', 'nimclient']}, 'type': 'string'}, {'name': 'state', 'description': 'State of the package, can be "present" or "absent" (defaults to "present")', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384, 'select': ['', 'present', 'absent']}, 'type': 'string'}, {'name': 'options', 'description': 'Options no pass to the package manager (defaults to empty)', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'See [package_state](#_package_state) for documentation.', 'parameter_rename': []}, {'bundle_name': 'package_state_windows', 'name': 'Package state windows', 'description': 'This method manage packages using a chocolatey on the system.', 'class_prefix': 'package_state_windows', 'class_parameter': 'PackageName', 'agent_support': ['dsc'], 'parameter': [{'name': 'PackageName', 'description': 'Software name to install', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'Status', 'description': "'present' or 'absent', defaults to 'present'", 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384, 'select': ['', 'present', 'absent']}, 'type': 'string'}, {'name': 'Provider', 'description': 'default to choco', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384, 'select': ['', 'choco']}, 'type': 'string'}, {'name': 'Params', 'description': 'params to pass to the package installation', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'Version', 'description': 'version, default to latest', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'Source', 'description': 'source', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'ProviderParams', 'description': 'provider parameters, default to choco', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'AutoUpgrade', 'description': 'autoUpgrade, default to false', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384, 'select': ['', 'true', 'false']}, 'type': 'string'}], 'documentation': 'Install a windows package using a given provider\n\n#### Parameters\n\nRequired args:\n\n* `PackageName` Name of target package\n* `Status` can be "present" or "absent"\n\nOptional args:\n\n* `Provider` Provider used to installed the package\n* `Params` Package parameters, passed to the installer\n* `Version` can be "any", "latest" or any exact specific version number\n* `Source` "any" or any specific arch\n* `ProviderParams` provider specific options\n* `AutoUpgrade` default set to false\n\n\n#### Providers\n\n##### choco\n\nThe method is a simple transcription of the cchoco `cChocoPaclageInstaller` DSC resource, adapted to Rudder.\nThe DSC module `cchoco` must be installed on your node before trying to use this method.\n\nYou can check the cchoco/chocolatey documentation to get more detailed information on the parameters.\nWARNING: If some exceptions are thrown about undefined env PATH variable after fresh cchoco lib in rudder,\nyou may need to reboot your machine or notify your system that the env variables have been changed.', 'parameter_rename': []}, {'bundle_name': 'package_verify', 'name': 'Package verify', 'description': 'Verify if a package is installed in its latest version available', 'class_prefix': 'package_install', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Name of the package to verify', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'parameter_rename': [{'old': 'package_name', 'new': 'name'}]}, {'bundle_name': 'package_verify_version', 'name': 'Package verify version', 'description': 'Verify if a package is installed in a specific version', 'class_prefix': 'package_install', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Name of the package to verify', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'version', 'description': 'Version of the package to verify (can be "latest" for latest version)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'parameter_rename': [{'old': 'package_name', 'new': 'name'}, {'old': 'package_version', 'new': 'version'}]}, {'bundle_name': 'permissions', 'name': 'Permissions (non recursive)', 'description': 'Set permissions on a file or directory (non recursively)', 'class_prefix': 'permissions', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'Path to the file/directory', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'mode', 'description': 'Mode to enforce (like "640")', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'owner', 'description': 'Owner to enforce (like "root")', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'group', 'description': 'Group to enforce (like "wheel")', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'parameter_rename': []}, {'bundle_name': 'permissions_acl_entry', 'name': 'Permissions POSIX acl entry', 'description': 'Verify that an ace is present on a file or directory.\nThis method will append the given aces to the current POSIX ACLs of\nthe target.', 'class_prefix': 'permissions_acl_entry', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'Path of the file or directory', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'recursive', 'description': 'Recursive Should ACLs cleanup be recursive, "true" or "false" (defaults to "false")', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384, 'select': ['', 'true', 'false']}, 'type': 'string'}, {'name': 'user', 'description': 'User acls, comma separated, like: bob:+rwx, alice:-w', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384, 'regex': '^$|^(([A-z0-9._-]+|\\*):([+-=]r?w?x?)?,? *)+$'}, 'type': 'string'}, {'name': 'group', 'description': 'Group acls, comma separated, like: wheel:+wx, anon:-rwx', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384, 'regex': '^$|^(([A-z0-9._-]+|\\*):([+-=]r?w?x?)?,? *)+$'}, 'type': 'string'}, {'name': 'other', 'description': 'Other acls, like -x', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384, 'regex': '^$|^[+-=^]r?w?x?$'}, 'type': 'string'}], 'documentation': "The `permissions_*acl_*` manage the POSIX ACL on files and directories.\n\nPlease note that the mask will be automatically recalculated when editing ACLs.\n\n#### Parameters\n\n##### Path\n\nPath can be a regex with the following format:\n\n* `*` matches any filename or directory at one level, e.g. `*.cf` will match all files in one directory that end in .cf but it won't search across directories. `*/*.cf` on the other hand will look two levels deep.\n* `?` matches a single letter\n* `[a-z]` matches any letter from a to z\n* `{x,y,anything}` will match x or y or anything.\n\n##### Recursive\n\nCan be:\n\n* `true` to apply the given aces to folder and sub-folders and files.\n* or `false` to apply to the strict match of `Path`\n\nIf left blank, recursivity will automatically be set to `false`\n\n##### User and Group\n\nACE for user and group can be left blank if they do not need any specification.\nIf fulfill, they must respect the format:\n\n`<username|groupname>:<operator><mode>`\n\nwith:\n\n* `username` being the Linux account name\n* `groupname` the Linux group name\n* Current `owner user` and `owner group` can be designed by the character `*`\n\nThe operator can be:\n* `+` to add the given ACE to the current ones.\n* `-` to remove the given ACE to the current ones.\n* `=` to force the given ACE to the current ones.\n\nYou can define multiple ACEs by separating them with commas.\n\n##### Other\n\nACE for other must respect the classic:\n\n* `[+-=]r?w?x?`\nIt can also be left blank to let the `Other` ACE unchanged.\n\n#### Example\n\nGiven a file with the following getfacl output:\n\n~~~~\nroot@server# getfacl /tmp/myTestFile\ngetfacl: Removing leading '/' from absolute path names\n# file: tmp/myTestFile\n# owner: root\n# group: root\nuser::rwx\nuser:bob:rwx\ngroup::r--\nmask::rwx\nother::---\n\n~~~~\n\nApplying this method with the following parameters:\n\n* `path`: /tmp/myTestFile\n* `recursive`: false\n* `user`: *:-x, bob:\n* `group`: *:+rw\n* `other`: =r\n\nWill transform the previous ACLs in:\n\n~~~~\nroot@server# getfacl /tmp/myTestFile\ngetfacl: Removing leading '/' from absolute path names\n# file: tmp/myTestFile\n# owner: root\n# group: root\nuser::rw-\nuser:bob:---\ngroup::rw-\nmask::rw-\nother::r--\n\n~~~~\n\nThis method can not remove a given ACE, see here how the user bob ACE is handled.", 'parameter_rename': []}, {'bundle_name': 'permissions_dirs', 'name': 'Permissions dirs', 'description': 'Verify if a directory has the right permissions non recursively', 'class_prefix': 'permissions', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'Path of the directory', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'mode', 'description': 'Mode to enforce', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'owner', 'description': 'Owner to enforce', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'group', 'description': 'Group to enforce', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'parameter_rename': []}, {'bundle_name': 'permissions_dirs_recurse', 'name': 'Permissions dirs recurse', 'description': 'Verify if a directory has the right permissions recursively', 'class_prefix': 'permissions', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'Path to the directory', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'mode', 'description': 'Mode to enforce', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'owner', 'description': 'Owner to enforce', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'group', 'description': 'Group to enforce', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'deprecated': 'Use [permissions_dirs_recursive](#_permissions_dirs_recursive) instead.', 'rename': 'permissions_dirs_recursive', 'parameter_rename': []}, {'bundle_name': 'permissions_dirs_recursive', 'name': 'Permissions dirs recursive', 'description': 'Verify if a directory has the right permissions recursively', 'class_prefix': 'permissions', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'Path to the directory', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'mode', 'description': 'Mode to enforce', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'owner', 'description': 'Owner to enforce', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'group', 'description': 'Group to enforce', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'parameter_rename': []}, {'bundle_name': 'permissions_group_acl_absent', 'name': 'Permissions group POSIX acl entry absent', 'description': 'Verify that an ace is absent on a file or directory for a given group.\nThis method will make sure that no ace is present in the POSIX ACL of the target.', 'class_prefix': 'permissions_group_acl_absent', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'Path of the file or directory', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'recursive', 'description': 'Recursive Should ACLs cleanup be recursive, "true" or "false" (defaults to "false")', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384, 'select': ['', 'true', 'false']}, 'type': 'string'}, {'name': 'group', 'description': 'Group name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': "The `permissions_*acl_*` manage the POSIX ACL on files and directories.\n\nPlease note that the mask will be automatically recalculated when editing ACLs.\n\n#### Parameters\n\n##### Path\n\nPath can be a regex with the following format:\n\n* `*` matches any filename or directory at one level, e.g. `*.cf` will match all files in one directory that end in .cf but it won't search across directories. `*/*.cf` on the other hand will look two levels deep.\n* `?` matches a single letter\n* `[a-z]` matches any letter from a to z\n* `{x,y,anything}` will match x or y or anything.\n\n##### Recursive\n\nCan be:\n\n* `true` to apply the given aces to folder and sub-folders and files.\n* or `false` to apply to the strict match of `Path`\n\nIf left blank, recursivity will automatically be set to `false`\n\n##### User\n\n`Username` to enforce the ace absence, being the Linux account name.\nThis method can only handle one groupname.\n\n#### Example\n\nGiven a file with the following getfacl output:\n\n~~~~\nroot@server# getfacl /tmp/myTestFile \ngetfacl: Removing leading '/' from absolute path names\n# file: tmp/myTestFile\n# owner: root\n# group: root\nuser::rwx\ngroup::r--\ngroup:bob:rwx\nmask::rwx\nother::---\n\n~~~~\n\nApplying this method with the following parameters:\n\n* `path`: /tmp/myTestFile\n* `recursive`: false\n* `group`: bob\n\nWill transform the previous ACLs in:\n\n~~~~\nroot@server# getfacl /tmp/myTestFile \ngetfacl: Removing leading '/' from absolute path names\n# file: tmp/myTestFile\n# owner: root\n# group: root\nuser::rwx\ngroup::r--\nmask::r--\nother::---\n\n~~~~", 'parameter_rename': []}, {'bundle_name': 'permissions_group_acl_present', 'name': 'Permissions group POSIX acl entry present', 'description': 'Verify that an ace is present on a file or directory for a given group.\nThis method will make sure the given ace is present in the POSIX ACL of the target for the given group.', 'class_prefix': 'permissions_group_acl_present', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'Path of the file or directory', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'recursive', 'description': 'Recursive Should ACLs cleanup be recursive, "true" or "false" (defaults to "false")', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384, 'select': ['', 'true', 'false']}, 'type': 'string'}, {'name': 'group', 'description': 'Group name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'ace', 'description': 'ACE to enforce for the given group.', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384, 'regex': '^[+-=]?(?=.*[rwx])r?w?x?$'}, 'type': 'string'}], 'documentation': "The `permissions_*acl_*` manage the POSIX ACL on files and directories.\n\nPlease note that the mask will be automatically recalculated when editing ACLs.\n\n#### Parameters\n\n##### Path\n\nPath can be a regex with the following format:\n\n* `*` matches any filename or directory at one level, e.g. `*.cf` will match all files in one directory that end in .cf but it won't search across directories. `*/*.cf` on the other hand will look two levels deep.\n* `?` matches a single letter\n* `[a-z]` matches any letter from a to z\n* `{x,y,anything}` will match x or y or anything.\n\n##### Recursive\n\nCan be:\n\n* `true` to apply the given aces to folder and sub-folders and files.\n* or `false` to apply to the strict match of `Path`\n\nIf left blank, recursivity will automatically be set to `false`\n\n##### Group\n\n`Group` to enfoorce the ace, being the Linux account name.\nThis method can only handle one groupname.\n\n##### ACE\n\nThe operator can be:\n* `+` to add the given ACE to the current ones.\n* `-` to remove the given ACE to the current ones.\n* `=` to force the given ACE to the current ones.\n* `empty` if no operator is specified, it will be interpreted as `=`.\n\nACE must respect the classic:\n\n* `^[+-=]?(?=.*[rwx])r?w?x?$`\n\n#### Example\n\nGiven a file with the following getfacl output:\n\n~~~~\nroot@server# getfacl /tmp/myTestFile \ngetfacl: Removing leading '/' from absolute path names\n# file: tmp/myTestFile\n# owner: root\n# group: root\nuser::rwx\ngroup::r--\ngroup:bob:rwx\nmask::rwx\nother::---\n\n~~~~\n\nApplying this method with the following parameters:\n\n* `path`: /tmp/myTestFile\n* `recursive`: false\n* `group`: bob\n* `ace`: -rw\n\nWill transform the previous ACLs in:\n\n~~~~\nroot@server# getfacl /tmp/myTestFile \ngetfacl: Removing leading '/' from absolute path names\n# file: tmp/myTestFile\n# owner: root\n# group: root\nuser::rwx\ngroup::r--\ngroup:bob:--x\nmask::r-x\nother::---\n\n~~~~", 'parameter_rename': []}, {'bundle_name': 'permissions_ntfs', 'name': 'Permissions NTFS', 'description': 'Ensure NTFS permissions on a file for a given user.', 'class_prefix': 'permissions_ntfs', 'class_parameter': 'path', 'agent_support': ['dsc'], 'parameter': [{'name': 'path', 'description': 'File path', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'user', 'description': 'DOMAIN\\Account', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'rights', 'description': 'Comma separated right list', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'accesstype', 'description': '"Allow" or "Deny"', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384, 'select': ['Allow', 'Deny', '']}, 'type': 'string'}, {'name': 'propagationpolicy', 'description': 'Define the propagation policy of the access rule that Rudder is applying', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384, 'select': ['ThisFolderOnly', 'ThisFolderSubfoldersAndFiles', 'ThisFolderAndSubfolders', 'ThisFolderAndFiles', 'SubfoldersAndFilesOnly', 'SubfoldersOnly', 'FilesOnly', '']}, 'type': 'string'}], 'documentation': 'Ensure that the correct NTFS permissions are applied on a file for a given user.\n\n Inheritance and propagation flags can also be managed. If left blank, no propagation will be set.\n\n To manage effective propagation or effective access, please disable the inheritance on the file before\n applying this generic method.\n\n Note: that the `Synchronize` permission may not work in some cases. This is a known bug.\n\n Right validate set:\n\n None, ReadData, ListDirectory, WriteData, CreateFiles, AppendData, CreateDirectories, ReadExtendedAttributes,\n WriteExtendedAttributes, ExecuteFile, Traverse, DeleteSubdirectoriesAndFiles, ReadAttributes, WriteAttributes, Write,\n Delete, ReadPermissions, Read, ReadAndExecute, Modify, ChangePermissions, TakeOwnership, Synchronize, FullControl\n\n AccessType validate set:\n\n Allow, Deny\n\n PropagationPolicy validate set:\n\n ThisFolderOnly, ThisFolderSubfoldersAndFiles, ThisFolderAndSubfolders, ThisFolderAndFiles, SubfoldersAndFilesOnly,\n SubfoldersOnly, FilesOnly', 'parameter_rename': []}, {'bundle_name': 'permissions_other_acl_present', 'name': 'Permissions other POSIX acl entry present', 'description': 'Verify that the other ace given is present on a file or directory.\nThis method will make sure the given other ace is present in the POSIX ACL of the target for.', 'class_prefix': 'permissions_other_acl_present', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'Path of the file or directory', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'recursive', 'description': 'Recursive Should ACLs cleanup be recursive, "true" or "false" (defaults to "false")', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384, 'select': ['', 'true', 'false']}, 'type': 'string'}, {'name': 'other', 'description': 'ACE to enforce for the given other.', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384, 'regex': '^[+-=]?(?=.*[rwx])r?w?x?$'}, 'type': 'string'}], 'documentation': "The `permissions_*acl_*` manage the POSIX ACL on files and directories.\n\nPlease note that the mask will be automatically recalculated when editing ACLs.\n\n#### Parameters\n\n##### Path\n\nPath can be a regex with the following format:\n\n* `*` matches any filename or directory at one level, e.g. `*.cf` will match all files in one directory that end in .cf but it won't search across directories. `*/*.cf` on the other hand will look two levels deep.\n* `?` matches a single letter\n* `[a-z]` matches any letter from a to z\n* `{x,y,anything}` will match x or y or anything.\n\n##### Recursive\n\nCan be:\n\n* `true` to apply the given aces to folder and sub-folders and files.\n* or `false` to apply to the strict match of `Path`\n\nIf left blank, recursivity will automatically be set to `false`\n\n##### Other_ACE\n\nThe operator can be:\n* `+` to add the given ACE to the current ones.\n* `-` to remove the given ACE to the current ones.\n* `=` to force the given ACE to the current ones.\n* `empty` if no operator is specified, it will be interpreted as `=`.\n\nACE must respect the classic:\n\n* `^[+-=]?(?=.*[rwx])r?w?x?$`\n\n#### Example\n\nGiven a file with the following getfacl output:\n\n~~~~\nroot@server# getfacl /tmp/myTestFile \ngetfacl: Removing leading '/' from absolute path names\n# file: tmp/myTestFile\n# owner: root\n# group: root\nuser::rwx\nuser:bob:rwx\ngroup::r--\nmask::rwx\nother::r-x\n\n~~~~\n\nApplying this method with the following parameters:\n\n* `path`: /tmp/myTestFile\n* `recursive`: false\n* `other ace`: -rw\n\nWill transform the previous ACLs in:\n\n~~~~\nroot@server# getfacl /tmp/myTestFile \ngetfacl: Removing leading '/' from absolute path names\n# file: tmp/myTestFile\n# owner: root\n# group: root\nuser::rwx\nuser:bob:rwx\ngroup::r--\nmask::rwx\nother::--x\n\n~~~~", 'parameter_rename': []}, {'bundle_name': 'permissions_posix_acls_absent', 'name': 'Permissions POSIX ACLs absent', 'description': 'Ensure that files or directories has no ACLs set', 'class_prefix': 'permissions_posix_acls_absent', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'Path of the file or directory', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'recursive', 'description': 'Should ACLs cleanup be recursive, "true" or "false" (defaults to "false")', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384, 'select': ['', 'true', 'false']}, 'type': 'string'}], 'documentation': "The `permissions_*acl_*` manage the POSIX ACL on files and directories.\n#### Parameters\n\n##### Path\n\nPath can be globbing with the following format:\n\n* * matches any filename or directory at one level, e.g. *.cf will match all files in one directory that end in .cf but it won't search across directories. */*.cf on the other hand will look two levels deep.\n* ? matches a single letter\n* [a-z] matches any letter from a to z\n* {x,y,anything} will match x or y or anything.\n\n##### Recursive\n\nCan be:\n\n* `true` to apply the given aces to folder and sub-folders and files.\n* or `false` to apply to the strict match of `Path`\n\nIf left blank, recursivity will automatically be set to `false`\n\n#### Example\nThe method has basically the same effect as `setfacl -b <path>`.\n\nGiven a file with the following getfacl output:\n\n~~~~\nroot@server# getfacl /tmp/myTestFile \ngetfacl: Removing leading '/' from absolute path names\n# file: tmp/myTestFile\n# owner: root\n# group: root\nuser::rwx\nuser:vagrant:rwx\ngroup::r--\nmask::rwx\nother::---\n\n~~~~\n\nIt will remove all ACLs, and only let classic rights, here:\n\n~~~~\nroot@server# getfacl myTestFile \n# file: myTestFile\n# owner: root\n# group: root\nuser::rwx\ngroup::r--\nother::---\n\nroot@server# ls -l myTestFile\n-rwxr----- 1 root root 0 Mar 22 11:24 myTestFile\nroot@server# \n\n~~~~", 'parameter_rename': []}, {'bundle_name': 'permissions_recurse', 'name': 'Permissions (recurse)', 'description': 'Verify if a file or directory has the right permissions recursively', 'class_prefix': 'permissions', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'Path to the file / directory', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'mode', 'description': 'Mode to enforce', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'owner', 'description': 'Owner to enforce', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'group', 'description': 'Group to enforce', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'deprecated': 'Use [permissions_recursive](#_permissions_recursive) instead.', 'rename': 'permissions_recursive', 'parameter_rename': []}, {'bundle_name': 'permissions_recursive', 'name': 'Permissions (recursive)', 'description': 'Verify if a file or directory has the right permissions recursively', 'class_prefix': 'permissions', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'Path to the file / directory', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'mode', 'description': 'Mode to enforce', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'owner', 'description': 'Owner to enforce', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'group', 'description': 'Group to enforce', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'The method ensures that all files and directories under `path` have\nthe correct owner, group owner and permissions.\n\nThis method is in fact a call to the *permissions_type_recursion* method with "all" type and "inf" recursion.', 'parameter_rename': []}, {'bundle_name': 'permissions_type_recursion', 'name': 'Permissions type recursion', 'description': 'Ensure that a file or directory is present and has the right mode/owner/group', 'class_prefix': 'permissions', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'Path to edit', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'mode', 'description': 'Mode of the path to edit', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'owner', 'description': 'Owner of the path to edit', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'group', 'description': 'Group of the path to edit', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'type', 'description': 'Type of the path to edit (all/files/directories)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'recursion', 'description': 'Recursion depth to enforce for this path (0, 1, 2, ..., inf)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'The method ensure that all files|directories|files and directories have\nthe correct owner, group owner and permissions.\n\nThe parameter *type* can be either: "*all*", "*files*" or "*directories*".\nThe parameter *recursion* can be either: "*0,1,2,3,.... inf*"\nThe level of recursion is the maximum depth of subfolder that will be managed by the method:\n\n* 0 being the current folder/file\n* 1 being the current folder/file and its subfolders\n* ..\n* inf being the file or the whole folder tree', 'parameter_rename': []}, {'bundle_name': 'permissions_user_acl_absent', 'name': 'Permissions user POSIX acl entry absent', 'description': 'Verify that an ace is absent on a file or directory for a given user.\nThis method will make sure that no ace is present in the POSIX ACL of the target.', 'class_prefix': 'permissions_user_acl_absent', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'Path of the file or directory', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'recursive', 'description': 'Recursive Should ACLs cleanup be recursive, "true" or "false" (defaults to "false")', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384, 'select': ['', 'true', 'false']}, 'type': 'string'}, {'name': 'user', 'description': 'Username of the Linux account.', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': "The `permissions_*acl_*` manage the POSIX ACL on files and directories.\n\nPlease note that the mask will be automatically recalculated when editing ACLs.\n\n#### Parameters\n\n##### Path\n\nPath can be a regex with the following format:\n\n* `*` matches any filename or directory at one level, e.g. `*.cf` will match all files in one directory that end in .cf but it won't search across directories. `*/*.cf` on the other hand will look two levels deep.\n* `?` matches a single letter\n* `[a-z]` matches any letter from a to z\n* `{x,y,anything}` will match x or y or anything.\n\n##### Recursive\n\nCan be:\n\n* `true` to apply the given aces to folder and sub-folders and files.\n* or `false` to apply to the strict match of `Path`\n\nIf left blank, recursivity will automatically be set to `false`\n\n##### User\n\n`Username` to enforce the ace absence, being the Linux account name.\nThis method can only handle one username.\n\n#### Example\n\nGiven a file with the following getfacl output:\n\n~~~~\nroot@server# getfacl /tmp/myTestFile \ngetfacl: Removing leading '/' from absolute path names\n# file: tmp/myTestFile\n# owner: root\n# group: root\nuser::rwx\nuser:bob:rwx\ngroup::r--\nmask::rwx\nother::---\n\n~~~~\n\nApplying this method with the following parameters:\n\n* `path`: /tmp/myTestFile\n* `recursive`: false\n* `user`: bob\n\nWill transform the previous ACLs in:\n\n~~~~\nroot@server# getfacl /tmp/myTestFile \ngetfacl: Removing leading '/' from absolute path names\n# file: tmp/myTestFile\n# owner: root\n# group: root\nuser::rwx\ngroup::r--\nmask::r--\nother::---\n\n~~~~", 'parameter_rename': []}, {'bundle_name': 'permissions_user_acl_present', 'name': 'Permissions user POSIX acl entry present', 'description': 'Verify that an ace is present on a file or directory for a given user.\nThis method will make sure the given ace is present in the POSIX ACL of the target.', 'class_prefix': 'permissions_user_acl_present', 'class_parameter': 'path', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'path', 'description': 'Path of the file or directory.', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'recursive', 'description': 'Recursive Should ACLs cleanup be recursive, "true" or "false" (defaults to "false").', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384, 'select': ['', 'true', 'false']}, 'type': 'string'}, {'name': 'user', 'description': 'Username of the Linux account.', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'ace', 'description': 'ACE to enforce for the given user.', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384, 'regex': '^[+-=]?(?=.*[rwx])r?w?x?$'}, 'type': 'string'}], 'documentation': "The `permissions_*acl_*` manage the POSIX ACL on files and directories.\n\nPlease note that the mask will be automatically recalculated when editing ACLs.\n\n#### Parameters\n\n##### Path\n\nPath can be globbing with the following format:\n\n* `*` matches any filename or directory at one level, e.g. `*.cf` will match all files in one directory that end in .cf but it won't search across directories. `*/*.cf` on the other hand will look two levels deep.\n* `?` matches a single letter\n* `[a-z]` matches any letter from a to z\n* `{x,y,anything}` will match x or y or anything.\n\n##### Recursive\n\nCan be:\n\n* `true` to apply the given aces to folder and sub-folders and files.\n* or `false` to apply to the strict match of `Path`\n\nIf left blank, recursivity will automatically be set to `false`\n\n##### User\n\n`Username` to enforce the ace, being the Linux account name.\nThis method can only handle one username.\n\n##### ACE\n\nThe operator can be:\n* `+` to add the given ACE to the current ones.\n* `-` to remove the given ACE to the current ones.\n* `=` to force the given ACE to the current ones.\n* `empty` if no operator is specified, it will be interpreted as `=`.\n\nACE must respect the classic:\n\n* `^[+-=]?(?=.*[rwx])r?w?x?$`\n\n#### Example\n\nGiven a file with the following getfacl output:\n\n~~~~\nroot@server# getfacl /tmp/myTestFile \ngetfacl: Removing leading '/' from absolute path names\n# file: tmp/myTestFile\n# owner: root\n# group: root\nuser::rwx\nuser:bob:rwx\ngroup::r--\nmask::rwx\nother::---\n\n~~~~\n\nApplying this method with the following parameters:\n\n* `path`: /tmp/myTestFile\n* `recursive`: false\n* `user`: bob\n* `ace`: -rw\n\nWill transform the previous ACLs in:\n\n~~~~\nroot@server# getfacl /tmp/myTestFile \ngetfacl: Removing leading '/' from absolute path names\n# file: tmp/myTestFile\n# owner: root\n# group: root\nuser::rwx\nuser:bob:--x\ngroup::r--\nmask::r-x\nother::---\n\n~~~~", 'parameter_rename': []}, {'bundle_name': 'registry_entry_absent', 'name': 'Registry entry absent', 'description': 'This generic method checks that a registry entry does not exists', 'class_prefix': 'registry_entry_absent', 'class_parameter': 'entry', 'agent_support': ['dsc'], 'parameter': [{'name': 'key', 'description': 'Registry key (ie, HKLM:\\Software\\Rudder)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'entry', 'description': 'Registry entry name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'parameter_rename': []}, {'bundle_name': 'registry_entry_present', 'name': 'Registry entry present', 'description': 'This generic method defines if a registry entry exists with the correct value', 'class_prefix': 'registry_entry_present', 'class_parameter': 'entry', 'agent_support': ['dsc'], 'parameter': [{'name': 'key', 'description': 'Registry key (ie, HKLM:\\Software\\Rudder)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'entry', 'description': 'Registry entry', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'value', 'description': 'Registry value', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'registryType', 'description': 'Registry value type (String, ExpandString, MultiString, Dword, Qword)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'parameter_rename': []}, {'bundle_name': 'registry_key_absent', 'name': 'Registry key absent', 'description': 'This generic method checks that a registry key does not exists', 'class_prefix': 'registry_key_absent', 'class_parameter': 'key', 'agent_support': ['dsc'], 'parameter': [{'name': 'key', 'description': 'Registry key (ie, HKLM:\\Software\\Rudder)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Remove a Registry Key if it is present on the system.\n\n There are two different supported syntaxes to describe a Registry Key:\n\n * with short drive name and ":" like HKLM:\\SOFTWARE\\myKey\n * with long drive name and without ":" like HKEY_LOCAL_MACHINE:\\SOFTWARE\\myKey\n\n Please, note that Rudder can not remove drives and "first-level" Registry Keys.', 'parameter_rename': []}, {'bundle_name': 'registry_key_present', 'name': 'Registry key present', 'description': 'This generic method checks that a Registry Key exists', 'class_prefix': 'registry_key_present', 'class_parameter': 'key', 'agent_support': ['dsc'], 'parameter': [{'name': 'key', 'description': 'Registry key (ie, HKLM:\\Software\\Rudder)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Create a Registry Key if it does not exist.\n There are two different supported syntaxes to describe a Registry Key:\n\n * with short drive name and ":" like HKLM:\\SOFTWARE\\myKey\n * with long drive name and without ":" like HKEY_LOCAL_MACHINE:\\SOFTWARE\\myKey\n\n Please, note that Rudder can not create new drive and new "first-level" Registry Keys.', 'parameter_rename': []}, {'bundle_name': 'report_if_condition', 'name': 'Report if condition', 'description': 'Report a Rudder report based on a condition.', 'class_prefix': 'report_if_condition', 'class_parameter': 'report_message', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'report_message', 'description': 'Message subject, will be extended based on the report status', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'condition', 'description': 'Condition to report a success', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This method will only send a Rudder report:\n\nIf the **condition** is met, it will report a compliant report, with the following message:\n`**<report_message>** was correct.`\n\nOtherwise, it will report an error, with the following message:\n`**report_message** was incorrect`\n\nThis method will never be in a repaired state.', 'parameter_rename': []}, {'bundle_name': 'schedule_simple', 'name': 'Schedule Simple', 'description': 'Trigger a repaired outcome when a job should be run', 'class_prefix': 'schedule_simple', 'class_parameter': 'job_id', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'job_id', 'description': 'A string to identify this job', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'agent_periodicity', 'description': 'Agent run interval (in minutes)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'max_execution_delay_minutes', 'description': 'On how many minutes you want to spread the job', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'max_execution_delay_hours', 'description': 'On how many hours you want to spread the job', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'start_on_minutes', 'description': 'At which minute should be the first run', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'start_on_hours', 'description': 'At which hour should be the first run', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'start_on_day_of_week', 'description': 'At which day of week should be the first run', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'periodicity_minutes', 'description': 'Desired job run interval (in minutes)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'periodicity_hours', 'description': 'Desired job run interval (in hours)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'periodicity_days', 'description': 'Desired job run interval (in days)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'mode', 'description': '"nodups": avoid duplicate runs in the same period / "catchup": avoid duplicates and one or more run have been missed, run once before next period / "stateless": no check is done on past runs', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This method compute the expected time for running the job, based on the parameters and splayed uing system ids, and define a conditions based on this computation:\n * `schedule_simple_${job_id}_kept` if the job should not be run now\n * `schedule_simple_${job_id}_repaired` if the job should be run\n * `schedule_simple_${job_id}_error` if their is an inconsistency in the method parameters\n\n#### Example\n\nIf you want to run a job, at every hour and half-hour (0:00 and 0:30),\nwith no spread across system, with an agent running with default schedule\nof 5 minutes, and making sure that the job is run (if the agent couldn\'t\nrun it, then at the next agent execution the job should be run), you will\ncall the method with the following parameters:\n\n```\nschedule_simple("job_schedule_id", "5", "0", "0", "0", "0", "0", "30", "0", "0", "catchup")\n``\n\nDuring each run right after o\'clock and half-hour, this method will define the condition\nschedule_simple_job_schedule_id_repaired, that you can use as a condition for a generic\nmethod `command_execution`', 'parameter_rename': []}, {'bundle_name': 'schedule_simple_catchup', 'name': 'Schedule Simple Catchup', 'description': 'Trigger a repaired outcome when a job should be run (avoid losing a job)', 'class_prefix': 'schedule_simple', 'class_parameter': 'job_id', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'job_id', 'description': 'A string to identify this job', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'agent_periodicity', 'description': 'Agent run interval (in minutes)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'max_execution_delay_minutes', 'description': 'On how many minutes you want to spread the job', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'max_execution_delay_hours', 'description': 'On how many hours you want to spread the job', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'start_on_minutes', 'description': 'At which minute should be the first run', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'start_on_hours', 'description': 'At which hour should be the first run', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'start_on_day_of_week', 'description': 'At which day of week should be the first run', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'periodicity_minutes', 'description': 'Desired job run interval (in minutes)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'periodicity_hours', 'description': 'Desired job run interval (in hours)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'periodicity_days', 'description': 'Desired job run interval (in days)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This bundle will define a condition `schedule_simple_${job_id}_{kept,repaired,not_ok,ok,reached}`\n * _ok or _kept for when there is nothing to do\n * _repaired if the job should run\n * _not_ok and _reached have their usual meaning\n If the agent run is skipped during the period, method tries to catchup the run on next agent run.\n If the agent run is skipped twice,, only one run is catched up.\n If the agent is run twice (for example from a manual run), the job is run only once.', 'parameter_rename': []}, {'bundle_name': 'schedule_simple_nodups', 'name': 'Schedule Simple Nodups', 'description': 'Trigger a repaired outcome when a job should be run (avoid running twice)', 'class_prefix': 'schedule_simple', 'class_parameter': 'job_id', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'job_id', 'description': 'A string to identify this job', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'agent_periodicity', 'description': 'Agent run interval (in minutes)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'max_execution_delay_minutes', 'description': 'On how many minutes you want to spread the job', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'max_execution_delay_hours', 'description': 'On how many hours you want to spread the job', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'start_on_minutes', 'description': 'At which minute should be the first run', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'start_on_hours', 'description': 'At which hour should be the first run', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'start_on_day_of_week', 'description': 'At which day of week should be the first run', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'periodicity_minutes', 'description': 'Desired job run interval (in minutes)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'periodicity_hours', 'description': 'Desired job run interval (in hours)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'periodicity_days', 'description': 'Desired job run interval (in days)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This bundle will define a condition `schedule_simple_${job_id}_{kept,repaired,not_ok,ok,reached}`\n * _ok or _kept for when there is nothing to do\n * _repaired if the job should run\n * _not_ok and _reached have their usual meaning\n If the agent is run twice (for example from a manual run), the jo is run only once.\n However if the agent run is skipped during the period, the job is never run.', 'parameter_rename': []}, {'bundle_name': 'schedule_simple_stateless', 'name': 'Schedule Simple Stateless', 'description': 'Trigger a repaired outcome when a job should be run (without checks)', 'class_prefix': 'schedule_simple', 'class_parameter': 'job_id', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'job_id', 'description': 'A string to identify this job', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'agent_periodicity', 'description': 'Agent run interval (in minutes)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'max_execution_delay_minutes', 'description': 'On how many minutes you want to spread the job', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'max_execution_delay_hours', 'description': 'On how many hours you want to spread the job', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'start_on_minutes', 'description': 'At which minute should be the first run', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'start_on_hours', 'description': 'At which hour should be the first run', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'start_on_day_of_week', 'description': 'At which day of week should be the first run', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'periodicity_minutes', 'description': 'Desired job run interval (in minutes)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'periodicity_hours', 'description': 'Desired job run interval (in hours)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'periodicity_days', 'description': 'Desired job run interval (in days)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This bundle will define a condition `schedule_simple_${job_id}_{kept,repaired,not_ok,ok,reached}`\n * _ok or _kept for when there is nothing to do\n * _repaired if the job should run\n * _not_ok and _reached have their usual meaning\n No effort is done to check if a run has already been done for this period or not.\n If the agent is run twice, the job will be run twice, and if the agent is not run, the job will no be run.', 'parameter_rename': []}, {'bundle_name': 'service_action', 'name': 'Service action', 'description': 'Trigger an action on a service using the appropriate tool', 'class_prefix': 'service_action', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Name of the service', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'action', 'description': 'Action to trigger on the service (start, stop, restart, reload, ...)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'The `service_*` methods manage the services running on the system.\n\n#### Parameters\n\n##### Service name\n\nThe name of the service is the name understood by the service manager, except for the\n`is-active-process` action, where it is the regex to match against the running processes list.\n\n##### Action\n\nThe action is the name of an action to run on the given service.\nThe following actions can be used:\n\n* `start`\n* `stop`\n* `restart`\n* `reload` (or `refresh`)\n* `is-active` (or `status`)\n* `is-active-process` (in this case, the "service" parameter is the regex to match againt process list)\n* `enable`\n* `disable`\n* `is-enabled`\n\nOther actions may also be used, depending on the selected service manager.\n\n#### Implementation\n\nThese methods will detect the method to use according to the platform. You can run the methods with an `info`\nverbosity level to see which service manager will be used for a given action.\n\nWARNING: Due to compatibility issues when mixing calls to systemctl and service/init.d,\nwhen an init script exists, we will not use systemctl compatibility layer but directly service/init.d.\n\nThe supported service managers are:\n\n* systemd (any unknown action will be passed directly)\n* upstart\n* smf (for Solaris)\n* service command (for non-boot actions, any unknown action will be passed directly)\n* /etc/init.d scripts (for non-boot actions, any unknown action will be passed directly)\n* SRC (for AIX) (for non-boot actions)\n* chkconfig (for boot actions)\n* update-rc.d (for boot actions)\n* chitab (for boot actions)\n* links in /etc/rcX.d (for boot actions)\n* Windows services\n\n#### Examples\n\n```\n# To restart the apache2 service\nservice_action("apache2", "restart");\nservice_restart("apache2");\n```', 'parameter_rename': [{'old': 'service_name', 'new': 'name'}]}, {'bundle_name': 'service_check_disabled_at_boot', 'name': 'Service check disabled at boot', 'description': 'Check if a service is set to not start at boot using the appropriate method', 'class_prefix': 'service_check_disabled_at_boot', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Service name (as recognized by systemd, init.d, etc...)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'parameter_rename': [{'old': 'service_name', 'new': 'name'}]}, {'bundle_name': 'service_check_running', 'name': 'Service check running', 'description': 'Check if a service is running using the appropriate method', 'class_prefix': 'service_check_running', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Process name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'parameter_rename': [{'old': 'service_name', 'new': 'name'}]}, {'bundle_name': 'service_check_running_ps', 'name': 'Service check running ps', 'description': 'Check if a service is running using ps', 'class_prefix': 'service_check_running', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Regular expression used to select a process in ps output', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'parameter_rename': [{'old': 'service_regex', 'new': 'name'}]}, {'bundle_name': 'service_check_started_at_boot', 'name': 'Service check started at boot', 'description': 'Check if a service is set to start at boot using the appropriate method', 'class_prefix': 'service_check_started_at_boot', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Service name (as recognized by systemd, init.d, etc...)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'parameter_rename': [{'old': 'service_name', 'new': 'name'}]}, {'bundle_name': 'service_disabled', 'name': 'Service disabled at boot', 'description': 'Force a service not to be enabled at boot', 'class_prefix': 'service_disabled', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Service name (as recognized by systemd, init.d, etc...)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'parameter_rename': [{'old': 'service_name', 'new': 'name'}]}, {'bundle_name': 'service_enabled', 'name': 'Service enabled at boot', 'description': 'Force a service to be started at boot', 'class_prefix': 'service_enabled', 'class_parameter': 'name', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Service name (as recognized by systemd, init.d, Windows, SRC, SMF, etc...)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'parameter_rename': [{'old': 'service_name', 'new': 'name'}]}, {'bundle_name': 'service_ensure_disabled_at_boot', 'name': 'Service ensure disabled at boot', 'description': 'Force a service not to be enabled at boot', 'class_prefix': 'service_ensure_disabled_at_boot', 'class_parameter': 'name', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Service name (as recognized by systemd, init.d, etc...)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'deprecated': 'Use [service_disabled_at_boot](#_service_disabled_at_boot) instead.', 'rename': 'service_disabled_at_boot', 'parameter_rename': [{'old': 'service_name', 'new': 'name'}]}, {'bundle_name': 'service_ensure_running', 'name': 'Service ensure running', 'description': 'Ensure that a service is running using the appropriate method', 'class_prefix': 'service_ensure_running', 'class_parameter': 'name', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Service name (as recognized by systemd, init.d, etc...)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'deprecated': 'Use [service_started](#_service_started) instead.', 'rename': 'service_started', 'parameter_rename': [{'old': 'service_name', 'new': 'name'}]}, {'bundle_name': 'service_ensure_running_path', 'name': 'Service ensure running with service path', 'description': 'Ensure that a service is running using the appropriate method, specifying the path of the service in the ps output, or using Windows task manager', 'class_prefix': 'service_ensure_running', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Service name (as recognized by systemd, init.d, Windows, etc...)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'path', 'description': "Service with its path, as in the output from 'ps'", 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'deprecated': 'Use [service_started_path](#_service_started_path) instead.', 'rename': 'service_started_path', 'parameter_rename': [{'old': 'service_name', 'new': 'name'}, {'old': 'service_path', 'new': 'path'}]}, {'bundle_name': 'service_ensure_started_at_boot', 'name': 'Service ensure started at boot', 'description': 'Force a service to be started at boot', 'class_prefix': 'service_ensure_started_at_boot', 'class_parameter': 'name', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Service name (as recognized by systemd, init.d, Windows, SRC, SMF, etc...)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'deprecated': 'Use [service_enabled](#_service_enabled) instead.', 'rename': 'service_enabled', 'parameter_rename': [{'old': 'service_name', 'new': 'name'}]}, {'bundle_name': 'service_ensure_stopped', 'name': 'Service ensure stopped', 'description': 'Ensure that a service is stopped using the appropriate method', 'class_prefix': 'service_ensure_stopped', 'class_parameter': 'name', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Service', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'deprecated': 'Use [service_stopped](#_service_stopped) instead.', 'rename': 'service_stopped', 'parameter_rename': [{'old': 'service_name', 'new': 'name'}]}, {'bundle_name': 'service_reload', 'name': 'Service reload', 'description': 'Reload a service using the appropriate method', 'class_prefix': 'service_reload', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Name of the service', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'See [service_action](#_service_action) for documentation.', 'parameter_rename': [{'old': 'service_name', 'new': 'name'}]}, {'bundle_name': 'service_restart', 'name': 'Service restart', 'description': 'Restart a service using the appropriate method', 'class_prefix': 'service_restart', 'class_parameter': 'name', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Name of the service', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'See [service_action](#_service_action) for documentation.', 'parameter_rename': [{'old': 'service_name', 'new': 'name'}]}, {'bundle_name': 'service_restart_if', 'name': 'Service restart at a condition', 'description': 'Restart a service using the appropriate method if the specified class is true, otherwise it is considered as not required and success classes are returned.', 'class_prefix': 'service_restart', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Name of the service', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'expression', 'description': 'Condition expression which will trigger the restart of Service "(package_service_installed|service_conf_changed)" by example', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'See [service_action](#_service_action) for documentation.', 'deprecated': 'Use [service_restart](#_service_restart) with a condition', 'parameter_rename': [{'old': 'service_name', 'new': 'name'}, {'old': 'trigger_class', 'new': 'expression'}]}, {'bundle_name': 'service_start', 'name': 'Service start', 'description': 'Start a service using the appropriate method', 'class_prefix': 'service_start', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Name of the service', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'See [service_action](#_service_action) for documentation.', 'deprecated': 'This is an action that should not be used in the general case.\nIf you really want to call the start method, use [service_action](#_service_action).\nOtherwise, simply call [service_started](#_service_started)', 'parameter_rename': [{'old': 'service_name', 'new': 'name'}]}, {'bundle_name': 'service_started', 'name': 'Service started', 'description': 'Ensure that a service is running using the appropriate method', 'class_prefix': 'service_started', 'class_parameter': 'name', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Service name (as recognized by systemd, init.d, etc...)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'parameter_rename': [{'old': 'service_name', 'new': 'name'}]}, {'bundle_name': 'service_started_path', 'name': 'Service started with service path', 'description': 'Ensure that a service is running using the appropriate method, specifying the path of the service in the ps output, or using Windows task manager', 'class_prefix': 'service_started', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Service name (as recognized by systemd, init.d, Windows, etc...)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'path', 'description': "Service with its path, as in the output from 'ps'", 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'parameter_rename': [{'old': 'service_name', 'new': 'name'}, {'old': 'service_path', 'new': 'path'}]}, {'bundle_name': 'service_status', 'name': 'Service status', 'description': 'This generic method defines if service should run or be stopped', 'class_prefix': 'service_status', 'class_parameter': 'service_name', 'agent_support': ['dsc'], 'parameter': [{'name': 'service_name', 'description': 'Service name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'status', 'description': "Desired state for the user - can be 'Stopped' or 'Running'", 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384, 'select': ['Stopped', 'Running']}, 'type': 'string'}], 'parameter_rename': []}, {'bundle_name': 'service_stop', 'name': 'Service stop', 'description': 'Stop a service using the appropriate method', 'class_prefix': 'service_stop', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Name of the service', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'See [service_action](#_service_action) for documentation.', 'deprecated': 'This is an action that should not be used in the general case.\nIf you really want to call the stop method, use [service_action](#_service_action).\nOtherwise, simply call [service_stopped](#_service_stopped)', 'parameter_rename': [{'old': 'service_name', 'new': 'name'}]}, {'bundle_name': 'service_stopped', 'name': 'Service stopped', 'description': 'Ensure that a service is stopped using the appropriate method', 'class_prefix': 'service_stopped', 'class_parameter': 'name', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Service', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'parameter_rename': [{'old': 'service_name', 'new': 'name'}]}, {'bundle_name': 'sharedfile_from_node', 'name': 'Sharedfile from node', 'description': 'This method retrieves a file shared from another Rudder node', 'class_prefix': 'sharedfile_from_node', 'class_parameter': 'file_id', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'remote_node', 'description': 'Which node to take the file from', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'file_id', 'description': 'Unique name that was used to identify the file on the sender', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384, 'regex': '^[A-z0-9._-]+$'}, 'type': 'string'}, {'name': 'file_path', 'description': 'Where to put the file content', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This method retrieves a file shared from a Rudder node using a unique file identifier.\n\nThe file will be downloaded using native agent protocol and copied into a new file.\nThe destination path must be the complete absolute path of the destination file.\n\nSee [sharedfile_to_node](#_sharedfile_to_node) for a complete example.', 'parameter_rename': [{'old': 'source_uuid', 'new': 'remote_node'}]}, {'bundle_name': 'sharedfile_to_node', 'name': 'Sharedfile to node', 'description': 'This method shares a file with another Rudder node', 'class_prefix': 'sharedfile_to_node', 'class_parameter': 'file_id', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'remote_node', 'description': 'Which node to share the file with', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'file_id', 'description': 'Unique name that will be used to identify the file on the receiver', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384, 'regex': '^[A-z0-9._-]+$'}, 'type': 'string'}, {'name': 'file_path', 'description': 'Path of the file to share', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'ttl', 'description': 'Time to keep the file on the policy server in seconds or in human readable form (see long description)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384, 'regex': '^(\\d+\\s*(days?|d))?(\\d+\\s*(hours?|h))?(\\d+\\s*(minutes?|m))?(\\d+\\s*(seconds?|s))?$'}, 'type': 'string'}], 'documentation': 'This method shares a file with another Rudder node using a unique file identifier.\n\nRead the Rudder documentation for a [high level overview of file sharing between nodes](https://docs.rudder.io/reference/current/usage/advanced_configuration_management.html#_share_files_between_nodes).\n\nThe file will be kept on the policy server and transmitted to the destination node\'s policy server if it is different.\nIt will be kept on this server for the destination node to download as long as it is not replaced by a new\nfile with the same id or remove by expiration of the TTL.\n\n#### Parameters\n\nThis section describes the generic method parameters.\n\n#### remote_node\n\nThe node you want to share this file with. The uuid of a node\nis visible in the Nodes details (in the Web interface) or by entering\n`rudder agent info` on the target node.\n\n##### file_id\n\nThis is a name that will be used to identify the file in the target node. It should be unique\nand describe the file content.\n\n##### file_path\n\nThe local absolute path of the file to share.\n\n##### ttl\n\nThe TTL can be:\n\n* A simple integer, in this case it is assumed to be a number of *seconds*\n* A string including units indications, the possible units are:\n\n* *days*, *day* or *d*\n* *hours*, *hour*, or *h*\n* *minutes*, *minute*, or *m*\n* *seconds*, *second* or *s*\n\nThe ttl value can look like *1day 2hours 3minutes 4seconds* or can be abbreviated in the form *1d 2h 3m 4s*, or without spaces *1d2h3m4s* or any combination like *1day2h 3minute 4seconds*\nAny unit can be skipped, but the decreasing order needs to be respected.\n\n##### file_id\n\nThis is a name that will be used to identify the file once stored on the server. It should be unique\nand describe the file content.\n\n#### Example:\n\nWe have a node *A*, with uuid `2bf1afdc-6725-4d3d-96b8-9128d09d353c` which wants to share\nthe `/srv/db/application.properties` with node *B* with uuid `73570beb-2d4a-43d2-8ffc-f84a6817849c`.\n\nWe want this file to stay available for one year for node *B* on its policy server.\n\nThe node *B* wants to download it into `/opt/application/etc/application.properties`.\n\nThey have to agree (i.e. it has to be defined in the policies of both nodes) on the id of the file,\nthat will be used during the exchange, here it will be `application.properties`.\n\nTo share the file, node *A* will use:\n\n```\nsharedfile_to_node("73570beb-2d4a-43d2-8ffc-f84a6817849c", "application.properties", "/srv/db/application.properties", "356 days")\n```\n\nTo download the file, node *B* will use [sharedfile_from_node](#_sharedfile_from_node) with:\n\n```\nsharedfile_from_node("2bf1afdc-6725-4d3d-96b8-9128d09d353c", "application.properties", "/opt/application/etc/application.properties")\n```', 'parameter_rename': [{'old': 'target_uuid', 'new': 'remote_node'}]}, {'bundle_name': 'sysctl_value', 'name': 'Sysctl value', 'description': 'Enforce a value in sysctl (optionally increase or decrease it)', 'class_prefix': 'sysctl_value', 'class_parameter': 'key', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'key', 'description': 'The key to enforce', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'value', 'description': 'The desired value', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'filename', 'description': 'File name where to put the value in /etc/sysctl.d (without the .conf extension)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'option', 'description': 'Optional modifier on value: Min, Max or Default (default value)', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Enforce a value in sysctl\n\n#### Behaviors\n\nChecks for the current value defined for the given key\nIf it is not set, this method attempts to set it in the file defined as argument\nIf it is set, and corresponds to the desired value, it will success\nIf it is set, and does not correspond, the value will be set in the file defined, sysctl \nconfiguration is reloaded with `sysctl --system` and the \nresulting value is checked. \nIf it is not taken into account by sysctl because\nits overridden in another file or its an invalid key, the method returns an error\n\n#### Prerequisite\n\nThis method requires an /etc/sysctl.d folder, and the `sysctl --system` option.\nIt does not support Debian 6 or earlier, CentOS/RHEL 6 or earlier, SLES 11 or earlier,\nUbuntu 12_04 or earlier, AIX and Solaris.\n\n##### Parameters\n\n`key` : the key to enforce/check\n`value` : the expected value for the key\n`filename` : filename (without extension) containing the key=value when need to be set, within /etc/sysctl.d.\n This method adds the correct extension at the end of the filename\nOptional parameter:\n `min`: The value is the minimal value we request. the value is only changed if the current value is lower than `value`\n `max`: The value is the maximal value we request: the value is only changed if the current value is higher than `value`\n `default` (default value): The value is strictly enforced.\n\nComparison is numerical if possible, else alphanumerical\nSo 10 > 2, but Test10 < Test2\n\n#### Examples\n\nTo ensure that swappiness is disabled, and storing the configuration parameter in 99_rudder.conf\n\n```\n sysctl_value("vm.swappiness", "99_rudder", "0", "")\n```\n\nTo ensure that the UDP buffer is at least 26214400\n\n```\n sysctl_value("net.core.rmem_max", "99_rudder", "26214400", "min")\n```', 'parameter_rename': []}, {'bundle_name': 'user_absent', 'name': 'User absent', 'description': 'Remove a user', 'class_prefix': 'user_absent', 'class_parameter': 'login', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'login', 'description': 'User login', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This method ensures that a user does not exist on the system.', 'parameter_rename': []}, {'bundle_name': 'user_create', 'name': 'User create', 'description': 'Create a user', 'class_prefix': 'user_create', 'class_parameter': 'login', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'login', 'description': 'User login', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'description', 'description': 'User description', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'home', 'description': "User's home directory", 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'group', 'description': "User's primary group", 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'shell', 'description': "User's shell", 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'locked', 'description': 'Is the user locked ? true or false', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': "This method does not create the user's home directory.", 'deprecated': 'Please split into calls to other user_* methods:\n[user_present](#_user_present) [user_fullname](#_user_fullname) [user_home](#_user_home)\n[user_primary_group](#_user_primary_group) [user_shell](#_user_shell) and [user_locked](#_user_locked)', 'parameter_rename': []}, {'bundle_name': 'user_fullname', 'name': 'User fullname', 'description': 'Define the fullname of the user, user must already exists.', 'class_prefix': 'user_fullname', 'class_parameter': 'login', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'login', 'description': "User's login", 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'fullname', 'description': "User's fullname", 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This method does not create the user.', 'parameter_rename': []}, {'bundle_name': 'user_group', 'name': 'User group', 'description': 'Define secondary group for a user', 'class_prefix': 'user_group', 'class_parameter': 'login', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'login', 'description': 'User login', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'group_name', 'description': 'Secondary group name for the user', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Ensure that a user is within a group\n\n#### Behavior\n\nEnsure that the user belongs in the given secondary group (non-exclusive)\n\n##### Parameters\n\n`login` : the user login\n`group_name`: secondary group name the user should belong to (non-exclusive)\n\n#### Examples\n\nTo ensure that user `test` belongs in group `dev`\n\n```\n user_group("test", "dev")\n```\nNote that it will make sure that user test is in group dev, but won\'t remove it\nfrom other groups it may belong to', 'parameter_rename': [{'old': 'user', 'new': 'login'}]}, {'bundle_name': 'user_home', 'name': 'User home', 'description': 'Define the home of the user. User must already exists.', 'class_prefix': 'user_home', 'class_parameter': 'login', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'login', 'description': "User's login", 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'home', 'description': "User's home", 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This method does not create the user, nor the home directory.\n entry example: /home/myuser\n The home given will be set, but not created.', 'parameter_rename': []}, {'bundle_name': 'user_locked', 'name': 'User locked', 'description': 'Ensure the user is locked. User must already exist.', 'class_prefix': 'user_locked', 'class_parameter': 'login', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'login', 'description': "User's login", 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This method does not create the user. Note that locked accounts will\n be marked with "!" in /etc/shadow, which is equivalent to "*".\n To unlock a user, apply a user_password method.', 'parameter_rename': []}, {'bundle_name': 'user_password_clear', 'name': 'User password clear', 'description': "Ensure a user's password.\n as used in the UNIX /etc/shadow file.", 'class_prefix': 'user_password_clear', 'class_parameter': 'login', 'agent_support': ['dsc'], 'parameter': [{'name': 'login', 'description': 'User login', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'password', 'description': 'User clear password', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'User must exists, password will appear in clear text in code.\n An empty password will lead to an error and be notified.', 'parameter_rename': []}, {'bundle_name': 'user_password_hash', 'name': 'User password hash', 'description': "Ensure a user's password. Password must respect `$id$salt$hashed` format\n as used in the UNIX /etc/shadow file.", 'class_prefix': 'user_password_hash', 'class_parameter': 'login', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'login', 'description': 'User login', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'password', 'description': 'User hashed password', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'User must exists, password must be pre-hashed. Does not handle\n empty password accounts. See UNIX /etc/shadow format.\n entry example: `$1$jp5rCMS4$mhvf4utonDubW5M00z0Ow0`\n \n An empty password will lead to an error and be notified.', 'parameter_rename': []}, {'bundle_name': 'user_present', 'name': 'User present', 'description': 'Ensure a user exists on the system.', 'class_prefix': 'user_present', 'class_parameter': 'login', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'login', 'description': 'User login', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': "This method does not create the user's home directory.\n Primary group will be created and set with default one, following the useradd default behavior.\n As in most UNIX system default behavior user creation will fail if a group with\n the user name already exists.", 'parameter_rename': []}, {'bundle_name': 'user_primary_group', 'name': 'User primary group', 'description': 'Define the primary group of the user. User must already exist.', 'class_prefix': 'user_primary_group', 'class_parameter': 'login', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'login', 'description': "User's login", 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'primary_group', 'description': "User's primary group", 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This method does not create the user.', 'parameter_rename': []}, {'bundle_name': 'user_shell', 'name': 'User shell', 'description': 'Define the shell of the user. User must already exist.', 'class_prefix': 'user_shell', 'class_parameter': 'login', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'login', 'description': "User's login", 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'shell', 'description': "User's shell", 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This method does not create the user.\n entry example: /bin/false', 'parameter_rename': []}, {'bundle_name': 'user_status', 'name': 'User status', 'description': 'This generic method defines if user is present or absent', 'class_prefix': 'user_status', 'class_parameter': 'user', 'agent_support': ['dsc'], 'parameter': [{'name': 'user', 'description': 'User name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'status', 'description': "Desired state for the user - can be 'Present' or 'Absent'", 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384, 'select': ['Present', 'Absent']}, 'type': 'string'}], 'parameter_rename': []}, {'bundle_name': 'user_uid', 'name': 'User uid', 'description': 'Define the uid of the user. User must already exists, uid must be non-allowed(unique).', 'class_prefix': 'user_uid', 'class_parameter': 'login', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'login', 'description': "User's login", 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'uid', 'description': "User's uid", 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'This method does not create the user.', 'parameter_rename': []}, {'bundle_name': 'variable_dict', 'name': 'Variable dict', 'description': 'Define a variable that contains key,value pairs (a dictionary)', 'class_prefix': 'variable_dict', 'class_parameter': 'name', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'prefix', 'description': 'The prefix of the variable name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'name', 'description': 'The variable to define, the full name will be prefix.name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'value', 'description': 'The variable content in JSON format', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'To use the generated variable, you must use the form `${prefix.name[key]}` with each name replaced with the parameters of this method.\n\nBe careful that using a global variable can lead to unpredictable content in case of multiple definition, which is implicitly the case when a technique has more than one instance (directive). \nPlease note that only global variables are available within templates.', 'parameter_rename': [{'old': 'variable_prefix', 'new': 'prefix'}, {'old': 'variable_name', 'new': 'name'}]}, {'bundle_name': 'variable_dict_from_file', 'name': 'Variable dict from JSON file', 'description': 'Define a variable that contains key,value pairs (a dictionary) from a JSON file', 'class_prefix': 'variable_dict_from_file', 'class_parameter': 'name', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'prefix', 'description': 'The prefix of the variable name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'name', 'description': 'The variable to define, the full name will be prefix.name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'file_name', 'description': 'The absolute local file name with JSON content', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'To use the generated variable, you must use the form `${prefix.name[key]}` with each name replaced with the parameters of this method.\n\nBe careful that using a global variable can lead to unpredictable content in case of multiple definition, which is implicitly the case when a technique has more than one instance (directive). \nPlease note that only global variables are available within templates.\n\nSee [variable_dict_from_file_type](#_variable_dict_from_file_type) for complete documentation.', 'parameter_rename': [{'old': 'variable_prefix', 'new': 'prefix'}, {'old': 'variable_name', 'new': 'name'}]}, {'bundle_name': 'variable_dict_from_file_type', 'name': 'Variable dict from file type', 'description': 'Define a variable that contains key,value pairs (a dictionary) from a JSON, CSV or YAML file', 'class_prefix': 'variable_dict_from_file_type', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'prefix', 'description': 'The prefix of the variable name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'name', 'description': 'The variable to define, the full name will be prefix.name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'file_name', 'description': 'The file name to load data from', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'file_type', 'description': 'The file type, can be "JSON", "CSV", "YAML" or "auto" for auto detection based on file extension, with a fallback to JSON (default is "auto")', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384, 'select': ['', 'auto', 'JSON', 'YAML', 'CSV']}, 'type': 'string'}], 'documentation': 'To use the generated variable, you must use the form `${prefix.name[key]}` with each name replaced with the parameters of this method.\n\nBe careful that using a global variable can lead to unpredictable content in case of multiple definition, which is implicitly the case when a technique has more than one instance (directive). \n\nThis method will load data from various file formats (yaml, json, csv). \n\n#### CSV parsing\n\nThe input file must use CRLF as line delimiter\nto be readable (as stated in RFC 4180).\n\n#### Examples\n\n```\n# To read a json file with format auto detection \nvariable_dict_from_file_type("prefix", "var", "/tmp/file.json", "");\n# To force yaml reading on a non file without yaml extension\nvariable_dict_from_file_type("prefix", "var", "/tmp/file", "YAML");\n```\n\nIf `/tmp/file.json` contains:\n\n```json\n{\n "key1": "value1"\n}\n```\n\nYou will be able to access the `value1` value with `${prefix.var[key1]}`.', 'parameter_rename': [{'old': 'variable_prefix', 'new': 'prefix'}, {'old': 'variable_name', 'new': 'name'}]}, {'bundle_name': 'variable_dict_from_osquery', 'name': 'Variable dict from osquery', 'description': 'Define a variable that contains key,value pairs (a dictionary) from an osquery query', 'class_prefix': 'variable_dict_from_osquery', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'prefix', 'description': 'The prefix of the variable name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'name', 'description': 'The variable to define, the full name will be prefix.name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'query', 'description': 'The query to execute (ending with a semicolon)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'To use the generated variable, you must use the form `${prefix.name[key]}` with each name replaced with the parameters of this method.\n\nBe careful that using a global variable can lead to unpredictable content in case of multiple definition, which is implicitly the case when a technique has more than one instance (directive). \nPlease note that only global variables are available within templates.\n\nThis method will define a dict variable from the output of an osquery query.\nThe query will be executed at every agent run, and its result will be usable as a standard\ndict variable.\n\n#### Setup\n\nThis method requires the presence of [osquery](https://osquery.io/) on the target nodes.\nIt won\'t install it automatically. Check the correct way of doing so for your OS.\n\n#### Building queries\n\nTo learn about the possible queries, read the [osquery schema](https://osquery.io/schema/) for your\nosquery version.\n\nYou can test the queries before using them with the `osqueryi` command, see the example below.\n\n#### Examples\n\n```\n# To get the number of cpus on the machine\nvariable_dict_from_osquery("prefix", "var1", "select cpu_logical_cores from system_info;");\n```\n\nIt will produce the dict from the output of:\n\n```\nosqueryi --json "select cpu_logical_cores from system_info;"\n```\n\nHence something like:\n\n```json\n[\n {"cpu_logical_cores":"8"}\n]\n```\n\nTo access this value, use the `${prefix.var1[0][cpu_logical_cores]}` syntax.', 'parameter_rename': [{'old': 'variable_prefix', 'new': 'prefix'}, {'old': 'variable_name', 'new': 'name'}]}, {'bundle_name': 'variable_dict_merge', 'name': 'Variable dict merge', 'description': 'Define a variable resulting of the merge of two other variables', 'class_prefix': 'variable_dict_merge', 'class_parameter': 'name', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'prefix', 'description': 'The prefix of the variable name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'name', 'description': 'The variable to define, the full name will be prefix.name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'first_variable', 'description': 'The first variable, which content will be overridden in the resulting variable if necessary (written in the form prefix.name)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'second_variable', 'description': 'The second variable, which content will override the first in the resulting variable if necessary (written in the form prefix.name)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'To use the generated variable, you must use the form `${prefix.name[key]}` with each name replaced with the parameters of this method.\n\nThe resulting variable will be the merge of the two parameters, which means it is built by:\n\n* Taking the content of the first variable\n* Adding the content of the second variable, and replacing the keys that were already there\n\nIt is only a one-level merge, and the value of the first-level key will be completely replaced by the merge.\n\nThis method will fail if one of the variables is not defined. See [variable_dict_merge_tolerant](#_variable_dict_merge_tolerant)\nif you want to allow one of the variables not to be defined.\n\n### Usage\n\nIf you have a `prefix.variable1` variable defined by:\n\n```json\n{ "key1": "value1", "key2": "value2", "key3": { "keyx": "valuex" } }\n```\n\nAnd a `prefix.variable2` variable defined by:\n\n```json\n{ "key1": "different", "key3": "value3", "key4": "value4" }\n```\n\nAnd that you use:\n\n```\nvariablr_dict_merge("prefix", "variable3, "prefix.variable1", "prefix.variable2")\n```\n\nYou will get a `prefix.variable3` variable containing:\n\n```json\n{\n "key1": "different",\n "key2": "value2",\n "key3": "value3",\n "key4": "value4"\n}\n```', 'parameter_rename': [{'old': 'variable_prefix', 'new': 'prefix'}, {'old': 'variable_name', 'new': 'name'}]}, {'bundle_name': 'variable_dict_merge_tolerant', 'name': 'Variable dict merge tolerant', 'description': 'Define a variable resulting of the merge of two other variables, allowing merging undefined variables', 'class_prefix': 'variable_dict_merge_tolerant', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'prefix', 'description': 'The prefix of the variable name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'name', 'description': 'The variable to define, the full name will be prefix.name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'first_variable', 'description': 'The first variable, which content will be overridden in the resulting variable if necessary (written in the form prefix.name)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'second_variable', 'description': 'The second variable, which content will override the first in the resulting variable if necessary (written in the form prefix.name)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'To use the generated variable, you must use the form `${prefix.name[key]}` with each name replaced with the parameters of this method.\n\nSee [variable_dict_merge](#_variable_dict_merge) for usage documentation. The only difference is that this method\nwill not fail if one of the variables do not exist, and will return the other one. If both are undefined, the method will still fail.', 'parameter_rename': [{'old': 'variable_prefix', 'new': 'prefix'}, {'old': 'variable_name', 'new': 'name'}]}, {'bundle_name': 'variable_iterator', 'name': 'Variable iterator', 'description': 'Define a variable that will be automatically iterated over', 'class_prefix': 'variable_iterator', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'prefix', 'description': 'The prefix of the variable name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'name', 'description': 'The variable to define, the full name will be prefix.name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'value', 'description': 'The variable content', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'separator', 'description': 'Regular expression that is used to split the value into items ( usually: , )', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': True, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'The generated variable is a special variable that is automatically\niterated over. When you call a generic method with this variable as a parameter, n calls will be made,\none for each items of the variable.\nNote: there is a limit of 10000 items \n\nTo use the generated variable, you must use the form `${prefix.name}` with each name replaced with the parameters of this method.\n\nBe careful that using a global variable can lead to unpredictable content in case of multiple definition, which is implicitly the case when a technique has more than one instance (directive). \nPlease note that only global variables are available within templates.', 'parameter_rename': [{'old': 'variable_prefix', 'new': 'prefix'}, {'old': 'variable_name', 'new': 'name'}]}, {'bundle_name': 'variable_iterator_from_file', 'name': 'Variable iterator from file', 'description': 'Define a variable that will be automatically iterated over', 'class_prefix': 'variable_iterator_from_file', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'prefix', 'description': 'The prefix of the variable name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'name', 'description': 'The variable to define, the full name will be prefix.name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'file_name', 'description': 'The path to the file', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'separator_regex', 'description': 'Regular expression that is used to split the value into items ( usually: \\n )', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'comments_regex', 'description': 'Regular expression that is used to remove comments ( usually: \\s*#.*?(?=\\n) )', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'The generated variable is a special variable that is automatically\niterated over. When you call a generic method with this variable as a parameter, n calls will be made,\none for each items of the variable.\nNote: there is a limit of 10000 items\nNote: empty items are ignored\n\nTo use the generated variable, you must use the form `${prefix.name}` with each name replaced with the parameters of this method.\n\nBe careful that using a global variable can lead to unpredictable content in case of multiple definition, which is implicitly the case when a technique has more than one instance (directive). \nPlease note that only global variables are available within templates.', 'parameter_rename': [{'old': 'variable_prefix', 'new': 'prefix'}, {'old': 'variable_name', 'new': 'name'}]}, {'bundle_name': 'variable_string', 'name': 'Variable string', 'description': 'Define a variable from a string parameter', 'class_prefix': 'variable_string', 'class_parameter': 'name', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'prefix', 'description': 'The prefix of the variable name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'name', 'description': 'The variable to define, the full name will be prefix.name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'value', 'description': 'The variable content', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'To use the generated variable, you must use the form `${prefix.name}` with each name replaced with the parameters of this method.\n\nBe careful that using a global variable can lead to unpredictable content in case of multiple definition, which is implicitly the case when a technique has more than one instance (directive). \nPlease note that only global variables are available within templates.', 'parameter_rename': [{'old': 'variable_prefix', 'new': 'prefix'}, {'old': 'variable_name', 'new': 'name'}]}, {'bundle_name': 'variable_string_default', 'name': 'Variable string with default', 'description': 'Define a variable from another variable name, with a default value if undefined', 'class_prefix': 'variable_string_default', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'prefix', 'description': 'The prefix of the variable name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'name', 'description': 'The variable to define, the full name will be prefix.name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'source_variable', 'description': 'The source variable name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'default_value', 'description': 'The default value to use if source_variable is not defined', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'To use the generated variable, you must use the form `${prefix.name}` with each name replaced with the parameters of this method.\n\nBe careful that using a global variable can lead to unpredictable content in case of multiple definition, which is implicitly the case when a technique has more than one instance (directive). \nPlease note that only global variables are available within templates.', 'parameter_rename': [{'old': 'variable_prefix', 'new': 'prefix'}, {'old': 'variable_name', 'new': 'name'}]}, {'bundle_name': 'variable_string_escaped', 'name': 'Variable string escaped', 'description': 'Define a variable from another string variable and escape regular expression characters in it.', 'class_prefix': 'variable_string_escaped', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'The variable to define, the full name will be prefix.name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'To use the generated variable, you must use the form `${<name>_escaped}` where <name> is the composed complete name\nof the variable you want to escape.\n\nPlease note that the variable you want to escape must be defined before this method evaluation.\n\n#### Example:\n\nWith a variable defined by the generic method `variable_string`, named `my_prefix.my_variable` and valued to:\n\n````\n something like [] that\n````\n\nPassing `my_prefix.my_variable` as `name` parameter to this method will result in a\nvariable named `my_prefix.my_variable_escaped` and valued to:\n\n````\nsomething\\ like\\ \\[\\]\\ that\n````', 'parameter_rename': [{'old': 'variable_name', 'new': 'name'}]}, {'bundle_name': 'variable_string_from_augeas', 'name': 'Variable string from Augeas', 'description': "Use Augeas binaries to call Augtool commands and options to get a node label's value.", 'class_prefix': 'variable_string_from_augeas', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'prefix', 'description': 'The prefix of the variable name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'name', 'description': 'The variable to define, the full name will be prefix.name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'path', 'description': 'The path to the file and node label', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'lens', 'description': 'The lens specified by the user in case he wants to load a specified lens associated with its file', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'file', 'description': 'The absolute path to the file specified by the user in case he wants to load a specified file associated with its lens', 'constraints': {'allow_empty_string': True, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Augeas is a tool that provides an abstraction layer for all the complexities that turn around editing files with regular expressions.\nIt\'s a tree based hierarchy tool, that handle system configuration files where you can securely modify your files. To do so you have to provide\nthe path to the node label\'s value.\n\nThis method aims to use `augtool` to extract a specific information from a configuration file into a rudder variable.\nIf Augeas is not installed on the agent, or if it fails to execute, it will produces an error.\n\n* **variable prefix**: target variable prefix\n* **variable name**: target variable name\n* **path**: augeas node path, use to describe the location of the target information we want to extract\n* **lens**: augeas lens to use, optional\n* **file**: absolute file path to target, optional\n\nActually there are two ways you can use this method:\n\n* Either by providing the augeas **path** to the node\'s label and let **lens** and **file** empty.\n** this way augeas will load the common files and lens automatically\n* Or by using a given **file** path and a specific **lens**.\n** better performances since only one lens is loaded\n** support custom lens, support custom paths\n\nThis mechanism is the same as in the `file_augeas_set` method.\n\n#### With autoload\n\nLet\'s consider that you want to obtain the value of the ip address of the first line in the `/etc/hosts`:\n\n(Note that the `label` and `value` parameters mentioned are naming examples of **variable prefix** and **variable name**, the augeas\n**path** `/etc/hosts/1/ipaddr`\nrepresents the `ipaddr` node label\'s value (in the augeas mean) in the first line of the file `/etc/hosts`).\n\n```\nvariable_string_from_augeas("label","value","/etc/hosts/1/ipaddr", "", "");\n```\n\n#### Without autoload\n\nHere we want the same information as in the first example, but we will force the lens to avoid loading unnecessary files.\n\n```\nvariable_string_from_augeas("label","value","/etc/hosts/1/ipaddr","Hosts","/etc/hosts");\n```\n\n#### Difference with `file augeas command`\n\nThis method is very similar to the `file augeas command` one, both execute an `augtool` command an dump its output in a rudder variable.\nBut their goal is really different:\n\n* This one will parse the output of the augeas `print` that we want to make it directly usable, but will be less flexible in its input.\n* The `file augeas command` offers much more possibilities to execute an augeas command to modify a file, but the output will be unparsed and most likely\n unusable as a rudder variable, expect to dump an error or configuration somewhere.', 'parameter_rename': [{'old': 'variable_prefix', 'new': 'prefix'}, {'old': 'variable_name', 'new': 'name'}]}, {'bundle_name': 'variable_string_from_command', 'name': 'Variable string from command', 'description': 'Define a variable from a command output', 'class_prefix': 'variable_string_from_command', 'class_parameter': 'name', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'prefix', 'description': 'The prefix of the variable name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'name', 'description': 'The variable to define, the full name will be prefix.name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'command', 'description': 'The command to execute', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Define a variable from a command output.\nThe method will execute a shell command and define a variable `${prefix.name}` from it.\n\n* Only `stdout` is kept\n* The variable will only be defined if the exit code of the command is 0\n* If the variable definition is successful, the method will report a success, it will\nreport an error otherwise.\n* The command will be executed even in *Audit mode*', 'parameter_rename': [{'old': 'variable_prefix', 'new': 'prefix'}, {'old': 'variable_name', 'new': 'name'}]}, {'bundle_name': 'variable_string_from_file', 'name': 'Variable string from file', 'description': 'Define a variable from a file content', 'class_prefix': 'variable_string_from_file', 'class_parameter': 'name', 'agent_support': ['dsc', 'cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'prefix', 'description': 'The prefix of the variable name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'name', 'description': 'The variable to define, the full name will be variable_prefix.variable_name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'file_name', 'description': 'The path of the file', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'To use the generated variable, you must use the form `${variable_prefix.variable_name}` with each name replaced with the parameters of this method.\n\nBe careful that using a global variable can lead to unpredictable content in case of multiple definition, which is implicitly the case when a technique has more than one instance (directive). \nPlease note that only global variables are available within templates.', 'parameter_rename': [{'old': 'variable_prefix', 'new': 'prefix'}, {'old': 'variable_name', 'new': 'name'}]}, {'bundle_name': 'variable_string_from_math_expression', 'name': 'Variable string from math expression', 'description': 'Define a variable from a mathematical expression', 'class_prefix': 'variable_string_from_math_expression', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'prefix', 'description': 'The prefix of the variable name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'name', 'description': 'The variable to define, the full name will be prefix.name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'expression', 'description': 'The mathematical expression to evaluate', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'format', 'description': 'The format string to use', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'To use the generated variable, you must use the form `${prefix.name}` with each name replaced with the parameters of this method.\n\nBe careful that using a global variable can lead to unpredictable content in case of multiple definition, which is implicitly the case when a technique has more than one instance (directive). \nPlease note that only global variables are available within templates.\n\n#### Usage\n\nThis function will evaluate a mathematical expression that may contain variables and format the result according to the provided format string.\n\nThe formatting string uses the standard POSIX printf format.\n\n#### Supported mathematical expressions\n\nAll the mathematical computations are done using floats.\n\nThe supported infix mathematical syntax, in order of precedence, is:\n\n- `(` and `)` parentheses for grouping expressions\n- `^` operator for exponentiation\n- `*` and `/` operators for multiplication and division\n- `%` operators for modulo operation\n- `+` and `-` operators for addition and subtraction\n- `==` "close enough" operator to tell if two expressions evaluate to the same number, with a tiny margin to tolerate floating point errors. It returns 1 or 0.\n- `>=` "greater or close enough" operator with a tiny margin to tolerate floating point errors. It returns 1 or 0.\n- `>` "greater than" operator. It returns 1 or 0.\n- `<=` "less than or close enough" operator with a tiny margin to tolerate floating point errors. It returns 1 or 0.\n- `<` "less than" operator. It returns 1 or 0.\n\nThe numbers can be in any format acceptable to the C `scanf` function with the `%lf` format specifier, followed by the `k`, `m`, `g`, `t`, or `p` SI units. So e.g. `-100` and `2.34m` are valid numbers.\n\nIn addition, the following constants are recognized:\n\n- `e`: 2.7182818284590452354\n- `log2e`: 1.4426950408889634074\n- `log10e`: 0.43429448190325182765\n- `ln2`: 0.69314718055994530942\n- `ln10`: 2.30258509299404568402\n- `pi`: 3.14159265358979323846\n- `pi_2`: 1.57079632679489661923 (pi over 2)\n- `pi_4`: 0.78539816339744830962 (pi over 4)\n- `1_pi`: 0.31830988618379067154 (1 over pi)\n- `2_pi`: 0.63661977236758134308 (2 over pi)\n- `2_sqrtpi`: 1.12837916709551257390 (2 over square root of pi)\n- `sqrt2`: 1.41421356237309504880 (square root of 2)\n- `sqrt1_2`: 0.70710678118654752440 (square root of 1/2)\n\nThe following functions can be used, with parentheses:\n\n- `ceil` and `floor`: the next highest or the previous highest integer\n- `log10`, `log2`, `log`\n- `sqrt`\n- `sin`, `cos`, `tan`, `asin`, `acos`, `atan`\n- `abs`: absolute value\n- `step`: 0 if the argument is negative, 1 otherwise\n\n#### Formatting options\n\nThe format field supports the following specifiers:\n\n* `%d` for decimal integer\n* `%x` for hexadecimal integer\n* `%o` for octal integer\n* `%f` for decimal floating point\n\nYou can use usual flags, width and precision syntax.\n\n#### Examples\n\nIf you use:\n\n```\nvariable_string("prefix", "var", "10");\nvariable_string_from_math_expression("prefix", "sum", "2.0+3.0", "%d");\nvariable_string_from_math_expression("prefix", "product", "3*${prefix.var}", "%d");\n```\n\nThe `prefix.sum` string variable will contain `5` and `prefix.product` will contain `30`.', 'parameter_rename': [{'old': 'variable_prefix', 'new': 'prefix'}, {'old': 'variable_name', 'new': 'name'}]}, {'bundle_name': 'variable_string_match', 'name': 'Variable string match', 'description': 'Test the content of a string variable', 'class_prefix': 'variable_string_match', 'class_parameter': 'name', 'agent_support': ['cfengine-community', 'cfengine-community'], 'parameter': [{'name': 'name', 'description': 'Complete name of the variable being tested, like my_prefix.my_variable', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'expected_match', 'description': 'Regex to use to test if the variable content is compliant', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Test a variable content and report a success if it matched, or an error if it does not or if the variable could not be found.\n Regex must respect PCRE format.\n Please note that this method is designed to only audit a variable state. If you want to use conditions resulting from this generic method,\n is it recommended to use instead condition_from_variable_match which is designed for it.', 'parameter_rename': [{'old': 'variable_name', 'new': 'name'}]}, {'bundle_name': 'windows_component_absent', 'name': 'Windows component absent', 'description': 'Ensure that a specific windows component is absent from the system.', 'class_prefix': 'windows_component_absent', 'class_parameter': 'component', 'agent_support': ['dsc'], 'parameter': [{'name': 'component', 'description': 'Windows component name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Ensure that a specific windows component is absent from the system.', 'parameter_rename': []}, {'bundle_name': 'windows_component_present', 'name': 'Windows component present', 'description': 'Ensure that a specific windows component is present on the system.', 'class_prefix': 'windows_component_present', 'class_parameter': 'component', 'agent_support': ['dsc'], 'parameter': [{'name': 'component', 'description': 'Windows component name', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Ensure that a specific windows component is present on the system.', 'parameter_rename': []}, {'bundle_name': 'windows_hotfix_absent', 'name': 'Windows hotfix absent', 'description': 'Ensure that a specific windows hotfix is absent from the system.', 'class_prefix': 'windows_hotfix_absent', 'class_parameter': 'hotfix', 'agent_support': ['dsc'], 'parameter': [{'name': 'hotfix', 'description': 'Windows hotfix name (ex: KB4033369)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Ensure that a specific windows hotfix is absent from the system.', 'parameter_rename': []}, {'bundle_name': 'windows_hotfix_present', 'name': 'Windows hotfix present', 'description': 'Ensure that a specific windows hotfix is present from the system.', 'class_prefix': 'windows_hotfix_present', 'class_parameter': 'hotfix', 'agent_support': ['dsc'], 'parameter': [{'name': 'hotfix', 'description': 'Windows hotfix name (ex: KB4033369)', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}, {'name': 'package_path', 'description': 'Windows hotfix package absolute path, can be a .msu archive or a .cab file', 'constraints': {'allow_empty_string': False, 'allow_whitespace_string': False, 'max_length': 16384}, 'type': 'string'}], 'documentation': 'Ensure that a specific windows hotfix is present from the system.', 'parameter_rename': []}], 'reason': 'Importing technique plugin_openscap_policies from rudder-synchronize'}
Updated by Nicolas CHARLES about 3 years ago
webapp is looking for "bundle_name" while it gets
JObject(List(JField(path,JString(/var/rudder/configuration-repository/ncf)), JField(technique,JObject(List(JField(bundle_name,JString(plugin_openscap_policies)), JField(version,JString(1.0)), JField(name,JString(plugin_openscap_policies)), JField(description,JString(## Summary
so the bundle_name is within the technique object
Updated by Nicolas CHARLES about 3 years ago
- Status changed from New to In progress
- Assignee set to Nicolas CHARLES
Updated by Nicolas CHARLES about 3 years ago
- Status changed from In progress to Pending technical review
- Assignee changed from Nicolas CHARLES to Félix DALLIDET
- Pull Request set to https://github.com/Normation/rudder-plugins/pull/427
Updated by Nicolas CHARLES about 3 years ago
- Status changed from Pending technical review to Pending release
Applied in changeset rudder:rudder-plugins|1e13651c0d2726527389a607dd4da21508f49c87.
Updated by Vincent MEMBRÉ over 1 year ago
- Status changed from Pending release to Released
Actions