cisco.meraki.networks_settings модуль — Модуль ресурса для настроек сетей

Примечание

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

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

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

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

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

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

Описание

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

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
localStatusPage словарь	Хэш параметров аутентификации страницы(ей) локального статуса, применяемых к сети.
authentication словарь	Хэш параметров аутентификации страницы(ей) локального статуса, применяемых к сети.
enabled булево	Включает/выключает аутентификацию на страницах локального статуса. Выбор: `false` `true`
password строка	Пароль, используемый для страницы(ей) локального статуса. Установите значение null, чтобы очистить пароль.
localStatusPageEnabled булево	Включает/выключает страницы статуса локального устройства (). Необязательно (по умолчанию false). Выбор: `false` `true`
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 строка	путь_журнала (строка), путь для вывода журнала; по умолчанию — рабочая директория скрипта, если не указано По умолчанию: `""`
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` ← (по умолчанию)
namedVlans dictionary	Хэш параметров Именных VLAN, применяемых к сети.
enabled boolean	Включает/выключает Именные VLAN в сети. Варианты: `false` `true`
networkId string	Параметр пути networkId. Идентификатор сети.
remoteStatusPageEnabled boolean	Включает/выключает доступ к странице состояния устройства (<a target=’_blank’>http //IP устройства в локальной сети)</a>. Необязательно. Может быть установлено только в том случае, если localStatusPageEnabled установлено в значение true. Варианты: `false` `true`
securePort dictionary	Хэш параметров SecureConnect, применяемых к сети.
enabled boolean	Включает/выключает SecureConnect в сети. Необязательно. Варианты: `false` `true`

Примечания

Примечание

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

См. также

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

Примеры

- name: Update all
  cisco.meraki.networks_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
    localStatusPage:
      authentication:
        enabled: false
        password: miles123
    localStatusPageEnabled: true
    namedVlans:
      enabled: true
    networkId: string
    remoteStatusPageEnabled: true
    securePort:
      enabled: false

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

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

Ключ	Описание
meraki_response dictionary	Словарь или список со значением, возвращенным Cisco Meraki Python SDK Возвращается: всегда Пример: `{"fips": {"enabled": true}, "localStatusPage": {"authentication": {"enabled": true, "username": "string"}}, "localStatusPageEnabled": true, "namedVlans": {"enabled": true}, "remoteStatusPageEnabled": true, "securePort": {"enabled": true}}`

Ключ

Описание

meraki_response

dictionary

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

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

Пример: {"fips": {"enabled": true}, "localStatusPage": {"authentication": {"enabled": true, "username": "string"}}, "localStatusPageEnabled": true, "namedVlans": {"enabled": true}, "remoteStatusPageEnabled": true, "securePort": {"enabled": true}}

Авторы

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_settings_module.html