Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Для использования в playbook, укажите: cisco.meraki.administered_licensing_subscription_subscriptions_info.

Новое в cisco.meraki 2.18.0

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

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

  • Получить все администрируемые подписки на лицензирование.
  • Вывести список доступных подписок.

Примечание

Этот модуль имеет соответствующий плагин действия.

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

direction

string

direction (строка), направление для постраничной навигации, либо “next” (по умолчанию), либо “prev” страница

Default: "https://api.meraki.com/api/v1"

endDate

string

Параметр запроса EndDate. Фильтрует подписки по конечной дате в формате ISO 8601. Для фильтрации по диапазону дат используйте ‘endDate<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 (целое число), время ожидания повторной попытки при ошибке параллельной обработки пакета действий

Default: 60

meraki_api_key

string / required

meraki_api_key (строка), API ключ, сгенерированный на панели управления; может также быть установлен как переменная среды MERAKI_DASHBOARD_API_KEY

meraki_base_url

string

meraki_base_url (строка), предшествует всем ресурсам конечной точки

Default: "https://api.meraki.com/api/v1"

meraki_be_geo_id

string

meraki_be_geo_id (строка), необязательный идентификатор партнера для отслеживания использования API; может также быть установлен как переменная среды BE_GEO_ID

Default: ""

meraki_caller

string

meraki_caller (строка), необязательный идентификатор для отслеживания использования API; может также быть установлен как переменная среды MERAKI_PYTHON_SDK_CALLER

Default: ""

meraki_certificate_path

string

meraki_certificate_path (строка), путь для проверки сертификата TLS/SSL, если используется локальный прокси-сервер

Default: ""

meraki_inherit_logging_config

boolean

meraki_inherit_logging_config (булево), наследует ваш собственный экземпляр регистратора

Choices:

  • false ← (default)
  • true

meraki_log_file_prefix

string

meraki_log_file_prefix (строка), имя файла журнала, к которому добавляется дата и метка времени

Default: "meraki_api_"

meraki_log_path

string

log_path (строка), путь к выходному журналу; по умолчанию, рабочий каталог скрипта, если не указан

Default: ""

meraki_maximum_retries

integer

meraki_maximum_retries (целое число), повторить до этого количества раз при возникновении ошибок 429 или других ошибок на стороне сервера

Default: 2

meraki_nginx_429_retry_wait_time

integer

meraki_nginx_429_retry_wait_time (целое число), время ожидания повторной попытки Nginx 429

Default: 60

meraki_output_log

boolean

meraki_output_log (булево), создать файл выходного журнала?

Choices:

  • false
  • true ← (default)

meraki_print_console

boolean

meraki_print_console (булево), выводить сообщения журнала в консоль?

Choices:

  • false
  • true ← (default)

meraki_requests_proxy

string

meraki_requests_proxy (строка), прокси-сервер и порт, если необходимо, для HTTPS

Default: ""

meraki_retry_4xx_error

boolean

meraki_retry_4xx_error (булево), повторить попытку при возникновении другой ошибки 4XX (кроме 429)?

Choices:

  • false ← (default)
  • true

meraki_retry_4xx_error_wait_time

integer

meraki_retry_4xx_error_wait_time (целое число), время ожидания повторной попытки при другой ошибке 4XX

Default: 60

meraki_simulate

boolean

meraki_simulate (булево), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения?

Choices:

  • false ← (default)
  • true

meraki_single_request_timeout

integer

meraki_single_request_timeout (целое число), максимальное количество секунд для каждого вызова API

Default: 60

meraki_suppress_logging

boolean

meraki_suppress_logging (boolean), отключение всего ведения журнала? тогда вы предоставлены сами себе!

Choices:

  • false ← (default)
  • true

meraki_use_iterator_for_get_pages

boolean

meraki_use_iterator_for_get_pages (boolean), методы list* будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами

Choices:

  • false ← (default)
  • true

meraki_wait_on_rate_limit

boolean

meraki_wait_on_rate_limit (boolean), повторить попытку, если обнаружена ошибка ограничения скорости 429?

Choices:

  • false
  • true ← (default)

organizationIds

list / elements=string

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

perPage

integer

Параметр запроса PerPage. Количество записей на страницу. Допустимый диапазон - 3-1000. По умолчанию - 1000.

productTypes

list / elements=string

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

startDate

string

Параметр запроса StartDate. Фильтрует подписки по дате начала в формате ISO 8601. Для фильтрации по диапазону дат используйте «startDate<option>=?» в запросе. Допустимые параметры включают lt, gt, lte, gte.

startingAfter

string

Параметр запроса StartingAfter. Маркер, используемый сервером для указания начала страницы. Часто это метка времени или ID, но не ограничивается ими. Этот параметр не должен определяться клиентскими приложениями. Ссылка на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link должна определять его.

statuses

list / elements=string

Параметр запроса Statuses. Список статусов, которые могут иметь возвращаемые подписки.

subscriptionIds

list / elements=string

Параметр запроса SubscriptionIds. Список идентификаторов подписок для извлечения.

total_pages

string / required

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_, используются Cisco Meraki Python SDK для установления соединения

См. также

См. также

Документация Cisco Meraki для 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_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: []
    startDate: string
    endDate: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ

Описание

meraki_response

list / elements=dictionary

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

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

Пример: "[\n  {\n    \"counts\": {\n      \"networks\": 0,\n      \"seats\": {\n        \"assigned\": 0,\n        \"available\": 0,\n        \"limit\": 0\n      }\n    },\n    \"description\": \"string\",\n    \"endDate\": \"string\",\n    \"entitlements\": [\n      {\n        \"seats\": {\n          \"assigned\": 0,\n          \"available\": 0,\n          \"limit\": 0\n        },\n        \"sku\": \"string\"\n      }\n    ],\n    \"name\": \"string\",\n    \"productTypes\": [\n      \"string\"\n    ],\n    \"startDate\": \"string\",\n    \"status\": \"string\",\n    \"subscriptionId\": \"string\",\n    \"webOrderId\": \"string\"\n  }\n]\n"

Авторы

  • Francisco Munoz (@fmunoz)

Ссылки на коллекцию

  • Система отслеживания ошибок
  • Репозиторий (источники)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/meraki/administered_licensing_subscription_subscriptions_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API