cisco.meraki.networks_cellular_gateway_connectivity_monitoring_destinations модуль — Модуль ресурсов для сетей _cellulargateway_connectivitymonitoringdestinations

Примечание

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

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

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

Для использования в книге задач укажите: cisco.meraki.networks_cellular_gateway_connectivity_monitoring_destinations.

Впервые в cisco.meraki 2.16.0

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

Обзор

Управлять обновлением операций ресурса networks_cellulargateway_connectivitymonitoringdestinations.
Обновлять пункты тестирования подключений для сети MG.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
destinations list / elements=dictionary	Список пунктов назначения мониторинга подключения.
default boolean	Логическое значение, указывающее, является ли это целевым пунктом тестирования по умолчанию (true) или нет (false). По умолчанию false. Допускается только одно значение по умолчанию. Варианты: `false` `true`
description string	Описание пункта назначения тестирования. Необязательно, по умолчанию пустая строка.
ip string	IP-адрес для проверки подключения.
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (integer), время ожидания повторной попытки при ошибке параллельной обработки действий По умолчанию: `60`
meraki_api_key string / required	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_caller string	meraki_caller (string), необязательный идентификатор для отслеживания использования API; может быть также установлен как переменная окружения MERAKI_PYTHON_SDK_CALLER По умолчанию: `""`
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` ← (по умолчанию)
networkId string	Параметр пути NetworkId. Идентификатор сети.

Примечания

Примечание

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

См. также

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

Примеры

- name: Update all
  cisco.meraki.networks_cellular_gateway_connectivity_monitoring_destinations:
    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
    destinations:
    - default: false
      description: Google
      ip: 8.8.8.8
    - default: true
      description: test description
      ip: 1.23.45.67
    - ip: 9.8.7.6
    networkId: string

Возвращаемые значения

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

Ключ	Описание
meraki_response словарь	Словарь или список с ответом, возвращаемым Cisco Meraki Python SDK Возвращается: всегда Пример: `{}`

Авторы

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