модуль cisco.meraki.meraki_ms_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_l3_interface.

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

УСТАРЕЛО

Удалено в:: версии 3.0.0
Причина:: Выпущены обновлённые модули с расширенными возможностями
Альтернатива:: cisco.meraki.devices_switch_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.
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`
serial string	Серийный номер коммутатора MS, на котором размещён интерфейс уровня 3.
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.
Поддержка вывода в формате camel case в модулях Meraki для Ansible будет прекращена в 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 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_l3_interface_module.html