cisco.dnac.sda_fabric_control_plane_device_v1_info 模块 – Sda Fabric 控制平面设备 V1 的信息模块

注意

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

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

要安装它,请使用:ansible-galaxy collection install cisco.dnac。您需要更多要求才能使用此模块,有关详细信息,请参阅要求

要在剧本中使用它,请指定:cisco.dnac.sda_fabric_control_plane_device_v1_info

cisco.dnac 3.1.0 中的新增功能

概要

  • 获取所有 Sda Fabric 控制平面设备 V1。

  • 从 SDA Fabric 获取控制平面设备。

注意

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

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

deviceManagementIpAddress

字符串

在 cisco.dnac 4.0.0 中添加

DeviceManagementIpAddress 查询参数。

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 方法是 sda.Sda.get_control_plane_device,

  • 使用的路径是 get /dna/intent/api/v1/business/sda/control-plane-device,

  • 支持 check_mode

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

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

另请参阅

另请参阅

有关 SDA GetControlPlaneDeviceFromSDAFabricV1 的 Cisco DNA Center 文档

GetControlPlaneDeviceFromSDAFabricV1 API 的完整参考。

示例

- name: Get all Sda Fabric Control Plane Device V1
  cisco.dnac.sda_fabric_control_plane_device_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}}"
    deviceManagementIpAddress: string
  register: result

返回值

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

描述

dnac_response

字典

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

已返回:始终

示例:{"description": "string", "deviceManagementIpAddress": "string", "deviceName": "string", "roles": "string", "routeDistributionProtocol": "string", "siteNameHierarchy": "string", "status": "string"}

作者

  • Rafael Campos (@racampos)