Модуль cisco.meraki.devices_live_tools_throughput_test_info — Модуль информации для устройств _livetools _throughputtest
Примечание
Этот модуль является частью коллекции cisco.meraki (версия 2.18.2).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.
Для её установки используйте: ansible-galaxy collection install cisco.meraki. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Для использования его в книге задач укажите: cisco.meraki.devices_live_tools_throughput_test_info.
Добавлена в cisco.meraki 2.18.0
Обзор
- Модуль информации для устройств _livetools _throughputtest
Примечание
У этого модуля есть соответствующий плагин действий.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- meraki >= 2.4.9
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
headers dictionary | Дополнительные заголовки. |
meraki_action_batch_retry_wait_time integer | meraki_action_batch_retry_wait_time (integer), время ожидания повторной попытки при ошибке параллельной обработки действий Default: |
meraki_api_key string / required | meraki_api_key (string), API ключ, сгенерированный на панели управления; может быть также установлен как переменная окружения MERAKI_DASHBOARD_API_KEY |
meraki_base_url string | meraki_base_url (string), предшествует всем конечным точкам ресурсов Default: |
meraki_be_geo_id string | meraki_be_geo_id (string), необязательный идентификатор партнера для отслеживания использования API; может быть также установлен как переменная окружения BE_GEO_ID Default: |
meraki_caller string | meraki_caller (string), необязательный идентификатор для отслеживания использования API; может быть также установлен как переменная окружения MERAKI_PYTHON_SDK_CALLER Default: |
meraki_certificate_path string | meraki_certificate_path (string), путь для проверки сертификата TLS/SSL, если используется локальный прокси Default: |
meraki_inherit_logging_config boolean | meraki_inherit_logging_config (boolean), наследует собственный экземпляр логгера Choices:
|
meraki_log_file_prefix string | meraki_log_file_prefix (string), имя файла журнала, к которому добавляются дата и время Default: |
meraki_log_path string | log_path (string), путь к выходному журналу; по умолчанию, рабочий каталог скрипта, если не указан Default: |
meraki_maximum_retries integer | meraki_maximum_retries (integer), повторить до этого количества раз при возникновении ошибок 429 или других ошибок на стороне сервера Default: |
meraki_nginx_429_retry_wait_time integer | meraki_nginx_429_retry_wait_time (integer), время ожидания повторной попытки Nginx 429 Default: |
meraki_output_log boolean | meraki_output_log (boolean), создать файл выходного журнала? Choices:
|
meraki_print_console boolean | meraki_print_console (boolean), выводить выходные данные журнала в консоль? Choices:
|
meraki_requests_proxy string | meraki_requests_proxy (string), прокси-сервер и порт, если необходимо, для HTTPS Default: |
meraki_retry_4xx_error boolean | meraki_retry_4xx_error (boolean), повторить попытку при возникновении других ошибок 4XX (кроме 429)? Choices:
|
meraki_retry_4xx_error_wait_time integer | meraki_retry_4xx_error_wait_time (integer), время ожидания повторной попытки при других ошибках 4XX Default: |
meraki_simulate boolean | meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения? Choices:
|
meraki_single_request_timeout целое число | meraki_single_request_timeout (целое число), максимальное количество секунд для каждого вызова API По умолчанию: |
meraki_suppress_logging булево | meraki_suppress_logging (булево), отключить всю регистрацию? Тогда на вас вся ответственность! Варианты:
|
meraki_use_iterator_for_get_pages булево | meraki_use_iterator_for_get_pages (булево), методы списка* будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами Варианты:
|
meraki_wait_on_rate_limit булево | meraki_wait_on_rate_limit (булево), повторить попытку, если встретилась ошибка ограничения скорости 429? Варианты:
|
Примечания
Примечание
- Используемые пути:
- Поддерживает
check_mode - Плагин выполняется на узле управления и не использует какие-либо плагины подключения ansible, а вместо этого встроенный менеджер подключений из Cisco Meraki SDK
- Параметры, начинающиеся с meraki_, используются Cisco Meraki Python SDK для установления подключения
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
meraki_response словарь | Словарь или список со значением, возвращенным Cisco Meraki Python SDK Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_info_module.html