cisco.dnac.license_device_license_summary_info (6.13.3) — module

Information module for License Device License Summary

| "added in version" 3.1.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3


Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Get all License Device License Summary.

Show license summary of devices.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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: "{{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

Inputs

    
limit:
    description:
    - Limit query parameter.
    type: int

order:
    description:
    - Order query parameter. Sorting order.
    type: str

headers:
    description: Additional headers.
    type: dict

sort_by:
    description:
    - Sort_by query parameter. Sort result by field.
    type: str

dna_level:
    description:
    - Dna_level query parameter. Device Cisco DNA license level.
    type: str

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

device_type:
    description:
    - Device_type query parameter. Type of device.
    type: str

device_uuid:
    description:
    - Device_uuid query parameter. Id of device.
    type: str

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

page_number:
    description:
    - Page_number query parameter. Page number of response.
    type: int

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

smart_account_id:
    description:
    - Smart_account_id query parameter. Id of smart account.
    type: int

registration_status:
    description:
    - Registration_status query parameter. Smart license registration status of device.
    type: str

virtual_account_name:
    description:
    - Virtual_account_name query parameter. Name of virtual account.
    type: str

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  elements: dict
  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"
  type: list

See also