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

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install cisco.meraki.

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

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

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

УСТАРЕЛО

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

Описание

Позволяет управлять и контролировать порты MX Merkai второго уровня.

Параметры

Параметр	Комментарии
access_policy string	Название политики. Применимо только к портам доступа. Варианты: `"open"` `"8021x-radius"` `"mac-radius"` `"hybris-radius"`
allowed_vlans string	Список идентификаторов VLAN, разрешенных на порту, разделенных запятыми, или «all», чтобы разрешить все VLAN на порту.
auth_key string / required	Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды `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, когда порт находится в режиме Trunk. VLAN доступа, когда порт находится в режиме Access.

Примечания

Примечание

Более подробная информация об API Meraki доступна по адресу https://dashboard.meraki.com/api_docs.
Некоторые параметры, вероятно, используются только разработчиками Meraki.
Начиная с Ansible 2.9, модули Meraki выводят ключи в формате snake_case. Чтобы использовать camelCase, установите переменную окружения ANSIBLE_MERAKI_FORMAT в значение camelcase.
Модули Meraki в Ansible прекратят поддержку вывода camelCase в Ansible 2.13. Обновите свои playbook'ы.
Режим проверки загружает текущую конфигурацию с панели управления, затем сравнивает изменения с этой загрузкой. Режим проверки сообщит об изменениях, если есть различия в конфигурациях, но не отправит изменения в 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-ID через запятую, разрешённых на порту, или «all» для разрешения всех VLAN на порту. Возвращается: success Пример: `"1,5,10"`
drop_untagged_traffic boolean	Порт Trunk может отбрасывать весь немаркированный трафик. При true не требуется ни один VLAN. Для портов доступа dropUntaggedTraffic не может быть установлено в значение true. Возвращается: success Пример: `true`
enabled boolean	Состояние включения порта. Возвращается: success Пример: `true`
number integer	ID номера порта MX. Возвращается: success Пример: `4`
type string	Тип порта. Возвращается: success Пример: `"access"`
vlan integer	Базовый VLAN, когда порт находится в режиме Trunk. VLAN доступа, когда порт находится в режиме Access. Возвращается: success Пример: `1`

Статус

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