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

Примечание

Этот плагин входит в коллекцию cisco.meraki (версия 2.1.3).

Для его установки используйте: ansible-galaxy collection install cisco.meraki.

Для использования в playbook, укажите: cisco.meraki.meraki_mx_uplink.

Новое в версии 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 строка			Варианты: snakecase ← camelcase	Указывает модулю, следует ли использовать для ключей ответа snake case (например, `net_id`) или camel case (например, `netId`).
output_level строка			Варианты: debug normal ←	Установите количество вывода отладки во время выполнения модуля.
rate_limit_retry_time целое число			По умолчанию: 165	Количество секунд для повторной попытки, если срабатывает ограничитель скорости.
state строка			Варианты: absent present query ←	Указывает, следует ли запросить объект, создать/изменить его или удалить.
timeout целое число			По умолчанию: 30	Время ожидания для HTTP-запросов.
use_https булево			Варианты: no yes ←	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki.
use_proxy булево			Варианты: no ← yes	Если `no`, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах.
validate_certs булево			Варианты: no yes ←	Требовать проверку 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. Обновите свои 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 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/meraki/meraki_mx_uplink_module.html