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

Примечание

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

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

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

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

Новое в cisco.meraki 2.18.0

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

Описание

Управление операцией создания ресурса devices _livetools _arptable.
Поместить в очередь задание для выполнения запроса таблицы ARP для устройства. Этот конечный пункт в настоящее время поддерживает коммутаторы.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
callback dictionary	Подробная информация о обратном вызове. Укажите либо httpServerId ИЛИ url и sharedSecret.
httpServer dictionary	Приёмник webhook, используемый для webhook обратного вызова.
id string	Идентификатор приёмника webhook, который будет получать информацию. При указании этого поля, оставьте поля url и sharedSecret пустыми.
payloadTemplate dictionary	Шаблон полезной нагрузки webhook, используемый для обратного вызова.
id string	Идентификатор шаблона полезной нагрузки. По умолчанию «wpt_00005» для шаблона Callback (включено).
sharedSecret string	Секретный ключ, который будет включен в запросы, отправленные в URL обратного вызова. Он может использоваться для проверки того, что запрос был отправлен Meraki. При использовании этого поля, пожалуйста, укажите также url.
url string	URL обратного вызова для целевого объекта webhook. При использовании этого поля, пожалуйста, укажите также sharedSecret.
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (integer), время ожидания повторной попытки при ошибке параллельной обработки пакета действий Default: `60`
meraki_api_key string / required	meraki_api_key (string), API ключ, сгенерированный на панели управления; может быть также установлен как переменная среды MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (string), предшествует всем ресурсам конечных точек Default: `"https://api.meraki.com/api/v1"`
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: `false` ← (default) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (string), имя файла журнала с добавлением даты и времени Default: `"meraki_api_"`
meraki_log_path string	log_path (string), путь к выходному журналу; по умолчанию, рабочий каталог скрипта, если не указано иное Default: `""`
meraki_maximum_retries integer	meraki_maximum_retries (integer), повторить до этого количества раз при возникновении ошибок 429 или других ошибок на стороне сервера Default: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (integer), время ожидания повторной попытки для ошибки Nginx 429 Default: `60`
meraki_output_log boolean	meraki_output_log (boolean), создать файл выходного журнала? Choices: `false` `true` ← (default)
meraki_print_console boolean	meraki_print_console (boolean), выводить сообщения журнала на консоль? Choices: `false` `true` ← (default)

meraki_requests_proxy строка	meraki_requests_proxy (строка), прокси-сервер и порт, если необходимо, для HTTPS По умолчанию: `""`
meraki_retry_4xx_error логическое	meraki_retry_4xx_error (логическое), повторить попытку при ошибке 4XX (кроме 429)? Варианты: `false` ← (по умолчанию) `true`
meraki_retry_4xx_error_wait_time целое число	meraki_retry_4xx_error_wait_time (целое число), время ожидания при повторной попытке ошибки 4XX По умолчанию: `60`
meraki_simulate логическое	meraki_simulate (логическое), имитировать вызовы POST/PUT/DELETE для предотвращения изменений? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout целое число	meraki_single_request_timeout (целое число), максимальное количество секунд для каждого вызова API По умолчанию: `60`
meraki_suppress_logging логическое	meraki_suppress_logging (логическое), отключить всю регистрацию? Тогда вы сами за себя! Варианты: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages логическое	meraki_use_iterator_for_get_pages (логическое), методы list* будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами Варианты: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit логическое	meraki_wait_on_rate_limit (логическое), повторить попытку при ошибке 429 лимита запросов? Варианты: `false` `true` ← (по умолчанию)
serial строка	Параметр пути Serial.

Примечания

Примечание

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

См. также

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

Примеры

- name: Create
  cisco.meraki.devices_live_tools_arp_table:
    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 Возвращается: всегда Пример: `{"arpTableId": "string", "callback": {"id": "string", "status": "string", "url": "string"}, "request": {"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_arp_table_module.html