cisco.dnac.compliance_device_details_v1_info 模块 – 用于合规设备详细信息 V1 的信息模块

注意

此模块是 cisco.dnac 集合(版本 6.25.0)的一部分。

如果您使用的是 ansible 包,您可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用:ansible-galaxy collection install cisco.dnac。您需要进一步的要求才能使用此模块,请参阅 要求 以了解详细信息。

要在 playbook 中使用它,请指定:cisco.dnac.compliance_device_details_v1_info

cisco.dnac 3.1.0 中的新增功能

概要

  • 获取所有合规设备详细信息 V1。

  • 返回合规详细信息。

注意

此模块具有相应的 action 插件

要求

在执行此模块的主机上需要以下要求。

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

complianceStatus

字符串

ComplianceStatus 查询参数。以逗号分隔指定“合规状态”。合规状态可以是 ‘COMPLIANT’、‘NON_COMPLIANT’、‘IN_PROGRESS’、‘NOT_AVAILABLE’、‘NOT_APPLICABLE’、‘ERROR’。

complianceType

字符串

ComplianceType 查询参数。以逗号分隔指定“合规类型”。合规类型可以是 ‘NETWORK_PROFILE’、‘IMAGE’、‘FABRIC’、‘APPLICATION_VISIBILITY’、‘FABRIC’、RUNNING_CONFIG’、‘NETWORK_SETTINGS’、‘WORKFLOW’、‘EOX’。

deviceUuid

字符串

DeviceUuid 查询参数。逗号分隔的“设备 ID”。

dnac_debug

布尔值

用于 Cisco DNA Center SDK 启用调试的标志。

选择

  • false ← (默认)

  • true

dnac_host

字符串 / 必填

Cisco DNA Center 主机名。

dnac_password

字符串

用于身份验证的 Cisco DNA Center 密码。

dnac_port

整数

Cisco DNA Center 端口。

默认: 443

dnac_username

别名:user

字符串

用于身份验证的 Cisco DNA Center 用户名。

默认: "admin"

dnac_verify

布尔值

用于启用或禁用 SSL 证书验证的标志。

选择

  • false

  • true ← (默认)

dnac_version

字符串

告知 SDK 要使用的 Cisco DNA Center 版本。

默认: "2.3.7.6"

headers

字典

其他标头。

limit

浮点数

限制查询参数。要检索的记录数。

offset

浮点数

偏移查询参数。偏移/起始行。

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 启用根据 JSON 模式验证请求主体的标志。

选择

  • false

  • true ← (默认)

说明

注意

  • 使用的 SDK 方法是 compliance.Compliance.get_compliance_detail_v1,

  • 使用的路径是 get /dna/intent/api/v1/compliance/detail,

  • 支持 check_mode

  • 该插件在控制节点上运行,不使用任何 Ansible 连接插件,而是使用 Cisco DNAC SDK 中的嵌入式连接管理器

  • 以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅

另请参阅

Cisco DNA Center 文档,了解 Compliance GetComplianceDetailV1

GetComplianceDetailV1 API 的完整参考。

示例

- name: Get all Compliance Device Details V1
  cisco.dnac.compliance_device_details_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}}"
    complianceType: string
    complianceStatus: string
    deviceUuid: string
    offset: 0
    limit: 0
  register: result

返回值

常见返回值记录在 此处,以下是此模块独有的字段

描述

dnac_response

字典

一个字典或列表,包含 Cisco DNAC Python SDK 返回的响应。

返回: 总是

示例: {"response": [{"category": "string", "complianceType": "string", "deviceUuid": "string", "displayName": "string", "lastSyncTime": 0, "lastUpdateTime": 0, "state": "string", "status": "string"}], "version": "string"}

作者

  • Rafael Campos (@racampos)