cisco.dnac.wireless_controllers_ssid_details_count_info 模块 – 无线控制器SSID详细信息计数信息模块

注意

此模块是 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_count_info。

cisco.dnac 6.15.0 中的新增功能

概要

  • 此模块表示模块 wireless_controllers_ssid_details_count_v1_info 的别名。

注意

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

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

adminStatus

布尔值

AdminStatus 查询参数。使用此查询参数根据SSID的管理状态获取SSID的数量。“true”值表示SSID的管理状态已启用，“false”值表示SSID的管理状态已禁用。

选项

  • false

  • true

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

字典

附加标头。

managed

布尔值

Managed 查询参数。如果值为“true”，则表示通过设计配置了SSID。如果值为“false”，则表示无线控制器的带外配置。

选项

  • false

  • true

networkDeviceId

字符串

NetworkDeviceId 路径参数。使用 API 调用 GET /dna/intent/api/v1/network-device/ip-address/${ipAddress} 获取 network device ID 值。

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 的标志，用于启用根据 JSON 模式验证请求正文。

选项

  • false

  • true ← (默认)

备注

注意

  • 使用的 SDK 方法为 wireless.Wireless.get_ssid_count_for_specific_wireless_controller_v1，

  • 使用的路径为 get /dna/intent/api/v1/wirelessControllers/{networkDeviceId}/ssidDetails/count，

  • 需要注意的是，此模块是 wireless_controllers_ssid_details_count_v1_info 的别名。

  • 支持 check_mode

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

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

另请参见

另请参见

Cisco DNA Center 无线 GetSSIDCountForSpecificWirelessControllerV1 文档

GetSSIDCountForSpecificWirelessControllerV1 API 的完整参考。

示例

- name: Get all Wireless Controllers Ssid Details Count Info
  cisco.dnac.wireless_controllers_ssid_details_count_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}}"
    adminStatus: True
    managed: True
    networkDeviceId: string
  register: result

返回值

常见的返回值已记录在 此处，以下是此模块独有的字段。

键

描述

dnac_response

字典

包含 Cisco DNAC Python SDK 返回的响应的字典或列表。

返回：始终

示例： {"response": {"count": 0}, "version": "string"}

作者

  • Rafael Campos (@racampos)