cisco.meraki.networks_appliance_sdwan_internet_policies module -- Resource module for networks _appliance _sdwan _internet _policies
Note
This module is part of the cisco.meraki collection (version 2.20.3).
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_sdwan_internet_policies.
New in cisco.meraki 2.20.0
Synopsis
Manage operation update of the resource networks _appliance _sdwan _internet _policies.
Update SDWAN internet traffic preferences 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 |
|---|---|
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_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: |
|
NetworkId path parameter. Network ID. |
|
Policies with respective traffic filters for an MX network. |
|
WAN failover and failback behavior. |
|
Performance class setting for 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 uplink preference rule. Must be one of 'wan1', 'wan2', 'bestForVoIP', 'loadBalancing' or 'defaultUplink'. |
|
Traffic filters. |
|
Traffic filter type. Must be 'custom', 'major_application', 'application (NBAR)', if type is 'application', you can pass either an NBAR App Category or Application. |
|
Value of traffic filter. |
|
Destination of 'custom' type traffic filter. |
|
List of application objects (either majorApplication or nbar). |
|
Id of the major application, or a list of NBAR Application Category or Application selections. |
|
Name of the major application or application category selected. |
|
App type (major or nbar). |
|
CIDR format address (e.g."192.168.10.1", which is the same as "192.168.10.1/32"), or "any". |
|
E.g. "any", "0" (also means "any"), "8080", "1-1024". |
|
Protocol of the traffic filter. Must be one of 'tcp', 'udp', 'icmp6' or 'any'. |
|
Source of traffic filter. |
|
CIDR format address (e.g."192.168.10.1", which is the same as "192.168.10.1/32"), or "any". Cannot be used in combination with the "vlan" property. |
|
Host ID in the VLAN. Should not exceed the VLAN subnet capacity. Must be used along with the "vlan" property and is 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. Cannot be used in combination with the "cidr" property and is currently only available under a template network. |
Notes
Note
SDK Method used are appliance.Appliance.update_network_appliance_sdwan_internet_policies,
Paths used are put /networks/{networkId}/appliance/sdwan/internetPolicies,
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 Dashboard API Python(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 updateNetworkApplianceSdwanInternetPolicies
Complete reference of the updateNetworkApplianceSdwanInternetPolicies API.
Examples
- name: Update all
cisco.meraki.networks_appliance_sdwan_internet_policies:
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}}"
networkId: string
wanTrafficUplinkPreferences:
- failOverCriterion: poorPerformance
performanceClass:
builtinPerformanceClassName: VoIP
customPerformanceClassId: '123456'
type: custom
preferredUplink: wan1
trafficFilters:
- type: custom
value:
destination:
applications:
- id: meraki:layer7/application/3
name: DNS
type: major
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 |