cisco.meraki.meraki_ms_l3_interface – Управление маршрутизируемыми интерфейсами на коммутаторах MS

Примечание

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

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

Для использования в книге задач укажите: cisco.meraki.meraki_ms_l3_interface

Описание
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Позволяет создавать, управлять и получать доступ к маршрутизируемым интерфейсам на коммутаторах Meraki MS.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
auth_key строка / обязательно			Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды `MERAKI_KEY` не задана.
default_gateway строка			Следующий прыжок для любого трафика, который не направляется в непосредственно подключённую подсеть или по статическому маршруту. Этот IP-адрес должен существовать в подсети с маршрутизируемым интерфейсом.
host строка		По умолчанию: "api.meraki.com"	Имя хоста панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, таким как Китай.
interface_id строка			Уникальный идентификатор интерфейса уровня 3.
interface_ip строка			IP-адрес, который будет использовать коммутатор для маршрутизации уровня 3 в данной VLAN или подсети. Не может быть таким же, как IP-адрес управления коммутатора.
internal_error_retry_time целое число		По умолчанию: 60	Количество секунд, в течение которых будет производиться повторная попытка, если сервер вернёт ошибку внутренней системы.
multicast_routing строка		Варианты: disabled enabled IGMP snooping querier	Включить поддержку мультикаста, если требуется маршрутизация мультикаста между VLAN.
name строка			Дружественное имя или описание интерфейса или VLAN.
org_id строка			Идентификатор организации.
org_name строка			Название организации. псевдонимы: организация
ospf_settings словарь			Настройки маршрутизации OSPF для интерфейса.
	area строка		Область OSPF, к которой должен принадлежать этот интерфейс. Может быть либо «disabled», либо идентификатор существующей области OSPF.
	cost целое число		Стоимость пути для этого интерфейса.
	is_passive_enabled булево	Варианты: no yes	При включении OSPF не будет работать на интерфейсе, но подсеть всё равно будет рекламироваться.
output_format строка		Варианты: snakecase ← camelcase	Указывает модулю, должны ли ключи ответа быть в формате snake case (например, `net_id`) или camel case (например, `netId`).
output_level строка		Варианты: debug normal ←	Установить объём отладочной информации во время выполнения модуля.
rate_limit_retry_time целое число		По умолчанию: 165	Количество секунд, в течение которых будет производиться повторная попытка, если срабатывает ограничитель скорости.
serial строка			Серийный номер коммутатора MS, на котором находится интерфейс уровня 3.
state строка		Варианты: present ← query absent	Создать или изменить организацию.
subnet строка			Сеть, в которой находится этот маршрутизируемый интерфейс, в обозначении CIDR.
timeout целое число		По умолчанию: 30	Время ожидания для HTTP-запросов.
use_https булево		Варианты: no yes ←	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki.
use_proxy булево		Варианты: no ← yes	Если `no`, прокси не будет использоваться, даже если он определён в переменной окружения на целевых хостах.
validate_certs булево		Варианты: no yes ←	Проверять ли HTTP-сертификаты.
vlan_id целое число			VLAN, на котором находится этот маршрутизируемый интерфейс. VLAN должен быть от 1 до 4094.

Примечания

Примечание

После создания интерфейса уровня 3 API не позволяет обновить интерфейс и указать default_gateway.
Дополнительную информацию об 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: Query all l3 interfaces
  meraki_ms_l3_interface:
    auth_key: abc123
    state: query
    serial: aaa-bbb-ccc

- name: Query one l3 interface
  meraki_ms_l3_interface:
    auth_key: abc123
    state: query
    serial: aaa-bbb-ccc
    name: Test L3 interface

- name: Create l3 interface
  meraki_ms_l3_interface:
    auth_key: abc123
    state: present
    serial: aaa-bbb-ccc
    name: "Test L3 interface 2"
    subnet: "192.168.3.0/24"
    interface_ip: "192.168.3.2"
    multicast_routing: disabled
    vlan_id: 11
    ospf_settings:
      area: 0
      cost: 1
      is_passive_enabled: true

- name: Update l3 interface
  meraki_ms_l3_interface:
    auth_key: abc123
    state: present
    serial: aaa-bbb-ccc
    name: "Test L3 interface 2"
    subnet: "192.168.3.0/24"
    interface_ip: "192.168.3.2"
    multicast_routing: disabled
    vlan_id: 11
    ospf_settings:
      area: 0
      cost: 2
      is_passive_enabled: true

- name: Delete l3 interface
  meraki_ms_l3_interface:
    auth_key: abc123
    state: absent
    serial: aaa-bbb-ccc
    interface_id: abc123344566

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

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

Ключ			Возвращаемое значение	Описание
data сложное			успех	Информация об интерфейсах уровня 3.
	default_gateway строка		успех	Следующий прыжок для любого трафика, который не направляется в непосредственно подключённую подсеть или по статическому маршруту. Пример: 192.168.2.1
	interface_id строка		успех	Уникальный идентификатор интерфейса уровня 3. Пример: 62487444811111120
	interface_ip строка		успех	IP-адрес, который будет использовать коммутатор для маршрутизации уровня 3 в данной VLAN или подсети. Пример: 192.168.2.2
	multicast_routing строка		успех	Включить поддержку мультикаста, если требуется маршрутизация мультикаста между VLAN. Пример: disabled
	name строка		успех	Дружественное имя или описание интерфейса или VLAN. Пример: L3 interface
	ospf_settings сложное		успех	Настройки маршрутизации OSPF для интерфейса.
		area строка	успех	Область OSPF, к которой должен принадлежать этот интерфейс.
		cost целое число	успех	Стоимость пути для этого интерфейса. Пример: 1
		is_passive_enabled булево	успех	При включении OSPF не будет работать на интерфейсе, но подсеть всё равно будет рекламироваться. Пример: True
	subnet строка		успех	Сеть, в которой находится этот маршрутизируемый интерфейс, в обозначении CIDR. Пример: 192.168.2.0/24
	vlan_id целое число		успех	VLAN, на котором находится этот маршрутизируемый интерфейс. Пример: 10

Авторы

Кевин Брайт (@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_ms_l3_interface_module.html