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

Install one or more feature licenses

Contributors
PDFs

POST /cluster/licensing/licenses

Installs one or more feature licenses.

Required properties

  • keys - Array containing a list of NLF or 26-character license keys.

  • system license add

Learn more

Parameters

Name Type In Required Description

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

Request Body

Name Type Description

_links

_links

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.
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "keys": [
    "AMEPOSOIKLKGEEEEDGNDEKSJDE"
  ],
  "licenses": [
    {
      "capacity": {
        "maximum_size": 0,
        "used_size": 0
      },
      "compliance": {
        "state": "compliant"
      },
      "expiry_time": "2019-03-02 19:00:00 UTC",
      "owner": "cluster1",
      "serial_number": "123456789",
      "start_time": "2019-02-02 19:00:00 UTC"
    }
  ],
  "name": "NFS",
  "scope": "string",
  "state": "compliant"
}

Response

Status: 201, Created
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"
        }
      },
      "keys": [
        "AMEPOSOIKLKGEEEEDGNDEKSJDE"
      ],
      "licenses": [
        {
          "capacity": {
            "maximum_size": 0,
            "used_size": 0
          },
          "compliance": {
            "state": "compliant"
          },
          "expiry_time": "2019-03-02 19:00:00 UTC",
          "owner": "cluster1",
          "serial_number": "123456789",
          "start_time": "2019-02-02 19:00:00 UTC"
        }
      ],
      "name": "NFS",
      "scope": "string",
      "state": "compliant"
    }
  ]
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

1115117

Generic licensing error

1115122

No cluster serial number found

1115124

No node serial number found

1115130

No license code was provided

1115131

Installation of the license failed

1115132

License already exists on system

1115134

Serial number does not belong to node

1115141

License data is invalid

1115142

License signature is invalid

1115143

Internal error applying the requested license

1115152

License does not apply to the platform

1115154

Unable to retrieve cluster ID

1115155

Invalid cluster ID found

1115159

License is not in an acceptable format

1115164

Minimum ONTAP version requirements not met

1115179

FlexCache is not supported on this system

1115180

FlexCache is not supported on cloud systems

1115407

Capacity pool licenses cannot be installed directly

66846818

Failed to interpret FlexCache license information

66846821

FlexCache is not supported on cloud systems

66846822

Invalid FlexCache capacity information provided

655294464

Failed to extract license contents

655294465

License key is invalid

655294466

Serial number is invalid

655294467

Version number is invalid

655294468

Expired license

655294469

License does not apply to the platform

655294470

License does not apply to the product
Name Type Description

errors

array[error]
Example error 
{
  "errors": [
    {
      "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

self

href

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.

owner

string

Cluster, node or license manager that owns the license.

serial_number

string

Serial number of the license.

start_time

string

Date and time when the license starts.

license_package

Name Type Description

_links

_links

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.

_links

Name Type Description

next

href

self

href

records

Name Type Description

_links

_links

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.