Spec-Zone.ru › Ansible

Модуль cisco.meraki.networks_vlan_profiles – Модуль ресурсов для networks_vlanprofiles

Примечание

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

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

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

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

Новая функция в cisco.meraki 2.18.0

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

Описание

  • Управление операциями обновления и удаления ресурса networks_vlanprofiles.
  • Удаление профиля VLAN сети.
  • Обновление существующего профиля VLAN сети.

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

iname

string

Параметр пути iname.

meraki_action_batch_retry_wait_time

integer

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

Default: 60

meraki_api_key

string / required

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

meraki_base_url

string

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

Default: "https://api.meraki.com/api/v1"

meraki_be_geo_id

string

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

Default: ""

meraki_caller

string

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

Default: ""

meraki_certificate_path

string

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

Default: ""

meraki_inherit_logging_config

boolean

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

Choices:

  • false ← (default)
  • true

meraki_log_file_prefix

string

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

Default: "meraki_api_"

meraki_log_path

string

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

Default: ""

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), время ожидания повтора попытки при ошибке 429 от Nginx

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

целое число

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

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

meraki_suppress_logging

булево

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

Варианты:

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

meraki_use_iterator_for_get_pages

булево

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

Варианты:

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

meraki_wait_on_rate_limit

булево

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

Варианты:

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

name

строка

Имя профиля, длина строки должна быть от 1 до 255 символов.

networkId

строка

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

vlanGroups

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

Массив групп VLAN.

name

строка

Имя VLAN, длина строки должна быть от 1 до 32 символов.

vlanIds

строка

Список идентификаторов VLAN, разделенных запятыми, или диапазоны идентификаторов.

vlanNames

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

Массив именованных VLAN.

adaptivePolicyGroup

словарь

Группа адаптивной политики, назначенная идентификатору VLAN.

id

строка

Идентификатор группы адаптивной политики.

name

строка

Имя VLAN, длина строки должна быть от 1 до 32 символов.

vlanId

строка

Идентификатор VLAN.

Примечания

Примечание

  • Используемые методы SDK: networks.Networks.delete_network_vlan_profile, networks.Networks.update_network_vlan_profile,
  • Используемые пути: delete /networks/{networkId}/vlanProfiles/{iname}, put /networks/{networkId}/vlanProfiles/{iname},
  • Не поддерживает check_mode
  • Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого использует встроенный диспетчер подключений Cisco DNAC SDK
  • Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

См. также

Документация Cisco Meraki для networks deleteNetworkVlanProfile

Полное описание API deleteNetworkVlanProfile.

Документация Cisco Meraki для networks updateNetworkVlanProfile

Полное описание API updateNetworkVlanProfile.

Примеры

- name: Delete by name
  cisco.meraki.networks_vlan_profiles:
    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: absent
    iname: string
    networkId: string

- name: Update by name
  cisco.meraki.networks_vlan_profiles:
    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
    iname: string
    name: My VLAN profile name
    networkId: string
    vlanGroups:
    - name: named-group-1
      vlanIds: 2,5-7
    vlanNames:
    - adaptivePolicyGroup:
        id: '791'
      name: named-1
      vlanId: '1'

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

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

Ключ

Описание

meraki_response

словарь

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

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

Пример: {"iname": "string", "isDefault": true, "name": "string", "vlanGroups": [{"name": "string", "vlanIds": "string"}], "vlanNames": [{"adaptivePolicyGroup": {"id": "string", "name": "string"}, "name": "string", "vlanId": "string"}]}

Авторы

  • 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/networks_vlan_profiles_module.html

Spec-Zone.ru

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