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 serviceAccount
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 guestBoolean
powerCycleLiveGuest(String uuid)
Power cycle a virtual guestBoolean
powerOffLiveGuest(String uuid)
Power off a virtual guestBoolean
powerOnLiveGuest(String uuid)
Power on a virtual guestBoolean
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 guestvoid
setMask(Host.Mask mask)
Host.Mask
withMask()
Use the existing mask on this service or create it if not presentHost.Mask
withNewMask()
Overwrite the existing mask on this service with a new one and return itMethods inherited from interface com.softlayer.api.ResultLimitable
getLastResponseTotalItemCount, getResultLimit, setResultLimit
-
Method Details
-
asAsync
Host.ServiceAsync asAsync()Description copied from interface:Service
Get an async version of this 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 interfaceMaskable
-
withMask
Host.Mask withMask()Description copied from interface:Maskable
Use the existing mask on this service or create it if not present -
setMask
-
getLiveGuestByUuid
Query a virtualization platform directly to retrieve details regarding a 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. -
getObject
- See Also:
- SoftLayer_Virtual_Host::getObject
-
pauseLiveGuest
Pause a virtual guest- See Also:
- SoftLayer_Virtual_Host::pauseLiveGuest
-
powerCycleLiveGuest
Power cycle a virtual guest -
powerOffLiveGuest
Power off a virtual guest -
powerOnLiveGuest
Power on a virtual guest- See Also:
- SoftLayer_Virtual_Host::powerOnLiveGuest
-
rebootSoftLiveGuest
Attempt to complete a soft reboot of a guest by shutting down the operating system. -
resumeLiveGuest
Resume a virtual guest- See Also:
- SoftLayer_Virtual_Host::resumeLiveGuest
-
getAccount
The account which a virtual host belongs to.- See Also:
- SoftLayer_Virtual_Host::getAccount
-
getBilledPerGuestFlag
Boolean flag indicating whether this virtualization platform gets billed per guest rather than at a fixed rate. -
getBilledPerMemoryUsageFlag
Boolean flag indicating whether this virtualization platform gets billed per memory usage rather than at a fixed rate. -
getGuests
The guests associated with a virtual host.- See Also:
- SoftLayer_Virtual_Host::getGuests
-
getHardware
The hardware record which a virtual host resides on.- See Also:
- SoftLayer_Virtual_Host::getHardware
-
getMetricTrackingObject
The metric tracking object for this virtual host. -
getPciDevices
- See Also:
- SoftLayer_Virtual_Host::getPciDevices
-