cisco.catalystcenter.compliance_sites_policys_violations_info module -- Information module for Compliance Sites Policys 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_policys_violations_info.

New in cisco.catalystcenter 2.11.0

Synopsis

  • Get all Compliance Sites Policys Violations.

  • Get Compliance Sites Policys Violations by id.

  • Retrieves the violations for a specific compliance policy.

  • Returns a specific compliance policy violation for a site.

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

catalystcenter_debug

aliases: dnac_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

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:

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

headers

dictionary

Additional headers.

hostname

string

Hostname query parameter. Hostname of the network device. Default behaviour is case-insensitive exact match. This field supports wildcard (`*`) character search. E.g. `*9800*`, `*.cisco.com`, `switch*`, `switch.*.lab.cisco.com`. Use the `GET /dna/intent/api/v1/network-device` endpoint to retrieve the network devices.

limit

integer

Limit query parameter. The number of records to show for this page.

managementAddress

string

ManagementAddress query parameter. Management address of the network device. Default behaviour is case- insensitive exact match. This field supports wildcard (`*`) character search. E.g. `*10.104*`, `*.42`, `172.10.*`, `172.10.*.4`. Use the `GET /dna/intent/api/v1/network-device` endpoint to retrieve the network devices.

offset

integer

Offset query parameter. The first record to show for this page; the first record is numbered 1.

order

string

Order query parameter. Whether ascending or descending order should be used to sort the response.

policyId

string

PolicyId path parameter. The `id` of the compliance policy.

ruleId

string

RuleId query parameter. The `id` of the rule within the compliance policy.

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.

validate_response_schema

boolean

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

Choices:

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_policy_violation, compliance.Compliance.retrieve_the_violations_for_a_policy,

  • Paths used are get /dna/intent/api/v1/compliance/sites/{siteId}/policys/{policyId}/violations, get /dna/intent/api/v1/compliance/sites/{siteId}/policys/{policyId}/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 RetrieveASpecificPolicyViolation

Complete reference of the RetrieveASpecificPolicyViolation API.

Cisco Catalyst Center documentation for Compliance RetrieveTheViolationsForAPolicy

Complete reference of the RetrieveTheViolationsForAPolicy API.

Examples

---
- name: Get all Compliance Sites Policys Violations
  cisco.catalystcenter.compliance_sites_policys_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}}"
    ruleId: e8eef5e2-1eab-426c-be77-97ee81dcba06
    ruleName: string
    violationMessage: string
    hostname: string
    managementAddress: string
    sortBy: severity
    order: desc
    offset: 1
    limit: 0
    siteId: b8eeb5e2-1eab-426c-be77-97ee81dcba07
    policyId: c9eef5e2-1eab-426c-be77-97ee81dcba05
  register: result
- name: Get Compliance Sites Policys Violations by id
  cisco.catalystcenter.compliance_sites_policys_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
    policyId: c9eef5e2-1eab-426c-be77-97ee81dcba05
    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": {"conditionId": "string", "errorCode": "string", "errorMessage": "string", "hostname": "string", "id": "string", "managementAddress": {}, "networkDeviceId": "string", "ruleId": "string", "ruleName": "string", "sequenceNumber": 0, "severity": "string", "type": "string", "violationMessage": "string"}, "version": "string"}`

Authors

  • Bryan Vargas (@bvargasre)