Модуль cisco.meraki.devices_switch_ports — модуль ресурса для devices _switch _ports

Примечание

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

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

Для установки используйте: ansible-galaxy collection install cisco.meraki. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

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

Добавлен в cisco.meraki 1.0.0

Краткое описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

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

Управление операцией обновления ресурса devices _switch _ports.
Обновление порта коммутатора.

Примечание

Для этого модуля имеется соответствующий модуль действий.

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
accessPolicyNumber integer	Номер пользовательской политики доступа, которую нужно настроить на порту коммутатора. Применимо только, если ‘accessPolicyType’ имеет значение ‘Custom access policy’.
accessPolicyType string	Тип политики доступа порта коммутатора. Применимо только к портам доступа. Возможные значения: ‘Open’, ‘Custom access policy’, ‘MAC allow list’ или ‘Sticky MAC allow list’.
adaptivePolicyGroupId string	ID группы адаптивных политик, которая будет использоваться для маркировки трафика через этот порт коммутатора. Этот ID должен существовать на момент настройки; в противном случае его необходимо создать с помощью API adaptivePolicy/groups. Нельзя применить к порту коммутатора, привязанного к профилю.
allowedVlans string	VLAN, разрешённые на порту коммутатора. Применимо только к магистральным портам.
daiTrusted boolean	Если значение равно true, ARP-пакеты для этого порта считаются доверенными, и Dynamic ARP Inspection пропускает трафик. Варианты: `false` `true`
dot3az dictionary	Настройки Dot3az для порта.
enabled boolean	Состояние Energy Efficient Ethernet порта коммутатора. Варианты: `false` `true`
enabled boolean	Состояние порта коммутатора. Варианты: `false` `true`
flexibleStackingEnabled boolean	Для поддерживаемых коммутаторов (например, MS420/MS425): включена ли для порта гибкая стекинг-конфигурация. Варианты: `false` `true`
highSpeed dictionary	Настройки включения высокоскоростного режима порта для C9500-32QC.
enabled boolean	Для C9500-32QC: включён ли высокоскоростной режим порта. Варианты: `false` `true`
isolationEnabled boolean	Состояние изоляции порта коммутатора. Варианты: `false` `true`
linkNegotiation string	Скорость соединения порта коммутатора.
macAllowList list / elements=string	Доступ к этому порту получат только устройства с MAC-адресами, указанными в этом списке. Можно указать до 20 MAC-адресов. Применимо только, если ‘accessPolicyType’ имеет значение ‘MAC allow list’.
macWhitelistLimit integer	Максимальное количество MAC-адресов для обычного списка разрешённых MAC-адресов. Применимо только, если ‘accessPolicyType’ имеет значение ‘MAC allow list’. Примечание: настройка поддерживается только в версиях выше ms18 и только для классических коммутаторов.
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (integer), время ожидания перед повтором при ошибке параллельного выполнения пакета действий По умолчанию: `60`
meraki_api_key string / обязательный	meraki_api_key (string), ключ API, созданный на панели управления; также можно задать в переменной среды MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (string), префикс для всех ресурсов конечных точек По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (string), необязательный идентификатор партнёра для отслеживания использования API; также можно задать в переменной среды BE_GEO_ID По умолчанию: `""`
meraki_certificate_path string	meraki_certificate_path (string), путь к сертификату TLS/SSL для проверки, если используется локальный прокси По умолчанию: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (boolean), использовать экземпляр вашего собственного регистратора Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (string), имя файла журнала с добавленными датой и временем По умолчанию: `"meraki_api_"`
meraki_log_path string	log_path (string), путь для выходного журнала; если не указан, по умолчанию используется рабочий каталог скрипта По умолчанию: `""`
meraki_maximum_retries integer	meraki_maximum_retries (integer), количество повторных попыток при ошибках 429 или других ошибках на стороне сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (integer), время ожидания перед повтором при ошибке 429 от Nginx По умолчанию: `60`
meraki_output_log boolean	meraki_output_log (boolean), создавать выходной файл журнала? Варианты: `false` `true` ← (по умолчанию)
meraki_print_console boolean	meraki_print_console (boolean), выводить журнал в консоль? Варианты: `false` `true` ← (по умолчанию)
meraki_requests_proxy string	meraki_requests_proxy (string), сервер и порт прокси для HTTPS, если требуется По умолчанию: `""`
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (boolean), повторять запрос при возникновении другой ошибки 4XX (кроме 429)? Варианты: `false` ← (по умолчанию) `true`
meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (integer), время ожидания перед повтором при других ошибках 4XX По умолчанию: `60`
meraki_simulate boolean	meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить внесение изменений? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (integer), максимальное время в секундах для каждого вызова API По умолчанию: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (boolean), отключить всё журналирование? Тогда вы предоставлены сами себе! Варианты: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (boolean), методы list* возвращают итератор с каждым объектом вместо полного списка всех элементов Варианты: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (boolean), повторять запрос при ошибке ограничения частоты запросов 429? Варианты: `false` `true` ← (по умолчанию)
name string	Имя порта коммутатора.
peerSgtCapable boolean	Если значение равно true, для трафика через этот порт коммутатора включён Peer SGT. Применимо только к магистральным портам, но не к портам доступа. Нельзя применить к порту коммутатора, привязанного к профилю. Варианты: `false` `true`
poeEnabled boolean	Состояние PoE порта коммутатора. Варианты: `false` `true`
portId string	Параметр пути PortId. Идентификатор порта.
portScheduleId string	Идентификатор расписания порта. Значение null удалит расписание порта.
profile dictionary	Атрибуты профиля.
enabled boolean	Если включено, конфигурация этого порта переопределяется профилем порта. Варианты: `false` `true`
id string	Если включено, идентификатор профиля порта, используемого для переопределения конфигурации порта.
iname string	Если включено, IName профиля.
rstpEnabled boolean	Состояние протокола быстрого связующего дерева. Варианты: `false` `true`
serial string	Параметр пути Serial.
stickyMacAllowList list / elements=string	Начальный список MAC-адресов для списка разрешённых закреплённых MAC-адресов. Применимо только, если ‘accessPolicyType’ имеет значение ‘Sticky MAC allow list’.
stickyMacAllowListLimit integer	Максимальное количество MAC-адресов для списка разрешённых закреплённых MAC-адресов. Применимо только, если ‘accessPolicyType’ имеет значение ‘Sticky MAC allow list’.
stormControlEnabled boolean	Состояние защиты от широковещательного шторма на порту коммутатора. Варианты: `false` `true`
stpGuard string	Состояние защиты STP (‘disabled’, ‘root guard’, ‘bpdu guard’ или ‘loop guard’).
stpPortFastTrunk boolean	Состояние STP PortFast Trunk на порту коммутатора. Варианты: `false` `true`
tags list / elements=string	Список тегов порта коммутатора.
type string	Тип порта коммутатора (‘access’, ‘trunk’, ‘stack’, ‘routed’, ‘svl’ или ‘dad’).
udld string	Действие при обнаружении однонаправленного соединения (только оповещение, принудительное применение). По умолчанию настроено только оповещение.
vlan integer	VLAN порта коммутатора. Для магистрального порта это собственная VLAN. Значение null очистит значение, заданное для магистральных портов.
voiceVlan integer	Голосовая VLAN порта коммутатора. Применимо только к портам доступа.

Примечания

Примечание

Используемые методы SDK: switch.Switch.update_device_switch_port,
Используемые пути: put /devices/{serial}/switch/ports/{portId},
Не поддерживает check_mode
Плагин работает на управляющем узле и не использует плагины подключений Ansible, а вместо этого использует встроенный менеджер подключений
из Cisco Dashboard API Python(SDK)
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

Документация Cisco Meraki по switch updateDeviceSwitchPort: Полный справочник по API updateDeviceSwitchPort.

Примеры

- name: Update by id
  cisco.meraki.devices_switch_ports:
    meraki_api_key: "{{ meraki_api_key }}"
    meraki_base_url: "{{ meraki_base_url }}"
    meraki_single_request_timeout: "{{ meraki_single_request_timeout }}"
    meraki_certificate_path: "{{ meraki_certificate_path }}"
    meraki_requests_proxy: "{{ meraki_requests_proxy }}"
    meraki_wait_on_rate_limit: "{{ meraki_wait_on_rate_limit }}"
    meraki_nginx_429_retry_wait_time: "{{ meraki_nginx_429_retry_wait_time }}"
    meraki_action_batch_retry_wait_time: "{{ meraki_action_batch_retry_wait_time }}"
    meraki_retry_4xx_error: "{{ meraki_retry_4xx_error }}"
    meraki_retry_4xx_error_wait_time: "{{ meraki_retry_4xx_error_wait_time }}"
    meraki_maximum_retries: "{{ meraki_maximum_retries }}"
    meraki_output_log: "{{ meraki_output_log }}"
    meraki_log_file_prefix: "{{ meraki_log_file_prefix }}"
    meraki_log_path: "{{ meraki_log_path }}"
    meraki_print_console: "{{ meraki_print_console }}"
    meraki_suppress_logging: "{{ meraki_suppress_logging }}"
    meraki_simulate: "{{ meraki_simulate }}"
    meraki_be_geo_id: "{{ meraki_be_geo_id }}"
    meraki_caller: "{{ meraki_caller }}"
    meraki_use_iterator_for_get_pages: "{{ meraki_use_iterator_for_get_pages }}"
    meraki_inherit_logging_config: "{{ meraki_inherit_logging_config }}"
    state: present
    accessPolicyNumber: 2
    accessPolicyType: Sticky MAC allow list
    adaptivePolicyGroupId: '123'
    allowedVlans: 1,3,5-10
    daiTrusted: false
    dot3az:
      enabled: false
    enabled: true
    flexibleStackingEnabled: true
    highSpeed:
      enabled: false
    isolationEnabled: false
    linkNegotiation: Auto negotiate
    macAllowList:
      - 34:56:fe:ce:8e:a0
      - 34:56:fe:ce:8e:a1
    macWhitelistLimit: 10
    name: My switch port
    peerSgtCapable: false
    poeEnabled: true
    portId: string
    portScheduleId: '1234'
    profile:
      enabled: false
      id: '1284392014819'
      iname: iname
    rstpEnabled: true
    serial: string
    stickyMacAllowList:
      - 34:56:fe:ce:8e:b0
      - 34:56:fe:ce:8e:b1
    stickyMacAllowListLimit: 5
    stormControlEnabled: true
    stpGuard: disabled
    stpPortFastTrunk: false
    tags:
      - tag1
      - tag2
    type: access
    udld: Alert only
    vlan: 10
    voiceVlan: 20

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

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

Ключ	Описание
meraki_response словарь	Словарь или список с ответом, возвращённым Cisco Meraki Python SDK Возвращается: всегда Пример: {"accessPolicyNumber": 0, "accessPolicyType": "string", "adaptivePolicyGroup": {"id": "string", "name": "string"}, "adaptivePolicyGroupId": "string", "allowedVlans": "string", "daiTrusted": true, "dot3az": {"enabled": true}, "enabled": true, "flexibleStackingEnabled": true, "highSpeed": {"enabled": true}, "isolationEnabled": true, "linkNegotiation": "string", "linkNegotiationCapabilities": ["string"], "macAllowList": ["string"], "macWhitelistLimit": 0, "mirror": {"mode": "string"}, "module": {"model": "string", "serial": "string", "slot": 0}, "name": "string", "peerSgtCapable": true, "poeEnabled": true, "portId": "string", "portScheduleId": "string", "profile": {"enabled": true, "id": "string", "iname": "string"}, "rstpEnabled": true, "schedule": {"id": "string", "name": "string"}, "stickyMacAllowList": ["string"], "stickyMacAllowListLimit": 0, "stormControlEnabled": true, "stpGuard": "string", "stpPortFastTrunk": true, "tags": ["string"], "type": "string", "udld": "string", "vlan": 0, "voiceVlan": 0}

Ключ

Описание

meraki_response

словарь

Словарь или список с ответом, возвращённым Cisco Meraki Python SDK

Возвращается: всегда

Пример: {"accessPolicyNumber": 0, "accessPolicyType": "string", "adaptivePolicyGroup": {"id": "string", "name": "string"}, "adaptivePolicyGroupId": "string", "allowedVlans": "string", "daiTrusted": true, "dot3az": {"enabled": true}, "enabled": true, "flexibleStackingEnabled": true, "highSpeed": {"enabled": true}, "isolationEnabled": true, "linkNegotiation": "string", "linkNegotiationCapabilities": ["string"], "macAllowList": ["string"], "macWhitelistLimit": 0, "mirror": {"mode": "string"}, "module": {"model": "string", "serial": "string", "slot": 0}, "name": "string", "peerSgtCapable": true, "poeEnabled": true, "portId": "string", "portScheduleId": "string", "profile": {"enabled": true, "id": "string", "iname": "string"}, "rstpEnabled": true, "schedule": {"id": "string", "name": "string"}, "stickyMacAllowList": ["string"], "stickyMacAllowListLimit": 0, "stormControlEnabled": true, "stpGuard": "string", "stpPortFastTrunk": true, "tags": ["string"], "type": "string", "udld": "string", "vlan": 0, "voiceVlan": 0}

Авторы

Francisco Munoz (@fmunoz)

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

© 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/devices_switch_ports_module.html