NSX-T Data Center REST API

Add a new license key (Deprecated)

This will add a license key to the system.
The API supports adding only one license key for each license edition
type - Standard, Advanced or Enterprise. If a new license key is tried
to add for an edition for which the license key already exists,
then this API will return an error.
Deprecated: Deprecated. For all licensing related workflows, please refer to the common Licensing documentation in the VMware Cloud Foundation for this version.

Request:

Method:

POST

URI Path(s):

/api/v1/licenses

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

License+

License (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
capacity_type	license metric License metrics specifying the capacity type of license key. Types are: - VM - CPU - USER(Concurrent User) - CORE - HOST	string	Readonly Enum: VM, CPU, USER, CORE, HOST
description	license edition	string	Readonly
expiry	date that license expires For the DLF license keys, the value is expiry time of license. For the VCF licenses, the value is always '-1'. The expiry time of the VCF license can be checked in the VCF Operations Console.	EpochMsTimestamp	Readonly
features	semicolon delimited feature list	string	Readonly
is_editable	whether the license can be edit	boolean	Readonly
is_eval	true for evalution license	boolean	Readonly
is_expired	whether the license has expired	boolean	Readonly
is_mh	multi-hypervisor support	boolean	Readonly
license_key	license key	secure_string	Required
product_name	product name	string	Readonly
product_version	product version	string	Readonly
quantity	license capacity; 0 for unlimited The license capacity. For the DLF license keys, 0 means unlimited capacity. For the VCF licenses, 0 means there is no capacity.	integer	Readonly
vc_names	vCenter names VCF licenses are from vCenters. This property is to record which vCenters this license comes from. If this license is NSX license and imported from NSX, this property is empty.	array of string	Readonly

Example Request:

POST https://<nsx-mgr>/api/v1/licenses { "license_key": "11111-22222-33333-44444-55555" }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

License+

License (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
capacity_type	license metric License metrics specifying the capacity type of license key. Types are: - VM - CPU - USER(Concurrent User) - CORE - HOST	string	Readonly Enum: VM, CPU, USER, CORE, HOST
description	license edition	string	Readonly
expiry	date that license expires For the DLF license keys, the value is expiry time of license. For the VCF licenses, the value is always '-1'. The expiry time of the VCF license can be checked in the VCF Operations Console.	EpochMsTimestamp	Readonly
features	semicolon delimited feature list	string	Readonly
is_editable	whether the license can be edit	boolean	Readonly
is_eval	true for evalution license	boolean	Readonly
is_expired	whether the license has expired	boolean	Readonly
is_mh	multi-hypervisor support	boolean	Readonly
license_key	license key	secure_string	Required
product_name	product name	string	Readonly
product_version	product version	string	Readonly
quantity	license capacity; 0 for unlimited The license capacity. For the DLF license keys, 0 means unlimited capacity. For the VCF licenses, 0 means there is no capacity.	integer	Readonly
vc_names	vCenter names VCF licenses are from vCenters. This property is to record which vCenters this license comes from. If this license is NSX license and imported from NSX, this property is empty.	array of string	Readonly

Example Response:

{ "capacity_type": "VM" "quantity": 1, "is_eval": false, "is_editable" : false, "description" : "NSX for vSphere - Standard" "expiry": 1458688231359, "license_key": "11111-22222-33333-44444-55555" }

Required Permissions:

crud

Feature:

system_configuration_license

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable