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。您需要其他要求才能使用此模块，请参阅 要求了解详情。
要在剧本中使用它，请指定： 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。 默认值： |
|
附加的头部。 |
|
Limit 查询参数。此页要显示的记录数。 |
|
Managed 查询参数。如果值为“true”，则表示SSID是通过设计配置的。如果值为“false”，则表示来自无线控制器的带外配置。 选项
|
|
NetworkDeviceId 路径参数。通过使用API调用GET /dna/intent/api/v1/network-device/ip-address/${ipAddress}获取网络设备ID值。 |
|
Offset 查询参数。此页要显示的第一条记录；第一条记录编号为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用于建立连接
另请参阅
另请参阅
- Cisco DNA Center关于无线GetSSIDDetailsForSpecificWirelessControllerV1的文档
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返回的响应的字典或列表 返回：始终 示例： |