cisco.meraki.devices_switch_routing_interfaces_dhcp module – Resource module for devices _switch _routing _interfaces _dhcp
Note
This module is part of the cisco.meraki collection (version 2.17.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install cisco.meraki.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.meraki.devices_switch_routing_interfaces_dhcp.
New in cisco.meraki 2.16.0
Synopsis
Manage operation update of the resource devices _switch _routing _interfaces _dhcp.
Update a layer 3 interface DHCP configuration for a switch.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
meraki >= 2.4.9
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
The PXE boot server filename for the DHCP server running on the switch interface. |
|
The PXE boot server IP for the DHCP server running on the switch interface. |
|
Enable DHCP boot options to provide PXE boot options configs for the dhcp server running on the switch interface. Choices:
|
|
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’). |
|
The DHCP mode options for the switch interface (‘dhcpDisabled’, ‘dhcpRelay’ or ‘dhcpServer’). |
|
Array of DHCP options consisting of code, type and value for the DHCP server running on the switch interface. |
|
The code for DHCP option which should be from 2 to 254. |
|
The type of the DHCP option which should be one of (‘text’, ‘ip’, ‘integer’ or ‘hex’). |
|
The value of the DHCP option. |
|
The DHCP relay server IPs to which DHCP packets would get relayed for the switch interface. |
|
The DHCP name server IPs when DHCP name server option is ‘custom’. |
|
The DHCP name server option for the dhcp server running on the switch interface (‘googlePublicDns’, ‘openDns’ or ‘custom’). |
|
Array of DHCP fixed IP assignments for the DHCP server running on the switch interface. |
|
The IP address of the client which has fixed IP address assigned to it. |
|
The MAC address of the client which has fixed IP address. |
|
The name of the client which has fixed IP address. |
|
InterfaceId path parameter. Interface ID. |
|
meraki_action_batch_retry_wait_time (integer), action batch concurrency error retry wait time Default: |
|
meraki_api_key (string), API key generated in dashboard; can also be set as an environment variable MERAKI_DASHBOARD_API_KEY |
|
meraki_base_url (string), preceding all endpoint resources Default: |
|
meraki_be_geo_id (string), optional partner identifier for API usage tracking; can also be set as an environment variable BE_GEO_ID Default: |
|
meraki_caller (string), optional identifier for API usage tracking; can also be set as an environment variable MERAKI_PYTHON_SDK_CALLER Default: |
|
meraki_certificate_path (string), path for TLS/SSL certificate verification if behind local proxy Default: |
|
meraki_inherit_logging_config (boolean), Inherits your own logger instance Choices:
|
|
meraki_log_file_prefix (string), log file name appended with date and timestamp Default: |
|
log_path (string), path to output log; by default, working directory of script if not specified Default: |
|
meraki_maximum_retries (integer), retry up to this many times when encountering 429s or other server-side errors Default: |
|
meraki_nginx_429_retry_wait_time (integer), Nginx 429 retry wait time Default: |
|
meraki_output_log (boolean), create an output log file? Choices:
|
|
meraki_print_console (boolean), print logging output to console? Choices:
|
|
meraki_requests_proxy (string), proxy server and port, if needed, for HTTPS Default: |
|
meraki_retry_4xx_error (boolean), retry if encountering other 4XX error (besides 429)? Choices:
|
|
meraki_retry_4xx_error_wait_time (integer), other 4XX error retry wait time Default: |
|
meraki_simulate (boolean), simulate POST/PUT/DELETE calls to prevent changes? Choices:
|
|
meraki_single_request_timeout (integer), maximum number of seconds for each API call Default: |
|
meraki_suppress_logging (boolean), disable all logging? you’re on your own then! Choices:
|
|
meraki_use_iterator_for_get_pages (boolean), list* methods will return an iterator with each object instead of a complete list with all items Choices:
|
|
meraki_wait_on_rate_limit (boolean), retry if 429 rate limit error encountered? Choices:
|
|
Array of DHCP reserved IP assignments for the DHCP server running on the switch interface. |
|
The comment for the reserved IP range. |
|
The ending IP address of the reserved IP range. |
|
The starting IP address of the reserved IP range. |
|
Serial path parameter. |
Notes
Note
SDK Method used are devices.Devices.update_device_switch_routing_interface_dhcp,
Paths used are put /devices/{serial}/switch/routing/interfaces/{interfaceId}/dhcp,
Does not support
check_modeThe plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK
The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection
See Also
See also
- Cisco Meraki documentation for devices updateDeviceSwitchRoutingInterfaceDhcp
Complete reference of the updateDeviceSwitchRoutingInterfaceDhcp API.
Examples
- 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
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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco Meraki Python SDK Returned: always Sample: |