VMware Cloud Director API - License

LicenseType

Element:

License

Type:

LicenseType

Namespace:

http://www.vmware.com/vcloud/extension/v1.5

Description:

This is used by the API to update and retrieve site license specific information.

Since:

1.5

Schema:

settings.xsd

Media type(s):

application/vnd.vmware.admin.licenseSettings+xml
application/vnd.vmware.admin.licenseSettings+json

Extends:

ResourceType

XML Representation:

<License xmlns="http://www.vmware.com/vcloud/extension/v1.5" xmlns:vcloud_v1.5="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string">
    <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string" model="xs:string"/>
    <SerialNumber> xs:string </SerialNumber>
    <LicensedVMCount> xs:int </LicensedVMCount>
    <ExpirationDate> xs:dateTime </ExpirationDate>
    <ValidSerial> xs:boolean </ValidSerial>
    <Expired> xs:boolean </Expired>
    <Persisted> xs:boolean </Persisted>
    <PublishingToRemoteSitesFeature> xs:boolean </PublishingToRemoteSitesFeature>
    <SubscribingToRemoteSitesFeature> xs:boolean </SubscribingToRemoteSitesFeature>
    <LicenseMetricsInfo href="xs:anyURI" type="xs:string">
        <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string" model="xs:string"/>
        <vRAM> xs:long </vRAM>
        <vCPU> xs:long </vCPU>
        <RunningVMs> xs:long </RunningVMs>
        <PhysicalMemoryUsed> xs:long </PhysicalMemoryUsed>
        <PhysicalSocketCount> xs:int </PhysicalSocketCount>
        <AvailablePhysicalMemory> xs:long </AvailablePhysicalMemory>
        <LastUpdate> xs:dateTime </LastUpdate>
        <PublishingToRemoteSites> xs:boolean </PublishingToRemoteSites>
        <SubscribingToRemoteSites> xs:boolean </SubscribingToRemoteSites>
    </LicenseMetricsInfo>
</License>

Attributes

Attribute	Type	Required	Modifiable	Since	Deprecated	Description
href	anyURI	No	always	1.5		The URI of the entity.
type	string	No	always	1.5		The MIME type of the entity.

Elements

Element	Type	Required	Modifiable	Since	Description
ExpirationDate	dateTime	No	none	1.5	The expiration date for this serial number. This is a read only field. for the API client. The license manager will set this field appropriately.
Expired	boolean	No	none	1.5	Flag indicating whether the provided serial number has expired. This is a read-only field for the API. The license manager will set this flag appropriately.
LicenseMetricsInfo	LicenseMetricsInfoType	No		1.5	Report of License usage metrics.
LicensedVMCount	int	No	none	1.5	The number of VMs this product is licensed for.
Link	LinkType	No	none	1.5	A reference to an entity or operation associated with this object.
Persisted	boolean	No	none	5.5	Flag indicating whether this license element is persisted. Note that starting with vCloud 5.5 attempting to set an expired license key while the system is federated with component-manager will not persist the key in the CIS Licensing sub system. Otherwise, for compatibility reason, if the key is expired and the system is not federated with component manager then this key gets persisted in the vCloud local licensing system.
PublishingToRemoteSitesFeature	boolean	No	none	5.5	Flag indicating whether the provided serial number has feature 'publishing-to-remote-sites'. This is a read-only field for the API. The license manager will set this flag appropriately.
SerialNumber	string	Yes	always	1.5	The site wide serial number string.
SubscribingToRemoteSitesFeature	boolean	No	none	5.5	Flag indicating whether the provided serial number has feature 'subscribing-to-remote-sites'. This is a read-only field for the API. The license manager will set this flag appropriately.
VCloudExtension	VCloudExtensionType	No	always	1.5	An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.
ValidSerial	boolean	No	none	1.5	Flag indicating whether the provided serial is valid. This is a read only field for the API client. The license manager will set this flag appropriately.

Operations

CRUD	Operation	Description	Since	Deprecated
read	GET /admin/extension/settings/license	Retrieve vCloud Director software license details.	1.5
as input	PUT /admin/extension/settings/license	Update vCloud Director software license details.	1.5