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

Примечание

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

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

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

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

Новое в cisco.meraki 2.18.0

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

Описание

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

Примечание

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

Требования

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

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 (целое число), время ожидания при повторных попытках из-за ошибки 429 Nginx По умолчанию: `60`
meraki_output_log логическое значение	meraki_output_log (логическое значение), создать файл журнала вывода? Варианты: `false` `true` ← (по умолчанию)
meraki_print_console логическое значение	meraki_print_console (логическое значение), вывести данные журнала в консоль? Варианты: `false` `true` ← (по умолчанию)

meraki_requests_proxy string	мерки_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 (целое число), время ожидания повторной попытки при ошибке 4XX По умолчанию: `60`
meraki_simulate boolean	meraki_simulate (boolean), смоделировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (целое число), максимальное количество секунд для каждого вызова 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` ← (по умолчанию)
ports list / elements=string	Список портов, для которых необходимо выполнить тестирование кабеля.
serial string	Параметр пути serial.

Примечания

Примечание

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

См. также

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

Примеры

- name: Create
  cisco.meraki.devices_live_tools_cable_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
    ports:
    - '2'
    - '8'
    serial: string

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

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

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