.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.compliance_policys_rules_conditions module -- Resource module for Compliance Policys Rules Conditions ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.46.0). To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.dnac.compliance_policys_rules_conditions`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 6.46.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create, update and delete of the resource Compliance Policys Rules Conditions. - This API operation creates a new condition within the specified compliance policy and rule. - Deletes a specific condition within the specified compliance policy and rule. - Updates an existing compliance condition within the specified compliance policy and rule. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk \>= 2.11.0 - python \>= 3.12 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module__parameter-action: .. rst-class:: ansible-option-title **action** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Compliance Policys Rules Conditions's action. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module__parameter-action/doesnotmatchaction: .. rst-class:: ansible-option-title **doesNotMatchAction** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Action to take when the condition does not match. The choice of action influences whether a violation is logged and whether further conditions are evaluated. For detailed enum descriptions, refer to the \`Features\` tab. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module__parameter-action/doesnotmatchviolationmessage: .. rst-class:: ansible-option-title **doesNotMatchViolationMessage** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Specify the custom violation message to be used to report violations when the condition does not match and raises violation. This field is applicable and required when \`doesNotMatchViolationMessageType\` is \`CUSTOM\_MESSAGE\`. Custom variables and automatically generated regular expression group variables can both be used in this field, similar to how they are used in the \`value\` field. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module__parameter-action/doesnotmatchviolationmessagetype: .. rst-class:: ansible-option-title **doesNotMatchViolationMessageType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The type of message to display when the condition does not match and results in a violation. This provides context about the violation. This field is applicable and required when \`doesNotMatchAction\` is either \`RAISE\_VIOLATION\_AND\_CONTINUE\` or \`RAISE\_VIOLATION\_AND\_STOP\`. For detailed enum descriptions, refer to the \`Features\` tab. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module__parameter-action/doesnotmatchviolationseverity: .. rst-class:: ansible-option-title **doesNotMatchViolationSeverity** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The severity level of the violation when the condition does not match. This field is applicable and required when \`doesNotMatchAction\` is either \`RAISE\_VIOLATION\_AND\_CONTINUE\` or \`RAISE\_VIOLATION\_AND\_STOP\`. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module__parameter-action/matchaction: .. rst-class:: ansible-option-title **matchAction** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Action to take when the condition matches. The choice of action influences whether a violation is logged and whether further conditions are evaluated. For detailed enum descriptions, refer to the \`Features\` tab. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module__parameter-action/matchviolationmessage: .. rst-class:: ansible-option-title **matchViolationMessage** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Specify the custom violation message to be used to report violations when the condition matches and raises violation. This field is applicable and required when \`matchViolationMessageType\` is \`CUSTOM\_MESSAGE\`. Custom variables and automatically generated regular expression group variables can both be used in this field, similar to how they are used in the \`value\` field. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module__parameter-action/matchviolationmessagetype: .. rst-class:: ansible-option-title **matchViolationMessageType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The type of message to display when the condition matches and results in a violation. This provides context about the violation. This field is applicable and required when \`matchAction\` is either \`RAISE\_VIOLATION\_AND\_CONTINUE\` or \`RAISE\_VIOLATION\_AND\_STOP\`. For detailed enum descriptions, refer to the \`Features\` tab. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module__parameter-action/matchviolationseverity: .. rst-class:: ansible-option-title **matchViolationSeverity** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The severity level of the violation when the condition matches. This field is applicable and required when \`matchAction\` is either \`RAISE\_VIOLATION\_AND\_CONTINUE\` or \`RAISE\_VIOLATION\_AND\_STOP\`. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module__parameter-blockendexpression: .. rst-class:: ansible-option-title **blockEndExpression** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The regular expression defining the end of a block. If not specified, block parsing will continue until new section starts in the configuration. This is applicable only when \`parseAsBlocks\` is set. This is an optional field. The value, when provided, must be a valid regular expression. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module__parameter-blockstartexpression: .. rst-class:: ansible-option-title **blockStartExpression** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The regular expression defining the start of a block. This is used to identify the beginning of relevant configuration sections. This is applicable and required only when \`parseAsBlocks\` is set. The value must be a valid regular expression. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module__parameter-blockviolationcriteria: .. rst-class:: ansible-option-title **blockViolationCriteria** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Criteria determining when a violation is raised based on block evaluation results. This allows for flexible compliance checks depending on whether a single failure or all failures should trigger a violation. For detailed enum descriptions, refer to the \`Features\` tab. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module__parameter-deviceproperty: .. rst-class:: ansible-option-title **deviceProperty** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The specific device property to consider as source for the condition. For detailed enum descriptions, refer to the \`Features\` tab. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **dnac_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA Center SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module__parameter-dnac_host: .. rst-class:: ansible-option-title **dnac_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco DNA Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module__parameter-dnac_password: .. rst-class:: ansible-option-title **dnac_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco DNA Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module__parameter-user: .. rst-class:: ansible-option-title **dnac_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **dnac_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module__parameter-dnac_version: .. rst-class:: ansible-option-title **dnac_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco DNA Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"3.1.6.0"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module__parameter-id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Id path parameter. The \`id\` of the condition. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module__parameter-operator: .. rst-class:: ansible-option-title **operator** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The operation used to evaluate the condition. String, regular expression, and expressions required for the operator to work are provided in \`value\` attribute. For detailed enum descriptions, refer to the \`Features\` tab. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module__parameter-parseasblocks: .. rst-class:: ansible-option-title **parseAsBlocks** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
An optional param that indicates whether to parse the configuration as discrete blocks for evaluation. Useful for conditions that apply to specific sections of a configuration file. This is applicable for all condition scopes except \`DEVICE\_PROPERTIES\`. When scope is \`PREVIOUSLY\_MATCHED\_BLOCKS\`, this helps extract sub-blocks or portion of the blocks. When this is set, \`blockStartExpression\` must be provided. Optionally, \`blockEndExpression\` can be provided to customise blocks further. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module__parameter-policyid: .. rst-class:: ansible-option-title **policyId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
PolicyId path parameter. The \`id\` of the compliance policy. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module__parameter-regexviolationcriteria: .. rst-class:: ansible-option-title **regexViolationCriteria** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Criteria determining when a violation is raised based on regular expression evaluation results. This allows for flexible compliance checks depending on whether a single failure or all failures should trigger a violation. For detailed enum descriptions, refer to the \`Features\` tab. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module__parameter-ruleid: .. rst-class:: ansible-option-title **ruleId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
RuleId path parameter. The \`id\` of the rule within the compliance policy. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module__parameter-scope: .. rst-class:: ansible-option-title **scope** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The source of data for the evaluation of the condition. For detailed enum descriptions, refer to the \`Features\` tab. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module__parameter-showcommand: .. rst-class:: ansible-option-title **showCommand** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The command executed on the device to retrieve output for evaluation. Pattern ^((S|s)(H|h)(O|o)(W|w))\\s+.+$ — The string must start with \`show\` (case-insensitive), followed by at least one space, and then any sequence of characters. For detailed information on using \`show\` command, refer to the \`Features\` tab. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module__parameter-value: .. rst-class:: ansible-option-title **value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The value or pattern used in the condition evaluation. Custom variables and automatically generated regular expression group variables can both be used in this field. For detailed information on using variables, refer to the \`Features\` tab. .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are compliance.Compliance.create\_a\_new\_condition, compliance.Compliance.delete\_a\_specific\_condition, compliance.Compliance.update\_an\_existing\_condition, - Paths used are post /dna/intent/api/v1/compliancePolicys/{policyId}/rules/{ruleId}/conditions, delete /dna/intent/api/v1/compliancePolicys/{policyId}/rules/{ruleId}/conditions/{id}, put /dna/intent/api/v1/compliancePolicys/{policyId}/rules/{ruleId}/conditions/{id}, - Does not support \ :literal:`check\_mode`\ - The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK - The parameters starting with dnac\_ are used by the Cisco DNAC Python SDK to establish the connection .. Seealso See Also -------- .. seealso:: `Cisco DNA Center documentation for Compliance CreateANewCondition `_ Complete reference of the CreateANewCondition API. `Cisco DNA Center documentation for Compliance DeleteASpecificCondition `_ Complete reference of the DeleteASpecificCondition API. `Cisco DNA Center documentation for Compliance UpdateAnExistingCondition `_ Complete reference of the UpdateAnExistingCondition API. .. Examples Examples -------- .. code-block:: yaml+jinja --- - name: Create cisco.dnac.compliance_policys_rules_conditions: dnac_host: "{{dnac_host}}" dnac_username: "{{dnac_username}}" dnac_password: "{{dnac_password}}" dnac_verify: "{{dnac_verify}}" dnac_port: "{{dnac_port}}" dnac_version: "{{dnac_version}}" dnac_debug: "{{dnac_debug}}" state: present action: doesNotMatchAction: string doesNotMatchViolationMessage: string doesNotMatchViolationMessageType: string doesNotMatchViolationSeverity: string matchAction: string matchViolationMessage: string matchViolationMessageType: string matchViolationSeverity: string blockEndExpression: string blockStartExpression: string blockViolationCriteria: string deviceProperty: string operator: string parseAsBlocks: true policyId: string regexViolationCriteria: string ruleId: string scope: string showCommand: string value: string - name: Delete by id cisco.dnac.compliance_policys_rules_conditions: dnac_host: "{{dnac_host}}" dnac_username: "{{dnac_username}}" dnac_password: "{{dnac_password}}" dnac_verify: "{{dnac_verify}}" dnac_port: "{{dnac_port}}" dnac_version: "{{dnac_version}}" dnac_debug: "{{dnac_debug}}" state: absent id: string policyId: string ruleId: string - name: Update by id cisco.dnac.compliance_policys_rules_conditions: dnac_host: "{{dnac_host}}" dnac_username: "{{dnac_username}}" dnac_password: "{{dnac_password}}" dnac_verify: "{{dnac_verify}}" dnac_port: "{{dnac_port}}" dnac_version: "{{dnac_version}}" dnac_debug: "{{dnac_debug}}" state: present action: doesNotMatchAction: string doesNotMatchViolationMessage: string doesNotMatchViolationMessageType: string doesNotMatchViolationSeverity: string matchAction: string matchViolationMessage: string matchViolationMessageType: string matchViolationSeverity: string blockEndExpression: string blockStartExpression: string blockViolationCriteria: string deviceProperty: string id: string operator: string parseAsBlocks: true policyId: string regexViolationCriteria: string ruleId: string scope: string showCommand: string value: string .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_conditions_module__return-dnac_response: .. rst-class:: ansible-option-title **dnac_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco DNAC Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors