.. 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.catalystcenter.compliance_policys_rules_conditions_module:

.. Anchors: short name for ansible.builtin

.. Anchors: aliases



.. Title

cisco.catalystcenter.compliance_policys_rules_conditions module -- Resource module for Compliance Policys Rules Conditions
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. Collection note

.. note::
    This module is part of the `cisco.catalystcenter collection <https://galaxy.ansible.com/cisco/catalystcenter>`_ (version 2.11.0).

    To install it, use: :code:`ansible-galaxy collection install cisco.catalystcenter`.
    You need further requirements to be able to use this module,
    see :ref:`Requirements <ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module_requirements>` for details.

    To use it in a playbook, specify: :code:`cisco.catalystcenter.compliance_policys_rules_conditions`.

.. version_added

.. rst-class:: ansible-version-added

New in cisco.catalystcenter 2.3.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 <action_plugins>`.

.. Aliases


.. Requirements

.. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module_requirements:

Requirements
------------
The below requirements are needed on the host that executes this module.

- catalystcentersdk \>= 3.2.3.0.0
- python \>= 3.12






.. Options

Parameters
----------

.. rst-class:: ansible-option-table

.. list-table::
  :width: 100%
  :widths: auto
  :header-rows: 1

  * - Parameter
    - Comments

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-action"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-action:

      .. rst-class:: ansible-option-title

      **action**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-action" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`dictionary`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Specifies actions based on condition outcomes, guiding subsequent operational steps.


      .. raw:: html

        </div>
    
  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-action/doesNotMatchAction"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-action/doesnotmatchaction:

      .. rst-class:: ansible-option-title

      **doesNotMatchAction**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-action/doesNotMatchAction" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      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. Options include - \`DO\_NOT\_RAISE\_VIOLATION\_AND\_CONTINUE\` No violation is raised, and processing continues. - \`DO\_NOT\_RAISE\_VIOLATION\_AND\_STOP\` No violation is raised, and processing stops. - \`RAISE\_VIOLATION\_AND\_CONTINUE\` A violation is raised, but processing continues. - \`RAISE\_VIOLATION\_AND\_STOP\` A violation is raised, and processing stops. Additionally, depending on \`matchAction\`, value must satisfy following criteria - \`doesNotMatchAction\` cannot be same as \`matchAction\`. - Both \`doesNotMatchAction\` and \`matchAction\` cannot raise violation in a single condition.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-action/doesNotMatchViolationMessage"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-action/doesnotmatchviolationmessage:

      .. rst-class:: ansible-option-title

      **doesNotMatchViolationMessage**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-action/doesNotMatchViolationMessage" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      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

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-action/doesNotMatchViolationMessageType"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-action/doesnotmatchviolationmessagetype:

      .. rst-class:: ansible-option-title

      **doesNotMatchViolationMessageType**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-action/doesNotMatchViolationMessageType" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      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\`. Options include - \`DEFAULT\_MESSAGE\` Use the automatic violation message generated by the system based on condition scope, operator, and value. - \`CUSTOM\_MESSAGE\` Use the violation message specified by the user in \`matchViolationMessage\` field.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-action/doesNotMatchViolationSeverity"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-action/doesnotmatchviolationseverity:

      .. rst-class:: ansible-option-title

      **doesNotMatchViolationSeverity**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-action/doesNotMatchViolationSeverity" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      The severity level of the violation.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-action/matchAction"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-action/matchaction:

      .. rst-class:: ansible-option-title

      **matchAction**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-action/matchAction" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Action to take when the condition matches. The choice of action influences whether a violation is logged and whether further conditions are evaluated. Options include - \`DO\_NOT\_RAISE\_VIOLATION\_AND\_CONTINUE\` No violation is raised, and processing continues. - \`DO\_NOT\_RAISE\_VIOLATION\_AND\_STOP\` No violation is raised, and processing stops. - \`RAISE\_VIOLATION\_AND\_CONTINUE\` A violation is raised, but processing continues. - \`RAISE\_VIOLATION\_AND\_STOP\` A violation is raised, and processing stops.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-action/matchViolationMessage"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-action/matchviolationmessage:

      .. rst-class:: ansible-option-title

      **matchViolationMessage**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-action/matchViolationMessage" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      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

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-action/matchViolationMessageType"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-action/matchviolationmessagetype:

      .. rst-class:: ansible-option-title

      **matchViolationMessageType**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-action/matchViolationMessageType" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      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\`. Options include - \`DEFAULT\_MESSAGE\` Use the automatic violation message generated by the system based on condition scope, operator, and value. - \`CUSTOM\_MESSAGE\` Use the violation message specified by the user in \`matchViolationMessage\` field.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-action/matchViolationSeverity"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-action/matchviolationseverity:

      .. rst-class:: ansible-option-title

      **matchViolationSeverity**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-action/matchViolationSeverity" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      The severity level of the violation.


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-blockEndExpression"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-blockendexpression:

      .. rst-class:: ansible-option-title

      **blockEndExpression**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-blockEndExpression" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      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

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-blockStartExpression"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-blockstartexpression:

      .. rst-class:: ansible-option-title

      **blockStartExpression**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-blockStartExpression" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      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

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-blockViolationCriteria"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-blockviolationcriteria:

      .. rst-class:: ansible-option-title

      **blockViolationCriteria**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-blockViolationCriteria" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      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. Options are - \`RAISE\_FOR\_EACH\_VIOLATION\` Violations are raised for each block that fails the evaluation criteria. - \`RAISE\_SINGLE\_FOR\_ANY\_VIOLATION\` A single violation is raised if any one of the blocks fails the evaluation criteria. Further processing of blocks is stopped as soon as a violation is detected and raised. - \`RAISE\_IF\_ALL\_VIOLATED\` A single violation is raised only if all the blocks fail the evaluation criteria.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-catalystcenter_debug"></div>
        <div class="ansibleOptionAnchor" id="parameter-dnac_debug"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-catalystcenter_debug:
      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-dnac_debug:

      .. rst-class:: ansible-option-title

      **catalystcenter_debug**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-catalystcenter_debug" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-aliases:`aliases: dnac_debug`

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`boolean`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Flag for Cisco Catalyst 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

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-catalystcenter_host"></div>
        <div class="ansibleOptionAnchor" id="parameter-dnac_host"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-catalystcenter_host:
      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-dnac_host:

      .. rst-class:: ansible-option-title

      **catalystcenter_host**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-catalystcenter_host" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-aliases:`aliases: dnac_host`

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`string` / :ansible-option-required:`required`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      The Cisco Catalyst Center hostname.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-catalystcenter_password"></div>
        <div class="ansibleOptionAnchor" id="parameter-dnac_password"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-catalystcenter_password:
      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-dnac_password:

      .. rst-class:: ansible-option-title

      **catalystcenter_password**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-catalystcenter_password" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-aliases:`aliases: dnac_password`

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      The Cisco Catalyst Center password to authenticate.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-catalystcenter_port"></div>
        <div class="ansibleOptionAnchor" id="parameter-dnac_port"></div>
        <div class="ansibleOptionAnchor" id="parameter-catalystcenter_api_port"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-catalystcenter_api_port:
      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-catalystcenter_port:
      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-dnac_port:

      .. rst-class:: ansible-option-title

      **catalystcenter_port**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-catalystcenter_port" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-aliases:`aliases: dnac_port, catalystcenter_api_port`

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`integer`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      The Cisco Catalyst Center port.


      .. rst-class:: ansible-option-line

      :ansible-option-default-bold:`Default:` :ansible-option-default:`443`

      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-catalystcenter_username"></div>
        <div class="ansibleOptionAnchor" id="parameter-dnac_username"></div>
        <div class="ansibleOptionAnchor" id="parameter-user"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-catalystcenter_username:
      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-dnac_username:
      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-user:

      .. rst-class:: ansible-option-title

      **catalystcenter_username**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-catalystcenter_username" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-aliases:`aliases: dnac_username, user`

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      The Cisco Catalyst Center username to authenticate.


      .. rst-class:: ansible-option-line

      :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"`

      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-catalystcenter_verify"></div>
        <div class="ansibleOptionAnchor" id="parameter-dnac_verify"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-catalystcenter_verify:
      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-dnac_verify:

      .. rst-class:: ansible-option-title

      **catalystcenter_verify**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-catalystcenter_verify" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-aliases:`aliases: dnac_verify`

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`boolean`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      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

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-catalystcenter_version"></div>
        <div class="ansibleOptionAnchor" id="parameter-dnac_version"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-catalystcenter_version:
      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-dnac_version:

      .. rst-class:: ansible-option-title

      **catalystcenter_version**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-catalystcenter_version" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-aliases:`aliases: dnac_version`

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Informs the SDK which version of Cisco Catalyst Center to use.


      .. rst-class:: ansible-option-line

      :ansible-option-default-bold:`Default:` :ansible-option-default:`"3.1.6.0"`

      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-deviceProperty"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-deviceproperty:

      .. rst-class:: ansible-option-title

      **deviceProperty**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-deviceProperty" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      The specific device property to consider as source for the condition. This is applicable and required when scope is \`DEVICE\_PROPERTIES\`. Possible values include - \`DEVICE\_NAME\` Hostname of the device. - \`IP\_ADDRESS\` IP address of the device. - \`OS\_NAME\` Name of the operating system of the device. - \`OS\_VERSION\` Version of the operating system running on the device.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-id"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-id:

      .. rst-class:: ansible-option-title

      **id**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-id" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Id path parameter. The \`id\` of the condition.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-name"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-name:

      .. rst-class:: ansible-option-title

      **name**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      The auto-generated name of the condition, summarizing its scope, operator, and value.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-operator"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-operator:

      .. rst-class:: ansible-option-title

      **operator**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-operator" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      The operation used to evaluate the condition. String, regular expression, and expressions required for the operator to work are provided in \`value\` attribute. Options include - \`CONTAINS\_STRING\` Checks if the specified string is present within the source of the condition. - \`DOES\_NOT\_CONTAIN\_STRING\` Ensures the string is absent from the source of the condition. - \`MATCHES\_EXPRESSION\` Evaluates whether there is a match for the regular expression within the source of the condition. - \`DOES\_NOT\_MATCH\_EXPRESSION\` Ensures there is no match for the regular expression within the source of the condition. - \`EVALUATE\_EXPRESSION\` Performs custom expression evaluation. When this is selected, the \`value\` field must contain three parts separated by a space \`\<left-hand-operand\> \<evaluate-operator\> \<right-hand-operand\>\` Available evaluation operators are \`\>\`, \`\>=\`, \`\<\`, \`\<=\`, \`==\`, and \`matches\`. Use \`matches\` to find case-sensitive exact match for string and IP address values. Example - To check if the custom variable \`\_STRING\` is matching \`TestString\` use \`\<\_STRING\> matches TestString\` in the \`value\` field. - Similarly, \`\<\_IP\_ADDR\> matches 3.3.3.3\` will check if the custom variable \`\_IP\_ADDR\` has the value \`3.3.3.3\`.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-parseAsBlocks"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-parseasblocks:

      .. rst-class:: ansible-option-title

      **parseAsBlocks**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-parseAsBlocks" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`boolean`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      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

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-policyId"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-policyid:

      .. rst-class:: ansible-option-title

      **policyId**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-policyId" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      PolicyId path parameter. The \`id\` of the compliance policy.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-regexViolationCriteria"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-regexviolationcriteria:

      .. rst-class:: ansible-option-title

      **regexViolationCriteria**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-regexViolationCriteria" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      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. Options are - \`RAISE\_FOR\_EACH\_VIOLATION\` Violations are raised for each regular expression match instance that fails the evaluation criteria. - \`RAISE\_SINGLE\_FOR\_ANY\_VIOLATION\` A single violation is raised if any one of the regular expression match instances fails the evaluation criteria. Further processing of match instances is stopped as soon as a violation is detected and raised. - \`RAISE\_IF\_ALL\_VIOLATED\` A single violation is raised only if all the regular expression match instances fail the evaluation criteria.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-ruleId"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-ruleid:

      .. rst-class:: ansible-option-title

      **ruleId**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-ruleId" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      RuleId path parameter. The \`id\` of the rule within the compliance policy.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-scope"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-scope:

      .. rst-class:: ansible-option-title

      **scope**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-scope" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      The source of data for the evaluation of the condition. Possible values include - \`CONFIGURATION\` Evaluates conditions against the running configuration of the device. - \`DEVICE\_PROPERTIES\` Checks the condition based on specific properties of the device. Device property is specified using the \`deviceProperty\` attribute. - \`DEVICE\_COMMAND\_OUTPUT\` Evaluates based on custom command output. Custom command is specified using the \`showCommand\` attribute. - \`PREVIOUSLY\_MATCHED\_BLOCKS\` Evaluates the current condition only on passed configuration blocks from previous condition. First condition within the rule cannot have this as scope. The condition previous to the one being created must either have \`parseAsBlocks\` set or must use \`PREVIOUSLY\_MATCHED\_BLOCKS\` as scope.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-sequenceNumber"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-sequencenumber:

      .. rst-class:: ansible-option-title

      **sequenceNumber**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-sequenceNumber" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`integer`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      The sequence number of the condition, indicating its order in the evaluation process.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-showCommand"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-showcommand:

      .. rst-class:: ansible-option-title

      **showCommand**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-showCommand" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      The command executed on the device to retrieve output for evaluation. This is applicable and required when the scope is \`DEVICE\_COMMAND\_OUTPUT\`.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-validate_response_schema"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-validate_response_schema:

      .. rst-class:: ansible-option-title

      **validate_response_schema**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-validate_response_schema" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`boolean`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Flag for Cisco Catalyst 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

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-value"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__parameter-value:

      .. rst-class:: ansible-option-title

      **value**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-value" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      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. To use variables, enclose the variable identifiers within \`\<\` and \`\>\`. During compliance check, these will be replaced with their corresponding values. If an invalid variable is specified, it will not be replaced and considered as a string. Example - To use custom variable with identifier \_snmp\_community\_name, input \`\<\_snmp\_community\_name\>\` in the value field. - To use the value of fourth matching group from second condition, input \`\<2.4\>\` in the value field. The value must satisfy the following requirements - When the \`operator\` is \`MATCHES\_EXPRESSION\` or \`DOES\_NOT\_MATCH\_EXPRESSION\`, the value must be a valid regular expression. - When the \`operator\` is \`EVALUATE\_EXPRESSION\`, the value must contain a valid expression as mentioned in \`EVALUATE\_EXPRESSION\` description.


      .. raw:: html

        </div>


.. 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 uses the embedded connection manager from Cisco CATALYST SDK
   - Requires Python \>= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)

.. Seealso

See Also
--------

.. seealso::

   `Cisco Catalyst Center documentation for Compliance CreateANewCondition <https://developer.cisco.com/docs/dna-center/#!create-a-new-condition>`_
       Complete reference of the CreateANewCondition API.
   `Cisco Catalyst Center documentation for Compliance DeleteASpecificCondition <https://developer.cisco.com/docs/dna-center/#!delete-a-specific-condition>`_
       Complete reference of the DeleteASpecificCondition API.
   `Cisco Catalyst Center documentation for Compliance UpdateAnExistingCondition <https://developer.cisco.com/docs/dna-center/#!update-an-existing-condition>`_
       Complete reference of the UpdateAnExistingCondition API.

.. Examples

Examples
--------

.. code-block:: yaml+jinja

    
    ---
    - name: Delete by id
      cisco.catalystcenter.compliance_policys_rules_conditions:
        catalystcenter_host: "{{catalystcenter_host}}"
        catalystcenter_username: "{{catalystcenter_username}}"
        catalystcenter_password: "{{catalystcenter_password}}"
        catalystcenter_verify: "{{catalystcenter_verify}}"
        catalystcenter_port: "{{catalystcenter_port}}"
        catalystcenter_version: "{{catalystcenter_version}}"
        catalystcenter_debug: "{{catalystcenter_debug}}"
        state: absent
        id: 1d78e50b-acd7-423b-bc5e-5f4c106eaa8f
        policyId: c9eef5e2-1eab-426c-be77-97ee81dcba05
        ruleId: e8eef5e2-1eab-426c-be77-97ee81dcba06
    - name: Update by id
      cisco.catalystcenter.compliance_policys_rules_conditions:
        catalystcenter_host: "{{catalystcenter_host}}"
        catalystcenter_username: "{{catalystcenter_username}}"
        catalystcenter_password: "{{catalystcenter_password}}"
        catalystcenter_verify: "{{catalystcenter_verify}}"
        catalystcenter_port: "{{catalystcenter_port}}"
        catalystcenter_version: "{{catalystcenter_version}}"
        catalystcenter_debug: "{{catalystcenter_debug}}"
        state: present
        action:
          doesNotMatchAction: string
          doesNotMatchViolationMessage: string
          doesNotMatchViolationMessageType: string
          doesNotMatchViolationSeverity: {}
          matchAction: string
          matchViolationMessage: string
          matchViolationMessageType: string
          matchViolationSeverity: {}
        blockEndExpression: string
        blockStartExpression: string
        blockViolationCriteria: string
        deviceProperty: string
        id: string
        name: string
        operator: string
        parseAsBlocks: true
        policyId: c9eef5e2-1eab-426c-be77-97ee81dcba05
        regexViolationCriteria: string
        ruleId: e8eef5e2-1eab-426c-be77-97ee81dcba06
        scope: string
        sequenceNumber: 0
        showCommand: string
        value: string
    - name: Create
      cisco.catalystcenter.compliance_policys_rules_conditions:
        catalystcenter_host: "{{catalystcenter_host}}"
        catalystcenter_username: "{{catalystcenter_username}}"
        catalystcenter_password: "{{catalystcenter_password}}"
        catalystcenter_verify: "{{catalystcenter_verify}}"
        catalystcenter_port: "{{catalystcenter_port}}"
        catalystcenter_version: "{{catalystcenter_version}}"
        catalystcenter_debug: "{{catalystcenter_debug}}"
        state: present
        action:
          doesNotMatchAction: string
          doesNotMatchViolationMessage: string
          doesNotMatchViolationMessageType: string
          doesNotMatchViolationSeverity: {}
          matchAction: string
          matchViolationMessage: string
          matchViolationMessageType: string
          matchViolationSeverity: {}
        blockEndExpression: string
        blockStartExpression: string
        blockViolationCriteria: string
        deviceProperty: string
        id: string
        name: string
        operator: string
        parseAsBlocks: true
        policyId: c9eef5e2-1eab-426c-be77-97ee81dcba05
        regexViolationCriteria: string
        ruleId: e8eef5e2-1eab-426c-be77-97ee81dcba06
        scope: string
        sequenceNumber: 0
        showCommand: string
        value: string




.. Facts


.. Return values

Return Values
-------------
Common return values are documented :ref:`here <common_return_values>`, 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

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-catalystcenter_response"></div>

      .. _ansible_collections.cisco.catalystcenter.compliance_policys_rules_conditions_module__return-catalystcenter_response:

      .. rst-class:: ansible-option-title

      **catalystcenter_response**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-catalystcenter_response" title="Permalink to this return value"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`dictionary`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      A dictionary or list with the response returned by the Cisco Catalyst Center 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

        </div>



..  Status (Presently only deprecated)


.. Authors

Authors
~~~~~~~

- Bryan Vargas (@bvargasre)



.. Extra links

Collection links
~~~~~~~~~~~~~~~~

.. raw:: html

  <p class="ansible-links">
    <a href="https://github.com/cisco-en-programmability/catalystcenter-ansible/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
    <a href="https://github.com/cisco-en-programmability/catalystcenter-ansible" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>
  </p>

.. Parsing errors