HostType

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+json
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" id="xs:string" operationKey="xs:string"
        name="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" id="xs:string" operationKey="xs:string"
                name="xs:string" status="xs:string" operation="xs:string" operationName="xs:string"
                serviceNamespace="xs:string" startTime="xs:dateTime" endTime="xs:dateTime" expiryTime="xs:dateTime"
                cancelRequested="xs:boolean">
            <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 stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
                    vendorSpecificErrorCode="xs:string">
                <vcloud_v1.5:TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"/>
            </vcloud_v1.5:Error>
            <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>
            <Details> xs:string </Details>
            <vcloud_v1.5:Result>
                <ResultContent> ... </ResultContent>
            </vcloud_v1.5:Result>
        </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	The URI of the entity.
type	string	No	always	1.0	The MIME type 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.
operationKey	string	No	create	5.1	Optional unique identifier to support idempotent semantics for create and delete operations.
name	string	Yes	always	1.0	The name of the entity.

Elements

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

Operations

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