cisco.dnac.sda_port_channels_info 模块 – 用于获取 Sda 端口通道信息的模块
注意
此模块是 cisco.dnac 集合(版本 6.25.0)的一部分。
如果您使用的是 ansible
包,您可能已经安装了此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用: ansible-galaxy collection install cisco.dnac
。您需要进一步的要求才能使用此模块,详情请参阅 要求。
要在 playbook 中使用它,请指定: cisco.dnac.sda_port_channels_info
。
cisco.dnac 6.15.0 中的新增功能
概要
此模块表示模块 sda_port_channels_v1_info 的别名
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要满足以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
---|---|
ConnectedDeviceType 查询参数。端口通道的连接设备类型。允许的值为 TRUNK、EXTENDED_NODE。 |
|
Cisco DNA Center SDK 的标志,用于启用调试。 选择
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认: |
|
用于身份验证的 Cisco DNA Center 用户名。 默认: |
|
用于启用或禁用 SSL 证书验证的标志。 选择
|
|
通知 SDK 使用哪个版本的 Cisco DNA Center。 默认: |
|
FabricId 查询参数。设备分配到的 Fabric 的 ID。 |
|
其他标头。 |
|
Limit 查询参数。要返回的最大记录数。 |
|
NetworkDeviceId 查询参数。网络设备的 ID。 |
|
Offset 查询参数。用于分页的起始记录。 |
|
PortChannelName 查询参数。端口通道的名称。 |
|
Cisco DNA Center SDK 的标志,用于启用针对 JSON 架构验证请求正文。 选择
|
注释
注意
使用的 SDK 方法是 sda.Sda.get_port_channels_v1,
使用的路径是 get /dna/intent/api/v1/sda/portChannels,
应该注意的是,此模块是 sda_port_channels_v1_info 的别名
支持
check_mode
该插件在控制节点上运行,不使用任何 ansible 连接插件,而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- 有关 SDA GetPortChannelsV1 的 Cisco DNA Center 文档
GetPortChannelsV1 API 的完整参考。
示例
- name: Get all Sda Port Channels Info
cisco.dnac.sda_port_channels_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}}"
fabricId: string
networkDeviceId: string
portChannelName: string
connectedDeviceType: string
offset: 0
limit: 0
register: result
返回值
常见的返回值记录在 此处,以下是此模块独有的字段
键 |
描述 |
---|---|
包含 Cisco DNAC Python SDK 返回的响应的字典或列表 返回: 始终 示例: |