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

Примечание

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

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

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

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

Описание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
access_policy_number целое число		Номер политики доступа для применения. Применимо только к портам типа access.
access_policy_type строка	Варианты: Открытый Пользовательская политика доступа Белый список MAC-адресов Временный белый список MAC-адресов	Тип политики доступа, применяемой к порту.
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	Указывает модулю, должны ли ключи ответа быть в формате snake case (например, `net_id`) или camel case (например, `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. Для использования camel case, установите переменную окружения ANSIBLE_MERAKI_FORMAT в camelcase.
Модули Meraki в Ansible перестанут поддерживать вывод в формате camel case в 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 для порта. Пример: True
	rstp_enabled boolean	success	Включено или выключено протокол быстрой расстановки остова (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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/meraki/meraki_ms_switchport_module.html