модуль cisco.meraki.organizations_inventory_orders_claim – модуль ресурсов для organizations _inventory _orders _claim

Примечание

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

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

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

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

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

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

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

Управление операцией создания ресурса organizations _inventory _orders _claim.
Получение заказа по уникальному защищенному номеру запроса на получение заказа — идентификатору запроса на получение заказа.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
claimId строка	Уникальный идентификатор запроса на получение заказа.
meraki_action_batch_retry_wait_time целое число	meraki_action_batch_retry_wait_time (целое число), время ожидания перед повторной попыткой при ошибке параллельного выполнения пакета действий По умолчанию: `60`
meraki_api_key строка / обязательный	meraki_api_key (строка), ключ API, созданный на панели управления; также можно задать в переменной среды MERAKI_DASHBOARD_API_KEY
meraki_base_url строка	meraki_base_url (строка), базовый URL для всех ресурсов конечных точек По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id строка	meraki_be_geo_id (строка), необязательный идентификатор партнера для отслеживания использования API; также можно задать в переменной среды BE_GEO_ID По умолчанию: `""`
meraki_certificate_path строка	meraki_certificate_path (строка), путь к сертификату для проверки TLS/SSL при работе через локальный прокси По умолчанию: `""`
meraki_inherit_logging_config логический	meraki_inherit_logging_config (логический), наследовать собственный экземпляр средства ведения журнала Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix строка	meraki_log_file_prefix (строка), к имени файла журнала добавляются дата и время По умолчанию: `"meraki_api_"`
meraki_log_path строка	log_path (строка), путь для вывода журнала; если не указан, используется рабочий каталог скрипта По умолчанию: `""`
meraki_maximum_retries целое число	meraki_maximum_retries (целое число), максимальное число повторных попыток при получении ответов 429 или других ошибок на стороне сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time целое число	meraki_nginx_429_retry_wait_time (целое число), время ожидания перед повторной попыткой при ответе Nginx 429 По умолчанию: `60`
meraki_output_log логический	meraki_output_log (логический), создавать файл журнала вывода? Варианты: `false` `true` ← (по умолчанию)
meraki_print_console логический	meraki_print_console (логический), выводить журнал в консоль? Варианты: `false` `true` ← (по умолчанию)
meraki_requests_proxy строка	meraki_requests_proxy (строка), адрес и порт прокси-сервера для HTTPS, если требуется По умолчанию: `""`
meraki_retry_4xx_error логический	meraki_retry_4xx_error (логический), повторять попытку при возникновении других ошибок 4XX (кроме 429)? Варианты: `false` ← (по умолчанию) `true`
meraki_retry_4xx_error_wait_time целое число	meraki_retry_4xx_error_wait_time (целое число), время ожидания перед повторной попыткой при других ошибках 4XX По умолчанию: `60`
meraki_simulate логический	meraki_simulate (логический), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить внесение изменений? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout целое число	meraki_single_request_timeout (целое число), максимальное число секунд для каждого вызова API По умолчанию: `60`
meraki_suppress_logging логический	meraki_suppress_logging (логический), отключить ведение всех журналов? Тогда действуйте на свой страх и риск! Варианты: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages логический	meraki_use_iterator_for_get_pages (логический), методы list* возвращают итератор с каждым объектом вместо полного списка всех элементов Варианты: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit логический	meraki_wait_on_rate_limit (логический), повторять попытку при достижении ограничения частоты запросов (ошибка 429)? Варианты: `false` `true` ← (по умолчанию)
organizationId строка	Параметр пути OrganizationId. Идентификатор организации.
subscriptions список / элементы=словарь	Отдельные подписки для получения.
description строка	Описание подписки.
name строка	Название подписки.
subscriptionId строка	Идентификатор подписки.

Примечания

Примечание

Используемый метод SDK: organizations.Organizations.claim_organization_inventory_orders,
Используемый путь: post /organizations/{organizationId}/inventory/orders/claim,
Не поддерживает check_mode
Плагин выполняется на управляющем узле и не использует плагины подключений Ansible, а вместо этого использует встроенный диспетчер подключений
из Cisco Dashboard API Python(SDK)
Параметры, начинающиеся с dnac_, используются Python SDK Cisco DNAC для установления подключения

См. также

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

Примеры

- name: Create
  cisco.meraki.organizations_inventory_orders_claim:
    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 }}"
    claimId: '12345'
    organizationId: string
    subscriptions:
      - description: Subscription for Wireless Network
        name: My Wireless Subscription
        subscriptionId: SUB1234132

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

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

Ключ	Описание
meraki_response словарь	Словарь или список с ответом, возвращенным Python SDK Cisco Meraki Возвращается: всегда Пример: `{"claimId": "string", "number": "string", "serials": ["string"], "subscriptions": [{"counts": {"seats": {"limit": 0}}, "description": "string", "endDate": "string", "isClaimed": true, "name": "string", "startDate": "string", "subscriptionId": "string"}]}`

Ключ

Описание

meraki_response

словарь

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

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

Пример: {"claimId": "string", "number": "string", "serials": ["string"], "subscriptions": [{"counts": {"seats": {"limit": 0}}, "description": "string", "endDate": "string", "isClaimed": true, "name": "string", "startDate": "string", "subscriptionId": "string"}]}

Авторы

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_inventory_orders_claim_module.html