/ home / cisco / cisco.dnac / 6.13.3 / module / compliance_device_by_id_info

cisco.dnac.compliance_device_by_id_info (6.13.3) — module

Information module for Compliance Device By Id

| "added in version" 3.1.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Get all Compliance Device By Id.

Return compliance detailed report for a device.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- 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

Inputs

    
key:
    description:
    - Key query parameter. Extended attribute key.
    type: str

value:
    description:
    - Value query parameter. Extended attribute value.
    type: str

headers:
    description: Additional headers.
    type: dict

category:
    description:
    - Category query parameter. ComplianceCategory can have any value among 'INTENT',
      'RUNNING_CONFIG'.
    type: str

diffList:
    description:
    - DiffList query parameter. Diff list pass true to fetch the diff list.
    type: bool

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

deviceUuid:
    description:
    - DeviceUuid path parameter.
    type: str

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

complianceType:
    description:
    - 'ComplianceType query parameter. ComplianceType can have any value among ''NETWORK_DESIGN'',
      ''NETWORK_PROFILE'', ''FABRIC'', ''POLICY'', ''RUNNING_CONFIG''.

      '
    type: str

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

Outputs

dnac_response:
  description: 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"
  type: dict