cisco.dnac.compliance_device_by_id_info module – Information module for Compliance Device By Id
Note
This module is part of the cisco.dnac collection (version 6.9.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install cisco.dnac.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.dnac.compliance_device_by_id_info.
New in cisco.dnac 3.1.0
Synopsis
Get all Compliance Device By Id.
Return compliance detailed report for a device.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.5.5
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
Category query parameter. ComplianceCategory can have any value among ‘INTENT’, ‘RUNNING_CONFIG’. |
|
ComplianceType query parameter. ComplianceType can have any value among ‘NETWORK_DESIGN’, ‘NETWORK_PROFILE’, ‘FABRIC’, ‘POLICY’, ‘RUNNING_CONFIG’. |
|
DeviceUuid path parameter. |
|
DiffList query parameter. Diff list pass true to fetch the diff list. Choices:
|
|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
Additional headers. |
|
Key query parameter. Extended attribute key. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
|
Value query parameter. Extended attribute value. |
Notes
Note
SDK Method used are compliance.Compliance.compliance_details_of_device,
Paths used are get /dna/intent/api/v1/compliance/{deviceUuid}/detail,
Supports
check_modeThe plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK
The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection
See Also
See also
- Cisco DNA Center documentation for Compliance ComplianceDetailsOfDevice
Complete reference of the ComplianceDetailsOfDevice API.
Examples
- name: Get all Compliance Device By Id
cisco.dnac.compliance_device_by_id_info:
dnac_host: "{{dnac_host}}"
dnac_username: "{{dnac_username}}"
dnac_password: "{{dnac_password}}"
dnac_verify: "{{dnac_verify}}"
dnac_port: "{{dnac_port}}"
dnac_version: "{{dnac_version}}"
dnac_debug: "{{dnac_debug}}"
headers: "{{my_headers | from_json}}"
category: string
complianceType: string
diffList: True
key: string
value: string
deviceUuid: 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 DNAC Python SDK Returned: always Sample: |