.. 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_variables_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.compliance_policys_rules_variables module -- Resource module for Compliance Policys Rules Variables ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. 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_variables`. .. 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 Variables. - This API operation creates a new variable within the specified compliance policy and rule. - Deletes a specific variable within the specified compliance policy and rule. - Updates an existing compliance variable 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_variables_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_variables_module__parameter-datatype: .. rst-class:: ansible-option-title **dataType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The data type of the variable. IP mask is supported in IP address form (e.g., 255.255.255.0) only. Interface names must be provided in their full form, such as GigabitEthernet1/0/1. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_variables_module__parameter-defaultvalue: .. rst-class:: ansible-option-title **defaultValue** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The default value for the variable. This is applicable when \`inputType\` is \`SINGLE\_TEXT\` or \`MULTI\_TEXT\`. Ensure that any type of data is formatted as a string, but it must match the required format for the data type and adhere to any provided constraints. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_variables_module__parameter-description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
A brief description of the variable. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_variables_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_variables_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_variables_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_variables_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_variables_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.compliance_policys_rules_variables_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_variables_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_variables_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_variables_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 variable. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_variables_module__parameter-identifier: .. rst-class:: ansible-option-title **identifier** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
This is the identifier of the variable. Variables are referenced using the identifier enclosed in angle brackets. Update operation cannot be used to change the identifier. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_variables_module__parameter-inputtype: .. rst-class:: ansible-option-title **inputType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The input type of the variable. For detailed enum descriptions, refer to the \`Features\` tab. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_variables_module__parameter-mandatory: .. rst-class:: ansible-option-title **mandatory** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Indicates if the variable is mandatory. .. 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_variables_module__parameter-maxlength: .. rst-class:: ansible-option-title **maxLength** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The maximum length constraint for the \`STRING\` values. This is only applicable when the \`inputType\` is \`SINGLE\_TEXT\` or \`MULTI\_TEXT\`. Max length must be between 1 and 255, both inclusive. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_variables_module__parameter-maxvalue: .. rst-class:: ansible-option-title **maxValue** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The maximum value constraint for the \`INTEGER\` variable. This is only applicable when the \`inputType\` is \`SINGLE\_TEXT\` or \`MULTI\_TEXT\`. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_variables_module__parameter-minvalue: .. rst-class:: ansible-option-title **minValue** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The minimum value constraint for the \`INTEGER\` variable. This is only applicable when the \`inputType\` is \`SINGLE\_TEXT\` or \`MULTI\_TEXT\`. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_variables_module__parameter-name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
This is the name of the variable. It should be a concise and descriptive title that clearly identifies the variable. The name must be unique within the specified rule. Pattern ^\\w\\ \\-\\(\\)+$. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_variables_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_variables_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_variables_module__parameter-selectionlist: .. rst-class:: ansible-option-title **selectionList** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Compliance Policys Rules Variables's selectionList. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_variables_module__parameter-selectionlist/default: .. rst-class:: ansible-option-title **default** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Indicates whether this selection option is the default. Depending on the \`inputType\`, either only one or multiple selection options can be set as default. .. 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_variables_module__parameter-selectionlist/key: .. rst-class:: ansible-option-title **key** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The key for the selection option, which uniquely identifies the value. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_variables_module__parameter-selectionlist/value: .. rst-class:: ansible-option-title **value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
This is the value for the selection option. Ensure that any type of data is formatted as a string, but it must match the required format for the data type and adhere to any provided constraints. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.compliance_policys_rules_variables_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_variables_module__parameter-validationregex: .. rst-class:: ansible-option-title **validationRegex** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
A regular expression pattern for constraining \`STRING\` values. This is only applicable when the \`inputType\` is \`SINGLE\_TEXT\` or \`MULTI\_TEXT\`. .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are compliance.Compliance.create\_a\_new\_variable, compliance.Compliance.delete\_a\_specific\_variable, compliance.Compliance.update\_an\_existing\_variable, - Paths used are post /dna/intent/api/v1/compliancePolicys/{policyId}/rules/{ruleId}/variables, delete /dna/intent/api/v1/compliancePolicys/{policyId}/rules/{ruleId}/variables/{id}, put /dna/intent/api/v1/compliancePolicys/{policyId}/rules/{ruleId}/variables/{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 CreateANewVariable `_ Complete reference of the CreateANewVariable API. `Cisco DNA Center documentation for Compliance DeleteASpecificVariable `_ Complete reference of the DeleteASpecificVariable API. `Cisco DNA Center documentation for Compliance UpdateAnExistingVariable `_ Complete reference of the UpdateAnExistingVariable API. .. Examples Examples -------- .. code-block:: yaml+jinja --- - name: Create cisco.dnac.compliance_policys_rules_variables: 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 dataType: string defaultValue: string description: string identifier: string inputType: string mandatory: true maxLength: 0 maxValue: 0 minValue: 0 name: string policyId: string ruleId: string selectionList: - default: true key: string value: string validationRegex: string - name: Delete by id cisco.dnac.compliance_policys_rules_variables: 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_variables: 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 dataType: string defaultValue: string description: string id: string inputType: string mandatory: true maxLength: 0 maxValue: 0 minValue: 0 name: string policyId: string ruleId: string selectionList: - default: true key: string value: string validationRegex: 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_variables_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