Модуль cisco.dnac.license_usage_details_info — Модуль информации о деталях использования лицензии

Примечание

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

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

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

Для использования в плейбуке укажите: cisco.dnac.license_usage_details_info.

Впервые в cisco.dnac 3.1.0

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

Описание

Получение деталей использования лицензии по имени.
Получение количества приобретённых и используемых лицензий Cisco DNA и Network.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
device_type строка	Параметр запроса device_type. Тип устройства, например, маршрутизатор, коммутатор, беспроводная сеть или ISE.
dnac_debug логическое	Флаг для Cisco DNA Center SDK для включения отладки. Варианты: `false` ← (по умолчанию) `true`
dnac_host строка / обязательно	Имя хоста Cisco DNA Center.
dnac_password строка	Пароль Cisco DNA Center для аутентификации.
dnac_port целое число	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username алиасы: user строка	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify логическое	Флаг для включения или отключения проверки сертификата SSL. Варианты: `false` `true` ← (по умолчанию)
dnac_version строка	Уведомляет SDK о версии Cisco DNA Center, которую нужно использовать. По умолчанию: `"2.3.7.6"`
headers словарь	Дополнительные заголовки.
smart_account_id строка	Параметр пути smart_account_id. Идентификатор интеллектуального аккаунта.
validate_response_schema логическое	Флаг для Cisco DNA Center SDK для включения проверки запрашиваемых тел на соответствие JSON-схеме. Варианты: `false` `true` ← (по умолчанию)
virtual_account_name строка	Параметр пути virtual_account_name. Название виртуального аккаунта. Ввод «Все» предоставит сведения о лицензии для всех виртуальных аккаунтов.

Примечания

Примечание

Используемые методы SDK — licenses.Licenses.license_usage_details,
Используемые пути — get /dna/intent/api/v1/licenses/usage/smartAccount/{smart_account_id}/virtualAccount/{virtual_account_name},
Поддерживает check_mode
Плагин работает на контрольном узле и не использует плагины подключения Ansible, а вместо этого встроенный менеджер подключения из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

Документация Cisco DNA Center по Licenses LicenseUsageDetails: Полная справка по API LicenseUsageDetails.

Примеры

- name: Get License Usage Details by name
  cisco.dnac.license_usage_details_info:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    headers: "{{my_headers | from_json}}"
    device_type: string
    smart_account_id: string
    virtual_account_name: string
  register: result

Значения возврата

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

Ключ	Описание
dnac_response словарь	Словарь или список с ответом, возвращённым Cisco DNAC Python SDK Возвращается: всегда Пример: {"purchased_dna_license": {"license_count_by_type": [{"license_count": 0, "license_type": "string"}], "total_license_count": 0}, "purchased_ise_license": {"license_count_by_type": [{"license_count": 0, "license_type": "string"}], "total_license_count": 0}, "purchased_network_license": {"license_count_by_type": [{"license_count": 0, "license_type": "string"}], "total_license_count": 0}, "used_dna_license": {"license_count_by_type": [{"license_count": 0, "license_type": "string"}], "total_license_count": 0}, "used_ise_license": {"license_count_by_type": [{"license_count": 0, "license_type": "string"}], "total_license_count": 0}, "used_network_license": {"license_count_by_type": [{"license_count": 0, "license_type": "string"}], "total_license_count": 0}}

Ключ

Описание

dnac_response

словарь

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

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

Пример: {"purchased_dna_license": {"license_count_by_type": [{"license_count": 0, "license_type": "string"}], "total_license_count": 0}, "purchased_ise_license": {"license_count_by_type": [{"license_count": 0, "license_type": "string"}], "total_license_count": 0}, "purchased_network_license": {"license_count_by_type": [{"license_count": 0, "license_type": "string"}], "total_license_count": 0}, "used_dna_license": {"license_count_by_type": [{"license_count": 0, "license_type": "string"}], "total_license_count": 0}, "used_ise_license": {"license_count_by_type": [{"license_count": 0, "license_type": "string"}], "total_license_count": 0}, "used_network_license": {"license_count_by_type": [{"license_count": 0, "license_type": "string"}], "total_license_count": 0}}

Авторы

Rafael Campos (@racampos)

Ссылки на сборку

© 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/dnac/license_usage_details_info_module.html