cisco.dnac.compliance_policys_rules_variables module – Resource module for Compliance Policys Rules Variables

Note

This module is part of the cisco.dnac collection (version 6.48.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.dnac. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.dnac.compliance_policys_rules_variables.

New in cisco.dnac 6.46.0

Synopsis

• 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 action plugin.

Requirements

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

• dnacentersdk >= 2.11.0

• python >= 3.12

Parameters

Parameter	Comments
dataType string	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.
defaultValue string	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.
description string	A brief description of the variable.
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: false ← (default) true
dnac_host string / required	The Cisco DNA Center hostname.
dnac_password string	The Cisco DNA Center password to authenticate.
dnac_port integer	The Cisco DNA Center port. Default: 443
dnac_username aliases: user string	The Cisco DNA Center username to authenticate. Default: "admin"
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: false true ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: "3.1.6.0"
id string	Id path parameter. The `id` of the variable.
identifier string	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.
inputType string	The input type of the variable. For detailed enum descriptions, refer to the `Features` tab.
mandatory boolean	Indicates if the variable is mandatory. Choices: false true
maxLength integer	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.
maxValue integer	The maximum value constraint for the `INTEGER` variable. This is only applicable when the `inputType` is `SINGLE_TEXT` or `MULTI_TEXT`.
minValue integer	The minimum value constraint for the `INTEGER` variable. This is only applicable when the `inputType` is `SINGLE_TEXT` or `MULTI_TEXT`.
name string	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\ \-\(\)+$.
policyId string	PolicyId path parameter. The `id` of the compliance policy.
ruleId string	RuleId path parameter. The `id` of the rule within the compliance policy.
selectionList list / elements=dictionary	Compliance Policys Rules Variables’s selectionList.
default boolean	Indicates whether this selection option is the default. Depending on the `inputType`, either only one or multiple selection options can be set as default. Choices: false true
key string	The key for the selection option, which uniquely identifies the value.
value string	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.
validate_response_schema boolean	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: false true ← (default)
validationRegex string	A regular expression pattern for constraining `STRING` values. This is only applicable when the `inputType` is `SINGLE_TEXT` or `MULTI_TEXT`.

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 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

See Also

See also

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

---
- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
dnac_response dictionary	A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

Authors

• Rafael Campos (@racampos)

Collection links

• Issue Tracker
• Repository (Sources)