cisco.dnac.compliance_device_by_id_v1_info module – Information module for Compliance Device By Id V1
Note
This module is part of the cisco.dnac collection (version 6.27.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_v1_info.
New in cisco.dnac 3.1.0
Synopsis
Get all Compliance Device By Id V1.
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.4.9
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
Category query parameter. Category can have any value among ‘INTENT’, ‘RUNNING_CONFIG’ , ‘IMAGE’ , ‘PSIRT’ , ‘DESIGN_OOD’ , ‘EOX’ , ‘NETWORK_SETTINGS’. |
|
ComplianceType query parameter. Specify “Compliance type(s)” separated by commas. The Compliance type can be ‘APPLICATION_VISIBILITY’, ‘EOX’, ‘FABRIC’, ‘IMAGE’, ‘NETWORK_PROFILE’, ‘NETWORK_SETTINGS’, ‘PSIRT’, ‘RUNNING_CONFIG’, ‘WORKFLOW’. |
|
DeviceUuid path parameter. Device Id. |
|
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. |
|
RemediationSupported query parameter. The ‘remediationSupported’ parameter can be set to ‘true’ or ‘false’. The result will be a combination of both values if it is not provided. Choices:
|
|
Status query parameter. ‘COMPLIANT’, ‘NON_COMPLIANT’, ‘ERROR’, ‘IN_PROGRESS’, ‘NOT_APPLICABLE’, ‘NOT_AVAILABLE’, ‘WARNING’, ‘REMEDIATION_IN_PROGRESS’ can be the value of the compliance ‘status’ parameter. COMPLIANT Device currently meets the compliance requirements. NON_COMPLIANT One of the compliance requirements like Software Image, PSIRT, Network Profile, Startup vs Running, etc. Are not met. ERROR Compliance is unable to compute status due to underlying errors. IN_PROGRESS Compliance check is in progress for the device. NOT_APPLICABLE Device is not supported for compliance, or minimum license requirement is not met. NOT_AVAILABLE Compliance is not available for the device. COMPLIANT_WARNING The device is compliant with warning if the last date of support is nearing. REMEDIATION_IN_PROGRESS Compliance remediation is in progress for the device. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Method used are compliance.Compliance.compliance_details_of_device_v1,
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 ComplianceDetailsOfDeviceV1
Complete reference of the ComplianceDetailsOfDeviceV1 API.
Examples
- name: Get all Compliance Device By Id V1
cisco.dnac.compliance_device_by_id_v1_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
status: string
remediationSupported: True
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: |