cisco.dnac.license_device_license_summary_info module – Information module for License Device License Summary
Note
This module is part of the cisco.dnac collection (version 6.22.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install cisco.dnac.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.dnac.license_device_license_summary_info.
New in cisco.dnac 3.1.0
Synopsis
Get all License Device License Summary.
Show license summary of devices.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.7.2
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
Device_type query parameter. Type of device. The valid values are Routers, Switches and Hubs, Wireless Controller. |
|
Device_uuid query parameter. Id of device. |
|
Dna_level query parameter. Device Cisco DNA license level. The valid values are Advantage, Essentials. |
|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
Additional headers. |
|
Limit query parameter. |
|
Order query parameter. Sorting order. |
|
Page_number query parameter. Page number of response. |
|
Registration_status query parameter. Smart license registration status of device. The valid values are Unknown, NA, Unregistered, Registered, Registration_expired, Reservation_in_progress, Registered_slr, Registered_plr, Registered_satellite. |
|
Smart_account_id query parameter. Id of smart account. |
|
Sort_by query parameter. Sort result by field. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
|
Virtual_account_name query parameter. Name of virtual account. |
Notes
Note
SDK Method used are licenses.Licenses.device_license_summary,
Paths used are get /dna/intent/api/v1/licenses/device/summary,
Supports
check_modeThe plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK
The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection
See Also
See also
- Cisco DNA Center documentation for Licenses DeviceLicenseSummary
Complete reference of the DeviceLicenseSummary API.
Examples
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |