License

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

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"/>
    <SerialNumber> xs:string </SerialNumber>
    <LicensedVMCount> xs:int </LicensedVMCount>
    <ExpirationDate> xs:dateTime </ExpirationDate>
    <ValidSerial> xs:boolean </ValidSerial>
    <Expired> xs:boolean </Expired>
    <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"/>
        <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>
    </LicenseMetricsInfo>
</License>

Attributes

Attribute	Type	Required	Modifiable	Since	Description
href	anyURI	No	always	1.5	Contains the URI to the entity.
type	string	No	always	1.5	Contains the type of the entity.

Elements

Element	Type	Occurrence	Modifiable	Since	Description
VCloudExtension	VCloudExtensionType	0..*	always	1.5	An optional extension element that can contain an arbitrary number of elements and attributes.
Link	LinkType	0..*	none	1.5	Optional link to an entity or operation associated with this object.
SerialNumber	string	1	always	1.5	The site wide serial number string.
LicensedVMCount	int	0..1	none	1.5	The number of VMs this product is licensed for.
ExpirationDate	dateTime	0..1	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.
ValidSerial	boolean	0..1	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.
Expired	boolean	0..1	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	0..1		1.5	Report of License usage metrics.

Operations

CRUD	Operation	Description	Since
read	GET /admin/extension/settings/license	Retrieves the {@link LicenseSpec}.	1.5
as input	PUT /admin/extension/settings/license	Updates the {@link LicenseSpec}.	1.5