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.2.1).

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.

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

New in version 3.1.0: of cisco.dnac

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

  • python >= 3.5

Parameters

Parameter

Comments

category

string

Category query parameter. ComplianceCategory can have any value among ‘INTENT’, ‘RUNNING_CONFIG’.

complianceType

string

ComplianceType query parameter. ComplianceType can have any value among ‘NETWORK_DESIGN’, ‘NETWORK_PROFILE’, ‘FABRIC’, ‘POLICY’, ‘RUNNING_CONFIG’.

deviceUuid

string

DeviceUuid path parameter.

diffList

boolean

DiffList query parameter. Diff list pass true to fetch the diff list.

Choices:

  • no

  • yes

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • no ← (default)

  • yes

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: “admin”

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • no

  • yes ← (default)

dnac_version

string

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

Default: “2.2.3.3”

headers

dictionary

Additional headers.

key

string

Key query parameter. Extended attribute key.

validate_response_schema

boolean

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

Choices:

  • no

  • yes ← (default)

value

string

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_mode

  • The 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

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:
      custom: value
    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

dnac_response

dictionary

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

Returned: always

Sample: “{\n \”deviceUuid\”: \”string\”,\n \”version\”: \”string\”,\n \”response\”: [\n {\n \”displayName\”: \”string\”,\n \”complianceType\”: \”string\”,\n \”lastSyncTime\”: 0,\n \”additionalDataURL\”: \”string\”,\n \”sourceInfoList\”: [\n {\n \”count\”: 0,\n \”displayName\”: \”string\”,\n \”diffList\”: [\n {\n \”displayName\”: \”string\”,\n \”moveFromPath\”: \”string\”,\n \”op\”: \”string\”,\n \”configuredValue\”: \”string\”,\n \”intendedValue\”: \”string\”,\n \”path\”: \”string\”,\n \”businessKey\”: \”string\”,\n \”extendedAttributes\”: \”string\”\n }\n ],\n \”sourceEnum\”: \”string\”,\n \”licenseAppName\”: \”string\”,\n \”provisioningArea\”: \”string\”,\n \”networkProfileName\”: \”string\”,\n \”nameWithBusinessKey\”: \”string\”,\n \”appName\”: \”string\”,\n \”name\”: \”string\”,\n \”type\”: \”string\”,\n \”businessKey\”: {\n \”otherAttributes\”: {\n \”cfsAttributes\”: \”string\”,\n \”name\”: \”string\”\n },\n \”resourceName\”: \”string\”,\n \”businessKeyAttributes\”: \”string\”\n }\n }\n ],\n \”deviceUuid\”: \”string\”,\n \”message\”: \”string\”,\n \”state\”: \”string\”,\n \”status\”: \”string\”,\n \”category\”: \”string\”,\n \”lastUpdateTime\”: 0\n }\n ]\n}\n”

Authors

  • Rafael Campos (@racampos)