SoftLayer_Virtual_Guest


SoftLayer_Virtual_Guest

Description

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.

Methods

activatePrivatePort

Activate the private port

activatePublicPort

Activate the public port

allowAccessToNetworkStorage

Allow access to a SoftLayer_Network_Storage volume from this device.

allowAccessToNetworkStorageList

Allow access to multiple SoftLayer_Network_Storage volumes from this device.

attachDiskImage

Attaches a disk image.

cancelIsolationForDestructiveAction

Reopens the public and/or private ports to reverse the changes made when the server was isolated for a destructive action.

captureImage

Captures a Flex Image of the hard disk on the virtual machine.

checkHostDiskAvailability

Checks the associated host for available disk space to determine if guest migration is necessary. This method is only used with local disks. If this method returns false, calling attachDiskImage($imageId) will automatically migrate the destination guest to a new host before attaching the portable …

configureMetadataDisk

Configures the guest’s metadata disk.

createArchiveTemplate

SoftLayer_Virtual_Guest_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.

createArchiveTransaction

SoftLayer_Virtual_Guest_Block_Device 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.

createObject

Create a new computing instance

createObjects

Create new computing instances

deleteObject

Delete a computing instance

deleteTag

Delete a tag

detachDiskImage

Detaches a disk image.

editObject

Edit a computing instance’s properties

executeIderaBareMetalRestore

Reboot a guest into the Idera Bare Metal Restore image.

executeR1SoftBareMetalRestore

Reboot a guest into the R1Soft Bare Metal Restore image.

executeRemoteScript

Download and run remote script from uri on the virtual guest. Requires https for script to be executed after download.

executeRescueLayer

Reboot a Linux guest into the Xen rescue image.

findByHostname

Find VSIs by hostname.

findByIpAddress

Find CCI by its primary public or private IP (ipv4) address.

generateOrderTemplate

Obtain an order container for a given template object

getAccount

The account that a virtual guest belongs to.

getActiveNetworkMonitorIncident

A virtual guest’s currently active network monitoring incidents.

getActiveTransaction

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

getActiveTransactions

Any active transaction(s) that are currently running for the server (example: os reload).

getAdditionalRequiredPricesForOsReload

Return a collection of SoftLayer_Item_Price objects for an OS reload

getAllowedHost

The SoftLayer_Network_Storage_Allowed_Host information to connect this Virtual Guest to Network Storage volumes that require access control lists.

getAllowedNetworkStorage

The SoftLayer_Network_Storage objects that this SoftLayer_Virtual_Guest has access to.

getAllowedNetworkStorageReplicas

The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Virtual_Guest has access to.

getAntivirusSpywareSoftwareComponent

A antivirus / spyware software component object.

getAttachedNetworkStorages

Return a list of SoftLayer_Network_Storage volumes authorized to this device.

getAvailableMonitoring

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

getAvailableNetworkStorages

Return a list of SoftLayer_Network_Storage volumes that can be authorized to this device.

getAverageDailyPrivateBandwidthUsage

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

getAverageDailyPublicBandwidthUsage

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

getBackendNetworkComponents

A guests’s backend network components.

getBackendRouters

A guest’s backend or private router.

getBandwidthAllocation

A computing instance’s allotted bandwidth (measured in GB).

getBandwidthAllotmentDetail

A computing instance’s allotted detail record. Allotment details link bandwidth allocation with allotments.

getBandwidthDataByDate

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

getBandwidthForDateRange

Retrieve bandwidth data from a tracking object.

getBandwidthImage

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

getBandwidthImageByDate

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

getBandwidthTotal

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

getBillingCycleBandwidthUsage

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

getBillingCyclePrivateBandwidthUsage

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

getBillingCyclePublicBandwidthUsage

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

getBillingItem

The billing item for a CloudLayer Compute Instance.

getBlockCancelBecauseDisconnectedFlag

Determines whether the instance is ineligible for cancellation because it is disconnected.

getBlockDeviceTemplateGroup

The global identifier for the image template that was used to provision or reload a guest.

getBlockDevices

A computing instance’s block devices. Block devices link SoftLayer_Virtual_Disk_Image to computing instances.

getBootMode

Retrieves the boot mode of the VSI.

getBrowserConsoleAccessLogs

A virtual guest’s browser access logs.

getConsoleAccessLog

get console access logs

getConsoleData

A container for a guest’s console data

getConsoleIpAddressFlag

A flag indicating a computing instance’s console IP address is assigned.

getConsoleIpAddressRecord

A record containing information about a computing instance’s console IP and port number.

getContinuousDataProtectionSoftwareComponent

A continuous data protection software component object.

getControlPanel

A guest’s control panel.

getCoreRestrictedOperatingSystemPrice

Return the associated core-restricted operating system item price for the virtual server.

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.

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.

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.

getCreateObjectOptions

Determine options available when creating a computing instance

getCurrentBandwidthSummary

An object that provides commonly used bandwidth summary components for the current billing cycle.

getCurrentBillingTotal

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

getCustomBandwidthDataByDate

Retrieve bandwidth graph by date.

getCustomMetricDataByDate

Retrieve bandwidth graph by date.

getDatacenter

The datacenter that a virtual guest resides in.

getDedicatedHost

The dedicated host associated with this guest.

getDeviceStatus

The device status of this virtual guest.

getDriveRetentionItemPrice

Return a drive retention SoftLayer_Item_Price object for a guest.

getEvaultNetworkStorage

A guest’s associated EVault network storage service account.

getFirewallProtectableSubnets

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

getFirewallServiceComponent

A computing instance’s hardware firewall services.

getFrontendNetworkComponents

A guest’s frontend network components.

getFrontendRouters

A guest’s frontend or public router.

getGlobalIdentifier

A guest’s universally unique identifier.

getGpuCount

The number of GPUs attached to the guest.

getGpuType

The name of the GPU type attached to the guest.

getHardwareFunctionDescription

The object’s function.

getHost

The virtual host on which a virtual guest resides (available only on private clouds).

getHostIpsSoftwareComponent

A host IPS software component object.

getHourlyBillingFlag

A guest’s hourly billing status.

getInboundPrivateBandwidthUsage

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

getInboundPublicBandwidthUsage

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

getItemPricesFromSoftwareDescriptions

Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description

getLastKnownPowerState

The last known power state of a virtual guest in the event the guest is turned off outside of IMS or has gone offline.

getLastOperatingSystemReload

The last transaction that a cloud server’s operating system was loaded.

getLastTransaction

The last transaction a cloud server had performed.

getLatestNetworkMonitorIncident

A virtual guest’s latest network monitoring incident.

getLocalDiskFlag

A flag indicating that the virtual guest has at least one disk which is local to the host it runs on. This does not include a SWAP device.

getLocation

Where guest is located within SoftLayer’s location hierarchy.

getManagedResourceFlag

A flag indicating that the virtual guest is a managed resource.

getMemoryMetricDataByDate

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

getMemoryMetricImage

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

getMemoryMetricImageByDate

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

getMetricTrackingObject

A guest’s metric tracking object.

getMetricTrackingObjectId

The metric tracking object id for this guest.

getMonitoringServiceComponent

A virtual guest’s network monitoring services.

getMonitoringUserNotification

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

getNetworkComponentFirewallProtectableIpAddresses

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

getNetworkComponents

A guests’s network components.

getNetworkMonitorIncidents

All of a virtual guest’s network monitoring incidents.

getNetworkMonitors

A guests’s network monitors.

getNetworkStorage

A guest’s associated network storage accounts.

getNetworkVlans

The network Vlans that a guest’s network components are associated with.

getObject

Retrieve a SoftLayer_Virtual_Guest record.

getOpenCancellationTicket

An open ticket requesting cancellation of this server, if one exists.

getOperatingSystem

A guest’s operating system.

getOperatingSystemReferenceCode

A guest’s operating system software description.

getOrderTemplate

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

getOrderedPackageId

The original package id provided with the order for a Cloud Computing Instance.

getOutboundPrivateBandwidthUsage

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

getOutboundPublicBandwidthUsage

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

getOverBandwidthAllocationFlag

Whether the bandwidth usage for this computing instance for the current billing cycle exceeds the allocation.

getPendingMaintenanceActions

Returns a list of all the pending maintenance actions affecting this guest.

getPendingMigrationFlag

When true this virtual guest must be migrated using SoftLayer_Virtual_Guest::migrate.

getPlacementGroup

The placement group that a virtual guest belongs to.

getPowerState

The current power state of a virtual guest.

getPrimaryBackendIpAddress

A guest’s primary private IP address.

getPrimaryBackendNetworkComponent

A guest’s primary backend network component.

getPrimaryIpAddress

The guest’s primary public IP address.

getPrimaryNetworkComponent

A guest’s primary public network component.

getPrivateNetworkOnlyFlag

Whether the computing instance only has access to the private network.

getProjectedOverBandwidthAllocationFlag

Whether the bandwidth usage for this computing instance for the current billing cycle is projected to exceed the allocation.

getProjectedPublicBandwidthUsage

The projected public outbound bandwidth for this computing instance for the current billing cycle.

getRecentEvents

Recent events that impact this computing instance.

getRecentMetricData

Recent metric data for a guest

getRegionalGroup

The regional group this guest is in.

getReservedCapacityGroup

The reserved capacity group the guest is associated with.

getReservedCapacityGroupFlag

Flag to indicate whether or not a guest is part of a reserved capacity group.

getReservedCapacityGroupInstance

The reserved capacity group instance the guest is associated with.

getReverseDomainRecords

Retrieve the reverse domain records associated with a server.

getScaleAssets

Collection of scale assets this guest corresponds to.

getScaleMember

The scale member for this guest, if applicable.

getScaledFlag

Whether or not this guest is a member of a scale group and was automatically created as part of a scale group action.

getSecurityScanRequests

A guest’s vulnerability scan requests.

getServerRoom

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

getSoftwareComponents

A guest’s installed software.

getSshKeys

SSH keys to be installed on the server during provisioning or an OS reload.

getStatus

A computing instance’s status.

getTransientGuestFlag

Whether or not a computing instance is a Transient Instance.

getTransientWebhookURI

The endpoint used to notify customers their transient guest is terminating.

getType

The type of this virtual guest.

getUpgradeItemPrices

Retrieve a computing instance’s upgradeable items.

getUpgradeRequest

A computing instance’s associated upgrade request object if any.

getUserData

A base64 encoded string containing custom user data for a Cloud Computing Instance order.

getUsers

A list of users that have access to this computing instance.

getValidBlockDeviceTemplateGroups

Return a list of valid block device template groups based on this host

getVirtualRack

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

getVirtualRackId

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

getVirtualRackName

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

isBackendPingable

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

isCloudInit

Determines if the virtual guest was provisioned from a cloud-init enabled image.

isPingable

Verifies if guest is pingable.

isolateInstanceForDestructiveAction

Closes the public or private ports to isolate the instance before a destructive action.

migrate

Creates a transaction to migrate a virtual guest to a new host. NOTE: Will only migrate if SoftLayer_Virtual_Guest property pendingMigrationFlag = true

migrateDedicatedHost

Migrate a dedicated instance from one dedicated host to another dedicated host

pause

Pause a guest.

powerCycle

Power cycle a guest.

powerOff

Power off a guest.

powerOffSoft

Cleanly shut down a guest and disable power

powerOn

Power on a guest.

rebootDefault

Power cycle a guest.

rebootHard

Power cycle a guest.

rebootSoft

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

reloadOperatingSystem

Reloads operating system configuration.

removeAccessToNetworkStorage

Remove access to a SoftLayer_Network_Storage volume from this device.

removeAccessToNetworkStorageList

Remove access to multiple SoftLayer_Network_Storage volumes from this device.

removeTags

Remove a tag reference

resume

Resume a guest.

setPrivateNetworkInterfaceSpeed

Updates the private network interface (eth0) speed.

setPublicNetworkInterfaceSpeed

Updates the public network interface (eth1) speed.

setUserMetadata

Configures the guest’s metadata disk.

shutdownPrivatePort

Shuts down the private port

shutdownPublicPort

Shuts down the public port

validateImageTemplate

Validates an image template for OS Reload

verifyReloadOperatingSystem

Verify that a virtual server can go through the operating system reload process.