License

Enables retrieval/modification and creation of license files. Most of the attributes are retrieved from the encrypted license. The create API simply provides the encrypted license that is in base64 format.

Overview

additionalSupportedVersions string
allowedAVRSGsCount integer
allowedAVRSsCount integer
allowedCPEsCount integer
allowedNICsCount integer
allowedVDFGsCount integer
allowedVDFsCount integer
allowedVMsCount integer
allowedVRSGsCount integer
allowedVRSsCount integer
city string
company string
country string
creationDate string read only   autogenerated   orderable  
customerKey string
email string
embeddedMetadata list read only   autogenerated  
encryptionMode boolean
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
expirationDate time filterable   orderable  
expiryTimestamp integer
externalID string filterable   orderable   locally unique  
isClusterLicense boolean
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
license string required  
licensedFeature string read only  
licenseEncryption enum (ENCRYPTION_DISABLED | ENCRYPTION_ENABLED)
licenseEntities string
licenseID integer
licenseType enum (CLUSTERED | STANDARD)
majorRelease integer
minorRelease integer
owner string autogenerated  
phone string
productVersion string
provider string
requestID string read only   autogenerated   locally unique  
state string
street string
system string read only   autogenerated  
uniqueLicenseIdentifier string
userName string filterable  
zip string

API Resource

/licenses/id
delete get

Parents

/licenses
get post

Children

/licenses/id/metadatas
get post
/licenses/id/globalmetadatas
get post put
/licenses/id/eventlogs
get

Members

This object has no members.

Attributes documentation

additionalSupportedVersions string
Discussion

Indicates additional versions supported by the license.


Charateristics

Format: free
SDK attribute: additionalSupportedVersions

allowedAVRSGsCount integer
Discussion

Maximum number of AVRSGs enabled with this license. A value of -1 indicates an unlimited number of AVRSGs


Charateristics

SDK attribute: allowedAVRSGsCount

allowedAVRSsCount integer
Discussion

Maximum number of AVRSs enabled with this license. A value of -1 indicates an unlimited number of AVRSs


Charateristics

SDK attribute: allowedAVRSsCount

allowedCPEsCount integer
Discussion

Maximum number of NSGs enabled with this license. A value of -1 indicates an unlimited number of NSGs


Charateristics

SDK attribute: allowedCPEsCount

allowedNICsCount integer
Discussion

Maximum number of NICs allowed. A value of -1 indicates unlimited number of NICs


Charateristics

SDK attribute: allowedNICsCount

allowedVDFGsCount integer
Discussion

Maximum number of VDFGs enabled with this license. A value of -1 indicates an unlimited number of VDFGs.


Charateristics

SDK attribute: allowedVDFGsCount

allowedVDFsCount integer
Discussion

Maximum number of VDFs enabled with this license. A value of -1 indicates an unlimited number of VDFs


Charateristics

SDK attribute: allowedVDFsCount

allowedVMsCount integer
Discussion

Maximum number of VMs enabled with this license. A value of -1 indicates an unlimited number of VMs


Charateristics

SDK attribute: allowedVMsCount

allowedVRSGsCount integer
Discussion

Maximum number of VRSGs enabled with this license. A value of -1 indicates an unlimited number of VRSGs


Charateristics

SDK attribute: allowedVRSGsCount

allowedVRSsCount integer
Discussion

Maximum number of VRSs enabled with this license. A value of -1 indicates an unlimited number of VRSs


Charateristics

SDK attribute: allowedVRSsCount

city string
Discussion

City of the owner associated with the license file


Charateristics

Format: free
SDK attribute: city

company string
Discussion

Company of the owner associated with the license file


Charateristics

Format: free
SDK attribute: company

country string
Discussion

Country of the owner associated with the license file


Charateristics

Format: free
SDK attribute: country

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.


Charateristics

SDK attribute: creationDate

customerKey string
Discussion

Customer key associated with the licese


Charateristics

Format: free
SDK attribute: customerKey

email string
Discussion

Email of the owner associated with the license file


Charateristics

Format: free
SDK attribute: email

embeddedMetadata list read only   autogenerated  
Discussion

Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.


Charateristics

SDK attribute: embeddedMetadata

encryptionMode boolean
Discussion

Indicates if the system is associated with a license that allows encryption or not


Charateristics

SDK attribute: encryptionMode

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level


Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

expirationDate time filterable   orderable  
Discussion

Expiration date of this license


Charateristics

SDK attribute: expirationDate

expiryTimestamp integer
Discussion

The Timestamp value of the expiration date of this license


Charateristics

SDK attribute: expiryTimestamp

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems


Charateristics

Format: free
SDK attribute: externalID

isClusterLicense boolean
Discussion

Indicates if the license is associated with standlone or cluster setup of VSD


Charateristics

SDK attribute: isClusterLicense

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.


Charateristics

Format: free
SDK attribute: lastUpdatedBy

lastUpdatedDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was last updated.


Charateristics

SDK attribute: lastUpdatedDate

license string required  
Discussion

Base 64 value of the license


Charateristics

Format: free
SDK attribute: license

licensedFeature string read only  
Discussion

Indicates the feature supported by the license. Possible value is "vss".


Charateristics

Format: free
SDK attribute: licensedFeature

licenseEncryption enum
Discussion

License encryption


Charateristics

Allowed values: ENCRYPTION_DISABLED, ENCRYPTION_ENABLED
SDK attribute: licenseEncryption

licenseEntities string
Discussion

Indicates non enforceable entities associated with the license.


Charateristics

Format: free
SDK attribute: licenseEntities

licenseID integer
Discussion

Unique identifier of the license file


Charateristics

SDK attribute: licenseID

licenseType enum
Discussion

None


Charateristics

Allowed values: CLUSTERED, STANDARD
SDK attribute: licenseType

majorRelease integer
Discussion

Major software release associated with this license


Charateristics

SDK attribute: majorRelease

minorRelease integer
Discussion

Minor software release for which this license has been issued


Charateristics

SDK attribute: minorRelease

owner string autogenerated  
Discussion

Identifies the user that has created this object.


Charateristics

Format: free
SDK attribute: owner

phone string
Discussion

Phone number of the owner associated with the license file


Charateristics

Format: free
SDK attribute: phone

productVersion string
Discussion

Version of the product that this license applies to


Charateristics

Format: free
SDK attribute: productVersion

provider string
Discussion

Provider of the license file


Charateristics

Format: free
SDK attribute: provider

requestID string read only   autogenerated   locally unique  
Discussion

Unique number generated by the License Management system used to identify each license.


Charateristics

Format: free
Max length: 255
SDK attribute: requestID

state string
Discussion

State of the owner associated with the license file


Charateristics

Format: free
SDK attribute: state

street string
Discussion

Address of the owner associated with the license file


Charateristics

Format: free
SDK attribute: street

system string read only   autogenerated  
Discussion

System name information provided by the License Management System.


Charateristics

Format: free
Max length: 255
SDK attribute: system

uniqueLicenseIdentifier string
Discussion

Indicates combined string of first 16 and last 16 characters of the license string to be shown in the API


Charateristics

Format: free
SDK attribute: uniqueLicenseIdentifier

userName string filterable  
Discussion

The name of the user associated with the license


Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: userName

zip string
Discussion

Zipcode of the owner associated with the license file


Charateristics

Format: free
SDK attribute: zip