cisco.catalystcenter.compliance_device_info module -- Information module for Compliance Device

Note

This module is part of the cisco.catalystcenter collection (version 2.2.2).

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_device_info.

New in cisco.catalystcenter 3.1.0

Synopsis

  • Get all Compliance Device.

  • Return compliance status of devices.

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 3.1.3.0.0

  • python >= 3.5

Parameters

Parameter

Comments

catalystcenter_api_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catalystcenter_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_username

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catalystcenter_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

string

Informs the SDK which version of Cisco Catalyst Center to use.

Default: :ansible-option-default:`"2.3.7.6"`

complianceStatus

string

ComplianceStatus query parameter. Specify "Compliance status(es)" separated by commas. The Compliance status can be 'COMPLIANT', 'NON_COMPLIANT', 'IN_PROGRESS', 'NOT_AVAILABLE', 'NOT_APPLICABLE', 'ERROR'.

deviceUuid

string

DeviceUuid query parameter. Comma separated 'Device Ids'.

headers

dictionary

Additional headers.

limit

float

Limit query parameter. The number of records to be retrieved defaults to 500 if not specified, with a maximum allowed limit of 500.

offset

float

Offset query parameter. Offset/starting row number.

validate_response_schema

boolean

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

Choices:

Notes

Note

  • SDK Method used are compliance.Compliance.get_compliance_status,

  • Paths used are get /dna/intent/api/v1/compliance,

  • 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

See Also

See also

Cisco DNA Center documentation for Compliance GetComplianceStatus

Complete reference of the GetComplianceStatus API.

Examples

---
- name: Get all Compliance Device
  cisco.catalystcenter.compliance_device_info:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_api_port: "{{catalystcenter_api_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    headers: "{{my_headers | from_json}}"
    complianceStatus: string
    deviceUuid: string
    offset: 0
    limit: 0
  register: result

Return Values

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

Key

Description

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco CATALYST Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": [{"complianceStatus": "string", "deviceUuid": "string", "lastUpdateTime": 0, "message": "string", "scheduleTime": 0}], "version": "string"}`

Authors

  • Rafael Campos (@racampos)