vCloud API - HostRecord

QueryResultHostRecordType

Element:

HostRecord

Type:

QueryResultHostRecordType

Namespace:

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

Description:

Type for a single host query result in records format.

Since:

1.5

Schema:

queryRecordView.xsd

Media type(s):

None

Extends:

QueryResultRecordType

XML Representation:

<HostRecord xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
        isEnabled="xs:boolean" isDeleted="xs:boolean" isBusy="xs:boolean" isPrepared="xs:boolean"
        isSupported="xs:boolean" isHung="xs:boolean" isPendingUpgrade="xs:boolean" state="xs:int"
        osVersion="xs:string" isCrossHostEnabled="xs:boolean" numberOfVMs="xs:int" isInMaintenanceMode="xs:boolean"
        vc="xs:string" vcName="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>
</HostRecord>

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 this host.	Yes	Yes
isEnabled	boolean	No	none	1.5		True if this entity is enabled	Yes	Yes
isDeleted	boolean	No	none	1.5		True if this entity is deleted	Yes	Yes
isBusy	boolean	No	none	1.5		True if this host has tasks in progress	Yes	Yes
isPrepared	boolean	No	none	1.5		True if this host is prepared	Yes	Yes
isSupported	boolean	No	none	1.5		True if this host's ESXi version is supported by this release of vCloud Director.	Yes	Yes
isHung	boolean	No	none	1.5		True if this host is hung.	Yes	Yes
isPendingUpgrade	boolean	No	none	1.5		True if this host has an upgrade pending.	Yes	Yes
state	int	No	none	1.5		State	Yes	Yes
osVersion	string	No	none	1.5		Operating system version	Yes	Yes
isCrossHostEnabled	boolean	No	none	1.5		True if this host is cross-host enabled.	Yes	Yes
numberOfVMs	int	No	none	1.5		Number of VMs	Yes	Yes
isInMaintenanceMode	boolean	No	none	1.5		True if this host is in maintenance mode.	Yes	Yes
vc	string	No	none	1.5		Virtual center reference or id	Yes	Yes
vcName	string	No	none	1.5		Vitual center 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