cisco.meraki.networks_appliance_traffic_shaping_uplink_selection module – Resource module for networks _appliance _trafficshaping _uplinkselection
Note
This module is part of the cisco.meraki collection (version 2.18.3).
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.networks_appliance_traffic_shaping_uplink_selection.
New in cisco.meraki 2.16.0
Synopsis
Manage operation update of the resource networks _appliance _trafficshaping _uplinkselection.
Update uplink selection settings for an MX network.
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 |
|---|---|
Toggle for enabling or disabling active-active AutoVPN. Choices:
|
|
The default uplink. Must be one of ‘wan1’ or ‘wan2’. |
|
WAN failover and failback behavior. |
|
Immediate WAN transition terminates all flows (new and existing) on current WAN when it is deemed unreliable. |
|
Toggle for enabling or disabling immediate WAN failover and failback. Choices:
|
|
Toggle for enabling or disabling load balancing. Choices:
|
|
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:
|
|
NetworkId path parameter. Network ID. |
|
Array of uplink preference rules for VPN traffic. |
|
Fail over criterion for this uplink preference rule. Must be one of ‘poorPerformance’ or ‘uplinkDown’. |
|
Performance class setting for this uplink preference rule. |
|
Name of builtin performance class, must be present when performanceClass type is ‘builtin’, and value must be one of ‘VoIP’. |
|
ID of created custom performance class, must be present when performanceClass type is ‘custom’. |
|
Type of this performance class. Must be one of ‘builtin’ or ‘custom’. |
|
Preferred uplink for this uplink preference rule. Must be one of ‘wan1’, ‘wan2’, ‘bestForVoIP’, ‘loadBalancing’ or ‘defaultUplink’. |
|
Array of traffic filters for this uplink preference rule. |
|
Type of this traffic filter. Must be one of ‘applicationCategory’, ‘application’ or ‘custom’. |
|
Value object of this traffic filter. |
|
Destination of this custom type traffic filter. |
|
CIDR format address, or “any”. E.g. “192.168.10.0/24”, “192.168.10.1” (same as “192.168.10.1/32”), “0.0.0.0/0” (same as “any”). |
|
FQDN format address. Currently only availabe in ‘destination’ of ‘vpnTrafficUplinkPreference’ object. E.g. ‘www.google.com’. |
|
Host ID in the VLAN, should be used along with ‘vlan’, and not exceed the vlan subnet capacity. Currently only available under a template network. |
|
Meraki network ID. Currently only available under a template network, and the value should be ID of either same template network, or another template network currently. E.g. “L_12345678”. |
|
E.g. “any”, “0” (also means “any”), “8080”, “1-1024”. |
|
VLAN ID of the configured VLAN in the Meraki network. Currently only available under a template network. |
|
ID of this applicationCategory or application type traffic filter. E.g. “meraki layer7/category/1”, “meraki layer7/application/4”. |
|
Protocol of this custom type traffic filter. Must be one of ‘tcp’, ‘udp’, ‘icmp’, ‘icmp6’ or ‘any’. |
|
Source of this custom type traffic filter. |
|
CIDR format address, or “any”. E.g. “192.168.10.0/24”, “192.168.10.1” (same as “192.168.10.1/32”), “0.0.0.0/0” (same as “any”). |
|
Host ID in the VLAN, should be used along with ‘vlan’, and not exceed the vlan subnet capacity. Currently only available under a template network. |
|
Meraki network ID. Currently only available under a template network, and the value should be ID of either same template network, or another template network currently. E.g. “L_12345678”. |
|
E.g. “any”, “0” (also means “any”), “8080”, “1-1024”. |
|
VLAN ID of the configured VLAN in the Meraki network. Currently only available under a template network. |
|
Array of uplink preference rules for WAN traffic. |
|
Preferred uplink for this uplink preference rule. Must be one of ‘wan1’ or ‘wan2’. |
|
Array of traffic filters for this uplink preference rule. |
|
Type of this traffic filter. Must be one of ‘custom’. |
|
Value object of this traffic filter. |
|
Destination of this custom type traffic filter. |
|
CIDR format address, or “any”. E.g. “192.168.10.0/24”, “192.168.10.1” (same as “192.168.10.1/32”), “0.0.0.0/0” (same as “any”). |
|
E.g. “any”, “0” (also means “any”), “8080”, “1-1024”. |
|
Protocol of this custom type traffic filter. Must be one of ‘tcp’, ‘udp’, ‘icmp6’ or ‘any’. |
|
Source of this custom type traffic filter. |
|
CIDR format address, or “any”. E.g. “192.168.10.0/24”, “192.168.10.1” (same as “192.168.10.1/32”), “0.0.0.0/0” (same as “any”). |
|
Host ID in the VLAN, should be used along with ‘vlan’, and not exceed the vlan subnet capacity. Currently only available under a template network. |
|
E.g. “any”, “0” (also means “any”), “8080”, “1-1024”. |
|
VLAN ID of the configured VLAN in the Meraki network. Currently only available under a template network. |
Notes
Note
SDK Method used are appliance.Appliance.update_network_appliance_traffic_shaping_uplink_selection,
Paths used are put /networks/{networkId}/appliance/trafficShaping/uplinkSelection,
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 appliance updateNetworkApplianceTrafficShapingUplinkSelection
Complete reference of the updateNetworkApplianceTrafficShapingUplinkSelection API.
Examples
- name: Update all
cisco.meraki.networks_appliance_traffic_shaping_uplink_selection:
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
activeActiveAutoVpnEnabled: true
defaultUplink: wan1
failoverAndFailback:
immediate:
enabled: true
loadBalancingEnabled: true
networkId: string
vpnTrafficUplinkPreferences:
- failOverCriterion: poorPerformance
performanceClass:
builtinPerformanceClassName: VoIP
customPerformanceClassId: '123456'
type: custom
preferredUplink: bestForVoIP
trafficFilters:
- type: applicationCategory
value:
destination:
cidr: any
fqdn: www.google.com
host: 254
network: L_12345678
port: 1-1024
vlan: 10
id: meraki:layer7/category/1
protocol: tcp
source:
cidr: 192.168.1.0/24
host: 200
network: L_23456789
port: any
vlan: 20
wanTrafficUplinkPreferences:
- preferredUplink: wan1
trafficFilters:
- type: custom
value:
destination:
cidr: any
port: any
protocol: tcp
source:
cidr: 192.168.1.0/24
host: 254
port: 1-1024
vlan: 10
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: |