cisco.meraki.meraki_mx_uplink_bandwidth 模块 – 管理 Meraki MX 设备上的上行链路

注意

此模块是 cisco.meraki 集合（版本 2.18.3）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install cisco.meraki。

要在 playbook 中使用它，请指定：cisco.meraki.meraki_mx_uplink_bandwidth。

cisco.meraki 1.1.0 中的新功能

已弃用

在以下版本中删除:

3.0.0 版

原因:

发布了具有增强功能更新的模块

替代方案:

cisco.meraki.networks_appliance_traffic_shaping_uplink_bandwidth

概要

• 配置和查询有关 Meraki MX 设备上行链路的信息。

参数

参数	注释
auth_key string / 必需	仪表板提供的身份验证密钥。如果未设置环境变量 MERAKI_KEY，则为必需。
cellular 字典	蜂窝上行链路的配置
bandwidth_limits 字典	用于配置带宽限制的结构
limit_down 整数	接口的最大下载速度
limit_up 整数	接口的最大上传速度
host 字符串	Meraki 仪表板的主机名。 可用于访问区域性 Meraki 环境，如中国。 默认: "api.meraki.com"
internal_error_retry_time 整数	如果服务器返回内部服务器错误，则重试的秒数。 默认: 60
net_id 字符串	VLAN 所在的或应所在的网络的 ID。
net_name 别名: network 字符串	VLAN 所在的或应所在的网络的名称。
org_id 字符串	与网络关联的组织的 ID。
org_name 别名: organization 字符串	与网络关联的组织的名称。
output_format 字符串	指示模块响应键应采用蛇形命名法（例如 net_id）还是驼峰命名法（例如 netId）。 选项 "snakecase" ← (默认) "camelcase"
output_level 字符串	设置模块执行期间的调试输出量。 选项 "debug" "normal" ← (默认)
rate_limit_retry_time 整数	如果触发速率限制器，则重试的秒数。 默认: 165
state 字符串	指定是否应查询、创建/修改或删除对象。 选项 "absent" "present" "query" ← (默认)
timeout 整数	HTTP 请求的超时时间。 默认: 30
use_https 布尔值	如果为 no，它将使用 HTTP。否则它将使用 HTTPS。 仅对 Meraki 内部开发人员有用。 选项 false true ← (默认)
use_proxy 布尔值	如果为 no，即使在目标主机上的环境变量中定义了代理，它也不会使用代理。 选项 false ← (默认) true
validate_certs 布尔值	是否验证 HTTP 证书。 选项 false true ← (默认)
wan1 字典	WAN1 上行链路的配置
bandwidth_limits 字典	用于配置带宽限制的结构
limit_down 整数	接口的最大下载速度
limit_up 整数	接口的最大上传速度
wan2 字典	WAN2 上行链路的配置
bandwidth_limits 字典	用于配置带宽限制的结构
limit_down 整数	接口的最大下载速度
limit_up 整数	接口的最大上传速度

注释

注意

• 某些选项可能仅供 Meraki 内的开发人员使用。

• 该模块以前名为 cisco.meraki.meraki_mx_uplink。

• 有关 Meraki API 的更多信息，请访问 https://dashboard.meraki.com/api_docs。

• 某些选项可能仅供 Meraki 内的开发人员使用。

• 从 Ansible 2.9 开始，Meraki 模块将键输出为蛇形命名法。要使用驼峰命名法，请将 ANSIBLE_MERAKI_FORMAT 环境变量设置为 camelcase。

• Ansible 的 Meraki 模块将在 Ansible 2.13 中停止支持驼峰命名法输出。请更新您的 playbook。

• 检查模式从仪表板下载当前配置，然后将更改与此下载进行比较。如果配置存在差异，检查模式将报告已更改，但不会将更改提交到 API 以进行更改验证。

示例

- name: Set MX uplink settings
  meraki_mx_uplink_bandwidth:
    auth_key: '{{auth_key}}'
    state: present
    org_name: '{{test_org_name}}'
    net_name: '{{test_net_name}} - Uplink'
    wan1:
      bandwidth_limits:
        limit_down: 1000000
        limit_up: 1000
    cellular:
      bandwidth_limits:
        limit_down: 0
        limit_up: 0
  delegate_to: localhost

- name: Query MX uplink settings
  meraki_mx_uplink_bandwidth:
    auth_key: '{{auth_key}}'
    state: query
    org_name: '{{test_org_name}}'
    net_name: '{{test_net_name}} - Uplink'
  delegate_to: localhost

返回值

常见返回值记录在此处，以下是此模块特有的字段

键	描述
数据 复杂	有关已创建或修改的组织的信息 返回: 成功
cellular 复杂	蜂窝接口 返回: 成功
bandwidth_limits 复杂	上行链路带宽限制的结构 返回: 成功
limit_down 整数	下载带宽限制 返回: 成功
limit_up 整数	上传带宽限制 返回: 成功
wan1 复杂	WAN1 接口 返回: 成功
bandwidth_limits 复杂	上行链路带宽限制的结构 返回: 成功
limit_down 整数	下载带宽限制 返回: 成功
limit_up 整数	上传带宽限制 返回: 成功
wan2 复杂	WAN2 接口 返回: 成功
bandwidth_limits 复杂	上行链路带宽限制的结构 返回: 成功
limit_down 整数	下载带宽限制 返回: 成功
limit_up 整数	上传带宽限制 返回: 成功

状态

• 此模块将在 3.0.0 版中删除。[已弃用]

• 有关更多信息，请参阅已弃用。

作者

• Kevin Breit (@kbreit)

集合链接

• 问题跟踪器
• 仓库（源代码）