Модуль cisco.meraki.devices_appliance_uplinks_settings — Модуль ресурсов для устройств _appliance _uplinks _settings

Примечание

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

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

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

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

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

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

Обзор

Управление обновлением операций ресурса devices _appliance _uplinks _settings.
Обновление настроек канала связи для устройства MX appliance.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
interfaces dictionary	Настройки интерфейса.
wan1 dictionary	Настройки WAN 1.
enabled boolean	Включить или отключить интерфейс. Варианты: `false` `true`
pppoe dictionary	Параметры конфигурации для PPPoE.
authentication dictionary	Настройки аутентификации PPPoE.
enabled boolean	Включена ли аутентификация PPPoE. Варианты: `false` `true`
password string	Пароль для аутентификации PPPoE. Этот параметр не возвращается.
username string	Имя пользователя для аутентификации PPPoE.
enabled boolean	Включен ли PPPoE. Варианты: `false` `true`
svis dictionary	Настройки SVI по протоколу.
ipv4 dictionary	Настройки IPv4 для статического/динамического режима.
address string	IP-адрес и маска подсети в статическом режиме.
assignmentMode string	Режим присваивания для этого SVI. Применяется только при отключенном PPPoE.
gateway string	IP-адрес шлюза в статическом режиме.
nameservers dictionary	Настройки сервера имен для этого SVI.
addresses list / elements=string	До 2 адресов серверов имен для использования, упорядоченных по приоритету от наивысшего к низшему.
ipv6 dictionary	Настройки IPv6 для статического/динамического режима.
address string	Статический адрес, который переопределит полученный(е) адреса(а) SLAAC.
assignmentMode string	Режим присваивания для этого SVI. Применяется только при отключенном PPPoE.
gateway string	Статический шлюз, который переопределит полученный автоконфигурацией шлюз.
nameservers dictionary	Настройки сервера имен для этого SVI.
addresses list / elements=string	До 2 адресов серверов имен для использования, упорядоченных по приоритету от наивысшего к низшему.
vlanTagging dictionary	Настройки VLAN-тегирования.
enabled boolean	Включено ли VLAN-тегирование. Варианты: `false` `true`

vlanId integer	Идентификатор VLAN для использования с тегированием VLAN.
wan2 dictionary	Параметры WAN 2.
enabled boolean	Включить или отключить интерфейс. Choices: `false` `true`
pppoe dictionary	Параметры конфигурации PPPoE.
authentication dictionary	Параметры аутентификации PPPoE.
enabled boolean	Включена ли аутентификация PPPoE. Choices: `false` `true`
password string	Пароль для аутентификации PPPoE. Этот параметр не возвращается.
username string	Имя пользователя для аутентификации PPPoE.
enabled boolean	Включен ли PPPoE. Choices: `false` `true`
svis dictionary	Параметры SVI по протоколу.
ipv4 dictionary	Параметры IPv4 для статического/динамического режима.
address string	IP-адрес и маска подсети в статическом режиме.
assignmentMode string	Режим назначения для этого SVI. Применяется только при отключенном PPPoE.
gateway string	IP-адрес шлюза в статическом режиме.
nameservers dictionary	Параметры сервера имен для этого SVI.
addresses list / elements=string	До 2 адресов серверов имен для использования, упорядоченных по приоритету от высшего к низшему.
ipv6 dictionary	Параметры IPv6 для статического/динамического режима.
address string	Статический адрес, который переопределит адрес(а), полученный(е) с помощью SLAAC.
assignmentMode string	Режим назначения для этого SVI. Применяется только при отключенном PPPoE.
gateway string	Статический шлюз, который переопределит шлюз, полученный с помощью autoconf.
nameservers dictionary	Параметры сервера имен для этого SVI.
addresses list / elements=string	До 2 адресов серверов имен для использования, упорядоченных по приоритету от высшего к низшему.
vlanTagging dictionary	Параметры тегирования VLAN.
enabled boolean	Включено ли тегирование VLAN. Choices: `false` `true`

vlanId integer	Идентификатор VLAN, который нужно использовать для тегирования VLAN.
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), время ожидания повторной попытки для ошибки 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 целое число	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 (логический тип), методы со звездочкой * будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами Допустимые значения: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit логический тип	meraki_wait_on_rate_limit (логический тип), повторить попытку, если возникла ошибка ограничения скорости 429? Допустимые значения: `false` `true` ← (по умолчанию)
serial строка	Параметр пути serial.

Примечания

Примечание

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

См. также

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

Примеры

- name: Update all
  cisco.meraki.devices_appliance_uplinks_settings:
    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
    interfaces:
      wan1:
        enabled: true
        pppoe:
          authentication:
            enabled: true
            password: password
            username: username
          enabled: true
        svis:
          ipv4:
            address: 9.10.11.10/16
            assignmentMode: static
            gateway: 13.14.15.16
            nameservers:
              addresses:
              - 1.2.3.4
          ipv6:
            address: 1:2:3::4
            assignmentMode: static
            gateway: 1:2:3::5
            nameservers:
              addresses:
              - 1001:4860:4860::8888
              - 1001:4860:4860::8844
        vlanTagging:
          enabled: true
          vlanId: 1
      wan2:
        enabled: true
        pppoe:
          authentication:
            enabled: true
            password: password
            username: username
          enabled: true
        svis:
          ipv4:
            address: 9.10.11.10/16
            assignmentMode: static
            gateway: 13.14.15.16
            nameservers:
              addresses:
              - 1.2.3.4
          ipv6:
            address: 1:2:3::4
            assignmentMode: static
            gateway: 1:2:3::5
            nameservers:
              addresses:
              - 1001:4860:4860::8888
              - 1001:4860:4860::8844
        vlanTagging:
          enabled: true
          vlanId: 1
    serial: string

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

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

Ключ	Описание
meraki_response словарь	Словарь или список с ответом, возвращенным Cisco Meraki Python SDK Возвращается: всегда Пример: {"wan1": {"enabled": true, "pppoe": {"authentication": {"enabled": true, "username": "string"}, "enabled": true}, "svis": {"ipv4": {"address": "string", "assignmentMode": "string", "gateway": "string", "nameservers": {"addresses": ["string"]}}, "ipv6": {"address": "string", "assignmentMode": "string", "gateway": "string", "nameservers": {"addresses": ["string"]}}}, "vlanTagging": {"enabled": true, "vlanId": 0}}, "wan2": {"enabled": true, "pppoe": {"authentication": {"enabled": true, "username": "string"}, "enabled": true}, "svis": {"ipv4": {"address": "string", "assignmentMode": "string", "gateway": "string", "nameservers": {"addresses": ["string"]}}, "ipv6": {"address": "string", "assignmentMode": "string", "gateway": "string", "nameservers": {"addresses": ["string"]}}}, "vlanTagging": {"enabled": true, "vlanId": 0}}}

Ключ

Описание

meraki_response

словарь

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

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

Пример: {"wan1": {"enabled": true, "pppoe": {"authentication": {"enabled": true, "username": "string"}, "enabled": true}, "svis": {"ipv4": {"address": "string", "assignmentMode": "string", "gateway": "string", "nameservers": {"addresses": ["string"]}}, "ipv6": {"address": "string", "assignmentMode": "string", "gateway": "string", "nameservers": {"addresses": ["string"]}}}, "vlanTagging": {"enabled": true, "vlanId": 0}}, "wan2": {"enabled": true, "pppoe": {"authentication": {"enabled": true, "username": "string"}, "enabled": true}, "svis": {"ipv4": {"address": "string", "assignmentMode": "string", "gateway": "string", "nameservers": {"addresses": ["string"]}}, "ipv6": {"address": "string", "assignmentMode": "string", "gateway": "string", "nameservers": {"addresses": ["string"]}}}, "vlanTagging": {"enabled": true, "vlanId": 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_appliance_uplinks_settings_module.html