cisco.meraki.networks_wireless_ssids_info 模块 – 网络 _wireless _ssids 的信息模块
注意
此模块是 cisco.meraki 集合(版本 2.18.3)的一部分。
如果您使用的是 ansible
包,则可能已经安装了此集合。它不包含在 ansible-core
中。要检查是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install cisco.meraki
。您需要进一步的要求才能使用此模块,请参阅 要求 了解详细信息。
要在 playbook 中使用它,请指定:cisco.meraki.networks_wireless_ssids_info
。
cisco.meraki 2.16.0 中的新功能
概要
获取所有网络 _wireless _ssids。
按 ID 获取网络 _wireless _ssids。
列出网络中的 MR SSID。
返回单个 MR SSID。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机上需要以下要求。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
---|---|
其他标头。 |
|
meraki_action_batch_retry_wait_time (integer),操作批处理并发错误重试等待时间 默认: |
|
meraki_api_key (string),在仪表板中生成的 API 密钥;也可以设置为环境变量 MERAKI_DASHBOARD_API_KEY |
|
meraki_base_url (string),所有端点资源的前缀 默认: |
|
meraki_be_geo_id (string),用于 API 使用情况跟踪的可选合作伙伴标识符;也可以设置为环境变量 BE_GEO_ID 默认: |
|
meraki_caller (string),用于 API 使用情况跟踪的可选标识符;也可以设置为环境变量 MERAKI_PYTHON_SDK_CALLER 默认: |
|
meraki_certificate_path (string),如果位于本地代理之后,则用于 TLS/SSL 证书验证的路径 默认: |
|
meraki_inherit_logging_config (boolean),继承您自己的记录器实例 选择
|
|
meraki_log_file_prefix (string),附加日期和时间戳的日志文件名 默认: |
|
log_path (string),输出日志的路径;如果未指定,则默认为脚本的工作目录 默认: |
|
meraki_maximum_retries (integer),遇到 429 或其他服务器端错误时,最多重试这么多次 默认: |
|
meraki_nginx_429_retry_wait_time (integer),Nginx 429 重试等待时间 默认: |
|
meraki_output_log (boolean),创建一个输出日志文件? 选择
|
|
meraki_print_console (boolean),将日志输出打印到控制台? 选择
|
|
meraki_requests_proxy (string),如果需要,HTTPS 的代理服务器和端口 默认: |
|
meraki_retry_4xx_error (boolean),如果遇到其他 4XX 错误(429 除外),是否重试? 选择
|
|
meraki_retry_4xx_error_wait_time (integer),其他 4XX 错误重试等待时间 默认: |
|
meraki_simulate (boolean),模拟 POST/PUT/DELETE 调用以防止更改? 选择
|
|
meraki_single_request_timeout (integer),每次 API 调用的最大秒数 默认: |
|
meraki_suppress_logging (boolean),禁用所有日志记录?那就靠你自己了! 选择
|
|
meraki_use_iterator_for_get_pages (boolean),list* 方法将返回一个迭代器,其中包含每个对象,而不是包含所有项的完整列表 选择
|
|
meraki_wait_on_rate_limit (boolean),如果遇到 429 速率限制错误,是否重试? 选择
|
|
NetworkId 路径参数。网络 ID。 |
|
Number 路径参数。 |
注意
注意
使用的 SDK 方法是 wireless.Wireless.get_network_wireless_ssid、wireless.Wireless.get_network_wireless_ssids,
使用的路径是 get /networks/{networkId}/wireless/ssids,get /networks/{networkId}/wireless/ssids/{number},
支持
check_mode
该插件在控制节点上运行,不使用任何 ansible 连接插件,而是使用 Cisco Meraki SDK 中的嵌入式连接管理器
以 meraki_ 开头的参数由 Cisco Meraki Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco Meraki 无线 getNetworkWirelessSsid 文档
getNetworkWirelessSsid API 的完整参考。
- Cisco Meraki 无线 getNetworkWirelessSsids 文档
getNetworkWirelessSsids API 的完整参考。
示例
- name: Get all networks _wireless _ssids
cisco.meraki.networks_wireless_ssids_info:
meraki_api_key: "{{meraki_api_key}}"
meraki_base_url: "{{meraki_base_url}}"
meraki_single_request_timeout: "{{meraki_single_request_timeout}}"
meraki_certificate_path: "{{meraki_certificate_path}}"
meraki_requests_proxy: "{{meraki_requests_proxy}}"
meraki_wait_on_rate_limit: "{{meraki_wait_on_rate_limit}}"
meraki_nginx_429_retry_wait_time: "{{meraki_nginx_429_retry_wait_time}}"
meraki_action_batch_retry_wait_time: "{{meraki_action_batch_retry_wait_time}}"
meraki_retry_4xx_error: "{{meraki_retry_4xx_error}}"
meraki_retry_4xx_error_wait_time: "{{meraki_retry_4xx_error_wait_time}}"
meraki_maximum_retries: "{{meraki_maximum_retries}}"
meraki_output_log: "{{meraki_output_log}}"
meraki_log_file_prefix: "{{meraki_log_file_prefix}}"
meraki_log_path: "{{meraki_log_path}}"
meraki_print_console: "{{meraki_print_console}}"
meraki_suppress_logging: "{{meraki_suppress_logging}}"
meraki_simulate: "{{meraki_simulate}}"
meraki_be_geo_id: "{{meraki_be_geo_id}}"
meraki_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
networkId: string
register: result
- name: Get networks _wireless _ssids by id
cisco.meraki.networks_wireless_ssids_info:
meraki_api_key: "{{meraki_api_key}}"
meraki_base_url: "{{meraki_base_url}}"
meraki_single_request_timeout: "{{meraki_single_request_timeout}}"
meraki_certificate_path: "{{meraki_certificate_path}}"
meraki_requests_proxy: "{{meraki_requests_proxy}}"
meraki_wait_on_rate_limit: "{{meraki_wait_on_rate_limit}}"
meraki_nginx_429_retry_wait_time: "{{meraki_nginx_429_retry_wait_time}}"
meraki_action_batch_retry_wait_time: "{{meraki_action_batch_retry_wait_time}}"
meraki_retry_4xx_error: "{{meraki_retry_4xx_error}}"
meraki_retry_4xx_error_wait_time: "{{meraki_retry_4xx_error_wait_time}}"
meraki_maximum_retries: "{{meraki_maximum_retries}}"
meraki_output_log: "{{meraki_output_log}}"
meraki_log_file_prefix: "{{meraki_log_file_prefix}}"
meraki_log_path: "{{meraki_log_path}}"
meraki_print_console: "{{meraki_print_console}}"
meraki_suppress_logging: "{{meraki_suppress_logging}}"
meraki_simulate: "{{meraki_simulate}}"
meraki_be_geo_id: "{{meraki_be_geo_id}}"
meraki_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
networkId: string
number: string
register: result
返回值
通用返回值记录在此处,以下是此模块特有的字段
键 |
描述 |
---|---|
一个字典或列表,其中包含 Cisco Meraki Python SDK 返回的响应 返回:始终 示例: |