Skip to main content
A newer release of this product is available.

Retrieve license packages

Contributors
PDFs

GET /cluster/licensing/licenses

Introduced In: 9.6

Retrieves a collection of license packages.

Note By default, the GET method only returns licensed packages. You must provide the following query "state=unlicensed" to retrieve unlicensed packages. Note: Starting with ONTAP 9.11.1, the GET method no longer returns the Base license record.

  • system license show-status

  • system license show

Parameters

Name Type In Required Description

description

string

query

False

Filter by description

  • Introduced in: 9.11

entitlement.risk

string

query

False

Filter by entitlement.risk

  • Introduced in: 9.11

entitlement.action

string

query

False

Filter by entitlement.action

  • Introduced in: 9.11

state

string

query

False

Filter by state

scope

string

query

False

Filter by scope

name

string

query

False

Filter by name

licenses.active

boolean

query

False

Filter by licenses.active

licenses.evaluation

boolean

query

False

Filter by licenses.evaluation

licenses.capacity.used_size

integer

query

False

Filter by licenses.capacity.used_size

licenses.capacity.maximum_size

integer

query

False

Filter by licenses.capacity.maximum_size

licenses.serial_number

string

query

False

Filter by licenses.serial_number

licenses.installed_license

string

query

False

Filter by licenses.installed_license

  • Introduced in: 9.9

licenses.compliance.state

string

query

False

Filter by licenses.compliance.state

licenses.start_time

string

query

False

Filter by licenses.start_time

licenses.shutdown_imminent

boolean

query

False

Filter by licenses.shutdown_imminent

  • Introduced in: 9.11

licenses.host_id

string

query

False

Filter by licenses.host_id

  • Introduced in: 9.9

licenses.owner

string

query

False

Filter by licenses.owner

licenses.expiry_time

string

query

False

Filter by licenses.expiry_time

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[records]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "description": "NFS License",
    "entitlement": {
      "action": "acquire_license",
      "risk": "high"
    },
    "keys": {
    },
    "licenses": {
      "capacity": {
        "maximum_size": 0,
        "used_size": 0
      },
      "compliance": {
        "state": "compliant"
      },
      "expiry_time": "2019-03-02T19:00:00Z",
      "host_id": "456-44-1234",
      "installed_license": "Core Bundle",
      "owner": "cluster1",
      "serial_number": "123456789",
      "start_time": "2019-02-02T19:00:00Z"
    },
    "name": "NFS",
    "scope": "not_available",
    "state": "compliant"
  }
}

Error

Status: Default, Error
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": {
      "code": "string",
      "message": "string"
    },
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

next

href

self

href

_links

Name Type Description

self

href

entitlement

Name Type Description

action

string

Entitlement action to be taken to mitigate the risk

risk

string

Entitlement risk of the package

capacity

Name Type Description

maximum_size

integer

Licensed capacity size (in bytes) that can be used.

used_size

integer

Capacity that is currently used (in bytes).

compliance

Name Type Description

state

string

Compliance state of the license.

licenses

Name Type Description

active

boolean

A flag indicating whether the license is currently being enforced.

capacity

capacity

compliance

compliance

evaluation

boolean

A flag indicating whether the license is in evaluation mode.

expiry_time

string

Date and time when the license expires.

host_id

string

A string that associates the license with a node or cluster.

installed_license

string

Name of license that enabled the feature.

owner

string

Cluster, node or license manager that owns the license.

serial_number

string

Serial number of the license.

shutdown_imminent

boolean

A flag indicating whether the Cloud ONTAP system is going to shutdown as the Cloud platform license has already expired.

  • readOnly: 1

  • Introduced in: 9.11

start_time

string

Date and time when the license starts.

records

Name Type Description

_links

_links

description

string

License description

entitlement

entitlement

keys

array[string]

licenses

array[licenses]

Installed licenses of the package.

name

string

Name of the license.

scope

string

Scope of the license.

state

string

Summary state of package based on all installed licenses.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.