cisco.meraki.networks_appliance_traffic_shaping_rules 模块 – 用于网络设备流量整形规则的资源模块
注意
此模块是 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_rules。
cisco.meraki 2.16.0 中的新功能
概要
管理资源网络设备流量整形规则的更新操作。
更新 MX 网络的流量整形设置规则。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要满足以下要求。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
是否启用（true）或禁用（false）默认流量整形规则。有 4 个默认规则，可以在您的网络的流量整形页面上看到。请注意，默认规则计入 8 个规则的限制。 选项
|
|
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。 |
|
流量整形规则的数组。规则按照指定的顺序应用。空列表（或 null）表示没有规则。请注意，最多允许 8 个规则。 |
|
描述流量整形规则定义的对象的列表。至少需要一个定义。 |
|
定义的类型。可以是 ‘application’、‘applicationCategory’、‘host’、‘port’、‘ipRange’ 或 ‘localNet’ 之一。 |
|
如果 “type” 是 ‘host’、‘port’、‘ipRange’ 或 ‘localNet’，则 “value” 必须是一个字符串，匹配主机名（例如 “somesite.com”）、端口（例如 8080）或 IP 范围（“192.1.0.0”、“192.1.0.0/16” 或 “10.1.0.0/16 80”）。 ‘localNet’ 也支持 CIDR 表示法，但不包括自定义端口。如果 “type” 是 ‘application’ 或 ‘applicationCategory’，则 “value” 必须是一个具有结构 { “id” “meraki layer7/…” } 的对象，其中 “id” 是应用程序类别或应用程序 ID（要获取网络 ID 列表，请使用 trafficShaping/applicationCategories 端点）。 |
|
由您的规则应用的 DSCP 标签。Null 表示“不更改 DSCP 标签”。有关可能的标签值列表，请使用 trafficShaping/dscpTaggingOptions 端点。 |
|
描述您的规则的带宽设置的对象。 |
|
带宽限制对象，指定上传（‘limitUp’）和下载（‘limitDown’）速度，单位为 Kbps。 仅当 ‘settings’ 设置为 ‘custom’ 时，这些限制才会被强制执行。 |
|
最大下载限制（整数，单位为 Kbps）。 |
|
最大上传限制（整数，单位为 Kbps）。 |
|
您的规则如何应用带宽限制。可以是 ‘network default’、‘ignore’ 或 ‘custom’ 之一。 |
|
一个字符串，指示绑定到您的规则的数据包的优先级级别。可以是 ‘low’、‘normal’ 或 ‘high’。 |
注意
注意
使用的 SDK 方法是 appliance.Appliance.update_network_appliance_traffic_shaping_rules,
使用的路径是 put /networks/{networkId}/appliance/trafficShaping/rules,
不支持
check_mode该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco Meraki 文档，了解 appliance updateNetworkApplianceTrafficShapingRules
updateNetworkApplianceTrafficShapingRules API 的完整参考。
示例
- name: Update all
cisco.meraki.networks_appliance_traffic_shaping_rules:
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
defaultRulesEnabled: true
networkId: string
rules:
- definitions:
- type: host
value: google.com
- type: port
value: '9090'
- type: ipRange
value: 192.1.0.0
- type: ipRange
value: 192.1.0.0/16
- type: ipRange
value: 10.1.0.0/16:80
- type: localNet
value: 192.168.0.0/16
dscpTagValue: 0
perClientBandwidthLimits:
bandwidthLimits:
limitDown: 1000000
limitUp: 1000000
settings: custom
priority: normal
返回值
常见的返回值记录在此处，以下是此模块独有的字段
键 |
描述 |
|---|---|
由 Cisco Meraki Python SDK 返回的响应的字典或列表 返回： 始终 示例： |