W3cubDocs

/Ansible

cisco.dnac.license_device_license_summary_info module – Information module for License Device License Summary Info

Note

This module is part of the cisco.dnac collection (version 6.31.3).

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

  • 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.

  • dnacentersdk >= 2.4.9
  • python >= 3.5

Parameters

Parameter

Comments

device_type

string

Device_type query parameter. Type of device.

device_uuid

string

Device_uuid query parameter. Id of device.

dna_level

string

Dna_level query parameter. Device Cisco DNA license level.

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • false ← (default)
  • true

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: "admin"

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • false
  • true ← (default)

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: "2.3.7.6"

headers

dictionary

Additional headers.

limit

float

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

string

Order query parameter. Sorting order.

page_number

float

Page_number query parameter. Page number of response.

registration_status

string

Registration_status query parameter. Smart license registration status of device.

smart_account_id

float

Smart_account_id query parameter. Id of smart account.

sort_by

string

Sort_by query parameter. Sort result by field.

validate_response_schema

boolean

Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

  • false
  • true ← (default)

virtual_account_name

string

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_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

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.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: 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

dnac_response

list / elements=dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

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

Authors

  • Rafael Campos (@racampos)

© 2012–2018 Michael DeHaan
© 2018–2025 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