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

Примечание

Этот модуль входит в коллекцию cisco.meraki (версия 2.18.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 строка / обязательно	Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды `MERAKI_KEY` не установлена.
cellular словарь	Настройка сотового канала
bandwidth_limits словарь	Структура для настройки лимитов пропускной способности
limit_down целое число	Максимальная скорость загрузки для интерфейса
limit_up целое число	Максимальная скорость отправки для интерфейса
host строка	Имя хоста для панели управления Meraki. Можно использовать для доступа к региональным средам Meraki, таким как Китай. По умолчанию: `"api.meraki.com"`
internal_error_retry_time целое число	Количество секунд для повторной попытки, если сервер возвращает ошибку внутренней серверной ошибки. По умолчанию: `60`
net_id строка	Идентификатор сети, в которой находится или должна находиться VLAN.
net_name псевдонимы: network строка	Имя сети, в которой находится или должна находиться VLAN.
org_id строка	Идентификатор организации, связанной с сетью.
org_name псевдонимы: organization строка	Название организации, связанной с сетью.
output_format строка	Указывает модулю, должны ли ключи ответа быть в формате snake_case (например, `net_id`) или camelCase (например, `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.
Дополнительную информацию об API Meraki можно найти по адресу https://dashboard.meraki.com/api_docs.
Некоторые из параметров, вероятно, используются только разработчиками Meraki.
Начиная с Ansible 2.9, модули Meraki выводят ключи в нижнем регистре со знаками подчёркивания. Для использования верблюжьего регистра установите переменную среды ANSIBLE_MERAKI_FORMAT в camelcase.
Модули Meraki Ansible перестанут поддерживать вывод в верблюжьем регистре в 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

Значения возврата

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

Ключ	Описание
data сложный	Информация об организации, которая была создана или изменена Возвращено: успех
cellular сложный	интерфейс cellular Возвращено: успех
bandwidth_limits сложный	Структура для лимитов пропускной способности канала Возвращено: успех
limit_down целое число	Лимит пропускной способности загрузки Возвращено: успех
limit_up целое число	Лимит пропускной способности выгрузки Возвращено: успех
wan1 сложный	Интерфейс WAN1 Возвращено: успех
bandwidth_limits сложный	Структура для лимитов пропускной способности канала Возвращено: успех
... (rest of the table)

Статус

Этот модуль будет удален в версии 3.0.0. [устаревший]
Дополнительную информацию см. в УСТАРЕВШЕМ.

Авторы

Kevin Breit (@kbreit)

Ссылки на сборки

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