Модуль cisco.meraki.devices_live_tools_throughput_test – Модуль ресурсов для устройств _livetools _throughputtest

Примечание

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

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

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

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

Новое в cisco.meraki 2.18.0

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

Описание

Управление операцией создания ресурса устройств _livetools _throughputtest.
Добавление задания для проверки пропускной способности устройства, тест будет выполняться в течение 10 секунд для проверки пропускной способности.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
callback словарь	Подробности для обратной связи. Пожалуйста, укажите либо httpServerId, либо url и sharedSecret.
httpServer словарь	Получатель веб-хука, используемый для веб-хука обратной связи.
id строка	Идентификатор получателя веб-хука, который будет получать информацию. При указании этого поля, оставьте поля url и sharedSecret пустыми.
payloadTemplate словарь	Шаблон полезной нагрузки веб-хука, используемого для обратной связи.
id строка	Идентификатор шаблона полезной нагрузки. По умолчанию для Обратной связи (включено) используется шаблон ‘wpt_00005’.
sharedSecret строка	Секретный ключ, который будет включен в запросы, отправляемые на URL обратной связи. Он может использоваться для проверки того, что запрос был отправлен Meraki. При использовании этого поля, также укажите поле url.
url строка	URL обратной связи для целевого веб-хука. При использовании этого поля, также укажите поле sharedSecret.
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 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 — devices.Devices.create_device_live_tools_throughput_test,
Используемые пути — post /devices/{serial}/liveTools/throughputTest,
Не поддерживает check_mode
Плагин работает на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

Документация Cisco Meraki по устройствам createDeviceLiveToolsThroughputTest: Полное описание API createDeviceLiveToolsThroughputTest.

Примеры

- name: Create
  cisco.meraki.devices_live_tools_throughput_test:
    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
    serial: string

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

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

Ключ	Описание
meraki_response словарь	Словарь или список с ответом, возвращаемым Cisco Meraki Python SDK Возвращается: всегда Пример: `{"callback": {"id": "string", "status": "string", "url": "string"}, "error": "string", "request": {"serial": "string"}, "result": {"speeds": {"downstream": 0}}, "status": "string", "throughputTestId": "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_throughput_test_module.html