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

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: cisco.meraki.meraki_ms_l3_interface.

УСТАРЕЛО
Описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

УСТАРЕЛО

Удалено в:: версии 3.0.0
Почему:: Выпущены обновлённые модули с расширенными функциями
Альтернатива:: cisco.meraki.devices_switch_routing_interfaces

Описание

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

END_OF_DOCUMENT_MARKER

Параметры

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

use_https boolean	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki. Варианты: `false` `true` ← (по умолчанию)
use_proxy boolean	Если `no`, прокси не будет использоваться, даже если он определен в переменной окружения на целевых хостах. Варианты: `false` ← (по умолчанию) `true`
validate_certs boolean	Подтверждать ли сертификаты HTTP. Варианты: `false` `true` ← (по умолчанию)
vlan_id integer	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. Пожалуйста, обновите свои playbook'ы.
Режим проверки скачивает текущую конфигурацию с панели управления, затем сравнивает изменения с этим скачиванием. Режим проверки сообщит об изменениях, если существуют различия в конфигурациях, но не отправляет изменения в 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, к которой должен принадлежать этот интерфейс. Возвращено: успешно Пример: `"0"`
cost целое число	Стоимость пути для этого интерфейса. Возвращено: успешно Пример: `1`
is_passive_enabled булево	При включенном режиме OSPF не будет работать на интерфейсе, но подсеть всё равно будет рекламироваться. Возвращено: успешно Пример: `true`
subnet строка	Сеть, в которой находится этот интерфейс маршрутизации, в нотации CIDR. Возвращено: успешно Пример: `"192.168.2.0/24"`
vlan_id целое число	VLAN, в котором находится этот интерфейс маршрутизации. Возвращено: успешно Пример: `10`

Статус

Этот модуль будет удален в версии 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_ms_l3_interface_module.html