Host

Element:

Host

Type:

HostType

Namespace:

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

Description:

Read only representation of one host in a vSphere server.

Since:

1.0

Schema:

vmwextensions.xsd

Media type(s):

application/vnd.vmware.admin.host+xml

Extends:

EntityType

XML Representation:

<Host 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" name="xs:string" id="xs:string">
    <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string"/>
    <Description> xs:string </Description>
    <vcloud_v1.5:Tasks>
        <vcloud_v1.5:Task href="xs:anyURI" type="xs:string" name="xs:string" id="xs:string"
                status="xs:string" operation="xs:string" operationName="xs:string" startTime="xs:dateTime"
                endTime="xs:dateTime" expiryTime="xs:dateTime">
            <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string"/>
            <Description> xs:string </Description>
            <vcloud_v1.5:Tasks> vcloud_v1.5:TasksInProgressType </vcloud_v1.5:Tasks>
            <vcloud_v1.5:Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <vcloud_v1.5:Error message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"
                    stackTrace="xs:string"/>
            <vcloud_v1.5:User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <vcloud_v1.5:Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Progress> xs:int </Progress>
            <Params> ... </Params>
        </vcloud_v1.5:Task>
    </vcloud_v1.5:Tasks>
    <Ready> xs:boolean </Ready>
    <Available> xs:boolean </Available>
    <Enabled> xs:boolean </Enabled>
    <Busy> xs:boolean </Busy>
    <EnableHostForHostSpanning> xs:boolean </EnableHostForHostSpanning>
    <CpuType> xs:string </CpuType>
    <NumOfCpusPackages> xs:int </NumOfCpusPackages>
    <NumOfCpusLogical> xs:int </NumOfCpusLogical>
    <CpuTotal> xs:long </CpuTotal>
    <MemUsed> xs:double </MemUsed>
    <MemTotal> xs:double </MemTotal>
    <HostOsName> xs:string </HostOsName>
    <HostOsVersion> xs:string </HostOsVersion>
    <SystemMessages> xs:string </SystemMessages>
    <VimPropertyPageUrl> xs:string </VimPropertyPageUrl>
    <VmMoRef> xs:string </VmMoRef>
</Host>

Attributes

Attribute	Type	Required	Modifiable	Since	Description
href	anyURI	No	always	1.0	Contains the URI to the entity.
type	string	No	always	1.0	Contains the type of the entity.
name	string	Yes	always	1.0	The name of the entity.
id	string	No	none	1.0	The entity identifier, expressed in URN format. The value of this attribute uniquely identifies the entity, persists for the life of the entity, and is never reused.

Elements

Element	Type	Occurrence	Modifiable	Since	Description
VCloudExtension	VCloudExtensionType	0..*	always	1.0	An optional extension element that can contain an arbitrary number of elements and attributes.
Link	LinkType	0..*	none	1.0	Optional link to an entity or operation associated with this object.
Description	string	0..1	always	1.0	Optional description.
Tasks	TasksInProgressType	0..1	none	1.0	A list of queued, running, or recently completed tasks associated with this entity.
Ready	boolean	1	none	1.0	Indicates whether the host is ready for use.
Available	boolean	1	none	1.0	Indicates whether the host is available.
Enabled	boolean	1	none	1.0	Indicated whether the host is enabled for use.
Busy	boolean	1	none	1.0	Indicates whether the host is busy.
EnableHostForHostSpanning	boolean	1	none	1.0	Indicates whether the host is enabled for host spanning.
CpuType	string	0..1	none	1.0	The CPU type of the host.
NumOfCpusPackages	int	1	none	1.0	How many hardware CPUs the host has.
NumOfCpusLogical	int	1	none	1.0	How many logical CPUs the host has.
CpuTotal	long	1	none	1.0	The total CPU power measured in MHz.
MemUsed	double	1	none	1.0	The used memory in the host.
MemTotal	double	1	none	1.0	The total memory in the host.
HostOsName	string	0..1	none	1.0	OS name of the host.
HostOsVersion	string	0..1	none	1.0	OS version of the host.
SystemMessages	string	0..1	none	1.0	System messages of the host.
VimPropertyPageUrl	string	0..1	none	1.0	URL to the VIM property page of the host.
VmMoRef	string	1	none	1.0	The host moref.

Operations

CRUD	Operation	Description	Since
read	GET /admin/extension/host/{id}	Gets a host.	1.0