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

Примечание

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

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

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

Чтобы использовать коллекцию в плейбуке, укажите: cisco.meraki.meraki_ms_stack_l3_interface.

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

УСТАРЕЛО

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

Краткое описание

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

Параметры

Параметр	Комментарии
auth_key string / обязательный	Ключ аутентификации, предоставленный панелью управления. Обязателен, если переменная среды `MERAKI_KEY` не задана.
default_gateway string	Следующий узел для трафика, направляемого не в непосредственно подключённую подсеть и не по статическому маршруту. Этот IP-адрес должен находиться в подсети с маршрутизируемым интерфейсом.
host string	Имя узла панели управления Meraki. Можно использовать для доступа к региональным средам Meraki, например к среде в Китае. По умолчанию: `"api.meraki.com"`
interface_id string	Уникальный идентификатор интерфейса уровня 3.
interface_ip string	IP-адрес, который коммутатор будет использовать для маршрутизации уровня 3 в этой VLAN или подсети. Он не может совпадать с IP-адресом управления коммутатора.
internal_error_retry_time integer	Количество секунд ожидания перед повторной попыткой, если сервер возвращает внутреннюю ошибку. По умолчанию: `60`
multicast_routing string	Включить поддержку многоадресной рассылки, если требуется маршрутизация многоадресного трафика между VLAN. Варианты: `"disabled"` `"enabled"` `"IGMP snooping querier"`
name string	Понятное имя или описание интерфейса либо VLAN.
net_id string	Идентификатор сети, к которой применяется конфигурация.
net_name псевдонимы: network string	Имя сети, к которой применяется конфигурация.
org_id string	Идентификатор организации.
org_name псевдонимы: organization string	Имя организации.
ospf_settings dictionary	Параметры маршрутизации OSPF для интерфейса.
area string	Область OSPF, к которой должен относиться этот интерфейс. Значением может быть «disabled» или идентификатор существующей области OSPF.
cost integer	Стоимость маршрута для этого интерфейса.
is_passive_enabled boolean	Если параметр включён, OSPF не будет работать на интерфейсе, но подсеть по-прежнему будет анонсироваться. Варианты: `false` `true`
output_format string	Указывает модулю, использовать ли в ключах ответа snake case (например, `net_id`) или camel case (например, `netId`). Варианты: `"snakecase"` ← (по умолчанию) `"camelcase"`
output_level string	Задаёт объём отладочных данных во время выполнения модуля. Варианты: `"debug"` `"normal"` ← (по умолчанию)
rate_limit_retry_time integer	Количество секунд ожидания перед повторной попыткой при срабатывании ограничителя частоты запросов. По умолчанию: `165`
stack_id string	Уникальный идентификатор стека.
state string	Создать или изменить организацию. Варианты: `"present"` ← (по умолчанию) `"query"` `"absent"`
subnet string	Сеть, к которой относится этот маршрутизируемый интерфейс, в нотации CIDR.
timeout integer	Время ожидания для 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.
В Ansible 2.13 модули Meraki для Ansible перестанут поддерживать вывод в camel case. Обновите свои плейбуки.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с загруженной конфигурацией. Режим проверки сообщает об изменениях, если конфигурации различаются, но не отправляет изменения в API для их проверки.

Примеры

- name: Query all l3 interfaces
  meraki_ms_stack_l3_interface:
    auth_key: abc123
    state: query
    serial: aaa-bbb-ccc

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

- name: Create l3 interface
  meraki_ms_stack_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_stack_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_stack_l3_interface:
    auth_key: abc123
    state: absent
    serial: aaa-bbb-ccc
    interface_id: abc123344566

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

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

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

Статус

Этот модуль будет удалён в версии 3.0.0. [устарело]
Дополнительные сведения см. в разделе УСТАРЕЛО.

Авторы

Kevin Breit (@kbreit)

Ссылки на коллекцию

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