cisco.meraki.networks_wireless_settings 模块 – 网络无线设置资源模块
注意
此模块是 cisco.meraki 集合 (版本 2.18.3) 的一部分。
如果您使用的是 ansible
包,则可能已经安装了此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用: ansible-galaxy collection install cisco.meraki
。您需要其他要求才能使用此模块,请参阅 要求 获取详细信息。
要在 playbook 中使用它,请指定: cisco.meraki.networks_wireless_settings
。
cisco.meraki 2.16.0 中的新增功能
概要
管理资源网络无线设置的操作更新。
更新网络的无线设置。
注意
此模块具有相应的 action 插件。
要求
执行此模块的主机需要以下要求。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
---|---|
用于启用或禁用网络中 IPv6 桥接的开关(注意,如果启用,则还必须将 SSID 配置为使用桥接模式)。 选项
|
|
用于启用或禁用网络中所有 AP 上的 LED 灯的开关(使其处于暗态)。 选项
|
|
用于启用或禁用网络位置分析的开关。 选项
|
|
meraki_action_batch_retry_wait_time (整数),操作批处理并发错误重试等待时间 默认值: |
|
meraki_api_key (字符串),在仪表盘中生成的 API 密钥;也可以设置为环境变量 MERAKI_DASHBOARD_API_KEY |
|
meraki_base_url (字符串),位于所有端点资源之前 默认值: |
|
meraki_be_geo_id (字符串),用于 API 使用跟踪的可选合作伙伴标识符;也可以设置为环境变量 BE_GEO_ID 默认值: |
|
meraki_caller (字符串),用于 API 使用跟踪的可选标识符;也可以设置为环境变量 MERAKI_PYTHON_SDK_CALLER 默认值: |
|
meraki_certificate_path (字符串),位于本地代理后面的 TLS/SSL 证书验证的路径 默认值: |
|
meraki_inherit_logging_config (布尔值),继承您自己的日志记录器实例 选项
|
|
meraki_log_file_prefix (字符串),日志文件名后附加日期和时间戳 默认值: |
|
log_path (字符串),输出日志的路径;如果未指定,则默认为脚本的工作目录 默认值: |
|
meraki_maximum_retries (整数),遇到 429 或其他服务器端错误时,最多重试这么多次 默认值: |
|
meraki_nginx_429_retry_wait_time (整数),Nginx 429 重试等待时间 默认值: |
|
meraki_output_log (布尔值),创建输出日志文件? 选项
|
|
meraki_print_console (布尔值),将日志输出打印到控制台? 选项
|
|
meraki_requests_proxy (字符串),如果需要,用于 HTTPS 的代理服务器和端口 默认值: |
|
meraki_retry_4xx_error (布尔值),如果遇到其他 4XX 错误(除了 429)则重试? 选项
|
|
meraki_retry_4xx_error_wait_time (整数),其他 4XX 错误重试等待时间 默认值: |
|
meraki_simulate (布尔值),模拟 POST/PUT/DELETE 调用以防止更改? 选项
|
|
meraki_single_request_timeout (整数),每个 API 调用的最大秒数 默认值: |
|
meraki_suppress_logging (布尔值),禁用所有日志记录?那么您就只能自求多福了! 选项
|
|
meraki_use_iterator_for_get_pages (布尔值),list* 方法将返回一个包含每个对象的迭代器,而不是包含所有项目的完整列表 选项
|
|
meraki_wait_on_rate_limit (布尔值),如果遇到 429 速率限制错误则重试? 选项
|
|
用于启用或禁用网络中网状网络的开关。 选项
|
|
无线网络的命名 VLAN 设置。 |
|
命名 VLAN 池 DHCP 监控设置。 |
|
设备在将脏 VLAN 添加回池之前将避免使用脏 VLAN 的持续时间(以分钟为单位)。 |
|
使用命名 VLAN 池的设备是否应从池中删除脏 VLAN,从而阻止客户端被分配到无法通过 DHCP 获取 IP 地址的 VLAN。 选项
|
|
NetworkId 路径参数。网络 ID。 |
|
应用于网络的升级策略。必须是“minimizeUpgradeTime”或“minimizeClientDowntime”之一。需要固件版本 MR 26.8 或更高版本。 |
注释
注意
使用的SDK方法是wireless.Wireless.update_network_wireless_settings,
使用的路径是put /networks/{networkId}/wireless/settings,
不支持
check_mode
插件在控制节点上运行,不使用任何 Ansible 连接插件,而是使用 Cisco DNAC SDK 中的嵌入式连接管理器。
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。
另请参阅
另请参阅
- 思科 Meraki 有关 wireless updateNetworkWirelessSettings 的文档
updateNetworkWirelessSettings API 的完整参考。
示例
- name: Update all
cisco.meraki.networks_wireless_settings:
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}}"
state: present
ipv6BridgeEnabled: false
ledLightsOn: false
locationAnalyticsEnabled: false
meshingEnabled: true
namedVlans:
poolDhcpMonitoring:
duration: 5
enabled: true
networkId: string
upgradeStrategy: minimizeUpgradeTime
返回值
常见的返回值已在 此处 记录,以下是此模块特有的字段
键 |
描述 |
---|---|
包含 Cisco Meraki Python SDK 返回的响应的字典或列表 返回:始终 示例: |