Модуль cisco.meraki.networks_switch_dhcp_v4_servers_seen_info – Модуль информации о просмотренных серверах DHCPv4 сети коммутатора

Примечание

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

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

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

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

Впервые в cisco.meraki 2.16.0

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

Описание

Получить все просмотренные серверы DHCPv4 коммутатора сети.
Возвращает серверы DHCPv4 сети, просмотренные в указанном временном интервале (по умолчанию 1 день).

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
direction string	direction (строка), направление для постраничной навигации, либо “next” (по умолчанию), либо “prev” страница По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore string	Параметр запроса EndingBefore. Маркер, используемый сервером для указания конца страницы. Часто это метка времени или ID, но не ограничивается ими. Этот параметр не должен определяться клиентскими приложениями. Ссылка на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link должна определять его.
headers dictionary	Дополнительные заголовки.
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (целое число), время ожидания повторной попытки при ошибке параллельной обработки пакета действий По умолчанию: `60`
meraki_api_key string / required	meraki_api_key (строка), API ключ, сгенерированный на панели управления; может также быть установлен как переменная окружения MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (строка), предшествует всем конечным ресурсам По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (строка), необязательный идентификатор партнера для отслеживания использования API; может также быть установлен как переменная окружения BE_GEO_ID По умолчанию: `""`
meraki_caller string	meraki_caller (строка), необязательный идентификатор для отслеживания использования API; может также быть установлен как переменная окружения MERAKI_PYTHON_SDK_CALLER По умолчанию: `""`
meraki_certificate_path string	meraki_certificate_path (строка), путь для проверки сертификата TLS/SSL, если используется локальный прокси По умолчанию: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (булево), наследует ваш собственный экземпляр регистратора Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (строка), имя файла журнала с добавлением даты и времени По умолчанию: `"meraki_api_"`
meraki_log_path string	log_path (строка), путь к выходному журналу; по умолчанию, рабочий каталог скрипта, если не указано иное По умолчанию: `""`
meraki_maximum_retries integer	meraki_maximum_retries (целое число), повторить до этого количества раз при возникновении ошибок 429 или других ошибок на стороне сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (целое число), время ожидания повторной попытки Nginx 429 По умолчанию: `60`
meraki_output_log boolean	meraki_output_log (булево), создать файл выходного журнала? Варианты: `false` `true` ← (по умолчанию)
meraki_print_console boolean	meraki_print_console (булево), выводить сообщения журнала на консоль? Варианты: `false` `true` ← (по умолчанию)
meraki_requests_proxy string	meraki_requests_proxy (строка), прокси-сервер и порт, если необходимо, для HTTPS По умолчанию: `""`
meraki_retry_4xx_error boolean	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` ← (по умолчанию)
networkId строка	Параметр пути NetworkId. Идентификатор сети.

Примечания

Примечание

Используемый метод SDK — switch.Switch.get_network_switch_dhcp_v4_servers_seen,
Используемые пути — get /networks/{networkId}/switch/dhcp/v4/servers/seen,
Поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco meraki SDK
Параметры, начинающиеся с meraki_, используются Cisco meraki Python SDK для установления соединения

См. также

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

Примеры

- name: Get all networks _switch _dhcp v4 _servers _seen
  cisco.meraki.networks_switch_dhcp_v4_servers_seen_info:
    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}}"
    t0: string
    timespan: 0
    perPage: 0
    startingAfter: string
    endingBefore: string
    networkId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response список / элементы=словарь	Словарь или список с ответом, возвращенным Cisco Meraki Python SDK Возвращаемое значение: всегда Пример: "[\n {\n \"clientId\": \"string\",\n \"device\": {\n \"interface\": {\n \"name\": \"string\",\n \"url\": \"string\"\n },\n \"name\": \"string\",\n \"serial\": \"string\",\n \"url\": \"string\"\n },\n \"ipv4\": {\n \"address\": \"string\",\n \"gateway\": \"string\",\n \"subnet\": \"string\"\n },\n \"isAllowed\": true,\n \"isConfigured\": true,\n \"lastAck\": {\n \"ipv4\": {\n \"address\": \"string\"\n },\n \"ts\": \"string\"\n },\n \"lastPacket\": {\n \"destination\": {\n \"ipv4\": {\n \"address\": \"string\"\n },\n \"mac\": \"string\",\n \"port\": 0\n },\n \"ethernet\": {\n \"type\": \"string\"\n },\n \"fields\": {\n \"chaddr\": \"string\",\n \"ciaddr\": \"string\",\n \"flags\": \"string\",\n \"giaddr\": \"string\",\n \"hlen\": 0,\n \"hops\": 0,\n \"htype\": 0,\n \"magicCookie\": \"string\",\n \"op\": 0,\n \"options\": [\n {\n \"name\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"secs\": 0,\n \"siaddr\": \"string\",\n \"sname\": \"string\",\n \"xid\": \"string\",\n \"yiaddr\": \"string\"\n },\n \"ip\": {\n \"dscp\": {\n \"ecn\": 0,\n \"tag\": 0\n },\n \"headerLength\": 0,\n \"id\": \"string\",\n \"length\": 0,\n \"protocol\": 0,\n \"ttl\": 0,\n \"version\": 0\n },\n \"source\": {\n \"ipv4\": {\n \"address\": \"string\"\n },\n \"mac\": \"string\",\n \"port\": 0\n },\n \"type\": \"string\",\n \"udp\": {\n \"checksum\": \"string\",\n \"length\": 0\n }\n },\n \"lastSeenAt\": \"string\",\n \"mac\": \"string\",\n \"seenBy\": [\n {\n \"name\": \"string\",\n \"serial\": \"string\",\n \"url\": \"string\"\n }\n ],\n \"type\": \"string\",\n \"vlan\": 0\n }\n]\n"

Ключ

Описание

meraki_response

список / элементы=словарь

Словарь или список с ответом, возвращенным Cisco Meraki Python SDK

Возвращаемое значение: всегда

Пример: "[\n {\n \"clientId\": \"string\",\n \"device\": {\n \"interface\": {\n \"name\": \"string\",\n \"url\": \"string\"\n },\n \"name\": \"string\",\n \"serial\": \"string\",\n \"url\": \"string\"\n },\n \"ipv4\": {\n \"address\": \"string\",\n \"gateway\": \"string\",\n \"subnet\": \"string\"\n },\n \"isAllowed\": true,\n \"isConfigured\": true,\n \"lastAck\": {\n \"ipv4\": {\n \"address\": \"string\"\n },\n \"ts\": \"string\"\n },\n \"lastPacket\": {\n \"destination\": {\n \"ipv4\": {\n \"address\": \"string\"\n },\n \"mac\": \"string\",\n \"port\": 0\n },\n \"ethernet\": {\n \"type\": \"string\"\n },\n \"fields\": {\n \"chaddr\": \"string\",\n \"ciaddr\": \"string\",\n \"flags\": \"string\",\n \"giaddr\": \"string\",\n \"hlen\": 0,\n \"hops\": 0,\n \"htype\": 0,\n \"magicCookie\": \"string\",\n \"op\": 0,\n \"options\": [\n {\n \"name\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"secs\": 0,\n \"siaddr\": \"string\",\n \"sname\": \"string\",\n \"xid\": \"string\",\n \"yiaddr\": \"string\"\n },\n \"ip\": {\n \"dscp\": {\n \"ecn\": 0,\n \"tag\": 0\n },\n \"headerLength\": 0,\n \"id\": \"string\",\n \"length\": 0,\n \"protocol\": 0,\n \"ttl\": 0,\n \"version\": 0\n },\n \"source\": {\n \"ipv4\": {\n \"address\": \"string\"\n },\n \"mac\": \"string\",\n \"port\": 0\n },\n \"type\": \"string\",\n \"udp\": {\n \"checksum\": \"string\",\n \"length\": 0\n }\n },\n \"lastSeenAt\": \"string\",\n \"mac\": \"string\",\n \"seenBy\": [\n {\n \"name\": \"string\",\n \"serial\": \"string\",\n \"url\": \"string\"\n }\n ],\n \"type\": \"string\",\n \"vlan\": 0\n }\n]\n"

Авторы

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/networks_switch_dhcp_v4_servers_seen_info_module.html