cisco.dnac.compliance_device_info 模块 – 合规设备信息的信息模块

注意

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

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

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

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

cisco.dnac 3.1.0 中的新增功能

概要

  • 此模块表示模块 compliance_device_v1_info 的别名

注意

此模块具有相应的 操作插件

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

complianceStatus

字符串

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

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

字典

其他标头。

validate_response_schema

布尔值

Cisco DNA Center SDK 用于启用针对 JSON 架构验证请求正文的标志。

选择

  • false

  • true ← (默认)

注释

注意

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

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

  • 应该注意的是,此模块是 compliance_device_v1_info 的别名

  • 支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 关于合规性 GetComplianceStatusV1 的文档

GetComplianceStatusV1 API 的完整参考。

示例

- name: Get all Compliance Device Info
  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: "{{my_headers | from_json}}"
    complianceStatus: string
    deviceUuid: string
  register: result

返回值

常用返回值记录在这里,以下是此模块独有的字段

描述

dnac_response

字典

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

返回:始终

示例: {"response": [{"complianceStatus": "string", "deviceUuid": "string", "lastUpdateTime": 0, "message": "string", "scheduleTime": 0}], "version": "string"}

作者

  • Rafael Campos (@racampos)