cisco.catalystcenter.license_usage_details_info module -- Information module for License Usage Details

Note

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

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

New in cisco.catalystcenter 3.1.0

Synopsis

  • Get License Usage Details by name.

  • Get count of purchased and in use Cisco DNA and Network licenses.

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 3.1.3.0.0

  • python >= 3.5

Parameters

Parameter

Comments

catc_api_port

integer

The Cisco Catalyst Center port.

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

catc_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catc_host

string / required

The Cisco Catalyst Center hostname.

catc_password

string

The Cisco Catalyst Center password to authenticate.

catc_username

string

The Cisco Catalyst Center username to authenticate.

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

catc_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catc_version

string

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

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

device_type

string

Device_type query parameter. Type of device like router, switch, wireless or ise.

headers

dictionary

Additional headers.

smart_account_id

string

Smart_account_id path parameter. Id of smart account.

validate_response_schema

boolean

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

Choices:

virtual_account_name

string

Virtual_account_name path parameter. Name of virtual account. Putting "All" will give license term detail for all virtual accounts.

Notes

Note

  • SDK Method used are licenses.Licenses.license_usage_details,

  • Paths used are get /dna/intent/api/v1/licenses/usage/smartAccount/{smart_account_id}/virtualAccount/{virtual_account_name},

  • 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

See Also

See also

Cisco DNA Center documentation for Licenses LicenseUsageDetails

Complete reference of the LicenseUsageDetails API.

Examples

---
- name: Get License Usage Details by name
  cisco.catalystcenter.license_usage_details_info:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_debug}}"
    headers: "{{my_headers | from_json}}"
    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

Description

dnac_response

dictionary

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

Returned: always

Sample: :ansible-rv-sample-value:`{"purchased\_dna\_license": {"license\_count\_by\_type": [{"license\_count": 0, "license\_type": "string"}], "total\_license\_count": 0}, "purchased\_network\_license": {"license\_count\_by\_type": [{"license\_count": 0, "license\_type": "string"}], "total\_license\_count": 0}, "used\_dna\_license": {"license\_count\_by\_type": [{"license\_count": 0, "license\_type": "string"}], "total\_license\_count": 0}, "used\_network\_license": {"license\_count\_by\_type": [{"license\_count": 0, "license\_type": "string"}], "total\_license\_count": 0}}`

Authors

  • Rafael Campos (@racampos)