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

Примечание

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

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

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

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

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

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

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

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

Примечание

Для этого модуля имеется соответствующий модуль действия.

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
deploymentType string	Параметр запроса DeploymentType. Фильтрация развертываний по типу.
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), добавляется перед всеми ресурсами конечных точек По умолчанию: `"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` ← (по умолчанию)
organizationId string	Параметр пути OrganizationId. Идентификатор организации.
perPage integer	Параметр запроса PerPage. Количество записей на возвращаемой странице. Допустимый диапазон: 3–1000. Значение по умолчанию — 20.
search string	Параметр запроса Search. Фильтрация по MAC-адресу, серийному номеру, новому или старому имени устройства либо модели.
sortBy string	Параметр запроса SortBy. Поле, используемое для сортировки результатов. По умолчанию — ‘status’.
sortOrder string	Параметр запроса SortOrder. Порядок сортировки. По умолчанию — ‘asc’.
startingAfter string	Параметр запроса StartingAfter. Токен, используемый сервером для указания начала страницы. Часто это временная метка или идентификатор, но значение не ограничивается ими. Клиентские приложения не должны задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
total_pages string / обязательный	total_pages(int), используйте вместе с perPage, чтобы получить все результаты в количестве до total_pages*perPage; -1 означает все страницы

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all organizations _wireless _devices _provisioning _deployments
  cisco.meraki.organizations_wireless_devices_provisioning_deployments_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
    search: string
    sortBy: string
    sortOrder: string
    deploymentType: string
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response list / элементы=dictionary	Словарь или список с ответом, возвращенным Python SDK Cisco Meraki Возвращается: всегда Пример: "[\n {\n \"items\": [\n {\n \"deploymentId\": \"string\",\n \"devices\": {\n \"old\": {\n \"serial\": \"string\",\n \"afterAction\": \"string\",\n \"name\": \"string\",\n \"model\": \"string\",\n \"mac\": \"string\",\n \"tags\": [\n \"string\"\n ],\n \"rfProfile\": {\n \"id\": \"string\",\n \"name\": \"string\"\n }\n },\n \"new\": {\n \"serial\": \"string\",\n \"name\": \"string\",\n \"model\": \"string\",\n \"mac\": \"string\",\n \"tags\": [\n \"string\"\n ],\n \"rfProfile\": {\n \"id\": \"string\",\n \"name\": \"string\"\n }\n }\n },\n \"status\": \"string\",\n \"type\": \"string\",\n \"network\": {\n \"id\": \"string\",\n \"name\": \"string\"\n },\n \"createdAt\": \"string\",\n \"requestedAt\": \"string\",\n \"lastUpdatedAt\": \"string\",\n \"completedAt\": \"string\",\n \"errors\": [\n \"string\"\n ]\n }\n ],\n \"meta\": {\n \"counts\": {\n \"items\": {\n \"total\": 0,\n \"remaining\": 0\n }\n }\n }\n }\n]\n"

Ключ

Описание

meraki_response

list / элементы=dictionary

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

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

Пример: "[\n {\n \"items\": [\n {\n \"deploymentId\": \"string\",\n \"devices\": {\n \"old\": {\n \"serial\": \"string\",\n \"afterAction\": \"string\",\n \"name\": \"string\",\n \"model\": \"string\",\n \"mac\": \"string\",\n \"tags\": [\n \"string\"\n ],\n \"rfProfile\": {\n \"id\": \"string\",\n \"name\": \"string\"\n }\n },\n \"new\": {\n \"serial\": \"string\",\n \"name\": \"string\",\n \"model\": \"string\",\n \"mac\": \"string\",\n \"tags\": [\n \"string\"\n ],\n \"rfProfile\": {\n \"id\": \"string\",\n \"name\": \"string\"\n }\n }\n },\n \"status\": \"string\",\n \"type\": \"string\",\n \"network\": {\n \"id\": \"string\",\n \"name\": \"string\"\n },\n \"createdAt\": \"string\",\n \"requestedAt\": \"string\",\n \"lastUpdatedAt\": \"string\",\n \"completedAt\": \"string\",\n \"errors\": [\n \"string\"\n ]\n }\n ],\n \"meta\": {\n \"counts\": {\n \"items\": {\n \"total\": 0,\n \"remaining\": 0\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_wireless_devices_provisioning_deployments_info_module.html