cisco.meraki.devices_appliance_uplinks_settings module -- Resource module for devices _appliance _uplinks _settings
Note
This module is part of the cisco.meraki collection (version 2.18.2).
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_appliance_uplinks_settings
.
New in cisco.meraki 2.16.0
Synopsis
Manage operation update of the resource devices _appliance _uplinks _settings.
Update the uplink settings for an MX appliance.
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 |
---|---|
Interface settings. |
|
WAN 1 settings. |
|
Enable or disable the interface. Choices: |
|
Configuration options for PPPoE. |
|
Settings for PPPoE Authentication. |
|
Whether PPPoE authentication is enabled. Choices: |
|
Password for PPPoE authentication. This parameter is not returned. |
|
Username for PPPoE authentication. |
|
Whether PPPoE is enabled. Choices: |
|
SVI settings by protocol. |
|
IPv4 settings for static/dynamic mode. |
|
IP address and subnet mask when in static mode. |
|
The assignment mode for this SVI. Applies only when PPPoE is disabled. |
|
Gateway IP address when in static mode. |
|
The nameserver settings for this SVI. |
|
Up to 2 nameserver addresses to use, ordered in priority from highest to lowest priority. |
|
IPv6 settings for static/dynamic mode. |
|
Static address that will override the one(s) received by SLAAC. |
|
The assignment mode for this SVI. Applies only when PPPoE is disabled. |
|
Static gateway that will override the one received by autoconf. |
|
The nameserver settings for this SVI. |
|
Up to 2 nameserver addresses to use, ordered in priority from highest to lowest priority. |
|
VLAN tagging settings. |
|
Whether VLAN tagging is enabled. Choices: |
|
The ID of the VLAN to use for VLAN tagging. |
|
WAN 2 settings. |
|
Enable or disable the interface. Choices: |
|
Configuration options for PPPoE. |
|
Settings for PPPoE Authentication. |
|
Whether PPPoE authentication is enabled. Choices: |
|
Password for PPPoE authentication. This parameter is not returned. |
|
Username for PPPoE authentication. |
|
Whether PPPoE is enabled. Choices: |
|
SVI settings by protocol. |
|
IPv4 settings for static/dynamic mode. |
|
IP address and subnet mask when in static mode. |
|
The assignment mode for this SVI. Applies only when PPPoE is disabled. |
|
Gateway IP address when in static mode. |
|
The nameserver settings for this SVI. |
|
Up to 2 nameserver addresses to use, ordered in priority from highest to lowest priority. |
|
IPv6 settings for static/dynamic mode. |
|
Static address that will override the one(s) received by SLAAC. |
|
The assignment mode for this SVI. Applies only when PPPoE is disabled. |
|
Static gateway that will override the one received by autoconf. |
|
The nameserver settings for this SVI. |
|
Up to 2 nameserver addresses to use, ordered in priority from highest to lowest priority. |
|
VLAN tagging settings. |
|
Whether VLAN tagging is enabled. Choices: |
|
The ID of the VLAN to use for VLAN tagging. |
|
meraki_action_batch_retry_wait_time (integer), action batch concurrency error retry wait time Default: :ansible-option-default:`60` |
|
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: :ansible-option-default:`"https://api.meraki.com/api/v1"` |
|
meraki_be_geo_id (string), optional partner identifier for API usage tracking; can also be set as an environment variable BE_GEO_ID Default: :ansible-option-default:`""` |
|
meraki_caller (string), optional identifier for API usage tracking; can also be set as an environment variable MERAKI_PYTHON_SDK_CALLER Default: :ansible-option-default:`""` |
|
meraki_certificate_path (string), path for TLS/SSL certificate verification if behind local proxy Default: :ansible-option-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 |
|
log_path (string), path to output log; by default, working directory of script if not specified Default: :ansible-option-default:`""` |
|
meraki_maximum_retries (integer), retry up to this many times when encountering 429s or other server-side errors Default: :ansible-option-default:`2` |
|
meraki_nginx_429_retry_wait_time (integer), Nginx 429 retry wait time Default: :ansible-option-default:`60` |
|
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: :ansible-option-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: :ansible-option-default:`60` |
|
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: :ansible-option-default:`60` |
|
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: |
|
Serial path parameter. |
Notes
Note
SDK Method used are appliance.Appliance.update_device_appliance_uplinks_settings,
Paths used are put /devices/{serial}/appliance/uplinks/settings,
Does not support
check_mode
The 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 appliance updateDeviceApplianceUplinksSettings
Complete reference of the updateDeviceApplianceUplinksSettings API.
Examples
- name: Update all
cisco.meraki.devices_appliance_uplinks_settings:
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
interfaces:
wan1:
enabled: true
pppoe:
authentication:
enabled: true
password: password
username: username
enabled: true
svis:
ipv4:
address: 9.10.11.10/16
assignmentMode: static
gateway: 13.14.15.16
nameservers:
addresses:
- 1.2.3.4
ipv6:
address: 1:2:3::4
assignmentMode: static
gateway: 1:2:3::5
nameservers:
addresses:
- 1001:4860:4860::8888
- 1001:4860:4860::8844
vlanTagging:
enabled: true
vlanId: 1
wan2:
enabled: true
pppoe:
authentication:
enabled: true
password: password
username: username
enabled: true
svis:
ipv4:
address: 9.10.11.10/16
assignmentMode: static
gateway: 13.14.15.16
nameservers:
addresses:
- 1.2.3.4
ipv6:
address: 1:2:3::4
assignmentMode: static
gateway: 1:2:3::5
nameservers:
addresses:
- 1001:4860:4860::8888
- 1001:4860:4860::8844
vlanTagging:
enabled: true
vlanId: 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 |