meraki_switchport – Управление портами коммутатора в облаке Meraki

Новое в версии 2.7.

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

Обзор

Позволяет управлять настройками портов коммутаторов Meraki MS.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
access_policy_number -		Номер политики доступа для применения. Применимо только к портам типа доступа.
allowed_vlans -	По умолчанию: "all"	Список номеров VLAN, разрешённых на порту коммутатора.
auth_key строка / обязательно		Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды `MERAKI_KEY` не установлена.
enabled булево	Варианты: нет да ←	Включить или выключить порт коммутатора.
host строка	По умолчанию: "api.meraki.com"	Имя хоста панели управления Meraki. Может использоваться для доступа к региональным окружениям Meraki, например, Китая.
internal_error_retry_time целое число	По умолчанию: 60	Количество секунд для повторной попытки, если сервер возвращает ошибку внутренней серверной части.
isolation_enabled булево	Варианты: нет ← да	Статус изоляции порта коммутатора.
link_negotiation -	Варианты: Автопереговоры ← 100 мегабит (авто) 100 мегабит полдуплекс (принудительно)	Скорость канала для порта коммутатора.
name -		Описание порта коммутатора. Псевдонимы: описание
number -		Номер порта.
org_id строка		Идентификатор организации.
org_name строка		Название организации. Псевдонимы: организация
output_format строка	Варианты: snakecase ← camelcase	Указывает модулю, нужно ли использовать ключи ответа в формате змейки (например, `net_id`) или верблюда (например, `netId`).
output_level строка	Варианты: отладка обычный ←	Установить объём вывода отладки во время выполнения модуля.
poe_enabled булево	Варианты: нет да ←	Включить или выключить Power over Ethernet для порта.
rate_limit_retry_time целое число	По умолчанию: 165	Количество секунд для повторной попытки, если срабатывает ограничение скорости.
rstp_enabled булево	Варианты: нет да ←	Включить или выключить Rapid Spanning Tree Protocol для порта.
serial -		Серийный номер коммутатора.
state строка	Варианты: запрос ← текущее	Указывает, нужно ли запросить или изменить порт коммутатора.
stp_guard -	Варианты: выключен ← защита корневого узла защита BPDU защита от петель	Установить состояние STP защиты.
tags -		Список меток, разделённых пробелами, для назначения порту.
timeout целое число	По умолчанию: 30	Время ожидания для HTTP запросов.
type -	Варианты: доступ ← trunk	Установить тип порта.
use_https булево	Варианты: нет да ←	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki.
use_proxy булево	Варианты: нет да	Если `no`, прокси не будет использоваться, даже если он определён в переменной окружения на целевых хостах.
validate_certs булево	Варианты: нет да ←	Проверять ли сертификаты HTTP.
vlan -		Номер VLAN, назначенный порту. Если порт типа trunk, указанная VLAN — это native VLAN.
voice_vlan -		Номер VLAN, назначенный порту для голосового трафика. Применимо только к портам типа доступа.

Примечания

Примечание

Дополнительную информацию о Meraki API можно найти по адресу https://dashboard.meraki.com/api_docs.
Некоторые параметры, вероятно, используются только разработчиками Meraki.
Начиная с Ansible 2.9, модули Meraki выводят ключи в формате змейки. Чтобы использовать формат верблюда, установите переменную среды ANSIBLE_MERAKI_FORMAT в значение camelcase.
Модули Meraki Ansible прекратят поддержку вывода в формате верблюда в Ansible 2.13. Обновите свои playbook.

Примеры

- name: Query information about all switchports on a switch
  meraki_switchport:
    auth_key: abc12345
    state: query
    serial: ABC-123
  delegate_to: localhost

- name: Query information about all switchports on a switch
  meraki_switchport:
    auth_key: abc12345
    state: query
    serial: ABC-123
    number: 2
  delegate_to: localhost

- name: Name switchport
  meraki_switchport:
    auth_key: abc12345
    state: present
    serial: ABC-123
    number: 7
    name: Test Port
  delegate_to: localhost

- name: Configure access port with voice VLAN
  meraki_switchport:
    auth_key: abc12345
    state: present
    serial: ABC-123
    number: 7
    enabled: true
    name: Test Port
    tags: desktop
    type: access
    vlan: 10
    voice_vlan: 11
  delegate_to: localhost

- name: Check access port for idempotency
  meraki_switchport:
    auth_key: abc12345
    state: present
    serial: ABC-123
    number: 7
    enabled: true
    name: Test Port
    tags: desktop
    type: access
    vlan: 10
    voice_vlan: 11
  delegate_to: localhost

- name: Configure trunk port with specific VLANs
  meraki_switchport:
    auth_key: abc12345
    state: present
    serial: ABC-123
    number: 7
    enabled: true
    name: Server port
    tags: server
    type: trunk
    allowed_vlans:
      - 10
      - 15
      - 20
  delegate_to: localhost

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

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

Ключ		Возвращённое значение	Описание
data complex		success	Информация, запрошенная или обновлённая для коммутационных портов.
	access_policy_number integer	success	Номер назначенной политики доступа. Применимо только к портам доступа. Пример: 1234
	enabled boolean	success	Состояние включения порта. Пример: True
	isolation_enabled boolean	success	Статус изоляции порта. Пример: True
	link_negotiation string	success	Скорость канала для порта. Пример: Автопереговоры
	name string	success	Описание порта, понятное пользователю. Пример: Порт телефона Джима
	number integer	success	Номер порта. Пример: 1
	poe_enabled boolean	success	Состояние включения Power over Ethernet для порта. Пример: True
	rstp_enabled boolean	success	Состояние включения/выключения протокола Rapid Spanning Tree Protocol (RSTP). Пример: True
	stp_guard string	success	Состояние STP-защиты. Пример: Защита корневого порта
	tags string	success	Список тегов, разделённых пробелами, назначенных порту. Пример: телефон маркетинг
	type string	success	Тип коммутационного порта. Пример: trunk
	vlan integer	success	Назначенный VLAN-порт. Пример: 10
	voice_vlan integer	success	VLAN, назначенный порту с устройствами, у которых включен голосовой VLAN. Пример: 20

Статус

Данный модуль не гарантирует обратной совместимости интерфейса. [preview]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Kevin Breit (@kbreit)

Подсказка

Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/meraki_switchport_module.html