cisco.catalystcenter.license_usage_info module -- Information module for License Usage

Note

This module is part of the cisco.catalystcenter collection (version 2.11.0).

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

New in cisco.catalystcenter 2.11.0

Synopsis

  • Get all License Usage. - > Retrieves the count of purchased, used, and available licenses Cisco DNA, Network, and CNS licenses for a smart account/virtual account in CSSM. Additionally, it provides information on the number of licenses consumed by devices managed through Cisco Catalyst Center.

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 3.2.3.0.0

  • python >= 3.12

Parameters

Parameter

Comments

catalystcenter_debug

aliases: dnac_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

aliases: dnac_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

aliases: dnac_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

aliases: dnac_port, catalystcenter_api_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catalystcenter_username

aliases: dnac_username, user

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catalystcenter_verify

aliases: dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

aliases: dnac_version

string

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

Default: :ansible-option-default:`"3.1.6.0"`

headers

dictionary

Additional headers.

limit

integer

Limit query parameter. The number of records to show for this page.

offset

integer

Offset query parameter. The first record to show for this page; the first record is numbered 1.

productFamily

string

ProductFamily query parameter. Family of the product | Family | Description | |--------------|------------------------------------------| | `SWITCH` | Switch product family | | `ROUTER` | Router product family | | `UNIFIED_AP` | Unified Access Point product family | | `ISE` | ISE product family |.

smartAccountId

string

SmartAccountId query parameter. Id of the smart account. Use `GET /dna/intent/api/v1/licenses/smartAccounts` intent API to find the smart account Id.

validate_response_schema

boolean

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

Choices:

virtualAccountId

string

VirtualAccountId query parameter. Id of the virtual account. Use `GET /dna/intent/api/v1/licenses/smartAccount/${id}/virtualAccounts` intent API to find the virtual account Id.

Notes

Note

  • SDK Method used are licenses.Licenses.api_to_obtain_license_counts_grouped_by_product_family_and_license_type,

  • Paths used are get /dna/intent/api/v1/licenseUsage,

  • Supports check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins,

  • but instead uses the embedded connection manager from Cisco CATALYST SDK

  • Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)

See Also

See also

Cisco Catalyst Center documentation for Licenses APIToObtainLicenseCounts_GroupedByProductFamilyAndLicenseType

Complete reference of the APIToObtainLicenseCounts_GroupedByProductFamilyAndLicenseType API.

Examples

---
- name: Get all License Usage
  cisco.catalystcenter.license_usage_info:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    headers: "{{my_headers | from_json}}"
    smartAccountId: 1034567
    virtualAccountId: 1267
    productFamily: SWITCH
    limit: 0
    offset: 1
  register: result

Return Values

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

Key

Description

catalystcenter_response

dictionary

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

Returned: always

Sample: :ansible-rv-sample-value:`{"response": [{"licenseCountsSummary": [{"licenses": [{"counts": {"available": 0, "purchased": 0, "used": 0, "usedByManagedNetworkDevices": 0}, "type": "string"}], "productFamily": "string"}], "smartAccountId": "string", "virtualAccountId": "string"}], "version": "string"}`

Authors

  • Bryan Vargas (@bvargasre)