Spec-Zone.ru › Ansible

Модуль cisco.meraki.organizations_config_templates_switch_profiles_ports — Модуль ресурсов для организаций _configtemplates _switch _profiles _ports

Примечание

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

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

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

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

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

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

Описание

  • Управление обновлением операции ресурса организаций _configtemplates _switch _profiles _ports.
  • Обновление порта шаблона коммутатора.

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

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

целое число

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

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

строка

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

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

строка

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

идентификаторШаблонаКонфигурации

строка

Параметр пути configTemplateId. Идентификатор шаблона конфигурации.

daiTrusted

булево

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

Варианты:

  • false
  • true

включен

булево

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

Варианты:

  • false
  • true

включен гибкий стекинг

булево

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

Варианты:

  • false
  • true

включена изоляция

булево

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

Варианты:

  • false
  • true

переговоры о связи

строка

Скорость связи для порта шаблона коммутатора.

Список разрешенных MAC-адресов

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

Только устройства с 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

строка

базовый_адрес_meraki (строка), предшествующий всем ресурсам конечной точки

По умолчанию: "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

строка

путь_к_сертификату_meraki (строка), путь к сертификату 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

строка

log_path (строка), путь вывода журнала; по умолчанию, рабочая директория сценария, если не указано

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

meraki_maximum_retries

integer

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

Default: 2

meraki_nginx_429_retry_wait_time

integer

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

Default: 60

meraki_output_log

boolean

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

Choices:

  • false
  • true ← (default)

meraki_print_console

boolean

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

Choices:

  • false
  • true ← (default)

meraki_requests_proxy

string

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

Default: ""

meraki_retry_4xx_error

boolean

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

Choices:

  • false ← (default)
  • true

meraki_retry_4xx_error_wait_time

integer

meraki_retry_4xx_error_wait_time (integer), время ожидания повтора попытки при других ошибках 4XX

Default: 60

meraki_simulate

boolean

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

Choices:

  • false ← (default)
  • true

meraki_single_request_timeout

integer

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

Default: 60

meraki_suppress_logging

boolean

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

Choices:

  • false ← (default)
  • true

meraki_use_iterator_for_get_pages

boolean

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

Choices:

  • false ← (default)
  • true

meraki_wait_on_rate_limit

boolean

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

Choices:

  • false
  • true ← (default)

name

string

Имя порта шаблона коммутатора.

organizationId

string

Параметр пути OrganizationId. Идентификатор организации.

poeEnabled

boolean

Статус PoE порта шаблона коммутатора.

Choices:

  • false
  • true

portId

string

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

portScheduleId

string

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

profile

dictionary

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

enabled

boolean

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

Варианты:

  • false
  • true

id

string

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

iname

string

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

profileId

string

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

rstpEnabled

boolean

Состояние протокола быстрой расстановки дерева.

Варианты:

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

tags

list / elements=string

Список тегов порта шаблона коммутатора.

type

string

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

udld

string

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

vlan

integer

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

voiceVlan

integer

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

Примечания

Примечание

  • Используемые методы SDK: switch.Switch.update_organization_config_template_switch_profile_port,
  • Используемые пути: put /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports/{portId},
  • Не поддерживает check_mode
  • Плагин работает на узле управления и не использует плагины соединения ansible, а вместо этого использует встроенный менеджер соединений из Cisco DNAC 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_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
    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
    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
    tags:
    - tag1
    - tag2
    type: access
    udld: Alert only
    vlan: 10
    voiceVlan: 20

Значения возврата

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

Ключ

Описание

meraki_response

словарь

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

Возвращаемое значение: всегда

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

Spec-Zone.ru

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