com.vmware.vcloud.sdk.admin.extensions
Class VMWHost

java.lang.Object
  com.vmware.vcloud.sdk.VcloudResource<T>
      com.vmware.vcloud.sdk.VcloudEntity<com.vmware.vcloud.api.rest.schema.extension.HostType>
          com.vmware.vcloud.sdk.admin.extensions.VMWHost

public class VMWHost
extends VcloudEntity<com.vmware.vcloud.api.rest.schema.extension.HostType>

Helper class for the VMWHost Resource in vCloud Admin Extension API.

Author:

Administrator

Method Summary

Task	disableHost() Disable the Host
static Task	disableHost(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType vmwHostRef) Disable the Host
Task	enableHost() Enable the Host
static Task	enableHost(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType vmwHostRef) Enable the Host
static VMWHost	getVMWHostById(VcloudClient client, String vCloudId) Get VMWHost helper using the vCloud ID
static VMWHost	getVMWHostByReference(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType reference) Returns the VMWHost Helper for the given vmw host reference
Task	prepareHost(String username, String password) Preparing the host
static Task	prepareHost(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType hostRef, String username, String password) Preparing the host
Task	repairHost() Repair the host
static Task	repairHost(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType hostRef) Repair the host
Task	unPrepareHost() UnPreparing the host
static Task	unPrepareHost(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType hostRef) UnPreparing the host
Task	upgradeHost() Upgrades the host agent
static Task	upgradeHost(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType hostRef) Upgrades the host agent

Methods inherited from class com.vmware.vcloud.sdk.VcloudEntity

getMetadata, getReference, getTasks

Methods inherited from class com.vmware.vcloud.sdk.VcloudResource

getResource

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getVMWHostByReference

public static VMWHost getVMWHostByReference(VcloudClient client,
                                            com.vmware.vcloud.api.rest.schema.ReferenceType reference)
                                     throws VCloudException

Returns the VMWHost Helper for the given vmw host reference

Parameters:

client -

reference -

Returns:

VMWHost

Throws:

VCloudException

getVMWHostById

public static VMWHost getVMWHostById(VcloudClient client,
                                     String vCloudId)
                              throws VCloudException

Get VMWHost helper using the vCloud ID

Parameters:

client - VcloudClient

vCloudId - format - The vCloud ID is of the form: "urn:vcloud:type:uuid". For example: "urn:vcloud:media:d9d976ba-e0ec-4682-a67d-380af49b54e1". String

Returns:

VMWHost

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

disableHost

public Task disableHost()
                 throws VCloudException

Disable the Host

Returns:

Task

Throws:

VCloudException

disableHost

public static Task disableHost(VcloudClient client,
                               com.vmware.vcloud.api.rest.schema.ReferenceType vmwHostRef)
                        throws VCloudException

Disable the Host

Parameters:

client - VcloudClient

vmwHostRef -

Returns:

Task

Throws:

VCloudException

enableHost

public Task enableHost()
                throws VCloudException

Enable the Host

Returns:

Task

Throws:

VCloudException

enableHost

public static Task enableHost(VcloudClient client,
                              com.vmware.vcloud.api.rest.schema.ReferenceType vmwHostRef)
                       throws VCloudException

Enable the Host

Parameters:

client - VcloudClient

vmwHostRef -

Returns:

Task

Throws:

VCloudException

unPrepareHost

public Task unPrepareHost()
                   throws VCloudException

UnPreparing the host

Returns:

Task

Throws:

VCloudException

unPrepareHost

public static Task unPrepareHost(VcloudClient client,
                                 com.vmware.vcloud.api.rest.schema.ReferenceType hostRef)
                          throws VCloudException

UnPreparing the host

Parameters:

client -

hostRef -

Returns:

Task

Throws:

VCloudException

prepareHost

public Task prepareHost(String username,
                        String password)
                 throws VCloudException

Preparing the host

Parameters:

username - String

password - String

Returns:

Task

Throws:

VCloudException

prepareHost

public static Task prepareHost(VcloudClient client,
                               com.vmware.vcloud.api.rest.schema.ReferenceType hostRef,
                               String username,
                               String password)
                        throws VCloudException

Preparing the host

Parameters:

client -

hostRef - ReferenceType

username - String

password - String

Returns:

Task

Throws:

VCloudException

repairHost

public Task repairHost()
                throws VCloudException

Repair the host

Returns:

Task

Throws:

VCloudException

repairHost

public static Task repairHost(VcloudClient client,
                              com.vmware.vcloud.api.rest.schema.ReferenceType hostRef)
                       throws VCloudException

Repair the host

Parameters:

client -

hostRef -

Returns:

Task

Throws:

VCloudException

upgradeHost

public Task upgradeHost()
                 throws VCloudException

Upgrades the host agent

Returns:

Task

Throws:

VCloudException

upgradeHost

public static Task upgradeHost(VcloudClient client,
                               com.vmware.vcloud.api.rest.schema.ReferenceType hostRef)
                        throws VCloudException

Upgrades the host agent

Parameters:

client -

hostRef -

Returns:

Task

Throws:

VCloudException