cisco.catalystcenter.compliance_policys_sites_rules_variables_info module -- Information 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_info.

New in cisco.catalystcenter 6.46.0

Synopsis

  • Get all Compliance Policys Sites Rules Variables.

  • Retrieve the site variables 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

_inherited

boolean

_inherited query parameter. Include values explicitly set for this site; when false, null values indicate that the site inherits these values from the parent site or a higher level in the site hierarchy.

Choices:

catalystcenter_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

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:

catalystcenter_version

string

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

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

headers

dictionary

Additional headers.

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:

Notes

Note

  • SDK Method used are compliance.Compliance.retrieve_site_variables,

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

  • Supports 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 RetrieveSiteVariables

Complete reference of the RetrieveSiteVariables API.

Examples

---
- name: Get all Compliance Policys Sites Rules Variables
  cisco.catalystcenter.compliance_policys_sites_rules_variables_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    _inherited: true
    policyId: string
    siteId: string
    ruleId: string
  register: result

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": {"inheritedSiteId": "string", "inheritedSiteName": "string", "variableValues": [{"id": "string", "values": ["string"]}]}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)