cisco / cisco.meraki / 2.18.0 / module / devices_appliance_uplinks_settings Resource module for devices _appliance _uplinks _settings | "added in version" 2.16.0 of cisco.meraki" Authors: Francisco Munoz (@fmunoz) This plugin has a corresponding action plugin.cisco.meraki.devices_appliance_uplinks_settings (2.18.0) — module
Install with ansible-galaxy collection install cisco.meraki:==2.18.0
collections: - name: cisco.meraki version: 2.18.0
Manage operation update of the resource devices _appliance _uplinks _settings.
Update the uplink settings for an MX appliance.
- 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
serial: description: Serial path parameter. type: str interfaces: description: Interface settings. suboptions: wan1: description: WAN 1 settings. suboptions: enabled: description: Enable or disable the interface. type: bool pppoe: description: Configuration options for PPPoE. suboptions: authentication: description: Settings for PPPoE Authentication. suboptions: enabled: description: Whether PPPoE authentication is enabled. type: bool password: description: Password for PPPoE authentication. This parameter is not returned. type: str username: description: Username for PPPoE authentication. type: str type: dict enabled: description: Whether PPPoE is enabled. type: bool type: dict svis: description: SVI settings by protocol. suboptions: ipv4: description: IPv4 settings for static/dynamic mode. suboptions: address: description: IP address and subnet mask when in static mode. type: str assignmentMode: description: The assignment mode for this SVI. Applies only when PPPoE is disabled. type: str gateway: description: Gateway IP address when in static mode. type: str nameservers: description: The nameserver settings for this SVI. suboptions: addresses: description: Up to 2 nameserver addresses to use, ordered in priority from highest to lowest priority. elements: str type: list type: dict type: dict ipv6: description: IPv6 settings for static/dynamic mode. suboptions: address: description: Static address that will override the one(s) received by SLAAC. type: str assignmentMode: description: The assignment mode for this SVI. Applies only when PPPoE is disabled. type: str gateway: description: Static gateway that will override the one received by autoconf. type: str nameservers: description: The nameserver settings for this SVI. suboptions: addresses: description: Up to 2 nameserver addresses to use, ordered in priority from highest to lowest priority. elements: str type: list type: dict type: dict type: dict vlanTagging: description: VLAN tagging settings. suboptions: enabled: description: Whether VLAN tagging is enabled. type: bool vlanId: description: The ID of the VLAN to use for VLAN tagging. type: int type: dict type: dict wan2: description: WAN 2 settings. suboptions: enabled: description: Enable or disable the interface. type: bool pppoe: description: Configuration options for PPPoE. suboptions: authentication: description: Settings for PPPoE Authentication. suboptions: enabled: description: Whether PPPoE authentication is enabled. type: bool password: description: Password for PPPoE authentication. This parameter is not returned. type: str username: description: Username for PPPoE authentication. type: str type: dict enabled: description: Whether PPPoE is enabled. type: bool type: dict svis: description: SVI settings by protocol. suboptions: ipv4: description: IPv4 settings for static/dynamic mode. suboptions: address: description: IP address and subnet mask when in static mode. type: str assignmentMode: description: The assignment mode for this SVI. Applies only when PPPoE is disabled. type: str gateway: description: Gateway IP address when in static mode. type: str nameservers: description: The nameserver settings for this SVI. suboptions: addresses: description: Up to 2 nameserver addresses to use, ordered in priority from highest to lowest priority. elements: str type: list type: dict type: dict ipv6: description: IPv6 settings for static/dynamic mode. suboptions: address: description: Static address that will override the one(s) received by SLAAC. type: str assignmentMode: description: The assignment mode for this SVI. Applies only when PPPoE is disabled. type: str gateway: description: Static gateway that will override the one received by autoconf. type: str nameservers: description: The nameserver settings for this SVI. suboptions: addresses: description: Up to 2 nameserver addresses to use, ordered in priority from highest to lowest priority. elements: str type: list type: dict type: dict type: dict vlanTagging: description: VLAN tagging settings. suboptions: enabled: description: Whether VLAN tagging is enabled. type: bool vlanId: description: The ID of the VLAN to use for VLAN tagging. type: int type: dict type: dict type: dict 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 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 meraki_output_log: default: true description: - meraki_output_log (boolean), create an output log file? type: bool 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 \"wan1\": {\n \"enabled\": true,\n \"pppoe\": {\n \"authentication\"\ : {\n \"enabled\": true,\n \"username\": \"string\"\n },\n\ \ \"enabled\": true\n },\n \"svis\": {\n \"ipv4\": {\n \ \ \"address\": \"string\",\n \"assignmentMode\": \"string\",\n \"\ gateway\": \"string\",\n \"nameservers\": {\n \"addresses\": [\n\ \ \"string\"\n ]\n }\n },\n \"ipv6\": {\n\ \ \"address\": \"string\",\n \"assignmentMode\": \"string\",\n \ \ \"gateway\": \"string\",\n \"nameservers\": {\n \"addresses\"\ : [\n \"string\"\n ]\n }\n }\n },\n \"vlanTagging\"\ : {\n \"enabled\": true,\n \"vlanId\": 0\n }\n },\n \"wan2\": {\n\ \ \"enabled\": true,\n \"pppoe\": {\n \"authentication\": {\n \ \ \"enabled\": true,\n \"username\": \"string\"\n },\n \"enabled\"\ : true\n },\n \"svis\": {\n \"ipv4\": {\n \"address\": \"string\"\ ,\n \"assignmentMode\": \"string\",\n \"gateway\": \"string\",\n\ \ \"nameservers\": {\n \"addresses\": [\n \"string\"\ \n ]\n }\n },\n \"ipv6\": {\n \"address\": \"\ string\",\n \"assignmentMode\": \"string\",\n \"gateway\": \"string\"\ ,\n \"nameservers\": {\n \"addresses\": [\n \"string\"\ \n ]\n }\n }\n },\n \"vlanTagging\": {\n \"enabled\"\ : true,\n \"vlanId\": 0\n }\n }\n}\n" type: dict