cisco.catalystcenter.compliance_sites_violations_info module -- Information module for Compliance Sites Violations

Note

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

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

New in cisco.catalystcenter 2.11.0

Synopsis

• Get all Compliance Sites Violations.

• Get Compliance Sites Violations by id.

• Retrieves details of a specific compliance violation for a site.

• Retrieves the compliance violations for a site with filtering, sorting, and searching capabilities.

Note

This module has a corresponding action plugin.

Requirements

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

• catalystcentersdk >= 3.2.3.0.0

• python >= 3.12

Parameters

Parameter	Comments
acknowledgementStatus string	AcknowledgementStatus query parameter. The acknowledgement status of the violation. If not specified, all violations will be considered regardless of their acknowledgement status.
catalystcenter_debug aliases: dnac_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 aliases: dnac_host string / required	The Cisco Catalyst Center hostname.
catalystcenter_password aliases: dnac_password string	The Cisco Catalyst Center password to authenticate.
catalystcenter_port aliases: dnac_port, catalystcenter_api_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catalystcenter_username aliases: dnac_username, user string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catalystcenter_verify aliases: dnac_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 aliases: dnac_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"`
complianceType string	ComplianceType query parameter. The type of compliance.
feature string	Feature query parameter. The feature that has the violation. Default behaviour is case-insensitive exact match. This field supports wildcard (`*`) character search. E.g. `*Wlan*`, `*SSID`, `Wireless*Config`, `*/Guest-SSID`.
headers dictionary	Additional headers.
limit integer	Limit query parameter. The number of records to show for this page.
offset integer	Offset query parameter. The first record to show for this page; the first record is numbered 1.
operation string	Operation query parameter. Represents the type of configuration operation performed.
order string	Order query parameter. Whether ascending or descending order should be used to sort the response.
parameter string	Parameter query parameter. The parameter name that has the violation. Default behaviour is case- insensitive exact match. This field supports wildcard (`*`) character search. E.g. `*interface*`, `*ssid`, `server*`, `admin*status`.
policyName string	PolicyName query parameter. The name of the policy. Default behaviour is case-insensitive exact match. This field supports wildcard (`*`) character search. E.g. `*Vlan*`, `password*policy`, `Traffic*`. Use the `GET /dna/intent/api/v1/compliancePolicys` endpoint to retrieve the policies.
ruleName string	RuleName query parameter. The name of the rule that has the violation. Default behaviour is case- insensitive exact match. This field supports wildcard (`*`) character search. E.g. `*Vlan*`, `*password`, `traffic*`, `*SMU*installed`. Use the `GET /dna/intent/api/v1/compliancePolicys/{policyId}/rules` endpoint to retrieve the rules.
siteId string	SiteId path parameter. The `id` of the site. Use the `GET /dna/intent/api/v1/sites` endpoint to retrieve the sites.
sortBy string	SortBy query parameter. Field to sort the results by.
subTypes list / elements=string	SubTypes query parameter. Specify the compliance sub-types. If not specified, all applicable sub-types will be considered.
templateName string	TemplateName query parameter. The name of the CLI template that has the violation. Default behaviour is case-insensitive exact match. This field supports wildcard (`*`) character search. E.g. `*Vlan*`, `*route`, `ACL*`, `interface*template`. Use the `GET /dna/intent/api/v2/template-programmer/template` endpoint to retrieve the templates.
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)
violationId string	ViolationId path parameter. The `id` of the violation.
violationMessage string	ViolationMessage query parameter. Message describing the violation. Default behaviour is case- insensitive exact match. This field supports wildcard (`*`) character search. E.g. `*Vlan*`, `*ssid`, `GigabitEthernet*`, `interface*has no acl*`. Use the `GET /dna/intent/api/v1/compliancePolicys/{policyId}/rules/{ruleId}/conditions` endpoint to retrieve the conditions.

Notes

Note

• SDK Method used are compliance.Compliance.retrieve_a_specific_violation, compliance.Compliance.retrieve_the_compliance_violations,

• Paths used are get /dna/intent/api/v1/compliance/sites/{siteId}/violations, get /dna/intent/api/v1/compliance/sites/{siteId}/violations/{violationId},

• 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

• Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)

See Also

See also

Cisco Catalyst Center documentation for Compliance RetrieveASpecificViolation

Complete reference of the RetrieveASpecificViolation API.

Cisco Catalyst Center documentation for Compliance RetrieveTheComplianceViolations

Complete reference of the RetrieveTheComplianceViolations API.

Examples

---
- name: Get all Compliance Sites Violations
  cisco.catalystcenter.compliance_sites_violations_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}}"
    complianceType: NETWORK_SETTINGS
    subTypes: []
    acknowledgementStatus: UNACKNOWLEDGED
    feature: string
    parameter: string
    operation: CHANGED
    templateName: string
    policyName: string
    ruleName: string
    violationMessage: string
    sortBy: severity
    order: desc
    offset: 1
    limit: 0
    siteId: b8eeb5e2-1eab-426c-be77-97ee81dcba07
  register: result
- name: Get Compliance Sites Violations by id
  cisco.catalystcenter.compliance_sites_violations_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}}"
    siteId: b8eeb5e2-1eab-426c-be77-97ee81dcba07
    violationId: string
  register: result

Return Values

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

Key

Description

catalystcenter_response dictionary

A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"actualValue": "string", "conditionId": "string", "feature": "string", "intendedValue": "string", "operation": "string", "parameter": "string", "policyId": "string", "policyName": "string", "ruleId": "string", "ruleName": "string", "sequenceNumber": 0, "templateId": "string", "templateName": "string", "violationMessage": "string"}, "version": "string"}`

Authors

• Bryan Vargas (@bvargasre)

Collection links

Issue Tracker Repository (Sources)