SoftLayer Virtual Guest

From SoftLayer Development Network Wiki

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

Contents 1 Overview 2 Endpoints 3 Methods 3.1 activatePrivatePort 3.2 activatePublicPort 3.3 createArchiveTransaction 3.4 editObject 3.5 getAccount 3.6 getActiveTransaction 3.7 getAntivirusSpywareSoftwareComponent 3.8 getAvailableMonitoring 3.9 getAverageDailyPrivateBandwidthUsage 3.10 getAverageDailyPublicBandwidthUsage 3.11 getBackendNetworkComponents 3.12 getBackendRouters 3.13 getBandwidthAllocation 3.14 getBandwidthAllotmentDetail 3.15 getBandwidthDataByDate 3.16 getBandwidthImage 3.17 getBandwidthImageByDate 3.18 getBandwidthTotal 3.19 getBillingCycleBandwidthUsage 3.20 getBillingCyclePrivateBandwidthUsage 3.21 getBillingCyclePublicBandwidthUsage 3.22 getBillingItem 3.23 getBlockDevices 3.24 getConsoleAccessLog 3.25 getConsoleIpAddressRecord 3.26 getControlPanel 3.27 getCpuMetricDataByDate 3.28 getCpuMetricImage 3.29 getCpuMetricImageByDate 3.30 getCurrentBillingDetail 3.31 getCurrentBillingTotal 3.32 getDataMinMax 3.33 getDatacenter 3.34 getEvaultNetworkStorage 3.35 getFirewallServiceComponent 3.36 getFrontendNetworkComponents 3.37 getFrontendRouters 3.38 getHost 3.39 getHostIpsSoftwareComponent 3.40 getHourlyBillingFlag 3.41 getInboundPrivateBandwidthUsage 3.42 getInboundPublicBandwidthUsage 3.43 getLastOperatingSystemReload 3.44 getLastTransaction 3.45 getLocation 3.46 getMemoryMetricDataByDate 3.47 getMemoryMetricImage 3.48 getMemoryMetricImageByDate 3.49 getMetricTrackingObject 3.50 getMonitoringUserNotification 3.51 getNetworkComponentFirewallProtectableIpAddresses 3.52 getNetworkComponents 3.53 getNetworkMonitors 3.54 getNetworkStorage 3.55 getNetworkVlans 3.56 getObject 3.57 getOperatingSystem 3.58 getOrderTemplate 3.59 getOutboundPrivateBandwidthUsage 3.60 getOutboundPublicBandwidthUsage 3.61 getPowerState 3.62 getPrimaryBackendIpAddress 3.63 getPrimaryBackendNetworkComponent 3.64 getPrimaryIpAddress 3.65 getPrimaryNetworkComponent 3.66 getProvisionDate 3.67 getRecentMetricData 3.68 getReverseDomainRecords 3.69 getSecurityScanRequests 3.70 getServerRoom 3.71 getSoftwareComponents 3.72 getUpgradeItemPrices 3.73 getUpgradeRequest 3.74 getUsers 3.75 getVirtualRack 3.76 getVirtualRackId 3.77 getVirtualRackName 3.78 isBackendPingable 3.79 isPingable 3.80 pause 3.81 powerCycle 3.82 powerOff 3.83 powerOffSoft 3.84 powerOn 3.85 rebootDefault 3.86 rebootHard 3.87 rebootSoft 3.88 reloadCurrentOperatingSystemConfiguration 3.89 reloadOperatingSystem 3.90 resume 3.91 setPrivateNetworkInterfaceSpeed 3.92 setPublicNetworkInterfaceSpeed 3.93 shutdownPrivatePort 3.94 shutdownPublicPort

Overview

The virtual guest service provides a common interface to any virtualization platform supported by SoftLayer. The interaction with various third party APIs is not needed when implementing this service to administer your guests. The SoftLayer_Virtual_Guest service also controls individual CloudLayer Computing Instances purchased from SoftLayer in a way that is analogous to the SoftLayer_Hardware_Server service's control over physical hardware purchased form SoftLayer.

Endpoints

SOAP WSDL	http://api.service.softlayer.com/soap/v3/SoftLayer_Virtual_Guest?wsdl
XML-RPC	http://api.service.softlayer.com/xmlrpc/v3/SoftLayer_Virtual_Guest

Methods

activatePrivatePort

Shuts down the public port

• returns

boolean

• parameters

None

---

activatePublicPort

Shuts down the public port

• returns

boolean

• parameters

None

---

createArchiveTransaction

Block Devices can be grouped together in and backed up in an archive for later use. This method generates a transaction to perform an archive of the provided block devices.

• returns

SoftLayer_Provisioning_Version1_Transaction

• parameters

string groupName

SoftLayer_Virtual_Guest_Block_DeviceArray blockDevices

---

editObject

Edit a computing instance's properties

• returns

boolean

• parameters

SoftLayer_Virtual_Guest templateObject

---

getAccount

Retrieve the account that a virtual guest belongs to.

• returns

SoftLayer_Account

• parameters

None

---

getActiveTransaction

Retrieve a transaction that is still be performed on a cloud server.

• returns

SoftLayer_Provisioning_Version1_Transaction

• parameters

None

---

getAntivirusSpywareSoftwareComponent

Retrieve a antivirus / spyware software component object.

• returns

SoftLayer_Software_Component

• parameters

None

---

getAvailableMonitoring

Retrieve an object that stores the maximum level for the monitoring query types and response types.

• returns

SoftLayer_Network_Monitor_Version1_Query_Host_StratumArray

• parameters

None

---

getAverageDailyPrivateBandwidthUsage

Retrieve the average daily private bandwidth usage for the current billing cycle.

• returns

float

• parameters

None

---

getAverageDailyPublicBandwidthUsage

Retrieve the average daily public bandwidth usage for the current billing cycle.

• returns

float

• parameters

None

---

getBackendNetworkComponents

Retrieve a guests's backend network components.

• returns

SoftLayer_Virtual_Guest_Network_ComponentArray

• parameters

None

---

getBackendRouters

Retrieve a guest's backend or private router.

• returns

SoftLayer_HardwareArray

• parameters

None

---

getBandwidthAllocation

Retrieve a computing instance's allotted bandwidth (measured in GB).

• returns

decimal

• parameters

None

---

getBandwidthAllotmentDetail

Retrieve a computing instance's allotted detail record. Allotment details link bandwidth allocation with allotments.

• returns

SoftLayer_Network_Bandwidth_Version1_Allotment_Detail

• parameters

None

---

getBandwidthDataByDate

Retrieve the amount of network traffic that occurred for the specified time frame for a computing instance.

• returns

SoftLayer_Metric_Tracking_Object_DataArray

• parameters

dateTime startDateTime

dateTime endDateTime

string networkType

---

getBandwidthImage

Retrieve a visual representation of the amount of network traffic that occurred for the specified time frame for a computing instance.

• returns

SoftLayer_Container_Bandwidth_GraphOutputs

• parameters

string networkType

string snapshotRange

dateTime dateSpecified

---

getBandwidthImageByDate

Retrieve a visual representation of the amount of network traffic that occurred for the specified time frame for a computing instance.

• returns

SoftLayer_Container_Bandwidth_GraphOutputs

• parameters

dateTime startDateTime

dateTime endDateTime

string networkType

---

getBandwidthTotal

Retrieve total amount of network traffic that was in use during the time specified by the input parameters for a computing instance.

• returns

unsigned long

• parameters

integer startDateTime

integer endDateTime

string direction

string side

---

getBillingCycleBandwidthUsage

Retrieve the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to.

• returns

SoftLayer_Network_Bandwidth_UsageArray

• parameters

None

---

getBillingCyclePrivateBandwidthUsage

Retrieve the raw private bandwidth usage data for the current billing cycle.

• returns

SoftLayer_Network_Bandwidth_Usage

• parameters

None

---

getBillingCyclePublicBandwidthUsage

Retrieve the raw public bandwidth usage data for the current billing cycle.

• returns

SoftLayer_Network_Bandwidth_Usage

• parameters

None

---

getBillingItem

Retrieve the billing item for a CloudLayer Compute Instance.

• returns

SoftLayer_Billing_Item

• parameters

None

---

getBlockDevices

Retrieve a computing instance's block devices. Block devices link disk images to computing instances.

• returns

SoftLayer_Virtual_Guest_Block_DeviceArray

• parameters

None

---

getConsoleAccessLog

get console access logs

• returns

SoftLayer_Network_Logging_SyslogArray

• parameters

None

---

getConsoleIpAddressRecord

Retrieve a record containing information about a computing instance's console IP and port number.

• returns

SoftLayer_Virtual_Guest_Network_Component_IpAddress

• parameters

None

---

getControlPanel

Retrieve a guest's control panel.

• returns

SoftLayer_Software_Component

• parameters

None

---

getCpuMetricDataByDate

Retrieve records containing the percentage of the amount of time that a cpu was in use for the specified time frame for a computing instance.

• returns

SoftLayer_Metric_Tracking_Object_DataArray

• parameters

dateTime startDateTime

dateTime endDateTime

array of integers cpuIndexes

---

getCpuMetricImage

Retrieve a visual representation of the percentage of the amount of time that a cpu was in use for the specified time frame for a computing instance.

• returns

SoftLayer_Container_Bandwidth_GraphOutputs

• parameters

string snapshotRange

dateTime dateSpecified

---

getCpuMetricImageByDate

Retrieve a visual representation of the percentage of the amount of time that a cpu was in use for the specified time frame for a computing instance.

• returns

SoftLayer_Container_Bandwidth_GraphOutputs

• parameters

dateTime startDateTime

dateTime endDateTime

array of integers cpuIndexes

---

getCurrentBillingDetail

Get the detail billing data for this instance's current billing period. This excludes bandwidth usage.

• returns

SoftLayer_Billing_ItemArray

• parameters

None

---

getCurrentBillingTotal

Get the total billing price for this instance's hourly usage up to this point. This includes total includes all bandwidth charges.

• returns

decimal

• parameters

None

---

getDataMinMax

Retrieve the dates that the maximum and minimum data was received for a computing instance

• returns

SoftLayer_Metric_Tracking_Object_DataArray

• parameters

None

---

getDatacenter

Retrieve the datacenter that a virtual guest resides in.

• returns

SoftLayer_Location

• parameters

None

---

getEvaultNetworkStorage

Retrieve a guest's associated EVault network storage service account.

• returns

SoftLayer_Network_StorageArray

• parameters

None

---

getFirewallServiceComponent

Retrieve a computing instance's hardware firewall services.

• returns

SoftLayer_Network_Component_Firewall

• parameters

None

---

getFrontendNetworkComponents

Retrieve a guests's frontend network components.

• returns

SoftLayer_Virtual_Guest_Network_ComponentArray

• parameters

None

---

getFrontendRouters

Retrieve a guest's frontend or public router.

• returns

SoftLayer_Hardware

• parameters

None

---

getHost

Retrieve the virtual host on which a virtual guest resides.

• returns

SoftLayer_Virtual_Host

• parameters

None

---

getHostIpsSoftwareComponent

Retrieve a host IPS software component object.

• returns

SoftLayer_Software_Component

• parameters

None

---

getHourlyBillingFlag

Retrieve whether or not a computing instance is billed hourly instead of monthly.

• returns

boolean

• parameters

None

---

getInboundPrivateBandwidthUsage

Retrieve the total private inbound bandwidth for this computing instance for the current billing cycle.

• returns

decimal

• parameters

None

---

getInboundPublicBandwidthUsage

Retrieve the total public inbound bandwidth for this computing instance for the current billing cycle.

• returns

decimal

• parameters

None

---

getLastOperatingSystemReload

Retrieve the last transaction that a cloud server's operating system was loaded.

• returns

SoftLayer_Provisioning_Version1_Transaction

• parameters

None

---

getLastTransaction

Retrieve the last transaction a cloud server had performed.

• returns

SoftLayer_Provisioning_Version1_Transaction

• parameters

None

---

getLocation

Retrieve where guest is located within SoftLayer's location hierarchy.

• returns

SoftLayer_Location

• parameters

None

---

getMemoryMetricDataByDate

Retrieve records containing the amount memory that was used for the specified time frame for a computing instance.

• returns

SoftLayer_Metric_Tracking_Object_DataArray

• parameters

dateTime startDateTime

dateTime endDateTime

---

getMemoryMetricImage

Retrieve a visual representation of the amount of memory used for the specified time frame for a computing instance.

• returns

SoftLayer_Container_Bandwidth_GraphOutputs

• parameters

string snapshotRange

dateTime dateSpecified

---

getMemoryMetricImageByDate

Retrieve a visual representation of the amount of memory used for the specified time frame for a computing instance.

• returns

SoftLayer_Container_Bandwidth_GraphOutputs

• parameters

dateTime startDateTime

dateTime endDateTime

---

getMetricTrackingObject

Retrieve a guest's metric tracking object.

• returns

SoftLayer_Metric_Tracking_Object

• parameters

None

---

getMonitoringUserNotification

Retrieve the monitoring notification objects for this guest. Each object links this guest instance to a user account that will be notified if monitoring on this guest object fails

• returns

SoftLayer_User_Customer_Notification_Virtual_GuestArray

• parameters

None

---

getNetworkComponentFirewallProtectableIpAddresses

Get the IP addresses associated with this CloudLayer computing instance that are protectable by a network component firewall.

• returns

SoftLayer_Network_Subnet_IpAddressArray

• parameters

None

---

getNetworkComponents

Retrieve a guests's network components.

• returns

SoftLayer_Virtual_Guest_Network_ComponentArray

• parameters

None

---

getNetworkMonitors

Retrieve a guests's network monitors.

• returns

SoftLayer_Network_Monitor_Version1_Query_HostArray

• parameters

None

---

getNetworkStorage

Retrieve a guest's associated network storage accounts.

• returns

SoftLayer_Network_StorageArray

• parameters

None

---

getNetworkVlans

Retrieve the network Vlans that a guest's network components are associated with.

• returns

SoftLayer_Network_VlanArray

• parameters

None

---

getObject

Retrieve a SoftLayer_Virtual_Guest record.

• returns

SoftLayer_Virtual_Guest

• parameters

None

---

getOperatingSystem

Retrieve a guest's operating system.

• returns

SoftLayer_Software_Component

• parameters

None

---

getOrderTemplate

Obtain an order container that is ready to be sent to the SoftLayer_Product_Order::placeOrder method.

• returns

SoftLayer_Container_Product_Order

• parameters

string billingType

---

getOutboundPrivateBandwidthUsage

Retrieve the total private outbound bandwidth for this computing instance for the current billing cycle.

• returns

decimal

• parameters

None

---

getOutboundPublicBandwidthUsage

Retrieve the total public outbound bandwidth for this computing instance for the current billing cycle.

• returns

decimal

• parameters

None

---

getPowerState

Retrieve the current power state of a virtual guest.

• returns

SoftLayer_Virtual_Guest_Power_State

• parameters

None

---

getPrimaryBackendIpAddress

Retrieve a guest's primary private IP address.

• returns

string

• parameters

None

---

getPrimaryBackendNetworkComponent

Retrieve a guest's primary backend network component.

• returns

SoftLayer_Virtual_Guest_Network_Component

• parameters

None

---

getPrimaryIpAddress

Retrieve the guest's primary public IP address.

• returns

string

• parameters

None

---

getPrimaryNetworkComponent

Retrieve a guest's primary public network component.

• returns

SoftLayer_Virtual_Guest_Network_Component

• parameters

None

---

getProvisionDate

Retrieve the date a cloud server was ordered.

• returns

dateTime

• parameters

None

---

getRecentMetricData

Recent metric data for a guest

• returns

SoftLayer_Metric_Tracking_ObjectArray

• parameters

unsigned integer time

---

getReverseDomainRecords

Retrieve the reverse domain records associated with a server.

• returns

SoftLayer_Dns_DomainArray

• parameters

None

---

getSecurityScanRequests

Retrieve a guest's vulnerability scan requests.

• returns

SoftLayer_Network_Security_Scanner_RequestArray

• parameters

None

---

getServerRoom

Retrieve the server room that a guest is located at. There may be more than one server room for every data center.

• returns

SoftLayer_Location

• parameters

None

---

getSoftwareComponents

Retrieve a guest's installed software.

• returns

SoftLayer_Software_ComponentArray

• parameters

None

---

getUpgradeItemPrices

Retrieve a computing instance's upgradeable items.

• returns

SoftLayer_Product_Item_PriceArray

• parameters

boolean includeDowngradeItemPrices

---

getUpgradeRequest

Retrieve a computing instance's associated upgrade request object if any.

• returns

SoftLayer_Product_Upgrade_Request

• parameters

None

---

getUsers

Retrieve a list of users that have access to this computing instance.

• returns

SoftLayer_User_CustomerArray

• parameters

None

---

getVirtualRack

Retrieve the name of the bandwidth allotment that a hardware belongs too.

• returns

SoftLayer_Network_Bandwidth_Version1_Allotment

• parameters

None

---

getVirtualRackId

Retrieve the id of the bandwidth allotment that a computing instance belongs too.

• returns

integer

• parameters

None

---

getVirtualRackName

Retrieve the name of the bandwidth allotment that a computing instance belongs too.

• returns

string

• parameters

None

---

isBackendPingable

Verifies if a guest's backend ip address is pingable.

• returns

boolean

• parameters

None

---

isPingable

Verifies if guest is pingable.

• returns

boolean

• parameters

None

---

pause

Pause a guest.

• returns

boolean

• parameters

None

---

powerCycle

Power cycle a guest.

• returns

boolean

• parameters

None

---

powerOff

Power off a guest.

• returns

boolean

• parameters

None

---

powerOffSoft

Cleanly shut down a guest and disable power

• returns

boolean

• parameters

None

---

powerOn

Power on a guest.

• returns

boolean

• parameters

None

---

rebootDefault

Power cycle a guest.

• returns

boolean

• parameters

None

---

rebootHard

Power cycle a guest.

• returns

boolean

• parameters

None

---

rebootSoft

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

• returns

boolean

• parameters

None

---

reloadCurrentOperatingSystemConfiguration

Perform an OS reload

• returns

SoftLayer_Provisioning_Version1_Transaction

• parameters

None

---

reloadOperatingSystem

Reloads operating system configuration.

• returns

string

• parameters

string token

SoftLayer_Container_Hardware_Server_Configuration config

---

resume

Resume a guest.

• returns

boolean

• parameters

None

---

setPrivateNetworkInterfaceSpeed

Updates the private network interface (eth0) speed.

• returns

boolean

• parameters

integer newSpeed

---

setPublicNetworkInterfaceSpeed

Updates the public network interface (eth1) speed.

• returns

boolean

• parameters

integer newSpeed

---

shutdownPrivatePort

Shuts down the public port

• returns

boolean

• parameters

None

---

shutdownPublicPort

Shuts down the public port

• returns

boolean

• parameters

None