Модуль cisco.meraki.devices_live_tools_ping — Модуль ресурсов для устройств _livetools _ping

Примечание

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

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

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

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

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

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

Описание

Управлять операцией создания ресурса устройств _livetools _ping.
Добавить в очередь задачу для отправки запроса ping целевому хосту с устройства.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
callback словарь	Детали для обратного вызова. Укажите либо httpServerId, либо url и sharedSecret.
httpServer словарь	Получатель веб-хуков, используемый для веб-хука обратного вызова.
id строка	ID получателя веб-хука, который получит информацию. Если вы указываете это значение, оставьте поля url и sharedSecret пустыми.
payloadTemplate словарь	Шаблон полезной нагрузки веб-хука, используемого для обратного вызова.
id строка	Идентификатор шаблона полезной нагрузки. По умолчанию для обратного вызова (включая) используется шаблон «wpt_00005».
sharedSecret строка	Общий секрет, который будет включён в запросы, отправленные на URL обратного вызова. Он может использоваться для проверки того, что запрос был отправлен Meraki. Если используется это поле, также укажите url.
url строка	URL обратного вызова для целевого веб-хука. Если используется это поле, также укажите sharedSecret.
count целое число	Параметр count для передачи в ping. 1..5, по умолчанию 5.
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` ← (по умолчанию)

END_OF_DOCUMENT_MARKER

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.
target string	FQDN, IPv4 или IPv6 адрес.

Примечания

Примечание

Используемый метод SDK: devices.Devices.create_device_live_tools_ping,
Используемые пути: post /devices/{serial}/liveTools/ping,
Не поддерживает check_mode
Плагин выполняется на контрольном узле и не использует плагины подключения ansible, а вместо этого встроенный менеджер подключения из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

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

Примеры

- name: Create
  cisco.meraki.devices_live_tools_ping:
    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
    callback:
      httpServer:
        id: aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vd2ViaG9va3M=
      payloadTemplate:
        id: wpt_2100
      sharedSecret: secret
      url: https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031
    count: 2
    serial: string
    target: 75.75.75.75

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

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

Ключ	Описание
meraki_response словарь	Словарь или список, содержащий ответ, возвращённый Cisco Meraki Python SDK Возвращаемое значение: всегда Пример: `{"callback": {"id": "string", "status": "string", "url": "string"}, "pingId": "string", "request": {"count": 0, "serial": "string", "target": "string"}, "status": "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/devices_live_tools_ping_module.html