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

Примечание

Этот модуль входит в коллекцию cisco.meraki (версия 2.18.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 целое число	Номер политики доступа для применения. Применимо только для портов типа доступ.
access_policy_type строка	Тип политики доступа, применяемой к порту. Варианты: `"Open"` `"Custom access policy"` `"MAC allow list"` `"Sticky MAC allow list"`
allowed_vlans список / элементы=строка	Список номеров VLAN, разрешенных на коммутационном порту. По умолчанию: `["all"]`
auth_key строка / обязательно	Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды `MERAKI_KEY` не задана.
enabled булево	Включен или отключен коммутационный порт. Варианты: `false` `true` ← (по умолчанию)
flexible_stacking_enabled булево	Поддерживаются ли гибкие возможности стекирования на порту. Варианты: `false` `true`
host строка	Имя хоста панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, таким как Китай. По умолчанию: `"api.meraki.com"`
internal_error_retry_time целое число	Количество секунд для повторной попытки, если сервер возвращает ошибку внутренней серверной ошибки. По умолчанию: `60`
isolation_enabled булево	Статус изоляции коммутационного порта. Варианты: `false` ← (по умолчанию) `true`
link_negotiation строка	Скорость канала для коммутационного порта. Варианты: `"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 словарь	Список MAC-адресов, разрешенных на порту. Применимо только для портов типа доступ. Применимо только для access_policy_type «Список разрешенных MAC-адресов».
macs список / элементы=строка	Список MAC-адресов для обновления в соответствии с опцией состояния.
state строка	Состояние, в котором должна остаться конфигурация. Merged, указанные MAC-адреса будут добавлены в текущий список разрешенных. Replaced, Все MAC-адреса перезаписываются, только указанные MAC-адреса существуют в списке разрешенных. Deleted, Удалить указанные MAC-адреса из текущего списка разрешенных. Варианты: `"merged"` `"replaced"` ← (по умолчанию) `"deleted"`
name псевдонимы: описание строка	Описание коммутационного порта.
number строка	Номер порта.
org_id строка	Идентификатор организации.
org_name псевдонимы: организация строка	Название организации.
output_format строка	Указывает модулю, следует ли использовать ключи ответа в формате snake case (например, `net_id`) или camel case (например, `netId`). Варианты: `"snakecase"` ← (по умолчанию) `"camelcase"`
output_level строка	Установите количество отладочной информации во время выполнения модуля. Варианты: `"debug"` `"normal"` ← (по умолчанию)

END_OF_DOCUMENT_MARKER

poe_enabled boolean	Включить или отключить Power Over 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. Применимо только для access_policy_type “Sticky MAC allow list”.
macs list / элементы=строка	Список MAC-адресов для обновления в зависимости от параметра state.
state string	Состояние, в котором должна быть оставлена конфигурация. Merged, предоставленные MAC-адреса будут добавлены в текущий разрешённый список. Replaced, все MAC-адреса перезаписываются, только MAC-адреса, предоставленные с exist в разрешённом списке. Deleted, удалить предоставленные MAC-адреса из текущего разрешённого списка. Варианты: `"merged"` `"replaced"` ← (по умолчанию) `"deleted"`
sticky_mac_allow_list_limit integer	Количество MAC-адресов, разрешённых в списке разрешённых MAC-адресов sticky-порта. Применимо только для портов типа access. Применимо только для access_policy_type “Sticky MAC allow list”. Значение должно быть равно или больше размера списка sticky_mac_allow_list. Значение будет проверено на валидность во время обработки.
stp_guard string	Установить состояние STP-защиты. Варианты: `"disabled"` ← (по умолчанию) `"root guard"` `"bpdu guard"` `"loop guard"`
tags list / элементы=строка	Список тегов для назначения порту.
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 — это native VLAN. Установка значения 0 для trunk очистит VLAN.
voice_vlan integer	Номер VLAN, назначенный порту для голосового трафика. Применимо только для портов типа access. Применимо только если 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. Для использования 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

- 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-адресов, разрешённых на не-sticky порту. Используется с access_policy_type списка разрешённых MAC-адресов. Возвращается: 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	Состояние включения PoE (Power Over Ethernet) для порта. Возвращается: success Пример: `true`
port_schedule_id string	Уникальный ID назначенного расписания порта Возвращается: success
rstp_enabled boolean	Включено или выключено состояние протокола Rapid Spanning Tree Protocol (RSTP) Возвращается: success Пример: `true`
sticky_mac_allow_list list / elements=string	Список MAC-адресов, разрешённых на sticky порту. Используется с access_policy_type списка разрешённых sticky MAC-адресов. Возвращается: 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-адресов, разрешённых на sticky порту. Возвращается: success Пример: `6`
stp_guard string	Состояние STP guard Возвращается: success Пример: `"Root Guard"`

метки список / элементы=строка	Список меток, назначенных порту. Возвращаемое значение: успех Пример: `["phone", "marketing"]`
тип строка	Тип коммутационного порта. Возвращаемое значение: успех Пример: `"trunk"`
udld строка	Состояние оповещения UDLD Возвращаемое значение: успех Пример: `"Alert only"`
vlan целое число	VLAN, назначенный порту. Возвращаемое значение: успех Пример: `10`
voice_vlan целое число	VLAN, назначенный порту с устройствами, включившими VLAN для голосовой связи. Возвращаемое значение: успех Пример: `20`

Статус

Этот модуль будет удалён в версии 3.0.0. [устаревший]
Для получения дополнительной информации см. УСТАРЕВШИЙ.

Авторы

Kevin Breit (@kbreit)

Ссылки на сборку

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