cisco.meraki.organizations_wireless_devices_provisioning_deployments module – Модуль ресурсов для развертываний подготовки беспроводных устройств организаций
Примечание
Этот модуль входит в коллекцию 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.
Добавлен в cisco.meraki 1.0.0
Краткое описание
- Управление операциями создания, обновления и удаления ресурса organizations _wireless _devices _provisioning _deployments.
- Создание развертывания без настройки для точки беспроводного доступа.
- Удаление развертывания без настройки.
- Обновление развертывания без настройки.
Примечание
Этому модулю соответствует плагин действий.
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- meraki >= 2.4.9
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
deploymentId string | Параметр пути DeploymentId. Идентификатор развертывания. |
items list / elements=dictionary | Список бесконтактных развертываний для создания. |
|
completedAt string |
Временная метка завершения запроса на бесконтактное развертывание. |
|
createdAt string |
Временная метка создания запроса на бесконтактное развертывание. |
|
deploymentId string |
Идентификатор запроса на бесконтактное развертывание. |
|
devices dictionary |
Массив, состоящий из старых и новых устройств. |
|
new dictionary |
Новое устройство. |
|
mac string |
MAC-адрес нового устройства. |
|
model string |
Модель нового устройства. |
|
name string |
Имя нового устройства или серийный номер, если имя не задано. |
|
rfProfile dictionary |
Радиочастотный профиль нового устройства. |
|
id string |
Идентификатор RfProfile нового устройства. |
|
name string |
Имя RfProfile нового устройства. |
|
serial string |
Серийный номер нового устройства. |
|
tags list / elements=string |
Тег(и) нового устройства. |
|
old dictionary |
Старое устройство. |
|
afterAction string |
Действие, которое необходимо выполнить со старым устройством. |
|
mac string |
MAC-адрес старого устройства. |
|
model string |
Модель старого устройства. |
|
name string |
Имя старого устройства. |
|
rfProfile dictionary |
Радиочастотный профиль старого устройства. |
|
id string |
Идентификатор радиочастотного профиля. |
|
name string |
Имя радиочастотного профиля. |
|
serial string |
Серийный номер старого устройства. |
|
tags list / elements=string |
Тег(и) старого устройства. |
|
errors list / elements=string |
Массив сообщений об ошибках, если они есть. |
|
lastUpdatedAt string |
Временная метка последнего обновления запроса на бесконтактное развертывание. |
|
network dictionary |
Сведения о сети. |
|
id string |
Идентификатор сети, в которую добавляется устройство. |
|
name string |
Имя сети, в которую добавляется устройство. |
|
requestedAt string |
Временная метка создания запроса на бесконтактное развертывание. |
|
status string |
Статус запроса на бесконтактное развертывание. Перечисление: ready, in progress, completed, failed. |
|
type string |
Тип запроса на бесконтактное развертывание. Перечисление: deploy, replace. |
meraki_action_batch_retry_wait_time integer | meraki_action_batch_retry_wait_time (integer), время ожидания перед повторной попыткой при ошибке параллельного выполнения пакета действий По умолчанию: |
meraki_api_key string / обязательный | meraki_api_key (string), ключ API, созданный на панели управления; его также можно задать в переменной среды MERAKI_DASHBOARD_API_KEY |
meraki_base_url string | meraki_base_url (string), базовый URL перед всеми ресурсами конечных точек По умолчанию: |
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), наследовать собственный экземпляр регистратора Варианты:
|
meraki_log_file_prefix string | meraki_log_file_prefix (string), имя файла журнала с добавленными датой и временной меткой По умолчанию: |
meraki_log_path string | log_path (string), путь для вывода журнала; если не указан, используется рабочий каталог скрипта По умолчанию: |
meraki_maximum_retries integer | meraki_maximum_retries (integer), максимальное количество повторных попыток при получении ответа 429 или других ошибок на стороне сервера По умолчанию: |
meraki_nginx_429_retry_wait_time integer | meraki_nginx_429_retry_wait_time (integer), время ожидания перед повторной попыткой при ответе 429 от Nginx По умолчанию: |
meraki_output_log boolean | meraki_output_log (boolean), создавать файл журнала вывода? Варианты:
|
meraki_print_console boolean | meraki_print_console (boolean), выводить журнал в консоль? Варианты:
|
meraki_requests_proxy string | meraki_requests_proxy (string), прокси-сервер и порт для HTTPS, если требуется По умолчанию: |
meraki_retry_4xx_error boolean | meraki_retry_4xx_error (boolean), повторять запрос при получении другой ошибки 4XX (кроме 429)? Варианты:
|
meraki_retry_4xx_error_wait_time integer | meraki_retry_4xx_error_wait_time (integer), время ожидания перед повторной попыткой при другой ошибке 4XX По умолчанию: |
meraki_simulate boolean | meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения? Варианты:
|
meraki_single_request_timeout integer | meraki_single_request_timeout (integer), максимальное количество секунд для каждого вызова API По умолчанию: |
meraki_suppress_logging boolean | meraki_suppress_logging (boolean), отключить ведение журнала? В таком случае вы действуете на свой страх и риск! Варианты:
|
meraki_use_iterator_for_get_pages boolean | meraki_use_iterator_for_get_pages (boolean), методы list* возвращают итератор с каждым объектом вместо полного списка всех элементов Варианты:
|
meraki_wait_on_rate_limit boolean | meraki_wait_on_rate_limit (boolean), повторять запрос при ошибке ограничения частоты запросов 429? Варианты:
|
meta dictionary | Метаданные, относящиеся к разбитому на страницы набору данных. |
|
counts dictionary |
Количество элементов в разбитом на страницы наборе данных. |
|
items dictionary |
Количество элементов в разбитом на страницы наборе данных. |
|
remaining integer |
Количество элементов набора данных, доступных на последующих страницах. |
|
total integer |
Общее количество элементов в наборе данных. |
organizationId string | Параметр пути OrganizationId. Идентификатор организации. |
Примечания
Примечание
- Используемые методы SDK: wireless.Wireless.create_organization_wireless_devices_provisioning_deployment, wireless.Wireless.delete_organization_wireless_devices_provisioning_deployment, wireless.Wireless.update_organization_wireless_devices_provisioning_deployments,
- Используемые пути: post /organizations/{organizationId}/wireless/devices/provisioning/deployments, delete /organizations/{organizationId}/wireless/devices/provisioning/deployments/{deploymentId}, put /organizations/{organizationId}/wireless/devices/provisioning/deployments,
- Не поддерживает
check_mode - Плагин работает на управляющем узле и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений
- из Cisco Dashboard API Python (SDK)
- Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения
См. также
См. также
- Документация Cisco Meraki по методу wireless createOrganizationWirelessDevicesProvisioningDeployment
-
Полное описание API createOrganizationWirelessDevicesProvisioningDeployment.
- Документация Cisco Meraki по методу wireless deleteOrganizationWirelessDevicesProvisioningDeployment
-
Полное описание API deleteOrganizationWirelessDevicesProvisioningDeployment.
- Документация Cisco Meraki по методу wireless updateOrganizationWirelessDevicesProvisioningDeployments
-
Полное описание API updateOrganizationWirelessDevicesProvisioningDeployments.
Примеры
- name: Create
cisco.meraki.organizations_wireless_devices_provisioning_deployments:
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 }}"
state: present
items:
- completedAt: "2018-02-11T00:00:00.090210Z"
createdAt: "2018-02-11T00:00:00.090210Z"
deploymentId: "1284392014819"
devices:
new:
mac: 00:11:22:33:44:55
model: CW9166I
name: My AP
rfProfile:
id: "1284392014819"
name: RF Profile Name
serial: Q234-ABCD-5678
tags:
- tag1
- tag2
old:
afterAction: unclaim
mac: 00:11:22:33:44:55
model: MR34
name: My AP
rfProfile:
id: "1284392014819"
name: RF Profile Name
serial: Q234-ABCD-5678
tags:
- tag1
- tag2
errors:
- error message1
- error message2
lastUpdatedAt: "2018-02-11T00:00:00.090210Z"
network:
id: N_24329156
name: Main Office
requestedAt: "2018-02-11T00:00:00.090210Z"
status: ready
type: replace
meta:
counts:
items:
remaining: 0
total: 20
organizationId: string
- name: Update all
cisco.meraki.organizations_wireless_devices_provisioning_deployments:
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 }}"
state: present
items:
- completedAt: "2018-02-11T00:00:00.090210Z"
createdAt: "2018-02-11T00:00:00.090210Z"
deploymentId: "1284392014819"
devices:
new:
mac: 00:11:22:33:44:55
model: CW9166I
name: My AP
rfProfile:
id: "1284392014819"
name: RF Profile Name
serial: Q234-ABCD-5678
tags:
- tag1
- tag2
old:
afterAction: unclaim
mac: 00:11:22:33:44:55
model: MR34
name: My AP
rfProfile:
id: "1284392014819"
name: RF Profile Name
serial: Q234-ABCD-5678
tags:
- tag1
- tag2
errors:
- error message1
- error message2
lastUpdatedAt: "2018-02-11T00:00:00.090210Z"
network:
id: N_24329156
name: Main Office
requestedAt: "2018-02-11T00:00:00.090210Z"
status: ready
type: replace
meta:
counts:
items:
remaining: 0
total: 20
organizationId: string
- name: Delete by id
cisco.meraki.organizations_wireless_devices_provisioning_deployments:
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 }}"
state: absent
deploymentId: string
organizationId: string
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meraki_response словарь | Словарь или список с ответом, возвращённым Cisco Meraki Python SDK Возвращается: всегда Пример: |
Ссылки коллекции
© 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_module.html