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

Примечание

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

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

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

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

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

УСТАРЕЛО

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

Краткое описание

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

Параметры

Параметр	Комментарии
access_policy_number integer	Номер применяемой политики доступа. Применимо только к портам доступа.
access_policy_type string	Тип политики доступа, применяемой к порту. Варианты: `"Open"` `"Custom access policy"` `"MAC allow list"` `"Sticky MAC allow list"`
allowed_vlans list / elements=string	Список номеров VLAN, разрешённых на порту коммутатора. По умолчанию: `["all"]`
auth_key string / обязательный	Ключ аутентификации, предоставленный панелью управления. Обязателен, если не задана переменная среды `MERAKI_KEY`.
enabled boolean	Определяет, должен ли порт коммутатора быть включён или отключён. Варианты: `false` `true` ← (по умолчанию)
flexible_stacking_enabled boolean	Определяет, поддерживаются ли на порту возможности гибкого стекирования. Варианты: `false` `true`
host string	Имя хоста панели управления Meraki. Можно использовать для доступа к региональным средам Meraki, например в Китае. По умолчанию: `"api.meraki.com"`
internal_error_retry_time integer	Количество секунд до повторной попытки, если сервер возвращает внутреннюю ошибку. По умолчанию: `60`
isolation_enabled boolean	Состояние изоляции порта коммутатора. Варианты: `false` ← (по умолчанию) `true`
link_negotiation string	Скорость соединения для порта коммутатора. Варианты: `"1 Gigabit full duplex (auto)"` `"1 Gigabit full duplex (forced)"` `"10 Gigabit full duplex (auto)"` `"10 Gigabit full duplex (forced)"` `"100 Megabit (auto)"` `"100 Megabit full duplex (forced)"` `"2.5 Gigabit full duplex (auto)"` `"2.5 Gigabit full duplex (forced)"` `"5 Gigabit full duplex (auto)"` `"5 Gigabit full duplex (forced)"` `"Auto negotiate"` ← (по умолчанию)
mac_allow_list dictionary	Список MAC-адресов, разрешённых на порту. Применимо только к портам доступа. Применимо только к access_policy_type «MAC allow list».
macs list / elements=string	Список MAC-адресов для обновления в соответствии с параметром state.
state string	Состояние, в котором должна остаться конфигурация. При объединении указанные MAC-адреса добавляются в текущий список разрешённых адресов. При замене все MAC-адреса перезаписываются; в списке разрешённых останутся только указанные MAC-адреса. При удалении указанные MAC-адреса удаляются из текущего списка разрешённых адресов. Варианты: `"merged"` `"replaced"` ← (по умолчанию) `"deleted"`
name псевдонимы: description string	Описание порта коммутатора.
number string	Номер порта.
org_id string	Идентификатор организации.
org_name псевдонимы: organization string	Название организации.
output_format string	Указывает модулю, должны ли ключи ответа быть в формате snake case (например, `net_id`) или camel case (например, `netId`). Варианты: `"snakecase"` ← (по умолчанию) `"camelcase"`
output_level string	Задаёт объём отладочного вывода во время выполнения модуля. Варианты: `"debug"` `"normal"` ← (по умолчанию)
poe_enabled boolean	Включает или отключает питание через Ethernet на порту. Варианты: `false` `true` ← (по умолчанию)
rate_limit_retry_time integer	Количество секунд до повторной попытки, если сработало ограничение частоты запросов. По умолчанию: `165`
rstp_enabled boolean	Включает или отключает протокол Rapid Spanning Tree на порту. Варианты: `false` `true` ← (по умолчанию)
serial string / обязательный	Серийный номер коммутатора.
state string	Указывает, следует ли запросить или изменить конфигурацию порта коммутатора. Варианты: `"query"` ← (по умолчанию) `"present"`
sticky_mac_allow_list dictionary	Список MAC-адресов, разрешённых на порту. Применимо только к портам доступа. Применимо только к access_policy_type «Sticky MAC allow list».
macs list / elements=string	Список MAC-адресов для обновления в соответствии с параметром state.
state string	Состояние, в котором должна остаться конфигурация. При объединении указанные MAC-адреса добавляются в текущий список разрешённых адресов. При замене все MAC-адреса перезаписываются; в списке разрешённых останутся только указанные MAC-адреса. При удалении указанные MAC-адреса удаляются из текущего списка разрешённых адресов. Варианты: `"merged"` `"replaced"` ← (по умолчанию) `"deleted"`
sticky_mac_allow_list_limit integer	Количество MAC-адресов, разрешённых в списке адресов для порта с привязкой MAC-адресов. Применимо только к портам доступа. Применимо только к access_policy_type «Sticky MAC allow list». Значение должно быть не меньше размера списка sticky_mac_allow_list. Во время обработки значение будет проверено на допустимость.
stp_guard string	Задаёт состояние защиты STP. Варианты: `"disabled"` ← (по умолчанию) `"root guard"` `"bpdu guard"` `"loop guard"`
tags list / elements=string	Список меток, назначаемых порту.
timeout integer	Время ожидания для HTTP-запросов. По умолчанию: `30`
type string	Задаёт тип порта. Варианты: `"access"` ← (по умолчанию) `"trunk"`
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 является VLAN по умолчанию. Установка значения 0 для порта trunk очистит VLAN.
voice_vlan integer	Номер VLAN, назначенной порту для голосового трафика. Применимо только к портам доступа. Применимо, только если для voice_vlan_state задано значение present.
voice_vlan_state string	Указывает, должна ли конфигурация voice VLAN присутствовать или отсутствовать. Варианты: `"absent"` `"present"` ← (по умолчанию)

Примечания

Примечание

Дополнительную информацию об API Meraki можно найти по адресу https://dashboard.meraki.com/api_docs.
Некоторые параметры, вероятно, используются только разработчиками Meraki.
Начиная с Ansible 2.9 модули Meraki выводят ключи в формате snake case. Чтобы использовать camel case, задайте для переменной среды ANSIBLE_MERAKI_FORMAT значение camelcase.
В Ansible 2.13 модули Meraki для Ansible перестанут поддерживать вывод в формате camel case. Обновите свои плейбуки.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с загруженной конфигурацией. В режиме проверки будет сообщено об изменениях, если конфигурации различаются, однако изменения не отправляются в 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
- name: Configure access port with sticky MAC allow list and limit.
  meraki_switchport:
    auth_key: abc12345
    state: present
    serial: ABC-123
    number: 5
    sticky_mac_allow_limit: 3
    sticky_mac_allow_list:
      macs:
        - aa:aa:bb:bb:cc:cc
        - bb:bb:aa:aa:cc:cc
        - 11:aa:bb:bb:cc:cc
      state: replaced
    delegate_to: localhost
- name: Delete an existing MAC address from the sticky MAC allow list.
  meraki_switchport:
    auth_key: abc12345
    state: present
    serial: ABC-123
    number: 5
    sticky_mac_allow_list:
      macs:
        - aa:aa:bb:bb:cc:cc
      state: deleted
    delegate_to: localhost
- name: Add a MAC address to sticky MAC allow list.
  meraki_switchport:
    auth_key: abc12345
    state: present
    serial: ABC-123
    number: 5
    sticky_mac_allow_list:
      macs:
        - 22:22:bb:bb:cc:cc
      state: merged
    delegate_to: localhost

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

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

Ключ	Описание
data complex	Информация о запрошенных или обновлённых портах коммутатора. Возвращается: success
access_policy_number integer	Номер назначенной политики доступа. Применимо только к портам доступа. Возвращается: success Пример: `1234`
access_policy_type string	Тип политики доступа, назначенной порту Возвращается: success, если назначена Пример: `"MAC allow list"`
allowed_vlans string	Список VLAN, разрешённых на порту доступа Возвращается: success, если порт настроен как порт доступа Пример: `"all"`
enabled boolean	Состояние порта: включён или выключен. Возвращается: success Пример: `true`
flexible_stacking_enabled boolean	Включена ли на порту поддержка гибкого стекирования. Возвращается: success
isolation_enabled boolean	Состояние изоляции порта. Возвращается: success Пример: `true`
link_negotiation string	Скорость соединения порта. Возвращается: success Пример: `"Auto negotiate"`
mac_allow_list list / elements=string	Список MAC-адресов, которым в данный момент разрешён доступ через порт без закрепления адресов. Используется с access_policy_type, равным MAC allow list. Возвращается: success Пример: `["11:aa:bb:bb:cc:cc", "22:aa:bb:bb:cc:cc", "33:aa:bb:bb:cc:cc"]`
name string	Понятное пользователю описание порта. Возвращается: success Пример: `"Jim Phone Port"`
number integer	Номер порта. Возвращается: success Пример: `1`
poe_enabled boolean	Состояние питания через Ethernet (PoE) на порту. Возвращается: success Пример: `true`
port_schedule_id string	Уникальный идентификатор назначенного расписания порта Возвращается: success
rstp_enabled boolean	Состояние протокола Rapid Spanning Tree Protocol (RSTP): включён или выключен Возвращается: success Пример: `true`
sticky_mac_allow_list list / elements=string	Список MAC-адресов, которым в данный момент разрешён доступ через порт с закреплением адресов. Используется с access_policy_type, равным Sticky MAC allow list. Возвращается: success Пример: `["11:aa:bb:bb:cc:cc", "22:aa:bb:bb:cc:cc", "33:aa:bb:bb:cc:cc"]`
sticky_mac_allow_list_limit integer	Количество MAC-адресов, которым разрешён доступ через порт с закреплением адресов. Возвращается: success Пример: `6`
stp_guard string	Состояние защиты STP Возвращается: success Пример: `"Root Guard"`
tags list / elements=string	Список тегов, назначенных порту. Возвращается: success Пример: `["phone", "marketing"]`
type string	Тип порта коммутатора. Возвращается: success Пример: `"trunk"`
udld string	Состояние оповещений UDLD Возвращается: success Пример: `"Alert only"`
vlan integer	VLAN, назначенная порту. Возвращается: success Пример: `10`
voice_vlan integer	VLAN, назначенная порту для устройств с включённой голосовой VLAN. Возвращается: success Пример: `20`

Статус

Этот модуль будет удалён в версии 3.0.0. [устарел]
Дополнительные сведения см. в разделе УСТАРЕВШИЕ ФУНКЦИИ.

Авторы

Kevin Breit (@kbreit)

Ссылки на коллекцию

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