Spec-Zone.ru › Ansible

Модуль cisco.meraki.devices_switch_ports – Модуль ресурсов для устройств _switch _ports

Примечание

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

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

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

Для использования в плейбуке укажите: cisco.meraki.devices_switch_ports.

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

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

Обзор

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

Примечание

У этого модуля есть соответствующий плагин действия.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

номерПолитикиДоступа

целое число

Номер настраиваемой политики доступа к порту коммутатора. Применимо только при «типПолитикиДоступа» - «Пользовательская политика доступа».

типПолитикиДоступа

строка

Тип политики доступа к порту коммутатора. Применимо только к портам доступа. Может быть одним из значений: «Открытый», «Пользовательская политика доступа», «Список разрешенных MAC-адресов» или «Список разрешенных MAC-адресов (постоянный)».

adaptivePolicyGroupId

строка

ID группы адаптивной политики, которая будет использоваться для маркировки трафика через этот порт коммутатора. Этот ID должен быть предварительно создан, в противном случае его нужно создать с помощью API adaptivePolicy/groups. Не может быть применён к порту коммутатора, связанному с профилем.

разрешённыеVLANы

строка

VLANы, разрешенные на порту коммутатора. Применимо только к магистральным портам.

daiTrusted

булево

Если true, пакеты ARP для этого порта будут считаться надёжными, и динамическая проверка ARP позволит трафику пройти.

Варианты:

  • false
  • true

включено

булево

Статус порта коммутатора.

Варианты:

  • false
  • true

flexibleStackingEnabled

булево

Для поддерживаемых коммутаторов (например, MS420/MS425), разрешено ли гибкое объединение на порту.

Варианты:

  • false
  • true

isolationEnabled

булево

Статус изоляции порта коммутатора.

Варианты:

  • false
  • true

linkNegotiation

строка

Скорость соединения для порта коммутатора.

macAllowList

список / элементы=строка

Только устройства с MAC-адресами, указанными в этом списке, будут иметь доступ к этому порту. Можно определить до 20 MAC-адресов. Применимо только при «типПолитикиДоступа» - «Список разрешенных MAC-адресов».

meraki_action_batch_retry_wait_time

целое число

meraki_action_batch_retry_wait_time (целое число), время ожидания при повторных ошибках обработки действий в пакетном режиме

По умолчанию: 60

ключAPI_meraki

строка / обязательно

ключAPI_meraki (строка), ключ API, сгенерированный в панели управления; также можно задать как переменную окружения MERAKI_DASHBOARD_API_KEY

meraki_base_url

строка

meraki_base_url (строка), предшествующая всем ресурсам конечной точки

По умолчанию: "https://api.meraki.com/api/v1"

meraki_be_geo_id

строка

meraki_be_geo_id (строка), необязательный идентификатор партнера для отслеживания использования API; также можно задать как переменную окружения BE_GEO_ID

По умолчанию: ""

meraki_caller

строка

meraki_caller (строка), необязательный идентификатор для отслеживания использования API; также можно задать как переменную окружения MERAKI_PYTHON_SDK_CALLER

По умолчанию: ""

meraki_certificate_path

строка

meraki_certificate_path (строка), путь к сертификату TLS/SSL для проверки, если используется локальный прокси

По умолчанию: ""

meraki_inherit_logging_config

булево

meraki_inherit_logging_config (булево), наследует свой экземпляр логгера

Варианты:

  • false ← (по умолчанию)
  • true

meraki_log_file_prefix

строка

meraki_log_file_prefix (строка), имя файла журнала, дополненное датой и временем

По умолчанию: "meraki_api_"

meraki_log_path

строка

путь_журнала (строка), путь вывода лога; по умолчанию - рабочий каталог скрипта, если не указано другое

По умолчанию: ""
END_OF_DOCUMENT_MARKER

meraki_maximum_retries

integer

meraki_maximum_retries (целое число), повторить до такого количества раз при возникновении ошибок 429 или других ошибок на стороне сервера

Default: 2

meraki_nginx_429_retry_wait_time

integer

meraki_nginx_429_retry_wait_time (целое число), время ожидания повтора 429 Nginx

Default: 60

meraki_output_log

boolean

meraki_output_log (булево), создать файл журнала вывода?

Choices:

  • false
  • true ← (default)

meraki_print_console

boolean

meraki_print_console (булево), выводить выходные данные журнала на консоль?

Choices:

  • false
  • true ← (default)

meraki_requests_proxy

string

meraki_requests_proxy (строка), прокси-сервер и порт, если необходимо, для HTTPS

Default: ""

meraki_retry_4xx_error

boolean

meraki_retry_4xx_error (булево), повторить попытку при возникновении другой ошибки 4XX (кроме 429)?

Choices:

  • false ← (default)
  • true

meraki_retry_4xx_error_wait_time

integer

meraki_retry_4xx_error_wait_time (целое число), время ожидания повтора другой ошибки 4XX

Default: 60

meraki_simulate

boolean

meraki_simulate (булево), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения?

Choices:

  • false ← (default)
  • true

meraki_single_request_timeout

integer

meraki_single_request_timeout (целое число), максимальное количество секунд для каждого вызова API

Default: 60

meraki_suppress_logging

boolean

meraki_suppress_logging (булево), отключить все ведение журнала? тогда вы предоставлены сами себе!

Choices:

  • false ← (default)
  • true

meraki_use_iterator_for_get_pages

boolean

meraki_use_iterator_for_get_pages (булево), методы list* будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами

Choices:

  • false ← (default)
  • true

meraki_wait_on_rate_limit

boolean

meraki_wait_on_rate_limit (булево), повторить попытку, если возникла ошибка ограничения скорости 429?

Choices:

  • false
  • true ← (default)

name

string

Имя порта коммутатора.

peerSgtCapable

boolean

Если true, Peer SGT включен для трафика через этот порт коммутатора. Применимо только к магистральному порту, не к порту доступа. Не может быть применено к порту коммутатора, связанному с профилем.

Choices:

  • false
  • true

poeEnabled

boolean

Статус PoE порта коммутатора.

Choices:

  • false
  • true

portId

string

Параметр пути PortId. Идентификатор порта.

portScheduleId

string

Идентификатор расписания порта. Значение null очистит расписание порта.

profile

dictionary

Атрибуты профиля.

enabled

boolean

При включении переопределите конфигурацию этого порта с помощью профиля порта.

Choices:

  • false
  • true

id

string

При включенном режиме, идентификатор профиля порта, используемого для переопределения конфигурации порта.

iname

string

При включенном режиме, Имя профиля.

rstpEnabled

boolean

Статус протокола быстрой обхода дерева.

Варианты:

  • false
  • true

serial

string

Параметр пути последовательности.

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»).

tags

list / elements=string

Список меток порта коммутатора.

type

string

Тип порта коммутатора («trunk» или «access»).

udld

string

Действие, которое необходимо выполнить при обнаружении однонаправленного канала (только предупреждение, принудительное). По умолчанию настроено только предупреждение.

vlan

integer

VLAN порта коммутатора. Для порта trunk это основной VLAN. Нулевое значение очистит установленное значение для портов trunk.

voiceVlan

integer

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

Примечания

Примечание

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

См. также

См. также

Документация Cisco Meraki по обновлению порта коммутатора 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_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
    enabled: true
    flexibleStackingEnabled: true
    isolationEnabled: false
    linkNegotiation: Auto negotiate
    macAllowList:
    - 34:56:fe:ce:8e:b0
    - 34:56:fe:ce:8e:b1
    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
    tags:
    - tag1
    - tag2
    type: access
    udld: Alert only
    vlan: 10
    voiceVlan: 20

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

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

Ключ

Описание

meraki_response

словарь

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

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

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

Авторы

  • Francisco Munoz (@fmunoz)

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

  • Система отслеживания проблем
  • Репозиторий (Исходный код)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API