cisco.meraki.meraki_mx_uplink_bandwidth – Управление каналами связи на устройствах Meraki MX
Примечание
Этот плагин входит в состав коллекции cisco.meraki (версия 2.2.0).
Для его установки используйте: ansible-galaxy collection install cisco.meraki.
Для использования в плейбуке укажите: cisco.meraki.meraki_mx_uplink_bandwidth.
Новое в версии 1.1.0: коллекции cisco.meraki
Описание
- Настройка и запрос информации о каналах связи на устройствах Meraki MX.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| auth_key строка / обязательно | Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды MERAKI_KEY не установлена. | |||
| cellular словарь | Настройка канала связи сотовой связи | |||
| bandwidth_limits словарь | Структура для настройки лимитов пропускной способности | |||
| limit_down целое число | Максимальная скорость загрузки для интерфейса | |||
| limit_up целое число | Максимальная скорость загрузки для интерфейса | |||
| host строка | По умолчанию: "api.meraki.com" | Имя хоста для панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, например, Китая. | ||
| internal_error_retry_time целое число | По умолчанию: 60 | Количество секунд для повторной попытки, если сервер возвращает ошибку внутренней серверной ошибки. | ||
| net_id строка | ID сети, в которой находится или должна находиться VLAN. | |||
| net_name строка | Имя сети, в которой находится или должна находиться VLAN. псевдонимы: сеть | |||
| org_id строка | ID организации, связанной с сетью. | |||
| org_name строка | Имя организации, связанной с сетью. псевдонимы: организация | |||
| output_format строка |
| Указывает модулю, должны ли ключи ответа быть в формате snake case (например, net_id) или camel case (например, netId). | ||
| output_level строка |
| Устанавливает объем отладочного вывода во время выполнения модуля. | ||
| rate_limit_retry_time целое число | По умолчанию: 165 | Количество секунд для повторной попытки, если триггер лимита скорости. | ||
| state строка |
| Указывает, должен ли объект быть запрошен, создан/изменен или удален. | ||
| timeout целое число | По умолчанию: 30 | Время ожидания для HTTP-запросов. | ||
| use_https логическое значение |
| Если no, то будет использоваться HTTP. В противном случае будет использоваться HTTPS.Полезно только для разработчиков Meraki. | ||
| use_proxy логическое значение |
| Если no, то прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах. | ||
| validate_certs логическое значение |
| Выполнять ли проверку сертификатов HTTP. | ||
| wan1 словарь | Настройка канала связи WAN1 | |||
| bandwidth_limits словарь | Структура для настройки лимитов пропускной способности | |||
| limit_down целое число | Максимальная скорость загрузки для интерфейса | |||
| limit_up целое число | Максимальная скорость загрузки для интерфейса | |||
| wan2 словарь | Настройка канала связи WAN2 | |||
| bandwidth_limits словарь | Структура для настройки лимитов пропускной способности | |||
| limit_down целое число | Максимальная скорость загрузки для интерфейса | |||
| limit_up целое число | Максимальная скорость загрузки для интерфейса | |||
Примечания
Примечание
- Некоторые параметры, вероятно, используются только разработчиками 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 | success | Интерфейс WAN1 | |||
| bandwidth_limits complex | success | Структура ограничений пропускной способности канала передачи данных | |||
| limit_down integer | success | Предел пропускной способности для загрузки | |||
| limit_up integer | success | Предел пропускной способности для отправки | |||
| wan2 complex | success | Интерфейс WAN2 | |||
| bandwidth_limits complex | success | Структура ограничений пропускной способности канала передачи данных | |||
| limit_down integer | success | Предел пропускной способности для загрузки | |||
| limit_up integer | success | Предел пропускной способности для отправки | |||
Авторы
- Kevin Breit (@kbreit)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/meraki/meraki_mx_uplink_bandwidth_module.html
