cisco.meraki.networks_switch_dhcp_server_policy 模块 – 网络_交换机_dhcp服务器策略的资源模块
注意
此模块是 cisco.meraki 集合 (版本 2.18.3) 的一部分。
如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.meraki。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。
要在 playbook 中使用它，请指定：cisco.meraki.networks_switch_dhcp_server_policy。
cisco.meraki 2.16.0 中的新增功能
概要
管理资源网络_交换机_dhcp服务器策略的操作更新。
更新 DHCP 服务器设置。仅当默认策略分别为允许/阻止时，才会应用阻止/允许的服务器。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要以下要求。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
DHCP 服务器的警报设置。 |
|
DHCP 服务器的电子邮件警报设置。 |
|
启用时，如果看到新的 DHCP 服务器，则发送电子邮件。默认值为 false。 选项
|
|
列出当 defaultPolicy 设置为阻止时允许在网络上使用的 DHCP 服务器的 MAC 地址。空数组将清除条目。 |
|
动态 ARP 检查设置。 |
|
启用或禁用网络上的动态 ARP 检查。默认值为 false。 选项
|
|
列出当 defaultPolicy 设置为允许时在网络上阻止的 DHCP 服务器的 MAC 地址。空数组将清除条目。 |
|
“允许”或“阻止”新的 DHCP 服务器。默认值为“允许”。 |
|
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速率限制错误时是否重试？ 选项
|
|
NetworkId 路径参数。网络ID。 |
备注
注意
使用的SDK方法是switch.Switch.update_network_switch_dhcp_server_policy,
使用的路径是put /networks/{networkId}/switch/dhcpServerPolicy,
不支持
check_mode该插件在控制节点上运行，不使用任何Ansible连接插件，而是使用Cisco DNAC SDK的嵌入式连接管理器
以dnac_开头的参数由Cisco DNAC Python SDK用于建立连接
另见
另见
- Cisco Meraki关于switch updateNetworkSwitchDhcpServerPolicy的文档
updateNetworkSwitchDhcpServerPolicy API的完整参考。
示例
- name: Update all
cisco.meraki.networks_switch_dhcp_server_policy:
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
alerts:
email:
enabled: true
allowedServers:
- 00:50:56:00:00:01
- 00:50:56:00:00:02
arpInspection:
enabled: true
blockedServers:
- 00:50:56:00:00:03
- 00:50:56:00:00:04
defaultPolicy: block
networkId: string
返回值
常用的返回值已在 此处 记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
包含Cisco Meraki Python SDK返回的响应的字典或列表 返回：始终 示例： |