cisco.dnac.compliance_policys_sites_rules_variables module -- Resource module for Compliance Policys Sites Rules Variables

Note

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

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

New in cisco.dnac 6.46.0

Synopsis

  • Manage operation update of the resource Compliance Policys Sites Rules Variables.

  • Set site variable values for the specified rule within the compliance policy.

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

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

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: :ansible-option-default:`443`

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

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

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

dnac_version

string

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

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

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.

siteId

string

SiteId path parameter. The `id` of the site to which compliance policy is associated.

validate_response_schema

boolean

Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

variableValues

list / elements=dictionary

Compliance Policys Sites Rules Variables's variableValues.

id

string

The `id` of the variable.

values

list / elements=string

List of variable values. The order of the list is preserved for compliance checks. The variable value is formatted as a string. It must be a valid string representation of the data and conform to the specified type. For variables with an input type of `SINGLE_SELECT` or `MULTI_SELECT`, pass the actual value, not the key.

Notes

Note

  • SDK Method used are compliance.Compliance.set_site_variables,

  • Paths used are put /dna/intent/api/v1/compliancePolicys/{policyId}/sites/{siteId}/rules/{ruleId}/variables,

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

Complete reference of the SetSiteVariables API.

Examples

---
- name: Update all
  cisco.dnac.compliance_policys_sites_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
    policyId: string
    ruleId: string
    siteId: string
    variableValues:
      - id: string
        values:
          - 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: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)