SoftLayer Virtual Host

From SoftLayer Development Network Wiki

This page refers to the SoftLayer_Virtual_Host service. For information on the SoftLayer_Virtual_Host data type please see SoftLayer_Virtual_Host (type).

Contents 1 Overview 2 Endpoints 3 Methods 3.1 getAccount 3.2 getBilledPerGuestFlag 3.3 getGuests 3.4 getHardware 3.5 getLiveGuestByUuid 3.6 getLiveGuestList 3.7 getLiveGuestRecentMetricData 3.8 getMetricTrackingObject 3.9 getObject 3.10 pauseLiveGuest 3.11 powerCycleLiveGuest 3.12 powerOffLiveGuest 3.13 powerOnLiveGuest 3.14 rebootSoftLiveGuest 3.15 resumeLiveGuest

Overview

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.

Endpoints

SOAP WSDL	Public Network:	https://api.softlayer.com/soap/v3/SoftLayer_Virtual_Host?wsdl
	Private Network:	http://api.service.softlayer.com/soap/v3/SoftLayer_Virtual_Host?wsdl
XML-RPC Endpoint	Public Network:	https://api.softlayer.com/xmlrpc/v3/SoftLayer_Virtual_Host
	Private Network:	http://api.service.softlayer.com/xmlrpc/v3/SoftLayer_Virtual_Host
REST URL	Public Network:	https://api.softlayer.com/rest/v3/SoftLayer_Virtual_Host/
	Private Network:	https://api.service.softlayer.com/rest/v3/SoftLayer_Virtual_Host/

Methods

getAccount

Retrieve the account which a virtual host belongs to.

• returns

SoftLayer_Account

• parameters

None

---

getBilledPerGuestFlag

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

• returns

boolean

• parameters

None

---

getGuests

Retrieve the guests associated with a virtual host.

• returns

SoftLayer_Virtual_GuestArray

• parameters

None

---

getHardware

Retrieve the hardware record which a virtual host resides on.

• returns

SoftLayer_Hardware

• parameters

None

---

getLiveGuestByUuid

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

• returns

SoftLayer_Virtual_Guest

• parameters

string uuid

---

getLiveGuestList

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

• returns

SoftLayer_Virtual_GuestArray

• parameters

None

---

getLiveGuestRecentMetricData

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

• returns

SoftLayer_Metric_Tracking_ObjectArray

• parameters

string uuid

unsigned integer time

integer limit

integer interval

---

getMetricTrackingObject

Retrieve the metric tracking object for this virtual host.

• returns

SoftLayer_Metric_Tracking_Object

• parameters

None

---

getObject

Retrieve a SoftLayer_Virtual_Host record.

• returns

SoftLayer_Virtual_Host

• parameters

None

---

pauseLiveGuest

Pause a guest.

• returns

boolean

• parameters

string uuid

---

powerCycleLiveGuest

Power cycle a guest.

• returns

boolean

• parameters

string uuid

---

powerOffLiveGuest

Power off a guest.

• returns

boolean

• parameters

string uuid

---

powerOnLiveGuest

Power on a guest.

• returns

boolean

• parameters

string uuid

---

rebootSoftLiveGuest

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

• returns

boolean

• parameters

string uuid

---

resumeLiveGuest

Resume a guest.

• returns

boolean

• parameters

string uuid