cisco.dnac.compliance_device_info – Information module for Compliance Device

Note

This plugin is part of the cisco.dnac collection (version 3.1.6).

To install it use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.compliance_device_info.

New in version 1.0.0: of cisco.dnac

Synopsis

  • Get all Compliance Device.

  • Get Compliance Device by id.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk

Parameters

Parameter Choices/Defaults Comments
complianceStatus
string
ComplianceStatus query parameter. Compliance status can be have value among 'COMPLIANT','NON_COMPLIANT','IN_PROGRESS', 'ERROR'.
deviceUuid
string
DeviceUuid query parameter. Comma separated deviceUuids.
headers
dictionary
Additional headers.
limit
integer
Limit query parameter. Number of records to be retrieved.
offset
integer
Offset query parameter. Offset/starting row.

See Also

See also

Compliance Device reference

Complete reference of the Compliance Device object model.

Examples

- name: Get all Compliance Device
  cisco.dnac.compliance_device_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:
      custom: value
    complianceStatus: string
    deviceUuid: string
    offset: 0
    limit: 0
  register: result

- name: Get Compliance Device by id
  cisco.dnac.compliance_device_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:
      custom: value
    deviceUuid: string
  register: result

Return Values

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

Key Returned Description
dnac_response
dictionary
always
A dictionary or list with the response returned by the Cisco DNAC Python SDK

Sample:
{ "version": "string", "response": { "deviceUuid": "string", "complianceStatus": "string", "message": "string", "scheduleTime": 0, "lastUpdateTime": 0 } }


Authors

  • Rafael Campos (@racampos)