NSX-T Data Center REST API

License (type)

{
  "additionalProperties": false,
  "description": "license properties",
  "extends": {
    "$ref": "Resource"
  },
  "id": "License",
  "module_id": "License",
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
      "items": {
        "$ref": "ResourceLink"
      },
      "readonly": true,
      "title": "References related to this resource",
      "type": "array"
    },
    "_schema": {
      "readonly": true,
      "title": "Schema for this resource",
      "type": "string"
    },
    "_self": {
      "$ref": "SelfResourceLink",
      "readonly": true,
      "title": "Link to this resource"
    },
    "capacity_type": {
      "description": "License metrics specifying the capacity type of license key. Types are: - VM - CPU - USER(Concurrent User) - CORE - HOST",
      "enum": [
        "VM",
        "CPU",
        "USER",
        "CORE",
        "HOST"
      ],
      "readonly": true,
      "title": "license metric",
      "type": "string"
    },
    "description": {
      "readonly": true,
      "title": "license edition",
      "type": "string"
    },
    "expiry": {
      "$ref": "EpochMsTimestamp",
      "description": "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.",
      "readonly": true,
      "title": "date that license expires"
    },
    "features": {
      "readonly": true,
      "title": "semicolon delimited feature list",
      "type": "string"
    },
    "is_editable": {
      "readonly": true,
      "title": "whether the license can be edit",
      "type": "boolean"
    },
    "is_eval": {
      "readonly": true,
      "title": "true for evalution license",
      "type": "boolean"
    },
    "is_expired": {
      "readonly": true,
      "title": "whether the license has expired",
      "type": "boolean"
    },
    "is_mh": {
      "readonly": true,
      "title": "multi-hypervisor support",
      "type": "boolean"
    },
    "license_key": {
      "required": true,
      "sensitive": true,
      "title": "license key",
      "type": "secure_string"
    },
    "product_name": {
      "readonly": true,
      "title": "product name",
      "type": "string"
    },
    "product_version": {
      "readonly": true,
      "title": "product version",
      "type": "string"
    },
    "quantity": {
      "description": "The license capacity. For the DLF license keys, 0 means unlimited capacity. For the VCF licenses, 0 means there is no capacity.",
      "readonly": true,
      "title": "license capacity; 0 for unlimited",
      "type": "integer"
    },
    "vc_names": {
      "description": "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.",
      "items": {
        "type": "string"
      },
      "readonly": true,
      "title": "vCenter names",
      "type": "array"
    }
  },
  "type": "object"
}