You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

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.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_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
interfaces dictionary	Interface settings.
wan1 dictionary	WAN 1 settings.
enabled boolean	Enable or disable the interface. Choices: `false` `true`
pppoe dictionary	Configuration options for PPPoE.
authentication dictionary	Settings for PPPoE Authentication.
enabled boolean	Whether PPPoE authentication is enabled. Choices: `false` `true`
password string	Password for PPPoE authentication. This parameter is not returned.
username string	Username for PPPoE authentication.
enabled boolean	Whether PPPoE is enabled. Choices: `false` `true`
svis dictionary	SVI settings by protocol.
ipv4 dictionary	IPv4 settings for static/dynamic mode.
address string	IP address and subnet mask when in static mode.
assignmentMode string	The assignment mode for this SVI. Applies only when PPPoE is disabled.
gateway string	Gateway IP address when in static mode.
nameservers dictionary	The nameserver settings for this SVI.
addresses list / elements=string	Up to 2 nameserver addresses to use, ordered in priority from highest to lowest priority.
ipv6 dictionary	IPv6 settings for static/dynamic mode.
address string	Static address that will override the one(s) received by SLAAC.
assignmentMode string	The assignment mode for this SVI. Applies only when PPPoE is disabled.
gateway string	Static gateway that will override the one received by autoconf.
nameservers dictionary	The nameserver settings for this SVI.
addresses list / elements=string	Up to 2 nameserver addresses to use, ordered in priority from highest to lowest priority.
vlanTagging dictionary	VLAN tagging settings.
enabled boolean	Whether VLAN tagging is enabled. Choices: `false` `true`
vlanId integer	The ID of the VLAN to use for VLAN tagging.
wan2 dictionary	WAN 2 settings.
enabled boolean	Enable or disable the interface. Choices: `false` `true`
pppoe dictionary	Configuration options for PPPoE.
authentication dictionary	Settings for PPPoE Authentication.
enabled boolean	Whether PPPoE authentication is enabled. Choices: `false` `true`
password string	Password for PPPoE authentication. This parameter is not returned.
username string	Username for PPPoE authentication.
enabled boolean	Whether PPPoE is enabled. Choices: `false` `true`
svis dictionary	SVI settings by protocol.
ipv4 dictionary	IPv4 settings for static/dynamic mode.
address string	IP address and subnet mask when in static mode.
assignmentMode string	The assignment mode for this SVI. Applies only when PPPoE is disabled.
gateway string	Gateway IP address when in static mode.
nameservers dictionary	The nameserver settings for this SVI.
addresses list / elements=string	Up to 2 nameserver addresses to use, ordered in priority from highest to lowest priority.
ipv6 dictionary	IPv6 settings for static/dynamic mode.
address string	Static address that will override the one(s) received by SLAAC.
assignmentMode string	The assignment mode for this SVI. Applies only when PPPoE is disabled.
gateway string	Static gateway that will override the one received by autoconf.
nameservers dictionary	The nameserver settings for this SVI.
addresses list / elements=string	Up to 2 nameserver addresses to use, ordered in priority from highest to lowest priority.
vlanTagging dictionary	VLAN tagging settings.
enabled boolean	Whether VLAN tagging is enabled. Choices: `false` `true`
vlanId integer	The ID of the VLAN to use for VLAN tagging.
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (integer), action batch concurrency error retry wait time Default: `60`
meraki_api_key string / required	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	meraki_base_url (string), preceding all endpoint resources Default: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	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	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	meraki_certificate_path (string), path for TLS/SSL certificate verification if behind local proxy Default: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (boolean), Inherits your own logger instance Choices: `false` ← (default) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (string), log file name appended with date and timestamp Default: `"meraki_api_"`
meraki_log_path string	log_path (string), path to output log; by default, working directory of script if not specified Default: `""`
meraki_maximum_retries integer	meraki_maximum_retries (integer), retry up to this many times when encountering 429s or other server-side errors Default: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (integer), Nginx 429 retry wait time Default: `60`
meraki_output_log boolean	meraki_output_log (boolean), create an output log file? Choices: `false` `true` ← (default)
meraki_print_console boolean	meraki_print_console (boolean), print logging output to console? Choices: `false` `true` ← (default)
meraki_requests_proxy string	meraki_requests_proxy (string), proxy server and port, if needed, for HTTPS Default: `""`
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (boolean), retry if encountering other 4XX error (besides 429)? Choices: `false` ← (default) `true`
meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (integer), other 4XX error retry wait time Default: `60`
meraki_simulate boolean	meraki_simulate (boolean), simulate POST/PUT/DELETE calls to prevent changes? Choices: `false` ← (default) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (integer), maximum number of seconds for each API call Default: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (boolean), disable all logging? you’re on your own then! Choices: `false` ← (default) `true`
meraki_use_iterator_for_get_pages boolean	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: `false` ← (default) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (boolean), retry if 429 rate limit error encountered? Choices: `false` `true` ← (default)
serial string	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

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

meraki_response

dictionary

A dictionary or list with the response returned by the Cisco Meraki Python SDK

Returned: always

Sample: {"wan1": {"enabled": true, "pppoe": {"authentication": {"enabled": true, "username": "string"}, "enabled": true}, "svis": {"ipv4": {"address": "string", "assignmentMode": "string", "gateway": "string", "nameservers": {"addresses": ["string"]}}, "ipv6": {"address": "string", "assignmentMode": "string", "gateway": "string", "nameservers": {"addresses": ["string"]}}}, "vlanTagging": {"enabled": true, "vlanId": 0}}, "wan2": {"enabled": true, "pppoe": {"authentication": {"enabled": true, "username": "string"}, "enabled": true}, "svis": {"ipv4": {"address": "string", "assignmentMode": "string", "gateway": "string", "nameservers": {"addresses": ["string"]}}, "ipv6": {"address": "string", "assignmentMode": "string", "gateway": "string", "nameservers": {"addresses": ["string"]}}}, "vlanTagging": {"enabled": true, "vlanId": 0}}}

Authors

Francisco Munoz (@fmunoz)

cisco.meraki.devices_appliance_uplinks_settings module – Resource module for devices _appliance _uplinks _settings

Synopsis 

Requirements 

Parameters 

Notes 

See Also 

Examples 

Return Values 

Authors

Collection links

cisco.meraki.devices_appliance_uplinks_settings module – Resource module for devices _appliance _uplinks _settings

Synopsis

Requirements

Parameters

Notes

See Also

Examples

Return Values

Authors

Collection links

Synopsis 

Requirements 

Parameters 

Notes 

See Also 

Examples 

Return Values 