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

Примечание

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

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

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

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

Добавлен в cisco.dnac 3.1.0

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

Обзор

Получение всех сводок лицензий устройств.
Отображение сводки лицензий устройств.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
device_type строка	Параметр запроса device_type. Тип устройства. Допустимые значения: Routers, Switches и Hubs, Wireless Controller.
device_uuid строка	Параметр запроса device_uuid. Идентификатор устройства.
dna_level строка	Параметр запроса dna_level. Уровень лицензии Cisco DNA для устройства. Допустимые значения: Advantage, Essentials.
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 словарь	Дополнительные заголовки.
limit вещественное число	Параметр запроса limit.
order строка	Параметр запроса order. Порядок сортировки.
page_number вещественное число	Параметр запроса page_number. Номер страницы ответа.
registration_status строка	Параметр запроса registration_status. Статус регистрации интеллектуальной лицензии устройства. Допустимые значения: Unknown, NA, Unregistered, Registered, Registration_expired, Reservation_in_progress, Registered_slr, Registered_plr, Registered_satellite.
smart_account_id строка	Параметр запроса smart_account_id. Идентификатор интеллектуальной учетной записи.
sort_by строка	Параметр запроса sort_by. Сортировать результаты по полю.
validate_response_schema булево	Флаг для включения проверки ответов Cisco DNA Center SDK на соответствие JSON-схеме. Варианты: `false` `true` ← (по умолчанию)
virtual_account_name строка	Параметр запроса virtual_account_name. Имя виртуальной учетной записи.

Примечания

Примечание

Используемые методы SDK: licenses.Licenses.device_license_summary,
Используемые пути: get /dna/intent/api/v1/licenses/device/summary,
Поддерживает check_mode
Плагин выполняется на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключения Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

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

Примеры

- name: Get all License Device License Summary
  cisco.dnac.license_device_license_summary_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}}"
    page_number: 0
    order: string
    sort_by: string
    dna_level: string
    device_type: string
    limit: 0
    registration_status: string
    virtual_account_name: string
    smart_account_id: string
    device_uuid: string
  register: result

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

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

Ключ	Описание
dnac_response словарь	Словарь или список с ответом, возвращаемым Cisco DNAC Python SDK Возвращается: всегда Пример: {"response": [{"authorization_status": "string", "customer_tag1": "string", "customer_tag2": "string", "customer_tag3": "string", "customer_tag4": "string", "device_name": "string", "device_type": "string", "device_uuid": "string", "dna_level": "string", "evaluation_license_expiry": "string", "hsec_status": "string", "ip_address": "string", "is_license_expired": true, "is_performance_allowed": true, "is_wireless": true, "is_wireless_capable": true, "last_successful_rum_usage_upload_time": "string", "last_updated_time": "string", "license_mode": "string", "mac_address": "string", "model": "string", "network_license": "string", "performance_license": "string", "registration_status": "string", "reservation_status": "string", "site": "string", "sle_auth_code": "string", "sle_state": "string", "smart_account_name": "string", "software_version": "string", "throughput_level": "string", "total_access_point_count": 0, "virtual_account_name": "string", "wireless_capable_dna_license": "string", "wireless_capable_network_license": "string"}], "version": "string"}

Ключ

Описание

dnac_response

словарь

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

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

Пример: {"response": [{"authorization_status": "string", "customer_tag1": "string", "customer_tag2": "string", "customer_tag3": "string", "customer_tag4": "string", "device_name": "string", "device_type": "string", "device_uuid": "string", "dna_level": "string", "evaluation_license_expiry": "string", "hsec_status": "string", "ip_address": "string", "is_license_expired": true, "is_performance_allowed": true, "is_wireless": true, "is_wireless_capable": true, "last_successful_rum_usage_upload_time": "string", "last_updated_time": "string", "license_mode": "string", "mac_address": "string", "model": "string", "network_license": "string", "performance_license": "string", "registration_status": "string", "reservation_status": "string", "site": "string", "sle_auth_code": "string", "sle_state": "string", "smart_account_name": "string", "software_version": "string", "throughput_level": "string", "total_access_point_count": 0, "virtual_account_name": "string", "wireless_capable_dna_license": "string", "wireless_capable_network_license": "string"}], "version": "string"}

Авторы

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