cisco.meraki.networks_switch_stacks_routing_interfaces_dhcp 模块 – 用于 networks _switch _stacks _routing _interfaces _dhcp 的资源模块
注意
此模块是 cisco.meraki 集合（版本 2.18.3）的一部分。
如果您正在使用 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.meraki。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。
要在 playbook 中使用它，请指定：cisco.meraki.networks_switch_stacks_routing_interfaces_dhcp。
cisco.meraki 2.16.0 中的新功能
概要
管理资源 networks _switch _stacks _routing _interfaces _dhcp 的操作更新。
更新交换机堆叠的第 3 层接口 DHCP 配置。
注意
此模块有一个对应的 操作插件。
要求
执行此模块的主机上需要以下要求。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
在交换机堆叠接口上运行的 DHCP 服务器的 PXE 引导服务器文件名。 |
|
在交换机堆叠接口上运行的 DHCP 服务器的 PXE 引导服务器 IP。 |
|
启用 DHCP 引导选项，为在交换机堆叠接口上运行的 DHCP 服务器提供 PXE 引导选项配置。 选择
|
|
在交换机堆叠接口上运行的 DHCP 服务器的 DHCP 租约时间配置（“30 分钟”、“1 小时”、“4 小时”、“12 小时”、“1 天”或“1 周”）。 |
|
交换机堆叠接口的 DHCP 模式选项（“dhcpDisabled”、“dhcpRelay”或“dhcpServer”）。 |
|
由代码、类型和值组成的 DHCP 选项数组，用于在交换机堆叠接口上运行的 DHCP 服务器。 |
|
DHCP 选项的代码，应为 2 到 254。 |
|
DHCP 选项的类型，应为（“text”、“ip”、“integer”或“hex”）之一。 |
|
DHCP 选项的值。 |
|
DHCP 中继服务器 IP，DHCP 数据包将中继到这些 IP 以用于交换机堆叠接口。 |
|
当 DHCP 名称服务器选项为“custom”时，DHCP 名称服务器 IP。 |
|
在交换机堆叠接口上运行的 DHCP 服务器的 DHCP 名称服务器选项（“googlePublicDns”、“openDns”或“custom”）。 |
|
在交换机堆叠接口上运行的 DHCP 服务器的 DHCP 固定 IP 分配数组。 |
|
已为其分配固定 IP 地址的客户端的 IP 地址。 |
|
具有固定 IP 地址的客户端的 MAC 地址。 |
|
具有固定 IP 地址的客户端的名称。 |
|
InterfaceId 路径参数。接口 ID。 |
|
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 (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。 |
|
在交换机堆栈接口上运行的 DHCP 服务器的 DHCP 保留 IP 分配数组。 |
|
保留 IP 范围的注释。 |
|
保留 IP 范围的结束 IP 地址。 |
|
保留 IP 范围的起始 IP 地址。 |
|
SwitchStackId 路径参数。交换机堆栈 ID。 |
注意
注意
使用的 SDK 方法是 switch.Switch.update_network_switch_stack_routing_interface_dhcp,
使用的路径是 put /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}/dhcp,
不支持
check_mode该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中嵌入的连接管理器。
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。
另请参阅
另请参阅
- Cisco Meraki 文档，了解 switch updateNetworkSwitchStackRoutingInterfaceDhcp
updateNetworkSwitchStackRoutingInterfaceDhcp API 的完整参考。
示例
- name: Update all
cisco.meraki.networks_switch_stacks_routing_interfaces_dhcp:
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
bootFileName: home_boot_file
bootNextServer: 1.2.3.4
bootOptionsEnabled: true
dhcpLeaseTime: 1 day
dhcpMode: dhcpServer
dhcpOptions:
- code: '5'
type: text
value: five
dhcpRelayServerIps:
- 1.2.3.4
dnsCustomNameservers:
- 8.8.8.8, 8.8.4.4
dnsNameserversOption: custom
fixedIpAssignments:
- ip: 192.168.1.12
mac: 22:33:44:55:66:77
name: Cisco Meraki valued client
interfaceId: string
networkId: string
reservedIpRanges:
- comment: A reserved IP range
end: 192.168.1.10
start: 192.168.1.1
switchStackId: string
返回值
常见返回值记录在这里，以下是此模块独有的字段。
键 |
描述 |
|---|---|
一个字典或列表，包含 Cisco Meraki Python SDK 返回的响应。 返回： 总是 示例： |