cisco.catalystcenter.compliance_sites_violations_network_devices_info module -- Information module for Compliance Sites Violations Network Devices
Note
This module is part of the cisco.catalystcenter collection (version 2.12.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_network_devices_info.
New in cisco.catalystcenter 2.11.0
Synopsis
Get all Compliance Sites Violations Network Devices.
Get Compliance Sites Violations Network Devices by id.
Retrieves the network device with the specified compliance violation for a site.
Retrieves the network devices with the specified compliance 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 |
|---|---|
Flag for Cisco Catalyst Center SDK to enable debugging. Choices: |
|
The Cisco Catalyst Center hostname. |
|
The Cisco Catalyst Center password to authenticate. |
|
The Cisco Catalyst Center port. Default: :ansible-option-default:`443` |
|
The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"` |
|
Family query parameter. Product family of the network device. Default behaviour is case-insensitive exact match. This field supports wildcard (`*`) character search. E.g. `*Controller*`, `*security`, `Switch*`. Use the `GET /dna/intent/api/v1/network-device` endpoint to retrieve the network devices. |
|
Additional headers. |
|
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 query parameter. The number of records to show for this page. |
|
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. |
|
NetworkDeviceId path parameter. The `id` of the network device. |
|
Offset query parameter. The first record to show for this page; the first record is numbered 1. |
|
Order query parameter. Whether ascending or descending order should be used to sort the response. |
|
Role query parameter. Role assigned to the network device. |
|
SiteId path parameter. The `id` of the site. Use the `GET /dna/intent/api/v1/sites` endpoint to retrieve the sites. |
|
SortBy query parameter. Field to sort the results by. |
|
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
|
Views query parameter. The specific view being requested. If this is not provided, then it will default to the `BASIC` view. If multiple views are provided, the response will contain the union of the views. Attributes covered by the views are * `BASIC` id, managementAddress, dnsResolvedManagementIpAddress, hostname, macAddress, serialNumbers, type, family, series, status, platformIds, softwareType, softwareVersion, vendor, stackDevice, bootTime, role, roleSource, apEthernetMacAddress, apManagerInterfaceIpAddress, apWlcIpAddress, deviceSupportLevel, snmpContact, snmpLocation, siteId, siteName * `CLI_TEMPLATE` id, managementAddress, dnsResolvedManagementIpAddress, hostname, macAddress, serialNumbers, type, family, series, status, platformIds, softwareType, softwareVersion, vendor, stackDevice, bootTime, role, roleSource, apEthernetMacAddress, apManagerInterfaceIpAddress, apWlcIpAddress, deviceSupportLevel, snmpContact, snmpLocation, siteId, siteName, templateName, templateId, operation, intendedValue, actualValue. |
|
ViolationId path parameter. The `id` of the violation. |
Notes
Note
SDK Method used are compliance.Compliance.retrieve_a_device_with_the_violation, compliance.Compliance.retrieve_the_devices_with_the_violation,
Paths used are get /dna/intent/api/v1/compliance/sites/{siteId}/violations/{violationId}/networkDevices, get /dna/intent/api/v1/compliance/sites/{siteId}/violations/{violationId}/networkDevices/{networkDeviceId},
Supports
check_modeThe 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 RetrieveADeviceWithTheViolation
Complete reference of the RetrieveADeviceWithTheViolation API.
- Cisco Catalyst Center documentation for Compliance RetrieveTheDevicesWithTheViolation
Complete reference of the RetrieveTheDevicesWithTheViolation API.
Examples
---
- name: Get all Compliance Sites Violations Network Devices
cisco.catalystcenter.compliance_sites_violations_network_devices_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}}"
hostname: string
managementAddress: string
family: string
role: ACCESS
sortBy: hostname
order: asc
offset: 1
limit: 0
siteId: b8eeb5e2-1eab-426c-be77-97ee81dcba07
violationId: string
register: result
- name: Get Compliance Sites Violations Network Devices by id
cisco.catalystcenter.compliance_sites_violations_network_devices_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}}"
views: ['BASIC']
siteId: b8eeb5e2-1eab-426c-be77-97ee81dcba07
violationId: string
networkDeviceId: string
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK Returned: always |