cisco.dnac.wireless_controllers_ssid_details_v1_info 模块 – 无线控制器 Ssid 详细信息 V1 的信息模块
注意
此模块是 cisco.dnac 集合（版本 6.25.0）的一部分。
如果您使用的是 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要满足进一步的要求才能使用此模块，请参阅 要求 了解详细信息。
要在 playbook 中使用它，请指定：cisco.dnac.wireless_controllers_ssid_details_v1_info。
cisco.dnac 6.15.0 中的新功能
概要
获取所有无线控制器 Ssid 详细信息 V1。
检索与特定无线控制器关联的 SSID 的所有详细信息。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要满足以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
AdminStatus 查询参数。使用此查询参数获取管理状态。 “true” 值表示 SSID 的管理状态已启用，而 “false” 值表示 SSID 的管理状态已禁用。 选择
|
|
用于 Cisco DNA Center SDK 启用调试的标志。 选择
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认值： |
|
用于身份验证的 Cisco DNA Center 用户名。 默认值： |
|
启用或禁用 SSL 证书验证的标志。 选择
|
|
通知 SDK 使用哪个版本的 Cisco DNA Center。 默认值： |
|
其他标头。 |
|
限制查询参数。此页面要显示的记录数。 |
|
Managed 查询参数。如果值为 “true”，则表示 SSID 通过设计进行配置。如果值为 “false”，则表示来自无线控制器的带外配置。 选择
|
|
NetworkDeviceId 路径参数。通过使用 API 调用 GET /dna/intent/api/v1/network-device/ip-address/${ipAddress} 获取网络设备 ID 值。 |
|
偏移量查询参数。此页面要显示的第一个记录；第一个记录编号为 1。 |
|
SsidName 查询参数。使用此查询参数获取与提供的 SSID 名称对应的 SSID 的详细信息。 |
|
用于 Cisco DNA Center SDK 启用针对 JSON 模式验证请求主体的标志。 选择
|
备注
注意
使用的 SDK 方法为 wireless.Wireless.get_ssid_details_for_specific_wireless_controller_v1，
使用的路径为 get /dna/intent/api/v1/wirelessControllers/{networkDeviceId}/ssidDetails，
支持
check_mode该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- 有关无线 GetSSIDDetailsForSpecificWirelessControllerV1 的 Cisco DNA Center 文档
GetSSIDDetailsForSpecificWirelessControllerV1 API 的完整参考。
示例
- name: Get all Wireless Controllers Ssid Details V1
cisco.dnac.wireless_controllers_ssid_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}}"
ssidName: string
adminStatus: True
managed: True
limit: 0
offset: 0
networkDeviceId: string
register: result
返回值
常见返回值记录在此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
包含 Cisco DNAC Python SDK 返回的响应的字典或列表 已返回：始终 示例： |