модуль cisco.meraki.devices_appliance_uplinks_settings — модуль ресурсов для devices _appliance _uplinks _settings

Примечание

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

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

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

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

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

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

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

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

Примечание

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

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

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	Статический шлюз, который заменит шлюз, полученный через autoconf.
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	Включение или отключение интерфейса. Варианты: `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	Статический шлюз, который заменит шлюз, полученный через autoconf.
nameservers dictionary	Настройки серверов имен для этого SVI.
addresses list / elements=string	До 2 адресов серверов имен для использования, упорядоченных по убыванию приоритета.
vlanTagging dictionary	Настройки тегирования VLAN.
enabled boolean	Включено ли тегирование VLAN. Варианты: `false` `true`
vlanId integer	Идентификатор VLAN для тегирования VLAN.
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), базовый адрес перед всеми ресурсами конечных точек По умолчанию: `"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), время ожидания перед повторной попыткой при ответе Nginx 429 По умолчанию: `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` ← (по умолчанию)
serial string	Параметр пути Serial.

Примечания

Примечание

Используемый метод SDK: appliance.Appliance.update_device_appliance_uplinks_settings,
Используемый путь: put /devices/{serial}/appliance/uplinks/settings,
Не поддерживает check_mode
Плагин выполняется на управляющем узле и не использует никакие плагины подключений Ansible, а вместо этого использует встроенный менеджер подключений
из Cisco Dashboard API Python(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_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
    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 dictionary	Словарь или список с ответом, возвращённым 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

dictionary

Словарь или список с ответом, возвращённым 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/meraki/devices_appliance_uplinks_settings_module.html