cisco.dnac.device_details_info 模块 – 设备详细信息信息模块
注意
此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。
如果您使用的是 ansible
包,则可能已经安装了此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用: ansible-galaxy collection install cisco.dnac
。您需要其他要求才能使用此模块,请参阅 需求 以了解详情。
要在 playbook 中使用它,请指定: cisco.dnac.device_details_info
。
cisco.dnac 3.1.0 中的新增功能
概要
此模块表示模块 device_details_v1_info 的别名
注意
此模块具有相应的 action 插件。
需求
在执行此模块的主机上需要以下需求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
---|---|
用于 Cisco DNA Center SDK 的标志,用于启用调试。 选项
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认值: |
|
用于身份验证的 Cisco DNA Center 用户名。 默认值: |
|
启用或禁用 SSL 证书验证的标志。 选项
|
|
告知 SDK 使用哪个版本的 Cisco DNA Center。 默认值: |
|
附加的 headers。 |
|
标识符查询参数。“macAddress”、“nwDeviceName”、“uuid”(不区分大小写)之一。 |
|
SearchBy 查询参数。网络设备的 MAC 地址、设备名称或 UUID。 |
|
时间戳查询参数。设备数据的 UTC 时间戳(毫秒)。 |
|
用于 Cisco DNA Center SDK 的标志,用于启用针对 JSON 架构的请求主体的验证。 选项
|
注释
注意
使用的 SDK 方法是 devices.Devices.get_device_detail_v1,
使用的路径是 get /dna/intent/api/v1/device-detail,
需要注意的是,此模块是 device_details_v1_info 的别名
支持
check_mode
插件在控制节点上运行,不使用任何 Ansible 连接插件,而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco DNA Center 设备 GetDeviceDetailV1 文档
GetDeviceDetailV1 API 的完整参考。
示例
- name: Get all Device Details Info
cisco.dnac.device_details_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}}"
timestamp: 0
identifier: string
searchBy: string
register: result
返回值
常见的返回值已在 此处 记录,以下是此模块特有的字段
键 |
描述 |
---|---|
包含 Cisco DNAC Python SDK 返回的响应的字典或列表 返回值:始终 示例: |