cisco.meraki.administered_licensing_subscription_subscriptions_info module – Информационный модуль для подписок на администрируемое лицензирование

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: cisco.meraki.administered_licensing_subscription_subscriptions_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"`
endDate string	Информационный модуль для получения сведений о подписках на администрируемое лицензирование. Параметр запроса EndDate. Фильтрация подписок по дате окончания в формате ISO 8601. Чтобы задать диапазон дат, используйте в запросе «endDate<option>=?». Допустимые значения option: lt, gt, lte, gte.
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` ← (по умолчанию)
name string	Информационный модуль для получения сведений о подписках на администрируемое лицензирование. Параметр запроса Name. Поиск по имени подписки.
organizationIds list / элементы=string	Информационный модуль для получения сведений о подписках на администрируемое лицензирование. Параметр запроса OrganizationIds. Организации, для которых нужно получить связанные подписки.
perPage integer	Информационный модуль для получения сведений о подписках на администрируемое лицензирование. Параметр запроса PerPage. Количество возвращаемых записей на странице. Допустимый диапазон: от 3 до 1000. Значение по умолчанию — 1000.
productTypes list / элементы=string	Информационный модуль для получения сведений о подписках на администрируемое лицензирование. Параметр запроса ProductTypes. Список типов продуктов, права на которые должны быть у возвращаемых подписок.
skus list / элементы=string	Информационный модуль для получения сведений о подписках на администрируемое лицензирование. Параметр запроса Skus. Список SKU, права на которые должны быть у возвращаемых подписок.
startDate string	Информационный модуль для получения сведений о подписках на администрируемое лицензирование. Параметр запроса StartDate. Фильтрация подписок по дате начала в формате ISO 8601. Чтобы задать диапазон дат, используйте в запросе «startDate<option>=?». Допустимые значения option: lt, gt, lte, gte.
startingAfter string	Информационный модуль для получения сведений о подписках на администрируемое лицензирование. Параметр запроса StartingAfter. Токен, с помощью которого сервер обозначает начало страницы. Часто это временная метка или идентификатор, но токен не ограничивается этими значениями. Клиентские приложения не должны задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
statuses list / элементы=string	Информационный модуль для получения сведений о подписках на администрируемое лицензирование. Параметр запроса Statuses. Список статусов, которые могут иметь возвращаемые подписки.
subscriptionIds list / элементы=string	Информационный модуль для получения сведений о подписках на администрируемое лицензирование. Параметр запроса SubscriptionIds. Список идентификаторов подписок для получения.
total_pages string / обязательный	total_pages(int), используйте вместе с perPage, чтобы получить до total_pages*perPage результатов; -1 означает все страницы

Примечания

Примечание

Используемый метод SDK: licensing.Licensing.get_administered_licensing_subscription_subscriptions,
Используемый путь: get /administered/licensing/subscription/subscriptions,
Поддерживает check_mode
Плагин выполняется на управляющем узле и не использует плагины подключений Ansible; вместо этого он использует встроенный менеджер подключений Cisco Meraki SDK
Параметры с префиксом meraki_ используются Python SDK Cisco Meraki для установки соединения

См. также

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

Примеры

- name: Get all administered _licensing _subscription _subscriptions
  cisco.meraki.administered_licensing_subscription_subscriptions_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
    subscriptionIds: []
    organizationIds: []
    statuses: []
    productTypes: []
    skus: []
    name: string
    startDate: string
    endDate: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response list / элементы=dictionary	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: "[\n {\n \"subscriptionId\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"status\": \"string\",\n \"startDate\": \"string\",\n \"endDate\": \"string\",\n \"lastUpdatedAt\": \"string\",\n \"webOrderId\": \"string\",\n \"type\": \"string\",\n \"smartAccount\": {\n \"status\": \"string\",\n \"account\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"domain\": \"string\"\n }\n },\n \"renewalRequested\": true,\n \"productTypes\": [\n \"string\"\n ],\n \"entitlements\": [\n {\n \"sku\": \"string\",\n \"seats\": {\n \"assigned\": 0,\n \"available\": 0,\n \"limit\": 0\n }\n }\n ],\n \"counts\": {\n \"seats\": {\n \"assigned\": 0,\n \"available\": 0,\n \"limit\": 0\n },\n \"networks\": 0,\n \"organizations\": 0\n },\n \"enterpriseAgreement\": {\n \"suites\": [\n \"string\"\n ]\n }\n }\n]\n"

Ключ

Описание

meraki_response

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

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

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

Пример: "[\n {\n \"subscriptionId\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"status\": \"string\",\n \"startDate\": \"string\",\n \"endDate\": \"string\",\n \"lastUpdatedAt\": \"string\",\n \"webOrderId\": \"string\",\n \"type\": \"string\",\n \"smartAccount\": {\n \"status\": \"string\",\n \"account\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"domain\": \"string\"\n }\n },\n \"renewalRequested\": true,\n \"productTypes\": [\n \"string\"\n ],\n \"entitlements\": [\n {\n \"sku\": \"string\",\n \"seats\": {\n \"assigned\": 0,\n \"available\": 0,\n \"limit\": 0\n }\n }\n ],\n \"counts\": {\n \"seats\": {\n \"assigned\": 0,\n \"available\": 0,\n \"limit\": 0\n },\n \"networks\": 0,\n \"organizations\": 0\n },\n \"enterpriseAgreement\": {\n \"suites\": [\n \"string\"\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/administered_licensing_subscription_subscriptions_info_module.html