модуль cisco.meraki.meraki_mx_l2_interface — настройка интерфейсов уровня 2 MX

Примечание

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

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

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

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

Добавлено в cisco.meraki 2.1.0

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

УСТАРЕЛО

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

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

Позволяет управлять портами уровня 2 Meraki MX и просматривать информацию о них.

Параметры

Параметр	Комментарии
access_policy string	Название политики. Применимо только к портам доступа. Варианты: `"open"` `"8021x-radius"` `"mac-radius"` `"hybris-radius"`
allowed_vlans string	Разделённый запятыми список разрешённых на порту идентификаторов VLAN или «all», чтобы разрешить все VLAN на порту.
auth_key string / обязательный	Ключ аутентификации, предоставленный панелью управления. Обязателен, если не задана переменная окружения `MERAKI_KEY`.
drop_untagged_traffic boolean	На транковом порту можно отбрасывать весь нетегированный трафик. Если задано значение true, VLAN не требуется. Для портов доступа нельзя задавать dropUntaggedTraffic равным true. Варианты: `false` `true`
enabled boolean	Состояние порта: включён или выключен. Варианты: `false` `true`
host string	Имя узла панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, например в Китае. По умолчанию: `"api.meraki.com"`
internal_error_retry_time integer	Количество секунд ожидания перед повторной попыткой, если сервер возвращает внутреннюю ошибку. По умолчанию: `60`
net_id string	Идентификатор сети.
net_name псевдонимы: name, network string	Название сети.
number псевдонимы: port, port_id integer	Идентификатор порта MX.
org_id string	Идентификатор организации, связанной с сетью.
org_name псевдонимы: organization string	Название организации.
output_format string	Указывает модулю, следует ли использовать в ключах ответа формат snake case (например, `net_id`) или camel case (например, `netId`). Варианты: `"snakecase"` ← (по умолчанию) `"camelcase"`
output_level string	Задаёт объём отладочных сообщений во время выполнения модуля. Варианты: `"debug"` `"normal"` ← (по умолчанию)
port_type string	Тип порта. Варианты: `"access"` `"trunk"`
rate_limit_retry_time integer	Количество секунд ожидания перед повторной попыткой, если сработало ограничение частоты запросов. По умолчанию: `165`
state string	Изменение конфигурации порта или получение сведений о нём. Варианты: `"present"` ← (по умолчанию) `"query"`
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 integer	Нативная VLAN, если порт работает в транковом режиме. VLAN доступа, если порт работает в режиме доступа.

Примечания

Примечание

Дополнительную информацию об 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 перестанут поддерживать вывод в формате camel case. Обновите свои плейбуки.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает с ней изменения. В режиме проверки будет сообщено об изменениях, если конфигурации различаются, но изменения не отправляются в API для проверки.

Примеры

- name: Query layer 2 interface settings
  meraki_mx_l2_interface:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: query
  delegate_to: localhost

- name: Query a single layer 2 interface settings
  meraki_mx_l2_interface:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: query
    number: 2
  delegate_to: localhost

- name: Update interface configuration
  meraki_mx_l2_interface:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: present
    number: 2
    port_type: access
    vlan: 10
  delegate_to: localhost

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

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

Ключ	Описание
data complex	Информация о созданном или изменённом объекте. Возвращается: success
access_policy string	Название политики. Применимо только к портам доступа. Возвращается: success Пример: `"guestUsers"`
allowed_vlans string	Разделённый запятыми список разрешённых на порту идентификаторов VLAN или «all», чтобы разрешить все VLAN на порту. Возвращается: success Пример: `"1,5,10"`
drop_untagged_traffic boolean	На транковом порту можно отбрасывать весь нетегированный трафик. Если задано значение true, VLAN не требуется. Для портов доступа нельзя задавать dropUntaggedTraffic равным true. Возвращается: success Пример: `true`
enabled boolean	Состояние порта: включён или выключен. Возвращается: success Пример: `true`
number integer	Идентификатор порта MX. Возвращается: success Пример: `4`
type string	Тип порта. Возвращается: success Пример: `"access"`
vlan integer	Нативная VLAN, если порт работает в транковом режиме. VLAN доступа, если порт работает в режиме доступа. Возвращается: success Пример: `1`

Статус

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