VMware Cloud Director API - VMRecord

QueryResultVMRecordType

Element:

VMRecord

Type:

QueryResultVMRecordType

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"
        vdcName="xs:string" vdc="xs:string" description="xs:string" vappScopedLocalId="xs:string"
        isVAppTemplate="xs:boolean" isDeleted="xs:boolean" guestOs="xs:string" detectedGuestOs="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" vmToolsStatus="xs:string"
        isInMaintenanceMode="xs:boolean" isAutoNature="xs:boolean" storageProfileName="xs:string" snapshot="xs:boolean"
        numOfSnapshots="xs:int" snapshotCreated="xs:dateTime" gcStatus="xs:string" autoUndeployDate="xs:dateTime"
        autoDeleteDate="xs:dateTime" isAutoUndeployNotified="xs:boolean" isAutoDeleteNotified="xs:boolean" isComputePolicyCompliant="xs:boolean"
        vmSizingPolicyId="xs:string" vmPlacementPolicyId="xs:string" encrypted="xs:boolean" dateCreated="xs:dateTime"
        totalStorageAllocatedMb="xs:long" isExpired="xs:boolean" defaultStoragePolicyName="xs:string" hasVgpuPolicy="xs:boolean"
        firmware="xs:string" tpmPresent="xs:boolean" replicationState="xs:string">
    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string" model="xs:string"/>
    <Metadata href="xs:anyURI" type="xs:string">
        <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string" model="xs:string"/>
        <MetadataEntry href="xs:anyURI" type="xs:string">
            <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string" model="xs:string"/>
            <Domain visibility="xs:string"/>
            <Key> xs:string </Key>
            <TypedValue/>
        </MetadataEntry>
    </Metadata>
</VMRecord>

Attributes

Attribute	Type	Required	Modifiable	Since	Deprecated	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
vdcName	string	No	none	36.0		VDC name	Yes	Yes
vdc	string	No	none	1.5		VDC reference or id	Yes	Yes
description	string	No	none	1.5		The description of this VM.	Yes	Yes
vappScopedLocalId	string	No	none	33.0		VM unique ID within vApp	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
detectedGuestOs	string	No	none	36.2		Detected 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, otherwise empty.	Yes	Yes
network	string	No	none	5.7		If configured, the HRef of the primary network, otherwise empty.	Yes	Yes
ipAddress	string	No	none	5.7		If configured, the IP Address of the VM on the primary network, 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
vmToolsStatus	string	No	none	29.0			Yes	Yes
isInMaintenanceMode	boolean	No	none	1.5		True if this entity is in maintenance mode	Yes	Yes
isAutoNature	boolean	No	none	22.0		True if the parent vApp is a managed vApp	Yes	Yes
storageProfileName	string	No	none	5.1		Storage profile name	Yes	Yes
snapshot	boolean	No	none	31.0			Yes	Yes
numOfSnapshots	int	No	none	39.0		Number of snapshots that exist for the VM	Yes	Yes
snapshotCreated	dateTime	No	none	31.0	39.0		Yes	Yes
gcStatus	string	No	none	13.0		GC status of this VM.	Yes	Yes
autoUndeployDate	dateTime	No	none	29.0		autoUndeployDate	Yes	Yes
autoDeleteDate	dateTime	No	none	29.0		autoDeleteDate	Yes	Yes
isAutoUndeployNotified	boolean	No	none	29.0			Yes	Yes
isAutoDeleteNotified	boolean	No	none	29.0			Yes	Yes
isComputePolicyCompliant	boolean	No	none	33.0		True if VM is compliant with Compute Policy	Yes	Yes
vmSizingPolicyId	string	No	none	33.0		Vm Sizing Policy	Yes	Yes
vmPlacementPolicyId	string	No	none	33.0		Vm Placement Policy	Yes	Yes
encrypted	boolean	No	none	34.0		True if VM is encrypted	Yes	Yes
dateCreated	dateTime	No	none	34.0		VM creation date	Yes	Yes
totalStorageAllocatedMb	long	No	none	34.0		Total storage allocated to disks, snapshots, and memory of this VM (in MB)	Yes	Yes
isExpired	boolean	No	none	34.0		True if VMs storage lease has expired. This value is obtained from VMs parent vApp (Even for stand-alone VMs whose enclosing vApp is not visible to users).	Yes	Yes
defaultStoragePolicyName	string	No	none	35.0		Storage Policy name to be used upon instantiation if this is a template, or null for non-template VMs.	Yes	Yes
hasVgpuPolicy	boolean	No	none	36.2		Whether this VM has a vGPU policy attached or tagged to it.	Yes	Yes
firmware	string	No	none	37.2		Type of firmware for this VM	Yes	Yes
tpmPresent	boolean	No	none	37.2		True if TPM device is present for this VM	Yes	Yes
replicationState	string	No	none	38.0		Replication state of the VM	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