cisco.dnac.license_usage_details_info – Information module for License Usage Details

Note

This plugin is part of the cisco.dnac collection (version 3.2.0).

To install it use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.license_usage_details_info.

New in version 3.1.0: of cisco.dnac

Synopsis

  • Get License Usage Details by name.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • dnacentersdk >= 2.3.1

  • python >= 3.5

Parameters

Parameter Choices/Defaults Comments
device_type
string
Device_type query parameter. Type of device like router, switch, wireless or ise.
dnac_debug
boolean
    Choices:
  • no ←
  • yes
Flag for Cisco DNA Center SDK to enable debugging.
dnac_host
string / required
The Cisco DNA Center hostname.
dnac_password
string
The Cisco DNA Center password to authenticate.
dnac_port
string
Default:
443
The Cisco DNA Center port.
dnac_username
string
Default:
"admin"
The Cisco DNA Center username to authenticate.

aliases: user
dnac_verify
boolean
    Choices:
  • no
  • yes ←
Flag to enable or disable SSL certificate verification.
dnac_version
string
Default:
"2.2.2.3"
Informs the SDK which version of Cisco DNA Center to use.
headers
dictionary
Additional headers.
smart_account_id
string
Smart_account_id path parameter. Id of smart account.
validate_response_schema
boolean
    Choices:
  • no
  • yes ←
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.
virtual_account_name
string
Virtual_account_name path parameter. Name of virtual account. Putting "All" will give license usage detail for all virtual accounts.

Notes

Note

  • Supports check_mode

See Also

See also

License Usage Details reference

Complete reference of the License Usage Details object model.

Examples

- name: Get License Usage Details by name
  cisco.dnac.license_usage_details_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
    device_type: string
    smart_account_id: string
    virtual_account_name: string
  register: result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
dnac_response
dictionary
always
A dictionary or list with the response returned by the Cisco DNAC Python SDK

Sample:
{ "purchased_dna_license": { "total_license_count": 0, "license_count_by_type": [ { "license_type": "string", "license_count": 0 } ] }, "purchased_network_license": { "total_license_count": 0, "license_count_by_type": [ { "license_type": "string", "license_count": 0 } ] }, "used_dna_license": { "total_license_count": 0, "license_count_by_type": [ { "license_type": "string", "license_count": 0 } ] }, "used_network_license": { "total_license_count": 0, "license_count_by_type": [ { "license_type": "string", "license_count": 0 } ] } }


Authors

  • Rafael Campos (@racampos)