cisco.meraki.devices_switch_routing_interfaces_dhcp 模块 – 设备_交换机_路由_接口_dhcp 资源模块

注意

此模块是 cisco.meraki 集合 (版本 2.18.3) 的一部分。

如果您使用的是 ansible 包,则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用: ansible-galaxy collection install cisco.meraki。您需要其他要求才能使用此模块,有关详细信息,请参见 要求

要在 playbook 中使用它,请指定: cisco.meraki.devices_switch_routing_interfaces_dhcp

cisco.meraki 2.16.0 中的新增功能

摘要

  • 管理资源设备_交换机_路由_接口_dhcp 的操作更新。

  • 更新交换机的 3 层接口 DHCP 配置。

注意

此模块具有相应的 动作插件

要求

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

  • meraki >= 2.4.9

  • python >= 3.5

参数

参数

注释

bootFileName

字符串

交换机接口上运行的 DHCP 服务器的 PXE 启动服务器文件名。

bootNextServer

字符串

交换机接口上运行的 DHCP 服务器的 PXE 启动服务器 IP。

bootOptionsEnabled

布尔值

启用 DHCP 启动选项,以提供交换机接口上运行的 dhcp 服务器的 PXE 启动选项配置。

选项

  • false

  • true

dhcpLeaseTime

字符串

交换机接口上运行的 dhcp 服务器的 DHCP 租期配置('30 分钟'、'1 小时'、'4 小时'、'12 小时'、'1 天' 或 '1 周')。

dhcpMode

字符串

交换机接口的 DHCP 模式选项('dhcpDisabled'、'dhcpRelay' 或 'dhcpServer')。

dhcpOptions

列表 / 元素=字典

由代码、类型和值组成的 DHCP 选项数组,用于在交换机接口上运行的 DHCP 服务器。

code

字符串

DHCP 选项的代码,应为 2 到 254 之间。

type

字符串

DHCP 选项的类型,应为 ('text'、'ip'、'integer' 或 'hex') 之一。

value

字符串

DHCP 选项的值。

dhcpRelayServerIps

列表 / 元素=字符串

将 DHCP 数据包转发到的 DHCP 中继服务器 IP,用于交换机接口。

dnsCustomNameservers

列表 / 元素=字符串

当 DHCP 命名服务器选项为 'custom' 时的 DHCP 命名服务器 IP。

dnsNameserversOption

字符串

交换机接口上运行的 dhcp 服务器的 DHCP 命名服务器选项('googlePublicDns'、'openDns' 或 'custom')。

fixedIpAssignments

列表 / 元素=字典

交换机接口上运行的 DHCP 服务器的 DHCP 固定 IP 分配数组。

ip

字符串

分配了固定 IP 地址的客户端的 IP 地址。

mac

字符串

具有固定 IP 地址的客户端的 MAC 地址。

name

字符串

具有固定 IP 地址的客户端的名称。

interfaceId

字符串

InterfaceId 路径参数。接口 ID。

meraki_action_batch_retry_wait_time

整数

meraki_action_batch_retry_wait_time (整数),操作批处理并发错误重试等待时间

默认值: 60

meraki_api_key

字符串 / 必需

meraki_api_key (字符串),在仪表盘中生成的 API 密钥;也可以设置为环境变量 MERAKI_DASHBOARD_API_KEY

meraki_base_url

字符串

meraki_base_url (字符串),位于所有端点资源之前

默认值: "https://api.meraki.com/api/v1"

meraki_be_geo_id

字符串

meraki_be_geo_id (字符串),用于 API 使用情况跟踪的可选合作伙伴标识符;也可以设置为环境变量 BE_GEO_ID

默认值: ""

meraki_caller

字符串

meraki_caller (字符串),用于 API 使用情况跟踪的可选标识符;也可以设置为环境变量 MERAKI_PYTHON_SDK_CALLER

默认值: ""

meraki_certificate_path

字符串

meraki_certificate_path (字符串),如果位于本地代理之后,则用于 TLS/SSL 证书验证的路径

默认值: ""

meraki_inherit_logging_config

布尔值

meraki_inherit_logging_config (布尔值),继承您自己的日志记录器实例

选项

  • false ← (默认)

  • true

meraki_log_file_prefix

字符串

meraki_log_file_prefix (字符串),日志文件名后附加日期和时间戳

默认值: "meraki_api_"

meraki_log_path

字符串

log_path (字符串),输出日志路径;如果未指定,则默认为脚本的工作目录

默认值: ""

meraki_maximum_retries

整数

meraki_maximum_retries (整数),遇到 429 或其他服务器端错误时,最多重试这么多次

默认值: 2

meraki_nginx_429_retry_wait_time

整数

meraki_nginx_429_retry_wait_time (整数),Nginx 429 重试等待时间

默认值: 60

meraki_output_log

布尔值

meraki_output_log (布尔值),创建输出日志文件?

选项

  • false

  • true ← (默认)

meraki_print_console

布尔值

meraki_print_console (布尔值),将日志输出打印到控制台?

选项

  • false

  • true ← (默认)

meraki_requests_proxy

字符串

meraki_requests_proxy (字符串),如果需要,用于 HTTPS 的代理服务器和端口

默认值: ""

meraki_retry_4xx_error

布尔值

meraki_retry_4xx_error (布尔值),遇到其他 4XX 错误(除了 429)时是否重试?

选项

  • false ← (默认)

  • true

meraki_retry_4xx_error_wait_time

整数

meraki_retry_4xx_error_wait_time (整数),其他 4XX 错误重试等待时间

默认值: 60

meraki_simulate

布尔值

meraki_simulate (布尔值),模拟 POST/PUT/DELETE 调用以防止更改?

选项

  • false ← (默认)

  • true

meraki_single_request_timeout

整数

meraki_single_request_timeout (整数),每个 API 调用的最大秒数

默认值: 60

meraki_suppress_logging

布尔值

meraki_suppress_logging (布尔值),禁用所有日志记录? 那么您就只能靠自己了!

选项

  • false ← (默认)

  • true

meraki_use_iterator_for_get_pages

布尔值

meraki_use_iterator_for_get_pages (布尔值),list* 方法将返回包含每个对象的迭代器,而不是包含所有项目的完整列表

选项

  • false ← (默认)

  • true

meraki_wait_on_rate_limit

布尔值

meraki_wait_on_rate_limit (布尔值),如果遇到 429 速率限制错误,是否重试?

选项

  • false

  • true ← (默认)

reservedIpRanges

列表 / 元素=字典

交换机接口上运行的 DHCP 服务器的 DHCP 保留 IP 地址分配数组。

comment

字符串

保留 IP 范围的注释。

end

字符串

保留 IP 范围的结束 IP 地址。

start

字符串

保留 IP 范围的起始 IP 地址。

serial

字符串

串口路径参数。

注释

注意

  • 使用的 SDK 方法为 switch.Switch.update_device_switch_routing_interface_dhcp,

  • 使用的路径为 put /devices/{serial}/switch/routing/interfaces/{interfaceId}/dhcp,

  • 不支持 check_mode

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

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

另请参见

另请参见

Cisco Meraki 关于 switch updateDeviceSwitchRoutingInterfaceDhcp 的文档

updateDeviceSwitchRoutingInterfaceDhcp API 的完整参考。

示例

- name: Update all
  cisco.meraki.devices_switch_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
    reservedIpRanges:
    - comment: A reserved IP range
      end: 192.168.1.10
      start: 192.168.1.1
    serial: string

返回值

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

描述

meraki_response

字典

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

返回:始终

示例: {"bootFileName": "string", "bootNextServer": "string", "bootOptionsEnabled": true, "dhcpLeaseTime": "string", "dhcpMode": "string", "dhcpOptions": [{"code": "string", "type": "string", "value": "string"}], "dhcpRelayServerIps": ["string"], "dnsCustomNameservers": ["string"], "dnsNameserversOption": "string", "fixedIpAssignments": [{"ip": "string", "mac": "string", "name": "string"}], "reservedIpRanges": [{"comment": "string", "end": "string", "start": "string"}]}

作者

  • Francisco Munoz (@fmunoz)