модуль cisco.meraki.organizations_devices_availabilities_info — информационный модуль для доступности устройств организаций

Примечание

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

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

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

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

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

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

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

Информационный модуль для получения сведений о доступности устройств организаций.
Получить сведения о доступности устройств всех организаций.
Получить сведения о доступности устройств в организации. Данные, возвращаемые этой конечной точкой, обновляются каждые 5 минут.

Примечание

Этому модулю соответствует модуль действий.

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
direction string	direction (string), направление постраничной навигации: «next» (по умолчанию) или «prev» По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore string	Информационный модуль для получения сведений о доступности устройств организаций. Параметр запроса 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 / элементы=string	Информационный модуль для получения сведений о доступности устройств организаций. Параметр запроса NetworkIds. Необязательный параметр для фильтрации сведений о доступности устройств по идентификатору сети. Фильтр использует несколько точных совпадений.
organizationId string	Информационный модуль для получения сведений о доступности устройств организаций. Параметр пути OrganizationId. Идентификатор организации.
perPage integer	Информационный модуль для получения сведений о доступности устройств организаций. Параметр запроса PerPage. Количество записей на возвращаемой странице. Допустимый диапазон: 3–1000. Значение по умолчанию — 1000.
productTypes list / элементы=string	Информационный модуль для получения сведений о доступности устройств организаций. Параметр запроса ProductTypes. Необязательный параметр для фильтрации сведений о доступности устройств по типам продуктов устройств. Фильтр использует несколько точных совпадений. Допустимые типы: wireless, appliance, switch, camera, cellularGateway, sensor, wirelessController и campusGateway.
serials list / элементы=string	Информационный модуль для получения сведений о доступности устройств организаций. Параметр запроса Serials. Необязательный параметр для фильтрации сведений о доступности устройств по серийным номерам устройств. Фильтр использует несколько точных совпадений.
startingAfter string	Информационный модуль для получения сведений о доступности устройств организаций. Параметр запроса StartingAfter. Токен, используемый сервером для указания начала страницы. Часто это временная метка или идентификатор, но токен не ограничивается этими значениями. Клиентские приложения не должны задавать этот параметр. Он должен определяться ссылкой на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
statuses list / элементы=string	Информационный модуль для получения сведений о доступности устройств организаций. Параметр запроса Statuses. Необязательный параметр для фильтрации сведений о доступности устройств по статусу устройства. Фильтр использует несколько точных совпадений.
tags list / элементы=string	Информационный модуль для получения сведений о доступности устройств организаций. Параметр запроса Tags. Необязательный параметр для фильтрации устройств по тегам. При фильтрации учитывается регистр. Если указаны теги, необходимо также указать «tagsFilterType» (см. ниже). Фильтр использует несколько точных совпадений.
tagsFilterType string	Информационный модуль для получения сведений о доступности устройств организаций. Параметр запроса TagsFilterType. Необязательный параметр со значением «withAnyTags» или «withAllTags», указывающий, возвращать ли устройства, содержащие ЛЮБОЙ или ВСЕ указанные теги. Если тип не указан, будет выбрано значение «withAnyTags».
total_pages string / обязательный	total_pages(int), используйте вместе с perPage, чтобы получить общее число результатов до total_pages*perPage; значение -1 — все страницы

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all organizations _devices _availabilities
  cisco.meraki.organizations_devices_availabilities_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
    statuses: []
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response list / элементы=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 \"status\": \"string\",\n \"tags\": [\n \"string\"\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_availabilities_info_module.html