.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.meraki.networks_appliance_traffic_shaping_uplink_selection module -- Resource module for networks \_appliance \_trafficshaping \_uplinkselection ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.meraki collection `_ (version 2.22.0). To install it, use: :code:`ansible-galaxy collection install cisco.meraki`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.meraki.networks_appliance_traffic_shaping_uplink_selection`. .. version_added .. rst-class:: ansible-version-added New in cisco.meraki 1.0.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operation update of the resource networks \_appliance \_trafficshaping \_uplinkselection. - Update uplink selection settings for an MX network. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - meraki \>= 2.4.9 - python \>= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-activeactiveautovpnenabled: .. rst-class:: ansible-option-title **activeActiveAutoVpnEnabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Toggle for enabling or disabling active-active AutoVPN. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-defaultuplink: .. rst-class:: ansible-option-title **defaultUplink** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The default uplink. Must be a WAN interface 'wanX'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-failoverandfailback: .. rst-class:: ansible-option-title **failoverAndFailback** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
WAN failover and failback behavior. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-failoverandfailback/immediate: .. rst-class:: ansible-option-title **immediate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Immediate WAN transition terminates all flows (new and existing) on current WAN when it is deemed unreliable. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-failoverandfailback/immediate/enabled: .. rst-class:: ansible-option-title **enabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Toggle for enabling or disabling immediate WAN failover and failback. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-loadbalancingenabled: .. rst-class:: ansible-option-title **loadBalancingEnabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Toggle for enabling or disabling load balancing. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-meraki_action_batch_retry_wait_time: .. rst-class:: ansible-option-title **meraki_action_batch_retry_wait_time** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
meraki\_action\_batch\_retry\_wait\_time (integer), action batch concurrency error retry wait time .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`60` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-meraki_api_key: .. rst-class:: ansible-option-title **meraki_api_key** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
meraki\_api\_key (string), API key generated in dashboard; can also be set as an environment variable MERAKI\_DASHBOARD\_API\_KEY .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-meraki_base_url: .. rst-class:: ansible-option-title **meraki_base_url** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
meraki\_base\_url (string), preceding all endpoint resources .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"https://api.meraki.com/api/v1"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-meraki_be_geo_id: .. rst-class:: ansible-option-title **meraki_be_geo_id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
meraki\_be\_geo\_id (string), optional partner identifier for API usage tracking; can also be set as an environment variable BE\_GEO\_ID .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`""` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-meraki_certificate_path: .. rst-class:: ansible-option-title **meraki_certificate_path** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
meraki\_certificate\_path (string), path for TLS/SSL certificate verification if behind local proxy .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`""` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-meraki_inherit_logging_config: .. rst-class:: ansible-option-title **meraki_inherit_logging_config** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
meraki\_inherit\_logging\_config (boolean), Inherits your own logger instance .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-meraki_log_file_prefix: .. rst-class:: ansible-option-title **meraki_log_file_prefix** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
meraki\_log\_file\_prefix (string), log file name appended with date and timestamp .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"meraki\_api\_"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-meraki_log_path: .. rst-class:: ansible-option-title **meraki_log_path** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
log\_path (string), path to output log; by default, working directory of script if not specified .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`""` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-meraki_maximum_retries: .. rst-class:: ansible-option-title **meraki_maximum_retries** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
meraki\_maximum\_retries (integer), retry up to this many times when encountering 429s or other server-side errors .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`2` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-meraki_nginx_429_retry_wait_time: .. rst-class:: ansible-option-title **meraki_nginx_429_retry_wait_time** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
meraki\_nginx\_429\_retry\_wait\_time (integer), Nginx 429 retry wait time .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`60` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-meraki_output_log: .. rst-class:: ansible-option-title **meraki_output_log** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
meraki\_output\_log (boolean), create an output log file? .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-meraki_print_console: .. rst-class:: ansible-option-title **meraki_print_console** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
meraki\_print\_console (boolean), print logging output to console? .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-meraki_requests_proxy: .. rst-class:: ansible-option-title **meraki_requests_proxy** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
meraki\_requests\_proxy (string), proxy server and port, if needed, for HTTPS .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`""` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-meraki_retry_4xx_error: .. rst-class:: ansible-option-title **meraki_retry_4xx_error** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
meraki\_retry\_4xx\_error (boolean), retry if encountering other 4XX error (besides 429)? .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-meraki_retry_4xx_error_wait_time: .. rst-class:: ansible-option-title **meraki_retry_4xx_error_wait_time** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
meraki\_retry\_4xx\_error\_wait\_time (integer), other 4XX error retry wait time .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`60` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-meraki_simulate: .. rst-class:: ansible-option-title **meraki_simulate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
meraki\_simulate (boolean), simulate POST/PUT/DELETE calls to prevent changes? .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-meraki_single_request_timeout: .. rst-class:: ansible-option-title **meraki_single_request_timeout** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
meraki\_single\_request\_timeout (integer), maximum number of seconds for each API call .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`60` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-meraki_suppress_logging: .. rst-class:: ansible-option-title **meraki_suppress_logging** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
meraki\_suppress\_logging (boolean), disable all logging? you're on your own then! .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-meraki_use_iterator_for_get_pages: .. rst-class:: ansible-option-title **meraki_use_iterator_for_get_pages** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
meraki\_use\_iterator\_for\_get\_pages (boolean), list\* methods will return an iterator with each object instead of a complete list with all items .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-meraki_wait_on_rate_limit: .. rst-class:: ansible-option-title **meraki_wait_on_rate_limit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
meraki\_wait\_on\_rate\_limit (boolean), retry if 429 rate limit error encountered? .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-networkid: .. rst-class:: ansible-option-title **networkId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
NetworkId path parameter. Network ID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-vpntrafficuplinkpreferences: .. rst-class:: ansible-option-title **vpnTrafficUplinkPreferences** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Array of uplink preference rules for VPN traffic. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-vpntrafficuplinkpreferences/failovercriterion: .. rst-class:: ansible-option-title **failOverCriterion** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Fail over criterion for this uplink preference rule. Must be one of 'poorPerformance' or 'uplinkDown'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-vpntrafficuplinkpreferences/performanceclass: .. rst-class:: ansible-option-title **performanceClass** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Performance class setting for this uplink preference rule. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-vpntrafficuplinkpreferences/performanceclass/builtinperformanceclassname: .. rst-class:: ansible-option-title **builtinPerformanceClassName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of builtin performance class, must be present when performanceClass type is 'builtin', and value must be one of 'VoIP'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-vpntrafficuplinkpreferences/performanceclass/customperformanceclassid: .. rst-class:: ansible-option-title **customPerformanceClassId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ID of created custom performance class, must be present when performanceClass type is 'custom'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-vpntrafficuplinkpreferences/performanceclass/type: .. rst-class:: ansible-option-title **type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Type of this performance class. Must be one of 'builtin' or 'custom'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-vpntrafficuplinkpreferences/preferreduplink: .. rst-class:: ansible-option-title **preferredUplink** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Preferred uplink for this uplink preference rule. Must be one of 'wan1', 'wan2', 'bestForVoIP', 'loadBalancing' or 'defaultUplink', or any other valid uplink(wanX) if it applies to the network. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-vpntrafficuplinkpreferences/trafficfilters: .. rst-class:: ansible-option-title **trafficFilters** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Array of traffic filters for this uplink preference rule. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-vpntrafficuplinkpreferences/trafficfilters/type: .. rst-class:: ansible-option-title **type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Type of this traffic filter. Must be one of 'applicationCategory', 'application' or 'custom'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-vpntrafficuplinkpreferences/trafficfilters/value: .. rst-class:: ansible-option-title **value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Value object of this traffic filter. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-vpntrafficuplinkpreferences/trafficfilters/value/destination: .. rst-class:: ansible-option-title **destination** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Destination of this custom type traffic filter. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-vpntrafficuplinkpreferences/trafficfilters/value/destination/cidr: .. rst-class:: ansible-option-title **cidr** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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"). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-vpntrafficuplinkpreferences/trafficfilters/value/destination/fqdn: .. rst-class:: ansible-option-title **fqdn** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
FQDN format address. Currently only availabe in 'destination' of 'vpnTrafficUplinkPreference' object. E.g. 'www.google.com'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-vpntrafficuplinkpreferences/trafficfilters/value/destination/host: .. rst-class:: ansible-option-title **host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-vpntrafficuplinkpreferences/trafficfilters/value/destination/network: .. rst-class:: ansible-option-title **network** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-vpntrafficuplinkpreferences/trafficfilters/value/destination/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
E.g. "any", "0" (also means "any"), "8080", "1-1024". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-vpntrafficuplinkpreferences/trafficfilters/value/destination/vlan: .. rst-class:: ansible-option-title **vlan** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
VLAN ID of the configured VLAN in the Meraki network. Currently only available under a template network. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-vpntrafficuplinkpreferences/trafficfilters/value/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ID of this applicationCategory or application type traffic filter. E.g. "meraki layer7/category/1", "meraki layer7/application/4". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-vpntrafficuplinkpreferences/trafficfilters/value/protocol: .. rst-class:: ansible-option-title **protocol** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Protocol of this custom type traffic filter. Must be one of 'tcp', 'udp', 'icmp', 'icmp6' or 'any'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-vpntrafficuplinkpreferences/trafficfilters/value/source: .. rst-class:: ansible-option-title **source** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Source of this custom type traffic filter. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-vpntrafficuplinkpreferences/trafficfilters/value/source/cidr: .. rst-class:: ansible-option-title **cidr** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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"). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-vpntrafficuplinkpreferences/trafficfilters/value/source/host: .. rst-class:: ansible-option-title **host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-vpntrafficuplinkpreferences/trafficfilters/value/source/network: .. rst-class:: ansible-option-title **network** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-vpntrafficuplinkpreferences/trafficfilters/value/source/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
E.g. "any", "0" (also means "any"), "8080", "1-1024". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-vpntrafficuplinkpreferences/trafficfilters/value/source/vlan: .. rst-class:: ansible-option-title **vlan** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
VLAN ID of the configured VLAN in the Meraki network. Currently only available under a template network. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-wantrafficuplinkpreferences: .. rst-class:: ansible-option-title **wanTrafficUplinkPreferences** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Array of uplink preference rules for WAN traffic. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-wantrafficuplinkpreferences/preferreduplink: .. rst-class:: ansible-option-title **preferredUplink** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Preferred uplink for this uplink preference rule. Must be one of 'wan1' or 'wan2', or any other valid uplink(wanX) if it applies to the network. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-wantrafficuplinkpreferences/trafficfilters: .. rst-class:: ansible-option-title **trafficFilters** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Array of traffic filters for this uplink preference rule. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-wantrafficuplinkpreferences/trafficfilters/type: .. rst-class:: ansible-option-title **type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Type of this traffic filter. Must be one of 'custom'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-wantrafficuplinkpreferences/trafficfilters/value: .. rst-class:: ansible-option-title **value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Value object of this traffic filter. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-wantrafficuplinkpreferences/trafficfilters/value/destination: .. rst-class:: ansible-option-title **destination** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Destination of this custom type traffic filter. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-wantrafficuplinkpreferences/trafficfilters/value/destination/cidr: .. rst-class:: ansible-option-title **cidr** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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"). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-wantrafficuplinkpreferences/trafficfilters/value/destination/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
E.g. "any", "0" (also means "any"), "8080", "1-1024". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-wantrafficuplinkpreferences/trafficfilters/value/protocol: .. rst-class:: ansible-option-title **protocol** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Protocol of this custom type traffic filter. Must be one of 'tcp', 'udp', 'icmp6' or 'any'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-wantrafficuplinkpreferences/trafficfilters/value/source: .. rst-class:: ansible-option-title **source** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Source of this custom type traffic filter. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-wantrafficuplinkpreferences/trafficfilters/value/source/cidr: .. rst-class:: ansible-option-title **cidr** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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"). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-wantrafficuplinkpreferences/trafficfilters/value/source/host: .. rst-class:: ansible-option-title **host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-wantrafficuplinkpreferences/trafficfilters/value/source/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
E.g. "any", "0" (also means "any"), "8080", "1-1024". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__parameter-wantrafficuplinkpreferences/trafficfilters/value/source/vlan: .. rst-class:: ansible-option-title **vlan** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
VLAN ID of the configured VLAN in the Meraki network. Currently only available under a template network. .. raw:: html
.. Attributes .. Notes 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 \ :literal:`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 Dashboard API Python(SDK) - The parameters starting with dnac\_ are used by the Cisco DNAC Python SDK to establish the connection .. Seealso See Also -------- .. seealso:: `Cisco Meraki documentation for appliance updateNetworkApplianceTrafficShapingUplinkSelection `_ Complete reference of the updateNetworkApplianceTrafficShapingUplinkSelection API. .. Examples Examples -------- .. code-block:: yaml+jinja - 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_caller: "{{ meraki_caller }}" 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_appliance_traffic_shaping_uplink_selection_module__return-meraki_response: .. rst-class:: ansible-option-title **meraki_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco Meraki Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"activeActiveAutoVpnEnabled": true, "defaultUplink": "string", "failoverAndFailback": {"immediate": {"enabled": true}}, "loadBalancingEnabled": true, "vpnTrafficUplinkPreferences": [{"failOverCriterion": "string", "performanceClass": {"builtinPerformanceClassName": "string", "customPerformanceClassId": "string", "type": "string"}, "preferredUplink": "string", "trafficFilters": [{"type": "string", "value": {"destination": {"cidr": "string", "fqdn": "string", "host": 0, "network": "string", "port": "string", "vlan": 0}, "id": "string", "protocol": "string", "source": {"cidr": "string", "host": 0, "network": "string", "port": "string", "vlan": 0}}}]}], "wanTrafficUplinkPreferences": [{"preferredUplink": "string", "trafficFilters": [{"type": "string", "value": {"destination": {"applications": [{"id": "string", "name": "string", "type": "string"}], "cidr": "string", "port": "string"}, "protocol": "string", "source": {"cidr": "string", "host": 0, "port": "string", "vlan": 0}}}]}]}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Francisco Munoz (@fmunoz) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors