cisco.meraki.administered_licensing_subscription_subscriptions_compliance_statuses_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_compliance_statuses_info.

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

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

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

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

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
headers словарь	Дополнительные заголовки.
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` ← (по умолчанию)
organizationIds список / элементы=строка	Информационный модуль для получения сведений о соответствии подписок на лицензирование, администрируемых системой. Параметр запроса OrganizationIds. Организации, для которых необходимо получить сведения о соответствии подписок.
subscriptionIds список / элементы=строка	Информационный модуль для получения сведений о соответствии подписок на лицензирование, администрируемых системой. Параметр запроса SubscriptionIds. Идентификаторы подписок.

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all administered _licensing _subscription _subscriptions _compliance _statuses
  cisco.meraki.administered_licensing_subscription_subscriptions_compliance_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 }}"
    organizationIds: []
    subscriptionIds: []
  register: result

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

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

Ключ	Описание
meraki_response список / элементы=словарь	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: "[\n {\n \"subscription\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"status\": \"string\"\n },\n \"violations\": {\n \"byProductClass\": [\n {\n \"productClass\": \"string\",\n \"gracePeriodEndsAt\": \"string\",\n \"missing\": {\n \"entitlements\": [\n {\n \"sku\": \"string\",\n \"quantity\": 0\n }\n ]\n }\n }\n ]\n }\n }\n]\n"

Ключ

Описание

meraki_response

список / элементы=словарь

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

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

Пример: "[\n {\n \"subscription\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"status\": \"string\"\n },\n \"violations\": {\n \"byProductClass\": [\n {\n \"productClass\": \"string\",\n \"gracePeriodEndsAt\": \"string\",\n \"missing\": {\n \"entitlements\": [\n {\n \"sku\": \"string\",\n \"quantity\": 0\n }\n ]\n }\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/administered_licensing_subscription_subscriptions_compliance_statuses_info_module.html