vCloud API - VMRecord

QueryResultVMRecordType

Element:

VMRecord

Type:

Namespace:

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

Description:

Type for a single vm query result in records format.

Since:

1.5

Schema:

queryRecordView.xsd

Media type(s):

None

Extends:

QueryResultRecordType

XML Representation:

<VMRecord xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
        containerName="xs:string" container="xs:string" ownerName="xs:string" owner="xs:string"
        vdc="xs:string" isVAppTemplate="xs:boolean" isDeleted="xs:boolean" guestOs="xs:string"
        numberOfCpus="xs:int" memoryMB="xs:int" status="xs:string" networkName="xs:string"
        network="xs:string" ipAddress="xs:string" isBusy="xs:boolean" isDeployed="xs:boolean"
        isPublished="xs:boolean" catalogName="xs:string" hardwareVersion="xs:int" isInMaintenanceMode="xs:boolean"
        storageProfileName="xs:string">
    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string">
        <VCloudExtension required="xs:boolean"/>
    </Link>
    <Metadata href="xs:anyURI" type="xs:string">
        <VCloudExtension required="xs:boolean"/>
        <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string">
            <VCloudExtension required="xs:boolean"/>
        </Link>
        <MetadataEntry href="xs:anyURI" type="xs:string">
            <VCloudExtension required="xs:boolean"/>
            <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string">
                <VCloudExtension required="xs:boolean"/>
            </Link>
            <Domain visibility="xs:string"/>
            <Key> xs:string </Key>
            <TypedValue/>
        </MetadataEntry>
    </Metadata>
</VMRecord>

Attributes

Attribute	Type	Required	Modifiable	Since	Description	Filter	Sort
href	anyURI	No	always	1.5	Contains the URI to the resource.	Yes	Yes
id	string	No	always	1.5	The resource identifier, expressed in URN format. The value of this attribute uniquely identifies the resource, persists for the life of the resource, and is never reused.	Yes	Yes
type	string	No	always	1.5	Contains the type of the resource.	Yes	Yes
name	string	No	none	1.5	The name of the VM.	Yes	Yes
containerName	string	No	none	1.5	The name of the vApp or vApp template that contains this VM.	Yes	Yes
container	string	No	none	1.5	The ID of the vApp or vApp template that contains this VM.	Yes	Yes
ownerName	string	No	none	5.7	The owner of the vApp or vApp template that contains this VM.	Yes	Yes
owner	string	No	none	5.7	The ID of the owner of the vApp or vApp template that contains this VM.	Yes	Yes
vdc	string	No	none	1.5	VDC reference or id	Yes	Yes
isVAppTemplate	boolean	No	none	1.5	True if the VM belongs to a vApp template.	Yes	Yes
isDeleted	boolean	No	none	1.5	True if this entity is deleted	Yes	Yes
guestOs	string	No	none	1.5	Guest operating system	Yes	Yes
numberOfCpus	int	No	none	1.5	Number of CPUs	Yes	Yes
memoryMB	int	No	none	1.5	Memory in MB	Yes	Yes
status	string	No	none	1.5	Status	Yes	Yes
networkName	string	No	none	1.5	If configured, the name of the primary network (associated with NIC-0), otherwise empty.	Yes	Yes
network	string	No	none	5.7	If configured, the HRef of the primary network (associated with NIC-0), otherwise empty.	Yes	Yes
ipAddress	string	No	none	5.7	If configured, the IP Address of the VM on the primary network (associated with NIC-0), otherwise empty.	Yes	Yes
isBusy	boolean	No	none	1.5	True if this entity is busy	Yes	Yes
isDeployed	boolean	No	none	1.5	True if this entity is deployed	Yes	Yes
isPublished	boolean	No	none	1.5	True if this entity is in a published catalog	Yes	Yes
catalogName	string	No	none	1.5	Catalog name	Yes	Yes
hardwareVersion	int	No	none	1.5	Hardware version	Yes	Yes
isInMaintenanceMode	boolean	No	none	1.5	True if this entity is in maintenance mode	Yes	Yes
storageProfileName	string	No	none	5.1	Storage profile name	Yes	Yes

Elements

Element	Type	Required	Modifiable	Since	Deprecated	Description
Link	LinkType	No	none	1.5		Contains a link to an operation associated with a specific relation type.
Metadata	MetadataType	No		5.1