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

Примечание

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

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

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

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

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

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

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

Информационный модуль для получения сведений о статусах подготовки устройств организации.
Получить все статусы подготовки устройств организации.
Получить сведения о статусах подготовки устройств в организации.

Примечание

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

Требования

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

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 / elements=string	Информационный модуль для получения сведений о статусах подготовки устройств организации. Параметр запроса NetworkIds. Необязательный параметр для фильтрации устройств по идентификатору сети. Для фильтра используются несколько точных совпадений.
organizationId string	Информационный модуль для получения сведений о статусах подготовки устройств организации. Параметр пути OrganizationId. Идентификатор организации.
perPage integer	Информационный модуль для получения сведений о статусах подготовки устройств организации. Параметр запроса PerPage. Количество записей на возвращаемой странице. Допустимый диапазон — от 3 до 1000. Значение по умолчанию — 1000.
productTypes list / elements=string	Информационный модуль для получения сведений о статусах подготовки устройств организации. Параметр запроса ProductTypes. Необязательный параметр для фильтрации устройств по типам продуктов устройств. Для фильтра используются несколько точных совпадений.
serials list / elements=string	Информационный модуль для получения сведений о статусах подготовки устройств организации. Параметр запроса Serials. Необязательный параметр для фильтрации устройств по серийным номерам. Для фильтра используются несколько точных совпадений.
startingAfter string	Информационный модуль для получения сведений о статусах подготовки устройств организации. Параметр запроса StartingAfter. Токен, с помощью которого сервер указывает начало страницы. Часто это метка времени или идентификатор, но возможны и другие значения. Клиентским приложениям не следует задавать этот параметр. Его следует брать из ссылки на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
status string	Информационный модуль для получения сведений о статусах подготовки устройств организации. Параметр запроса Status. Необязательный параметр для фильтрации устройств по статусу подготовки. Допустимые статусы: unprovisioned, incomplete, complete.
tags list / elements=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_provisioning_statuses,
Используемый путь: get /organizations/{organizationId}/devices/provisioning/statuses,
Поддерживает check_mode
Плагин выполняется на управляющем узле и не использует подключаемые модули соединения Ansible, а вместо этого применяет встроенный менеджер соединений Cisco Meraki SDK
Параметры, начинающиеся с meraki_, используются Python SDK Cisco Meraki для установки соединения

См. также

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

Примеры

- name: Get all organizations _devices _provisioning _statuses
  cisco.meraki.organizations_devices_provisioning_statuses_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: []
    status: string
    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 \"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_provisioning_statuses_info_module.html