Модуль cisco.meraki.networks_appliance_settings – Модуль ресурсов для настроек устройств сети

Примечание

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

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

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

Для использования в playbook, укажите: cisco.meraki.networks_appliance_settings.

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

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

Описание

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

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
clientTrackingMethod строка	Метод отслеживания клиентов сети.
deploymentMode строка	Режим развертывания сети.
dynamicDns словарь	Настройки динамической DNS для сети.
enabled логическое	Включена динамическая DNS. Варианты: `false` `true`
prefix строка	Префикс URL динамической DNS. Для обновления необходимо включить DDNS.
meraki_action_batch_retry_wait_time целое число	meraki_action_batch_retry_wait_time (целое число), время ожидания при повторных ошибках в пакетных действиях По умолчанию: `60`
meraki_api_key строка / обязательно	meraki_api_key (строка), 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 строка	log_path (строка), путь для вывода лога; по умолчанию рабочая директория скрипта, если не указан По умолчанию: `""`
meraki_maximum_retries целое число	meraki_maximum_retries (целое число), количество попыток повтора при возникновении ошибок 429 или других ошибок на стороне сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time целое число	meraki_nginx_429_retry_wait_time (целое число), время ожидания повтора при ошибке Nginx 429 По умолчанию: `60`
meraki_output_log логическое	meraki_output_log (логическое), создать файл лога вывода? Варианты: `false` `true` ← (по умолчанию)
meraki_print_console логическое	meraki_print_console (логическое), вывести выходные данные лога в консоль? Варианты: `false` `true` ← (по умолчанию)
meraki_requests_proxy строка	meraki_requests_proxy (строка), сервер прокси и порт, если необходимо, для 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` ← (по умолчанию)
networkId string	Параметр пути networkId. Идентификатор сети.

Примечания

Примечание

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

См. также

Документация Cisco Meraki по обновлению настроек сетевого прибора updateNetworkApplianceSettings: Полное описание API updateNetworkApplianceSettings.

Примеры

- name: Update all
  cisco.meraki.networks_appliance_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
    clientTrackingMethod: MAC address
    deploymentMode: routed
    dynamicDns:
      enabled: true
      prefix: test
    networkId: string

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

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

Ключ	Описание
meraki_response словарь	Словарь или список с ответом, возвращенным Cisco Meraki Python SDK Возвращается: всегда Пример: `{"clientTrackingMethod": "string", "deploymentMode": "string", "dynamicDns": {"enabled": true, "prefix": "string", "url": "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_appliance_settings_module.html