.. Document meta
:orphan:
.. |antsibull-internal-nbsp| unicode:: 0xA0
:trim:
.. role:: ansible-attribute-support-label
.. role:: ansible-attribute-support-property
.. role:: ansible-attribute-support-full
.. role:: ansible-attribute-support-partial
.. role:: ansible-attribute-support-none
.. role:: ansible-attribute-support-na
.. Anchors
.. _ansible_collections.cisco.dnac.license_device_license_summary_info_module:
.. Anchors: short name for ansible.builtin
.. Anchors: aliases
.. Title
cisco.dnac.license_device_license_summary_info -- Information module for License Device License Summary
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. Collection note
.. note::
This plugin is part of the `cisco.dnac collection <https://galaxy.ansible.com/cisco/dnac>`_ (version 4.1.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 :code:`ansible-galaxy collection list`.
To install it, use: :code:`ansible-galaxy collection install cisco.dnac`.
To use it in a playbook, specify: :code:`cisco.dnac.license_device_license_summary_info`.
.. version_added
.. versionadded:: 3.1.0 of cisco.dnac
.. contents::
:local:
:depth: 1
.. Deprecated
Synopsis
--------
.. Description
- Get all License Device License Summary.
.. note::
This module has a corresponding :ref:`action plugin <action_plugins>`.
.. Aliases
.. Requirements
Requirements
------------
The below requirements are needed on the host that executes this module.
- dnacentersdk >= 2.4.0
- python >= 3.5
.. Options
Parameters
----------
.. raw:: html
<table border=0 cellpadding=0 class="documentation-table">
<tr>
<th colspan="1">Parameter</th>
<th>Choices/<font color="blue">Defaults</font></th>
<th width="100%">Comments</th>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-device_type"></div>
<b>device_type</b>
<a class="ansibleOptionLink" href="#parameter-device_type" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Device_type query parameter. Type of device.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-device_uuid"></div>
<b>device_uuid</b>
<a class="ansibleOptionLink" href="#parameter-device_uuid" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Device_uuid query parameter. Id of device.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-dna_level"></div>
<b>dna_level</b>
<a class="ansibleOptionLink" href="#parameter-dna_level" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Dna_level query parameter. Device Cisco DNA license level.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-dnac_debug"></div>
<b>dnac_debug</b>
<a class="ansibleOptionLink" href="#parameter-dnac_debug" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b> ←</div></li>
<li>yes</li>
</ul>
</td>
<td>
<div>Flag for Cisco DNA Center SDK to enable debugging.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-dnac_host"></div>
<b>dnac_host</b>
<a class="ansibleOptionLink" href="#parameter-dnac_host" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
/ <span style="color: red">required</span> </div>
</td>
<td>
</td>
<td>
<div>The Cisco DNA Center hostname.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-dnac_password"></div>
<b>dnac_password</b>
<a class="ansibleOptionLink" href="#parameter-dnac_password" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>The Cisco DNA Center password to authenticate.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-dnac_port"></div>
<b>dnac_port</b>
<a class="ansibleOptionLink" href="#parameter-dnac_port" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
<b>Default:</b><br/><div style="color: blue">443</div>
</td>
<td>
<div>The Cisco DNA Center port.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-dnac_username"></div>
<b>dnac_username</b>
<a class="ansibleOptionLink" href="#parameter-dnac_username" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
<b>Default:</b><br/><div style="color: blue">"admin"</div>
</td>
<td>
<div>The Cisco DNA Center username to authenticate.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: user</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-dnac_verify"></div>
<b>dnac_verify</b>
<a class="ansibleOptionLink" href="#parameter-dnac_verify" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li>
<li><div style="color: blue"><b>yes</b> ←</div></li>
</ul>
</td>
<td>
<div>Flag to enable or disable SSL certificate verification.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-dnac_version"></div>
<b>dnac_version</b>
<a class="ansibleOptionLink" href="#parameter-dnac_version" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
<b>Default:</b><br/><div style="color: blue">"2.2.3.3"</div>
</td>
<td>
<div>Informs the SDK which version of Cisco DNA Center to use.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-headers"></div>
<b>headers</b>
<a class="ansibleOptionLink" href="#parameter-headers" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">dictionary</span>
</div>
</td>
<td>
</td>
<td>
<div>Additional headers.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-limit"></div>
<b>limit</b>
<a class="ansibleOptionLink" href="#parameter-limit" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">integer</span>
</div>
</td>
<td>
</td>
<td>
<div>Limit query parameter.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-order"></div>
<b>order</b>
<a class="ansibleOptionLink" href="#parameter-order" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Order query parameter. Sorting order.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-page_number"></div>
<b>page_number</b>
<a class="ansibleOptionLink" href="#parameter-page_number" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">integer</span>
</div>
</td>
<td>
</td>
<td>
<div>Page_number query parameter. Page number of response.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-registration_status"></div>
<b>registration_status</b>
<a class="ansibleOptionLink" href="#parameter-registration_status" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Registration_status query parameter. Smart license registration status of device.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-smart_account_id"></div>
<b>smart_account_id</b>
<a class="ansibleOptionLink" href="#parameter-smart_account_id" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">integer</span>
</div>
</td>
<td>
</td>
<td>
<div>Smart_account_id query parameter. Id of smart account.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-sort_by"></div>
<b>sort_by</b>
<a class="ansibleOptionLink" href="#parameter-sort_by" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Sort_by query parameter. Sort result by field.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-validate_response_schema"></div>
<b>validate_response_schema</b>
<a class="ansibleOptionLink" href="#parameter-validate_response_schema" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li>
<li><div style="color: blue"><b>yes</b> ←</div></li>
</ul>
</td>
<td>
<div>Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-virtual_account_name"></div>
<b>virtual_account_name</b>
<a class="ansibleOptionLink" href="#parameter-virtual_account_name" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Virtual_account_name query parameter. Name of virtual account.</div>
</td>
</tr>
</table>
<br/>
.. Attributes
.. Notes
Notes
-----
.. note::
- Supports ``check_mode``
- The 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
.. Seealso
See Also
--------
.. seealso::
`License Device License Summary reference <https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary>`_
Complete reference of the License Device License Summary object model.
.. Examples
Examples
--------
.. code-block:: yaml+jinja
- 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:
custom: value
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
.. Facts
.. Return values
Return Values
-------------
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
.. raw:: html
<table border=0 cellpadding=0 class="documentation-table">
<tr>
<th colspan="1">Key</th>
<th>Returned</th>
<th width="100%">Description</th>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="return-dnac_response"></div>
<b>dnac_response</b>
<a class="ansibleOptionLink" href="#return-dnac_response" title="Permalink to this return value"></a>
<div style="font-size: small">
<span style="color: purple">list</span>
/ <span style="color: purple">elements=dictionary</span> </div>
</td>
<td>always</td>
<td>
<div>A dictionary or list with the response returned by the Cisco DNAC Python SDK</div>
<br/>
<div style="font-size: smaller"><b>Sample:</b></div>
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">[
{
"authorization_status": "string",
"last_updated_time": "string",
"is_performance_allowed": true,
"sle_auth_code": "string",
"throughput_level": "string",
"hsec_status": "string",
"device_uuid": "string",
"site": "string",
"total_access_point_count": 0,
"model": "string",
"is_wireless_capable": true,
"registration_status": "string",
"sle_state": "string",
"performance_license": "string",
"license_mode": "string",
"is_license_expired": true,
"software_version": "string",
"reservation_status": "string",
"is_wireless": true,
"network_license": "string",
"evaluation_license_expiry": "string",
"wireless_capable_network_license": "string",
"device_name": "string",
"device_type": "string",
"dna_level": "string",
"virtual_account_name": "string",
"last_successful_rum_usage_upload_time": "string",
"ip_address": "string",
"wireless_capable_dna_license": "string",
"mac_address": "string",
"customer_tag1": "string",
"customer_tag2": "string",
"customer_tag3": "string",
"customer_tag4": "string",
"smart_account_name": "string"
}
]</div>
</td>
</tr>
</table>
<br/><br/>
.. Status (Presently only deprecated)
.. Authors
Authors
~~~~~~~
- Rafael Campos (@racampos)
.. Parsing errors