cisco.meraki.meraki_mx_uplink_bandwidth module – Управление восходящими каналами на устройствах Meraki MX

Примечание

Этот модуль входит в коллекцию cisco.meraki (версия 2.23.2).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install cisco.meraki.

Чтобы использовать её в плейбуке, укажите: 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 dictionary	Настройка сотового восходящего канала
bandwidth_limits dictionary	Структура для настройки ограничений пропускной способности
limit_down integer	Максимальная скорость загрузки для интерфейса
limit_up integer	Максимальная скорость отдачи для интерфейса
host string	Имя хоста панели управления Meraki. Можно использовать для доступа к региональным средам Meraki, например в Китае. По умолчанию: `"api.meraki.com"`
internal_error_retry_time integer	Количество секунд до повторной попытки, если сервер возвращает внутреннюю ошибку. По умолчанию: `60`
net_id string	Идентификатор сети, в которой находится VLAN или в которой он должен находиться.
net_name псевдонимы: network string	Имя сети, в которой находится VLAN или в которой он должен находиться.
org_id string	Идентификатор организации, связанной с сетью.
org_name псевдонимы: organization string	Имя организации, связанной с сетью.
output_format string	Указывает модулю, следует ли использовать для ключей ответа snake case (например, `net_id`) или camel case (например, `netId`). Варианты: `"snakecase"` ← (по умолчанию) `"camelcase"`
output_level string	Задаёт объём отладочной информации, выводимой во время выполнения модуля. Варианты: `"debug"` `"normal"` ← (по умолчанию)
rate_limit_retry_time integer	Количество секунд до повторной попытки при срабатывании ограничения частоты запросов. По умолчанию: `165`
state string	Указывает, нужно ли запросить сведения об объекте, создать или изменить его либо удалить. Варианты: `"absent"` `"present"` `"query"` ← (по умолчанию)
timeout integer	Время ожидания для HTTP-запросов. По умолчанию: `30`
use_https boolean	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki. Варианты: `false` `true` ← (по умолчанию)
use_proxy boolean	Если `no`, прокси использоваться не будет, даже если он указан в переменной среды на целевых хостах. Варианты: `false` ← (по умолчанию) `true`
validate_certs boolean	Следует ли проверять сертификаты HTTP. Варианты: `false` `true` ← (по умолчанию)
wan1 dictionary	Настройка восходящего канала WAN1
bandwidth_limits dictionary	Структура для настройки ограничений пропускной способности
limit_down integer	Максимальная скорость загрузки для интерфейса
limit_up integer	Максимальная скорость отдачи для интерфейса
wan2 dictionary	Настройка восходящего канала WAN2
bandwidth_limits dictionary	Структура для настройки ограничений пропускной способности
limit_down integer	Максимальная скорость загрузки для интерфейса
limit_up integer	Максимальная скорость отдачи для интерфейса

Примечания

Примечание

Некоторые параметры, вероятно, используются только разработчиками Meraki.
Ранее модуль назывался cisco.meraki.meraki_mx_uplink.
Дополнительные сведения об API Meraki см. на странице https://dashboard.meraki.com/api_docs.
Некоторые параметры, вероятно, используются только разработчиками Meraki.
Начиная с Ansible 2.9 модули Meraki выводят ключи в формате snake case. Чтобы использовать camel case, задайте для переменной среды ANSIBLE_MERAKI_FORMAT значение camelcase.
Модули Meraki в Ansible перестанут поддерживать вывод в формате camel case в Ansible 2.13. Обновите свои плейбуки.
Режим проверки загружает текущую конфигурацию из панели управления, а затем сравнивает изменения с загруженными данными. В режиме проверки будет сообщено об изменениях, если конфигурации различаются, но изменения не отправляются в 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

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
data complex	Сведения об организации, которая была создана или изменена Возвращается: success
cellular complex	Сотовый интерфейс Возвращается: success
bandwidth_limits complex	Структура ограничений пропускной способности восходящего канала Возвращается: success
limit_down integer	Ограничение пропускной способности для загрузки Возвращается: success
limit_up integer	Ограничение пропускной способности для отдачи Возвращается: success
wan1 complex	Интерфейс WAN1 Возвращается: success
bandwidth_limits complex	Структура ограничений пропускной способности восходящего канала Возвращается: success
limit_down integer	Ограничение пропускной способности для загрузки Возвращается: success
limit_up integer	Ограничение пропускной способности для отдачи Возвращается: success
wan2 complex	Интерфейс WAN2 Возвращается: success
bandwidth_limits complex	Структура ограничений пропускной способности восходящего канала Возвращается: success
limit_down integer	Ограничение пропускной способности для загрузки Возвращается: success
limit_up integer	Ограничение пропускной способности для отдачи Возвращается: success

Статус

Этот модуль будет удалён в версии 3.0.0. [устарело]
Дополнительные сведения см. в разделе УСТАРЕЛО.

Авторы

Kevin Breit (@kbreit)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/meraki/meraki_mx_uplink_bandwidth_module.html