cisco.dnac.wireless_enterprise_ssid_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_enterprise_ssid_v1_info

cisco.dnac 3.1.0 中的新增功能

概要

  • 获取所有无线企业 SSID V1。

  • 获取企业 SSID。

注意

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

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

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

字典

其他标头。

ssidName

字符串

SsidName 查询参数。输入需要检索的企业 SSID 名称。如果未输入,将检索所有企业 SSID。

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 启用针对 JSON 架构验证请求体的标志。

选择

  • false

  • true ← (默认)

注释

注意

  • 使用的 SDK 方法为 wireless.Wireless.get_enterprise_ssid_v1,

  • 使用的路径为 get /dna/intent/api/v1/enterprise-ssid,

  • 支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 文档,了解 Wireless GetEnterpriseSSIDV1

GetEnterpriseSSIDV1 API 的完整参考。

示例

- name: Get all Wireless Enterprise Ssid V1
  cisco.dnac.wireless_enterprise_ssid_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
  register: result

返回值

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

描述

dnac_response

列表 / elements=字典

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

返回:始终

示例: "[\n  {\n    \"instanceUuid\": \"string\",\n    \"version\": 0,\n    \"ssidDetails\": [\n      {\n        \"name\": \"string\",\n        \"wlanType\": \"string\",\n        \"enableFastLane\": true,\n        \"securityLevel\": \"string\",\n        \"authServer\": \"string\",\n        \"passphrase\": \"string\",\n        \"trafficType\": \"string\",\n        \"enableMACFiltering\": true,\n        \"isEnabled\": true,\n        \"isFabric\": true,\n        \"fastTransition\": \"string\",\n        \"radioPolicy\": \"string\",\n        \"enableBroadcastSSID\": true,\n        \"nasOptions\": [\n          \"string\"\n        ],\n        \"aaaOverride\": true,\n        \"coverageHoleDetectionEnable\": true,\n        \"protectedManagementFrame\": \"string\",\n        \"multiPSKSettings\": [\n          {\n            \"priority\": 0,\n            \"passphraseType\": \"string\",\n            \"passphrase\": \"string\"\n          }\n        ],\n        \"clientRateLimit\": 0,\n        \"enableSessionTimeOut\": true,\n        \"sessionTimeOut\": 0,\n        \"enableClientExclusion\": true,\n        \"clientExclusionTimeout\": 0,\n        \"enableBasicServiceSetMaxIdle\": true,\n        \"basicServiceSetClientIdleTimeout\": 0,\n        \"enableDirectedMulticastService\": true,\n        \"enableNeighborList\": true,\n        \"mfpClientProtection\": \"string\"\n      }\n    ],\n    \"groupUuid\": \"string\",\n    \"inheritedGroupUuid\": \"string\",\n    \"inheritedGroupName\": \"string\"\n  }\n]\n"

作者

  • Rafael Campos (@racampos)