Try SpotterResource module for devices _switch _routing _interfaces _dhcp
| "added in version" 2.16.0 of cisco.meraki"
Authors: Francisco Munoz (@fmunoz)
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install cisco.meraki:==2.18.0
collections:
- name: cisco.meraki
version: 2.18.0Manage operation update of the resource devices _switch _routing _interfaces _dhcp.
Update a layer 3 interface DHCP configuration for a switch.
- 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
serial:
description: Serial path parameter.
type: str
dhcpMode:
description: The DHCP mode options for the switch interface ('dhcpDisabled', 'dhcpRelay'
or 'dhcpServer').
type: str
dhcpOptions:
description: Array of DHCP options consisting of code, type and value for the DHCP
server running on the switch interface.
elements: dict
suboptions:
code:
description: The code for DHCP option which should be from 2 to 254.
type: str
type:
description: The type of the DHCP option which should be one of ('text', 'ip',
'integer' or 'hex').
type: str
value:
description: The value of the DHCP option.
type: str
type: list
interfaceId:
description: InterfaceId path parameter. Interface ID.
type: str
bootFileName:
description: The PXE boot server filename for the DHCP server running on the switch
interface.
type: str
dhcpLeaseTime:
description: The DHCP lease time config for the dhcp server running on switch interface
('30 minutes', '1 hour', '4 hours', '12 hours', '1 day' or '1 week').
type: str
meraki_caller:
default: ''
description:
- meraki_caller (string), optional identifier for API usage tracking; can also be
set as an environment variable MERAKI_PYTHON_SDK_CALLER
type: str
bootNextServer:
description: The PXE boot server IP for the DHCP server running on the switch interface.
type: str
meraki_api_key:
description:
- meraki_api_key (string), API key generated in dashboard; can also be set as an environment
variable MERAKI_DASHBOARD_API_KEY
required: true
type: str
meraki_base_url:
default: https://api.meraki.com/api/v1
description:
- meraki_base_url (string), preceding all endpoint resources
type: str
meraki_log_path:
default: ''
description:
- log_path (string), path to output log; by default, working directory of script if
not specified
type: str
meraki_simulate:
default: false
description:
- meraki_simulate (boolean), simulate POST/PUT/DELETE calls to prevent changes?
type: bool
meraki_be_geo_id:
default: ''
description:
- meraki_be_geo_id (string), optional partner identifier for API usage tracking; can
also be set as an environment variable BE_GEO_ID
type: str
reservedIpRanges:
description: Array of DHCP reserved IP assignments for the DHCP server running on
the switch interface.
elements: dict
suboptions:
comment:
description: The comment for the reserved IP range.
type: str
end:
description: The ending IP address of the reserved IP range.
type: str
start:
description: The starting IP address of the reserved IP range.
type: str
type: list
meraki_output_log:
default: true
description:
- meraki_output_log (boolean), create an output log file?
type: bool
bootOptionsEnabled:
description: Enable DHCP boot options to provide PXE boot options configs for the
dhcp server running on the switch interface.
type: bool
dhcpRelayServerIps:
description: The DHCP relay server IPs to which DHCP packets would get relayed for
the switch interface.
elements: str
type: list
fixedIpAssignments:
description: Array of DHCP fixed IP assignments for the DHCP server running on the
switch interface.
elements: dict
suboptions:
ip:
description: The IP address of the client which has fixed IP address assigned
to it.
type: str
mac:
description: The MAC address of the client which has fixed IP address.
type: str
name:
description: The name of the client which has fixed IP address.
type: str
type: list
dnsCustomNameservers:
description: The DHCP name server IPs when DHCP name server option is 'custom'.
elements: str
type: list
dnsNameserversOption:
description: The DHCP name server option for the dhcp server running on the switch
interface ('googlePublicDns', 'openDns' or 'custom').
type: str
meraki_print_console:
default: true
description:
- meraki_print_console (boolean), print logging output to console?
type: bool
meraki_requests_proxy:
default: ''
description:
- meraki_requests_proxy (string), proxy server and port, if needed, for HTTPS
type: str
meraki_log_file_prefix:
default: meraki_api_
description:
- meraki_log_file_prefix (string), log file name appended with date and timestamp
type: str
meraki_maximum_retries:
default: 2
description:
- meraki_maximum_retries (integer), retry up to this many times when encountering
429s or other server-side errors
type: int
meraki_retry_4xx_error:
default: false
description:
- meraki_retry_4xx_error (boolean), retry if encountering other 4XX error (besides
429)?
type: bool
meraki_certificate_path:
default: ''
description:
- meraki_certificate_path (string), path for TLS/SSL certificate verification if behind
local proxy
type: str
meraki_suppress_logging:
default: false
description:
- meraki_suppress_logging (boolean), disable all logging? you're on your own then!
type: bool
meraki_wait_on_rate_limit:
default: true
description:
- meraki_wait_on_rate_limit (boolean), retry if 429 rate limit error encountered?
type: bool
meraki_inherit_logging_config:
default: false
description:
- meraki_inherit_logging_config (boolean), Inherits your own logger instance
type: bool
meraki_single_request_timeout:
default: 60
description:
- meraki_single_request_timeout (integer), maximum number of seconds for each API
call
type: int
meraki_nginx_429_retry_wait_time:
default: 60
description:
- meraki_nginx_429_retry_wait_time (integer), Nginx 429 retry wait time
type: int
meraki_retry_4xx_error_wait_time:
default: 60
description:
- meraki_retry_4xx_error_wait_time (integer), other 4XX error retry wait time
type: int
meraki_use_iterator_for_get_pages:
default: false
description:
- meraki_use_iterator_for_get_pages (boolean), list* methods will return an iterator
with each object instead of a complete list with all items
type: bool
meraki_action_batch_retry_wait_time:
default: 60
description:
- meraki_action_batch_retry_wait_time (integer), action batch concurrency error retry
wait time
type: int
meraki_response:
description: A dictionary or list with the response returned by the Cisco Meraki
Python SDK
returned: always
sample: "{\n \"bootFileName\": \"string\",\n \"bootNextServer\": \"string\",\n\
\ \"bootOptionsEnabled\": true,\n \"dhcpLeaseTime\": \"string\",\n \"dhcpMode\"\
: \"string\",\n \"dhcpOptions\": [\n {\n \"code\": \"string\",\n \
\ \"type\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"dhcpRelayServerIps\"\
: [\n \"string\"\n ],\n \"dnsCustomNameservers\": [\n \"string\"\n ],\n\
\ \"dnsNameserversOption\": \"string\",\n \"fixedIpAssignments\": [\n {\n\
\ \"ip\": \"string\",\n \"mac\": \"string\",\n \"name\": \"string\"\
\n }\n ],\n \"reservedIpRanges\": [\n {\n \"comment\": \"string\"\
,\n \"end\": \"string\",\n \"start\": \"string\"\n }\n ]\n}\n"
type: dict