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

Note

This module is part of the cisco.catalystcenter collection (version 2.3.1).

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

To use it in a playbook, specify: cisco.catalystcenter.compliance_policys_sites_rules_variables.

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

• catalystcentersdk >= 3.1.6.0.0

• python >= 3.12

Parameters

Parameter	Comments
catalystcenter_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catalystcenter_host string / required	The Cisco Catalyst Center hostname.
catalystcenter_password string	The Cisco Catalyst Center password to authenticate.
catalystcenter_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catalystcenter_username string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catalystcenter_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catalystcenter_version string	Informs the SDK which version of Cisco Catalyst 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 Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
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 uses the embedded connection manager from Cisco CATALYST SDK

See Also

See also

Cisco DNA Center documentation for Compliance SetSiteVariables

Complete reference of the SetSiteVariables API.

Examples

---
- name: Update all
  cisco.catalystcenter.compliance_policys_sites_rules_variables:
    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
    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)

Collection links

Issue Tracker Repository (Sources)