cisco.catalystcenter.license_device_license_summary_info module -- Information module for License Device License Summary Info
Note
This module is part of the cisco.catalystcenter collection (version 2.1.4).
To install it, use: ansible-galaxy collection install cisco.catalystcenter.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.catalystcenter.license_device_license_summary_info.
New in cisco.catalystcenter 3.1.0
Synopsis
This module represents an alias of the module license_device_license_summary_v1_info
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
catalystcentersdk >= 2.3.7.9
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
The Cisco CATALYST Center port. Default: :ansible-option-default:`443` |
|
Flag for Cisco CATALYST Center SDK to enable debugging. Choices: |
|
The Cisco CATALYST Center hostname. |
|
The Cisco CATALYST Center password to authenticate. |
|
The Cisco CATALYST Center username to authenticate. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Cisco CATALYST Center to use. Default: :ansible-option-default:`"2.3.7.6"` |
|
Device_type query parameter. Type of device. |
|
Device_uuid query parameter. Id of device. |
|
Dna_level query parameter. Device Cisco DNA license level. |
|
Additional headers. |
|
Limit query parameter. Specifies the maximum number of device license summaries to return per page. Must be an integer between 1 and 500, inclusive. |
|
Order query parameter. Sorting order. |
|
Page_number query parameter. Page number of response. |
|
Registration_status query parameter. Smart license registration status of device. |
|
Smart_account_id query parameter. Id of smart account. |
|
Sort_by query parameter. Sort result by field. |
|
Flag for Cisco CATALYST 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_v1,
Paths used are get /dna/intent/api/v1/licenses/device/summary,
It should be noted that this module is an alias of license_device_license_summary_v1_info
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 CATALYST SDK
The parameters starting with catalystCenter_ are used by the Cisco CATALYST Python SDK to establish the connection
See Also
See also
- Cisco DNA Center documentation for Licenses DeviceLicenseSummaryV1
Complete reference of the DeviceLicenseSummaryV1 API.
Examples
- name: Get all License Device License Summary Info
cisco.catalystcenter.license_device_license_summary_info:
_host: "{{ _host }}"
_username: "{{ _username }}"
_password: "{{ _password }}"
_verify: "{{ _verify }}"
_api_port: "{{ _api_port }}"
_version: "{{ _version }}"
_debug: "{{ _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: 0
device_uuid: string
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|