Package com.softlayer.api.service.virtual

Interface Host.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

Host

@ApiService("SoftLayer_Virtual_Host")
public static interface Host.Service
extends Service

The virtual host service provides a common interface to any virtualization platform supported by SoftLayer. Interaction with various third party APIs is not needed when implementing this service to administer your hosts.

See Also:

SoftLayer_Virtual_Host

Method Summary

Modifier and Type	Method	Description
Host.ServiceAsync	asAsync()	Get an async version of this service
Account	getAccount()	The account which a virtual host belongs to.
Boolean	getBilledPerGuestFlag()	Boolean flag indicating whether this virtualization platform gets billed per guest rather than at a fixed rate.
Boolean	getBilledPerMemoryUsageFlag()	Boolean flag indicating whether this virtualization platform gets billed per memory usage rather than at a fixed rate.
List<Guest>	getGuests()	The guests associated with a virtual host.
Server	getHardware()	The hardware record which a virtual host resides on.
Guest	getLiveGuestByUuid(String uuid)	Query a virtualization platform directly to retrieve details regarding a guest.
List<Guest>	getLiveGuestList()	Query a virtualization platform directly to retrieve a list of known guests.
List<Object>	getLiveGuestRecentMetricData(String uuid, Long time, Long limit, Long interval)	Query a virtualization platform directly to retrieve recent metric data for a guest.
Object	getMetricTrackingObject()	The metric tracking object for this virtual host.
Host	getObject()
List<PciDevice>	getPciDevices()
Boolean	pauseLiveGuest(String uuid)	Pause a virtual guest
Boolean	powerCycleLiveGuest(String uuid)	Power cycle a virtual guest
Boolean	powerOffLiveGuest(String uuid)	Power off a virtual guest
Boolean	powerOnLiveGuest(String uuid)	Power on a virtual guest
Boolean	rebootSoftLiveGuest(String uuid)	Attempt to complete a soft reboot of a guest by shutting down the operating system.
Boolean	resumeLiveGuest(String uuid)	Resume a virtual guest
void	setMask(Host.Mask mask)
Host.Mask	withMask()	Use the existing mask on this service or create it if not present
Host.Mask	withNewMask()	Overwrite the existing mask on this service with a new one and return it

Methods inherited from interface com.softlayer.api.Maskable

clearMask, setMask, setMask

Methods inherited from interface com.softlayer.api.ResultLimitable

getLastResponseTotalItemCount, getResultLimit, setResultLimit

Method Detail

asAsync

Host.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

Host.Mask withNewMask()

Description copied from interface: Maskable

Overwrite the existing mask on this service with a new one and return it

Specified by:

withNewMask in interface Maskable

withMask

Host.Mask withMask()

Description copied from interface: Maskable

Use the existing mask on this service or create it if not present

Specified by:

withMask in interface Maskable

setMask

void setMask(Host.Mask mask)

getLiveGuestByUuid

@ApiMethod(instanceRequired=true)
Guest getLiveGuestByUuid(String uuid)

Query a virtualization platform directly to retrieve details regarding a guest.

See Also:

SoftLayer_Virtual_Host::getLiveGuestByUuid

getLiveGuestList

@ApiMethod(instanceRequired=true)
List<Guest> getLiveGuestList()

Query a virtualization platform directly to retrieve a list of known guests.

See Also:

SoftLayer_Virtual_Host::getLiveGuestList

getLiveGuestRecentMetricData

@ApiMethod(instanceRequired=true)
List<Object> getLiveGuestRecentMetricData(String uuid,
                                          Long time,
                                          Long limit,
                                          Long interval)

Query a virtualization platform directly to retrieve recent metric data for a guest.

See Also:

SoftLayer_Virtual_Host::getLiveGuestRecentMetricData

getObject

@ApiMethod(instanceRequired=true)
Host getObject()

See Also:

SoftLayer_Virtual_Host::getObject

pauseLiveGuest

@ApiMethod(instanceRequired=true)
Boolean pauseLiveGuest(String uuid)

Pause a virtual guest

See Also:

SoftLayer_Virtual_Host::pauseLiveGuest

powerCycleLiveGuest

@ApiMethod(instanceRequired=true)
Boolean powerCycleLiveGuest(String uuid)

Power cycle a virtual guest

See Also:

SoftLayer_Virtual_Host::powerCycleLiveGuest

powerOffLiveGuest

@ApiMethod(instanceRequired=true)
Boolean powerOffLiveGuest(String uuid)

Power off a virtual guest

See Also:

SoftLayer_Virtual_Host::powerOffLiveGuest

powerOnLiveGuest

@ApiMethod(instanceRequired=true)
Boolean powerOnLiveGuest(String uuid)

Power on a virtual guest

See Also:

SoftLayer_Virtual_Host::powerOnLiveGuest

rebootSoftLiveGuest

@ApiMethod(instanceRequired=true)
Boolean rebootSoftLiveGuest(String uuid)

Attempt to complete a soft reboot of a guest by shutting down the operating system.

See Also:

SoftLayer_Virtual_Host::rebootSoftLiveGuest

resumeLiveGuest

@ApiMethod(instanceRequired=true)
Boolean resumeLiveGuest(String uuid)

Resume a virtual guest

See Also:

SoftLayer_Virtual_Host::resumeLiveGuest

getAccount

@ApiMethod(instanceRequired=true)
Account getAccount()

The account which a virtual host belongs to.

See Also:

SoftLayer_Virtual_Host::getAccount

getBilledPerGuestFlag

@ApiMethod(instanceRequired=true)
Boolean getBilledPerGuestFlag()

Boolean flag indicating whether this virtualization platform gets billed per guest rather than at a fixed rate.

See Also:

SoftLayer_Virtual_Host::getBilledPerGuestFlag

getBilledPerMemoryUsageFlag

@ApiMethod(instanceRequired=true)
Boolean getBilledPerMemoryUsageFlag()

Boolean flag indicating whether this virtualization platform gets billed per memory usage rather than at a fixed rate.

See Also:

SoftLayer_Virtual_Host::getBilledPerMemoryUsageFlag

getGuests

@ApiMethod(instanceRequired=true)
List<Guest> getGuests()

The guests associated with a virtual host.

See Also:

SoftLayer_Virtual_Host::getGuests

getHardware

@ApiMethod(instanceRequired=true)
Server getHardware()

The hardware record which a virtual host resides on.

See Also:

SoftLayer_Virtual_Host::getHardware

getMetricTrackingObject

@ApiMethod(instanceRequired=true)
Object getMetricTrackingObject()

The metric tracking object for this virtual host.

See Also:

SoftLayer_Virtual_Host::getMetricTrackingObject

getPciDevices

@ApiMethod(instanceRequired=true)
List<PciDevice> getPciDevices()

See Also:

SoftLayer_Virtual_Host::getPciDevices