модуль cisco.meraki.networks_switch_dhcp_v4_servers_seen_info — информационный модуль для сетей _switch _dhcp v4 _servers _seen

Примечание

Этот модуль входит в коллекцию cisco.meraki (версия 2.23.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 1.0.0

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

Краткое описание

Информационный модуль для получения сведений о DHCPv4-серверах, обнаруженных коммутаторами в сети.
Получает все сети _switch _dhcp v4 _servers _seen.
Возвращает сведения о DHCPv4-серверах сети, обнаруженных за выбранный период времени (по умолчанию — 1 день).

Примечание

Этому модулю соответствует плагин действий.

Требования

На узле, где выполняется этот модуль, необходимы следующие компоненты.

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
direction string	direction (строка), направление пагинации: “next” (по умолчанию) или “prev” (предыдущая страница) По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore string	Информационный модуль для получения сведений о DHCPv4-серверах, обнаруженных коммутаторами в сети. Параметр запроса EndingBefore. Токен, используемый сервером для обозначения конца страницы. Часто это временная метка или идентификатор, но токен не ограничивается этими значениями. Клиентские приложения не должны задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
headers dictionary	Дополнительные заголовки.
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (целое число), время ожидания перед повтором при ошибке параллельного выполнения пакета действий По умолчанию: `60`
meraki_api_key string / обязательный	meraki_api_key (строка), ключ API, созданный в панели управления; также его можно задать с помощью переменной среды MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (строка), базовый URL, предшествующий всем ресурсам конечных точек По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (строка), необязательный идентификатор партнёра для отслеживания использования API; также его можно задать с помощью переменной среды BE_GEO_ID По умолчанию: `""`
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 integer	meraki_retry_4xx_error_wait_time (целое число), время ожидания перед повтором при другой ошибке 4XX По умолчанию: `60`
meraki_simulate boolean	meraki_simulate (логическое значение), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить внесение изменений? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (целое число), максимальное количество секунд для каждого вызова API По умолчанию: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (логическое значение), отключить все журналы? Тогда действуйте на свой страх и риск! Варианты: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (логическое значение), методы list* будут возвращать итератор с каждым объектом вместо полного списка всех элементов Варианты: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (логическое значение), повторять запрос при ошибке ограничения частоты запросов 429? Варианты: `false` `true` ← (по умолчанию)
networkId string	Информационный модуль для получения сведений о DHCPv4-серверах, обнаруженных коммутаторами в сети. Параметр пути NetworkId. Идентификатор сети.
perPage integer	Информационный модуль для получения сведений о DHCPv4-серверах, обнаруженных коммутаторами в сети. Параметр запроса PerPage. Количество записей на возвращаемой странице. Допустимый диапазон: от 3 до 1000. Значение по умолчанию — 1000.
startingAfter string	Информационный модуль для получения сведений о DHCPv4-серверах, обнаруженных коммутаторами в сети. Параметр запроса StartingAfter. Токен, используемый сервером для обозначения начала страницы. Часто это временная метка или идентификатор, но токен не ограничивается этими значениями. Клиентские приложения не должны задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
t0 string	Информационный модуль для получения сведений о DHCPv4-серверах, обнаруженных коммутаторами в сети. Параметр запроса T0. Начало временного интервала, за который собираются данные. Максимальный период ретроспективного просмотра — 31 день от текущей даты.
timespan float	Информационный модуль для получения сведений о DHCPv4-серверах, обнаруженных коммутаторами в сети. Параметр запроса Timespan. Временной интервал, за который будут получены данные. Если указан timespan, не указывайте параметр t0. Значение задаётся в секундах и должно быть не больше 31 дня. По умолчанию — 1 день.
total_pages string / обязательный	total_pages (целое число), используйте вместе с perPage, чтобы получить все результаты до total_pages*perPage; значение -1 означает все страницы

Примечания

Примечание

Используемый метод 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_, используются Python SDK Cisco meraki для установки подключения

См. также

Документация 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_caller: "{{ meraki_caller }}"
    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 list / elements=dictionary	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: "[\n {\n \"mac\": \"string\",\n \"vlan\": 0,\n \"clientId\": \"string\",\n \"isAllowed\": true,\n \"lastSeenAt\": \"string\",\n \"seenBy\": [\n {\n \"serial\": \"string\",\n \"name\": \"string\",\n \"url\": \"string\"\n }\n ],\n \"type\": \"string\",\n \"device\": {\n \"serial\": \"string\",\n \"name\": \"string\",\n \"url\": \"string\",\n \"interface\": {\n \"name\": \"string\",\n \"url\": \"string\"\n }\n },\n \"ipv4\": {\n \"address\": \"string\",\n \"subnet\": \"string\",\n \"gateway\": \"string\"\n },\n \"isConfigured\": true,\n \"lastAck\": {\n \"ts\": \"string\",\n \"ipv4\": {\n \"address\": \"string\"\n }\n },\n \"lastPacket\": {\n \"source\": {\n \"mac\": \"string\",\n \"ipv4\": {\n \"address\": \"string\"\n },\n \"port\": 0\n },\n \"destination\": {\n \"mac\": \"string\",\n \"ipv4\": {\n \"address\": \"string\"\n },\n \"port\": 0\n },\n \"type\": \"string\",\n \"ethernet\": {\n \"type\": \"string\"\n },\n \"ip\": {\n \"id\": \"string\",\n \"version\": 0,\n \"length\": 0,\n \"headerLength\": 0,\n \"protocol\": 0,\n \"ttl\": 0,\n \"dscp\": {\n \"tag\": 0,\n \"ecn\": 0\n }\n },\n \"udp\": {\n \"length\": 0,\n \"checksum\": \"string\"\n },\n \"fields\": {\n \"op\": 0,\n \"htype\": 0,\n \"hlen\": 0,\n \"hops\": 0,\n \"xid\": \"string\",\n \"secs\": 0,\n \"flags\": \"string\",\n \"ciaddr\": \"string\",\n \"yiaddr\": \"string\",\n \"siaddr\": \"string\",\n \"giaddr\": \"string\",\n \"chaddr\": \"string\",\n \"sname\": \"string\",\n \"magicCookie\": \"string\",\n \"options\": [\n {\n \"name\": \"string\",\n \"value\": \"string\"\n }\n ]\n }\n }\n }\n]\n"

Ключ

Описание

meraki_response

list / elements=dictionary

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

Возвращается: всегда

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

Авторы

Francisco Munoz (@fmunoz)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/meraki/networks_switch_dhcp_v4_servers_seen_info_module.html