модуль cisco.meraki.organizations_devices_uplinks_addresses_by_device_info — информационный модуль для organizations _devices _uplinks _addresses _bydevice

Примечание

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

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

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

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

Добавлено в cisco.meraki 1.0.0

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

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

Информационный модуль для Organizations Devices Uplinks Addresses Bydevice Info.
Получить все organizations _devices _uplinks _addresses _bydevice.
Вывести текущие адреса uplink-каналов устройств в организации.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
direction string	direction (string): направление разбивки на страницы — «next» (по умолчанию) или «prev» По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore string	Информационный модуль для Organizations Devices Uplinks Addresses Bydevice Info. Параметр запроса EndingBefore. Токен, используемый сервером для указания конца страницы. Часто это метка времени или идентификатор, но значение не ограничивается ими. Клиентские приложения не должны задавать этот параметр. Он должен указываться в ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
headers dictionary	Дополнительные заголовки.
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (integer): время ожидания перед повтором при ошибке параллельного выполнения пакета действий По умолчанию: `60`
meraki_api_key string / обязательный	meraki_api_key (string): ключ API, созданный на панели управления; его также можно задать с помощью переменной среды MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (string): базовый URL для всех ресурсов конечных точек По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (string): необязательный идентификатор партнера для отслеживания использования API; его также можно задать с помощью переменной среды BE_GEO_ID По умолчанию: `""`
meraki_certificate_path string	meraki_certificate_path (string): путь к сертификату TLS/SSL для проверки, если используется локальный прокси-сервер По умолчанию: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (boolean): использовать собственный экземпляр регистратора Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (string): имя файла журнала с добавленными датой и временем По умолчанию: `"meraki_api_"`
meraki_log_path string	log_path (string): путь к выходному файлу журнала; если не указан, используется рабочий каталог скрипта По умолчанию: `""`
meraki_maximum_retries integer	meraki_maximum_retries (integer): количество повторных попыток при получении ошибок 429 или других ошибок на стороне сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (integer): время ожидания перед повтором после ошибки Nginx 429 По умолчанию: `60`
meraki_output_log boolean	meraki_output_log (boolean): создавать выходной файл журнала? Варианты: `false` `true` ← (по умолчанию)
meraki_print_console boolean	meraki_print_console (boolean): выводить журнал в консоль? Варианты: `false` `true` ← (по умолчанию)
meraki_requests_proxy string	meraki_requests_proxy (string): адрес и порт прокси-сервера для 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 (integer): время ожидания перед повтором после другой ошибки 4XX По умолчанию: `60`
meraki_simulate boolean	meraki_simulate (boolean): имитировать вызовы POST/PUT/DELETE, чтобы предотвратить внесение изменений? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (integer): максимальное количество секунд для каждого вызова 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` ← (по умолчанию)
networkIds list / elements=string	Информационный модуль для Organizations Devices Uplinks Addresses Bydevice Info. Параметр запроса NetworkIds. Необязательный параметр для фильтрации uplink-каналов устройств по идентификатору сети. Для фильтра используются несколько точных совпадений.
organizationId string	Информационный модуль для Organizations Devices Uplinks Addresses Bydevice Info. Параметр пути OrganizationId. Идентификатор организации.
perPage integer	Информационный модуль для Organizations Devices Uplinks Addresses Bydevice Info. Параметр запроса PerPage. Количество записей на возвращаемой странице. Допустимый диапазон: 3–1000. Значение по умолчанию — 1000.
productTypes list / elements=string	Информационный модуль для Organizations Devices Uplinks Addresses Bydevice Info. Параметр запроса ProductTypes. Необязательный параметр для фильтрации uplink-каналов устройств по типам устройств. Для фильтра используются несколько точных совпадений.
serials list / elements=string	Информационный модуль для Organizations Devices Uplinks Addresses Bydevice Info. Параметр запроса Serials. Необязательный параметр для фильтрации доступности устройств по серийным номерам. Для фильтра используются несколько точных совпадений.
startingAfter string	Информационный модуль для Organizations Devices Uplinks Addresses Bydevice Info. Параметр запроса StartingAfter. Токен, используемый сервером для указания начала страницы. Часто это метка времени или идентификатор, но значение не ограничивается ими. Клиентские приложения не должны задавать этот параметр. Он должен указываться в ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
tags list / elements=string	Информационный модуль для Organizations Devices Uplinks Addresses Bydevice Info. Параметр запроса Tags. Необязательный параметр для фильтрации устройств по тегам. Фильтрация учитывает регистр. Если указаны теги, также следует указать «tagsFilterType» (см. ниже). Для фильтра используются несколько точных совпадений.
tagsFilterType string	Информационный модуль для Organizations Devices Uplinks Addresses Bydevice Info. Параметр запроса TagsFilterType. Необязательный параметр со значением «withAnyTags» или «withAllTags», указывающий, следует ли возвращать устройства, содержащие ЛЮБЫЕ или ВСЕ из указанных тегов. Если тип не указан, выбирается «withAnyTags».
total_pages string / обязательный	total_pages(int): используйте вместе с perPage, чтобы получить общее количество результатов до total_pages*perPage; -1 означает все страницы

Примечания

Примечание

Используемый метод SDK: organizations.Organizations.get_organization_devices_uplinks_addresses_by_device,
Используемые пути: get /organizations/{organizationId}/devices/uplinks/addresses/byDevice,
Поддерживает check_mode
Плагин выполняется на управляющем узле и не использует плагины подключений Ansible, а вместо этого использует встроенный диспетчер подключений из Cisco meraki SDK
Параметры, начинающиеся с meraki_, используются Python SDK Cisco meraki для установления подключения

См. также

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

Примеры

- name: Get all organizations _devices _uplinks _addresses _bydevice
  cisco.meraki.organizations_devices_uplinks_addresses_by_device_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 }}"
    perPage: 0
    startingAfter: string
    endingBefore: string
    networkIds: []
    productTypes: []
    serials: []
    tags: []
    tagsFilterType: string
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response list / elements=dictionary	Словарь или список с ответом, возвращенным Python SDK Cisco Meraki Возвращается: всегда Пример: "[\n {\n \"mac\": \"string\",\n \"name\": \"string\",\n \"network\": {\n \"id\": \"string\"\n },\n \"productType\": \"string\",\n \"serial\": \"string\",\n \"tags\": [\n \"string\"\n ],\n \"uplinks\": [\n {\n \"interface\": \"string\",\n \"addresses\": [\n {\n \"protocol\": \"string\",\n \"assignmentMode\": \"string\",\n \"address\": \"string\",\n \"gateway\": \"string\",\n \"nameservers\": {\n \"addresses\": [\n \"string\"\n ]\n },\n \"public\": {\n \"address\": \"string\"\n },\n \"vlan\": {\n \"id\": \"string\"\n }\n }\n ]\n }\n ]\n }\n]\n"

Ключ

Описание

meraki_response

list / elements=dictionary

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

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

Пример: "[\n {\n \"mac\": \"string\",\n \"name\": \"string\",\n \"network\": {\n \"id\": \"string\"\n },\n \"productType\": \"string\",\n \"serial\": \"string\",\n \"tags\": [\n \"string\"\n ],\n \"uplinks\": [\n {\n \"interface\": \"string\",\n \"addresses\": [\n {\n \"protocol\": \"string\",\n \"assignmentMode\": \"string\",\n \"address\": \"string\",\n \"gateway\": \"string\",\n \"nameservers\": {\n \"addresses\": [\n \"string\"\n ]\n },\n \"public\": {\n \"address\": \"string\"\n },\n \"vlan\": {\n \"id\": \"string\"\n }\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/organizations_devices_uplinks_addresses_by_device_info_module.html