cisco.meraki.meraki_mx_l2_interface – Настройка интерфейсов MX уровня 2

Примечание

Этот плагин входит в коллекцию cisco.meraki (версия 2.2.0).

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

Для использования в плейбуке укажите: cisco.meraki.meraki_mx_l2_interface.

Новое в версии 2.1.0: из cisco.meraki

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Обеспечивает управление и визуализацию портов MX Merkai уровня 2.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
access_policy строка	Варианты: open 8021x-radius mac-radius hybris-radius	Имя политики. Применимо только к портам доступа.
allowed_vlans строка		Список идентификаторов VLAN, разрешенных на порту, разделенных запятыми, или «all» для разрешения всех VLAN на порту.
auth_key строка / обязательно		Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды `MERAKI_KEY` не задана.
drop_untagged_traffic логическое	Варианты: no yes	Порт типа Trunk может отбрасывать весь немаркированный трафик. Если значение true, VLAN не требуется. Для портов доступа значение dropUntaggedTraffic не может быть установлено в true.
enabled логическое	Варианты: no yes	Состояние включения порта.
host строка	Значение по умолчанию: "api.meraki.com"	Имя хоста для панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, таким как Китай.
internal_error_retry_time целое число	Значение по умолчанию: 60	Количество секунд для повторной попытки, если сервер возвращает ошибку внутренней службы.
net_id строка		Идентификационный номер сети.
net_name строка		Имя сети. псевдонимы: name, network
number целое число		Идентификационный номер порта MX. псевдонимы: port, port_id
org_id строка		Идентификатор организации, связанной с сетью.
org_name строка		Имя организации. псевдонимы: organization
output_format строка	Варианты: snakecase ← camelcase	Указывает модулю, следует ли использовать для ключей ответа регистронезависимый формат (например, `net_id`) или регистрозависимый формат (например, `netId`).
output_level строка	Варианты: debug normal ←	Устанавливает объем отладочной информации во время выполнения модуля.
port_type строка	Варианты: access trunk	Тип порта.
rate_limit_retry_time целое число	Значение по умолчанию: 165	Количество секунд для повторной попытки, если срабатывает ограничение скорости.
state строка	Варианты: present ← query	Изменение или запрос состояния порта.
timeout целое число	Значение по умолчанию: 30	Время ожидания для HTTP-запросов.
use_https логическое	Варианты: no yes ←	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki.
use_proxy логическое	Варианты: no ← yes	Если `no`, прокси не будет использоваться, даже если он определён в переменной среды на целевых узлах.
validate_certs логическое	Варианты: no yes ←	Выполнять ли проверку сертификатов HTTP.
vlan целое число		VLAN по умолчанию, когда порт находится в режиме Trunk. VLAN доступа, когда порт находится в режиме доступа.

Примечания

Примечание

Дополнительную информацию об 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 сложный		успех	Информация о созданном или изменённом объекте.
	access_policy строка	успех	Название политики. Применимо только к портам доступа. Пример: guestUsers
	allowed_vlans строка	успех	Список VLAN-ID через запятую, разрешённых на порту, или «all» для разрешения всех VLAN на порту. Пример: 1,5,10
	drop_untagged_traffic логическое	успех	Порт trunk может отбрасывать весь немаркированный трафик. При значении true не требуется VLAN. Порты доступа не могут иметь dropUntaggedTraffic, установленным в true. Пример: True
	enabled логическое	успех	Состояние включения порта. Пример: True
	number целое число	успех	Идентификационный номер порта MX. Пример: 4
	type строка	успех	Тип порта. Пример: access
	vlan целое число	успех	VLAN по умолчанию, когда порт находится в режиме Trunk. VLAN доступа, когда порт находится в режиме Access. Пример: 1

Авторы

Kevin Breit (@kbreit)

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