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

Примечание

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

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

Для использования в книге задач укажите: cisco.meraki.meraki_switchport.

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

Описание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
access_policy_number целое число		Номер политики доступа для применения. Применимо только к портам типа access.
access_policy_type строка	Варианты: Open Пользовательская политика доступа Белый список MAC-адресов Постоянный белый список MAC-адресов	Тип политики доступа для применения к порту.
allowed_vlans список / элементы=строка	Значение по умолчанию: "all"	Список номеров VLAN, разрешенных на порту коммутатора.
auth_key строка / обязательный		Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная окружения `MERAKI_KEY` не задана.
enabled логическое значение	Варианты: no да ←	Включен или выключен порт коммутатора.
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 строка	Варианты: snake_case ← camelCase	Указывает модулю, следует ли использовать в ключах ответа snake_case (например, `net_id`) или camelCase (например, `netId`).
output_level строка	Варианты: debug normal ←	Устанавливает объем отладочного вывода во время выполнения модуля.
poe_enabled логическое значение	Варианты: нет да ←	Включить или отключить Power over Ethernet на порту.
rate_limit_retry_time целое число	Значение по умолчанию: 165	Количество секунд для повторной попытки, если срабатывает ограничение скорости.
rstp_enabled логическое значение	Варианты: нет да ←	Включить или отключить протокол Rapid Spanning Tree на порту.
serial строка / обязательный		Серийный номер коммутатора.
state строка	Варианты: запрос ← present	Указывает, следует ли запросить состояние порта или изменить его.
stp_guard строка	Варианты: отключен ← root guard bpdu guard loop guard	Установить состояние защиты STP.
tags список / элементы=строка		Список тегов для назначения порту.
timeout целое число	Значение по умолчанию: 30	Время ожидания для HTTP-запросов.
type строка	Варианты: доступ ← trunk	Установить тип порта.
use_https логическое значение	Варианты: нет да ←	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki.
use_proxy логическое значение	Варианты: нет ← да	Если `no`, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах.
validate_certs логическое значение	Варианты: нет да ←	Проверять ли сертификаты HTTP.
vlan целое число		Номер VLAN, назначенный порту. Если порт типа trunk, указанная VLAN — это родственная VLAN.
voice_vlan целое число		Номер 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. Обновите свои книги задач.
Режим проверки скачивает текущую конфигурацию с панели управления, затем сравнивает изменения с этим скачиванием. Режим проверки сообщит о изменениях, если есть различия в конфигурациях, но не отправит изменения в API для проверки изменений.

Примеры

- 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	Описание порта для удобства пользователя. Пример: Порт телефона Jim
	number integer	success	Номер порта. Пример: 1
	poe_enabled boolean	success	Состояние включения PoE (Power Over Ethernet) для порта. Пример: True
	rstp_enabled boolean	success	Включено или выключено протокол Rapid Spanning Tree (RSTP). Пример: True
	stp_guard string	success	Состояние STP-защиты. Пример: Защита корневого узла
	tags list / elements=string	success	Список тегов, назначенных порту. Пример: ['телефон', 'маркетинг']
	type string	success	Тип коммутационного порта. Пример: trunk
	vlan integer	success	Назначенный VLAN для порта. Пример: 10
	voice_vlan integer	success	VLAN, назначенный порту с устройствами, включенными в голосовую VLAN. Пример: 20

Авторы

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.10/collections/cisco/meraki/meraki_switchport_module.html