Модуль cisco.meraki.organizations_config_templates_switch_profiles_ports – модуль ресурса для organizations _configtemplates _switch _profiles _ports

Примечание

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

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

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

Чтобы использовать модуль в сценарии, укажите: cisco.meraki.organizations_config_templates_switch_profiles_ports.

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

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

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

Управление операцией обновления ресурса organizations _configtemplates _switch _profiles _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’.
allowedVlans string	VLAN, разрешённые на порту шаблона коммутатора. Применимо только к транковым портам.
configTemplateId string	Параметр пути ConfigTemplateId. Идентификатор шаблона конфигурации.
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), базовый URL, указываемый перед ресурсами конечных точек По умолчанию: `"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	Имя порта шаблона коммутатора.
organizationId string	Параметр пути OrganizationId. Идентификатор организации.
poeEnabled boolean	Состояние PoE для порта шаблона коммутатора. Возможные значения: `false` `true`
portId string	Параметр пути PortId. Идентификатор порта.
portScheduleId string	Идентификатор расписания порта. Значение null удаляет расписание порта.
profile dictionary	Атрибуты профиля.
enabled boolean	Если параметр включён, конфигурация этого порта переопределяется профилем порта. Возможные значения: `false` `true`
id string	Если параметр включён, идентификатор профиля порта, используемого для переопределения конфигурации порта.
iname string	Если параметр включён, IName профиля.
profileId string	Параметр пути ProfileId. Идентификатор профиля.
rstpEnabled boolean	Состояние протокола Rapid Spanning Tree Protocol. Возможные значения: `false` `true`
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 порта шаблона коммутатора. Для порта trunk это собственный VLAN. Значение null сбросит значение, заданное для портов trunk.
voiceVlan integer	Голосовой VLAN порта шаблона коммутатора. Применяется только к портам доступа.

Примечания

Примечание

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

См. также

Документация Cisco Meraki по switch updateOrganizationConfigTemplateSwitchProfilePort: Полное описание API updateOrganizationConfigTemplateSwitchProfilePort.

Примеры

- name: Update by id
  cisco.meraki.organizations_config_templates_switch_profiles_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
    allowedVlans: 1,3,5-10
    configTemplateId: string
    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
    organizationId: string
    poeEnabled: true
    portId: string
    portScheduleId: '1234'
    profile:
      enabled: false
      id: '1284392014819'
      iname: iname
    profileId: string
    rstpEnabled: true
    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 dictionary	Словарь или список с ответом, возвращённым Cisco Meraki Python SDK Возвращается: всегда Пример: {"accessPolicyNumber": 0, "accessPolicyType": "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", "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

dictionary

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

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

Пример: {"accessPolicyNumber": 0, "accessPolicyType": "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", "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/organizations_config_templates_switch_profiles_ports_module.html