cisco.meraki.networks_appliance_traffic_shaping_uplink_selection 模块 – 用于 networks _appliance _trafficshaping _uplinkselection 的资源模块
注意
此模块是 cisco.meraki 集合（版本 2.18.3）的一部分。
如果您正在使用 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.meraki。您需要进一步的要求才能使用此模块，有关详细信息，请参阅 要求。
要在 playbook 中使用它，请指定：cisco.meraki.networks_appliance_traffic_shaping_uplink_selection。
cisco.meraki 2.16.0 中的新增功能
概要
管理资源 networks _appliance _trafficshaping _uplinkselection 的更新操作。
更新 MX 网络的上行链路选择设置。
注意
此模块具有相应的 action 插件。
要求
执行此模块的主机需要满足以下要求。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
用于启用或禁用主动-主动 AutoVPN 的切换开关。 选择
|
|
默认上行链路。必须是 “wan1” 或 “wan2” 之一。 |
|
WAN 故障转移和故障恢复行为。 |
|
当当前 WAN 被认为不可靠时，立即 WAN 转换会终止当前 WAN 上的所有流（新的和现有的）。 |
|
用于启用或禁用立即 WAN 故障转移和故障恢复的切换开关。 选择
|
|
用于启用或禁用负载平衡的切换开关。 选择
|
|
meraki_action_batch_retry_wait_time（整数），操作批处理并发错误重试等待时间 默认值： |
|
meraki_api_key（字符串），仪表板中生成的 API 密钥；也可以设置为环境变量 MERAKI_DASHBOARD_API_KEY |
|
meraki_base_url（字符串），位于所有端点资源之前 默认值： |
|
meraki_be_geo_id（字符串），用于 API 使用情况跟踪的可选合作伙伴标识符；也可以设置为环境变量 BE_GEO_ID 默认值： |
|
meraki_caller（字符串），用于 API 使用情况跟踪的可选标识符；也可以设置为环境变量 MERAKI_PYTHON_SDK_CALLER 默认值： |
|
meraki_certificate_path（字符串），如果位于本地代理之后，则用于 TLS/SSL 证书验证的路径 默认值： |
|
meraki_inherit_logging_config（布尔值），继承您自己的记录器实例 选择
|
|
meraki_log_file_prefix（字符串），附加了日期和时间戳的日志文件名 默认值： |
|
log_path（字符串），输出日志的路径；默认情况下，如果未指定，则为脚本的工作目录 默认值： |
|
meraki_maximum_retries（整数），当遇到 429 或其他服务器端错误时，最多重试此次数 默认值： |
|
meraki_nginx_429_retry_wait_time（整数），Nginx 429 重试等待时间 默认值： |
|
meraki_output_log（布尔值），创建输出日志文件？ 选择
|
|
meraki_print_console（布尔值），将日志输出打印到控制台？ 选择
|
|
meraki_requests_proxy（字符串），如果需要，用于 HTTPS 的代理服务器和端口 默认值： |
|
meraki_retry_4xx_error（布尔值），如果遇到其他 4XX 错误（除了 429），是否重试？ 选择
|
|
meraki_retry_4xx_error_wait_time（整数），其他 4XX 错误重试等待时间 默认值： |
|
meraki_simulate（布尔值），模拟 POST/PUT/DELETE 调用以防止更改？ 选择
|
|
meraki_single_request_timeout（整数），每个 API 调用的最大秒数 默认值： |
|
meraki_suppress_logging（布尔值），禁用所有日志记录？那你自己负责！ 选择
|
|
meraki_use_iterator_for_get_pages（布尔值），list* 方法将返回一个迭代器，其中包含每个对象，而不是包含所有项的完整列表 选择
|
|
meraki_wait_on_rate_limit (布尔值), 如果遇到 429 速率限制错误是否重试？ 选择
|
|
NetworkId 路径参数。网络 ID。 |
|
VPN 流量的上行链路偏好规则数组。 |
|
此上行链路偏好规则的故障转移标准。必须是 “poorPerformance” 或 “uplinkDown” 之一。 |
|
此上行链路偏好规则的性能类设置。 |
|
内置性能类的名称，当 performanceClass 类型为 “builtin” 时必须存在，且值必须为 “VoIP” 之一。 |
|
创建的自定义性能类的 ID，当 performanceClass 类型为 “custom” 时必须存在。 |
|
此性能类的类型。必须是 “builtin” 或 “custom” 之一。 |
|
此上行链路偏好规则的首选上行链路。必须是 “wan1”、“wan2”、“bestForVoIP”、“loadBalancing” 或 “defaultUplink” 之一。 |
|
此上行链路偏好规则的流量过滤器数组。 |
|
此流量过滤器的类型。必须是 “applicationCategory”、“application” 或 “custom” 之一。 |
|
此流量过滤器的值对象。 |
|
此自定义类型流量过滤器的目标。 |
|
CIDR 格式地址，或 “any”。例如 “192.168.10.0/24”、“192.168.10.1”（与 “192.168.10.1/32” 相同）、“0.0.0.0/0”（与 “any” 相同）。 |
|
FQDN 格式地址。目前仅在 “vpnTrafficUplinkPreference” 对象的 “destination” 中可用。例如 “www.google.com”。 |
|
VLAN 中的主机 ID，应与 “vlan” 一起使用，且不应超过 vlan 子网容量。目前仅在模板网络下可用。 |
|
Meraki 网络 ID。目前仅在模板网络下可用，且该值应为同一模板网络或当前另一个模板网络的 ID。例如 “L_12345678”。 |
|
例如 “any”、“0”（也表示 “any”）、“8080”、“1-1024”。 |
|
在 Meraki 网络中配置的 VLAN 的 VLAN ID。目前仅在模板网络下可用。 |
|
此 applicationCategory 或 application 类型流量过滤器的 ID。例如 “meraki layer7/category/1”、“meraki layer7/application/4”。 |
|
此自定义类型流量过滤器的协议。必须是 “tcp”、“udp”、“icmp”、“icmp6” 或 “any” 之一。 |
|
此自定义类型流量过滤器的源。 |
|
CIDR 格式地址，或 “any”。例如 “192.168.10.0/24”、“192.168.10.1”（与 “192.168.10.1/32” 相同）、“0.0.0.0/0”（与 “any” 相同）。 |
|
VLAN 中的主机 ID，应与 “vlan” 一起使用，且不应超过 vlan 子网容量。目前仅在模板网络下可用。 |
|
Meraki 网络 ID。目前仅在模板网络下可用，且该值应为同一模板网络或当前另一个模板网络的 ID。例如 “L_12345678”。 |
|
例如 “any”、“0”（也表示 “any”）、“8080”、“1-1024”。 |
|
在 Meraki 网络中配置的 VLAN 的 VLAN ID。目前仅在模板网络下可用。 |
|
WAN 流量的上行链路偏好规则数组。 |
|
此上行链路偏好规则的首选上行链路。必须是 “wan1” 或 “wan2” 之一。 |
|
此上行链路偏好规则的流量过滤器数组。 |
|
此流量过滤器的类型。必须是 “custom”。 |
|
此流量过滤器的值对象。 |
|
此自定义类型流量过滤器的目标。 |
|
CIDR 格式地址，或 “any”。例如 “192.168.10.0/24”、“192.168.10.1”（与 “192.168.10.1/32” 相同）、“0.0.0.0/0”（与 “any” 相同）。 |
|
例如 “any”、“0”（也表示 “any”）、“8080”、“1-1024”。 |
|
此自定义类型流量过滤器的协议。必须是 “tcp”、“udp”、“icmp6” 或 “any” 之一。 |
|
此自定义类型流量过滤器的源。 |
|
CIDR 格式地址，或 “any”。例如 “192.168.10.0/24”、“192.168.10.1”（与 “192.168.10.1/32” 相同）、“0.0.0.0/0”（与 “any” 相同）。 |
|
VLAN 中的主机 ID，应与 “vlan” 一起使用，且不应超过 vlan 子网容量。目前仅在模板网络下可用。 |
|
例如 “any”、“0”（也表示 “any”）、“8080”、“1-1024”。 |
|
在 Meraki 网络中配置的 VLAN 的 VLAN ID。目前仅在模板网络下可用。 |
注释
注意
使用的 SDK 方法是 appliance.Appliance.update_network_appliance_traffic_shaping_uplink_selection，
使用的路径是 put /networks/{networkId}/appliance/trafficShaping/uplinkSelection，
不支持
check_mode该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用来自 Cisco DNAC SDK 的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco Meraki 文档，了解 appliance updateNetworkApplianceTrafficShapingUplinkSelection
updateNetworkApplianceTrafficShapingUplinkSelection API 的完整参考。
示例
- 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
返回值
常见返回值记录在此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
一个字典或列表，其中包含 Cisco Meraki Python SDK 返回的响应 返回: 总是 示例: |