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.
captureImage
Captures a Flex Image of the hard disk on the virtual machine.
closeAlarm
Returns monitoring alarm detailed history
configureMetadataDisk
Configures the guest's metadata disk.
createArchiveTransaction
[[SoftLayer_Virtual_Guest_Block_Devices|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.
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.
findByIpAddress
Find CCI by its primary public or private IP (ipv4) address.
generateOrderTemplate
Obtain an order container for a given template object
getAccount
Retrieve the account that a virtual guest belongs to.
getActiveNetworkMonitorIncident
Retrieve a virtual guest's currently active network monitoring incidents.
getActiveTransaction
Retrieve a transaction that is still be performed on a cloud server.
getActiveTransactions
Retrieve 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
getAlarmHistory
Returns monitoring alarm detailed history
getAllowedHost
Retrieve the SoftLayer_Network_Storage_Allowed_Host information to connect this Virtual Guest to Network Storage volumes that require access control lists.
getAllowedNetworkStorage
Retrieve the SoftLayer_Network_Storage objects that this SoftLayer_Virtual_Guest has access to.
getAllowedNetworkStorageReplicas
Retrieve the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Virtual_Guest has access to.
getAntivirusSpywareSoftwareComponent
Retrieve a antivirus / spyware software component object.
getAttachedNetworkStorages
Return a list of SoftLayer_Network_Storage volumes authorized to this device.
getAvailableMonitoring
Retrieve 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
Retrieve the average daily private bandwidth usage for the current billing cycle.
getAverageDailyPublicBandwidthUsage
Retrieve the average daily public bandwidth usage for the current billing cycle.
getBackendNetworkComponents
Retrieve a guests's backend network components.
getBackendRouters
Retrieve a guest's backend or private router.
getBandwidthAllocation
Retrieve a computing instance's allotted bandwidth (measured in GB).
getBandwidthAllotmentDetail
Retrieve 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
Retrieve the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to.
getBillingCyclePrivateBandwidthUsage
Retrieve the raw private bandwidth usage data for the current billing cycle.
getBillingCyclePublicBandwidthUsage
Retrieve the raw public bandwidth usage data for the current billing cycle.
getBillingItem
Retrieve the billing item for a CloudLayer Compute Instance.
getBlockCancelBecauseDisconnectedFlag
Retrieve determines whether the instance is ineligible for cancellation because it is disconnected.
getBlockDeviceTemplateGroup
Retrieve the global identifier for the image template that was used to provision or reload a guest.
getBlockDevices
Retrieve a computing instance's block devices. Block devices link [[SoftLayer_Virtual_Disk_Image|disk images]] to computing instances.
getBootMode
Retrieves the boot mode of the VSI.
getConsoleAccessLog
get console access logs
getConsoleIpAddressFlag
Retrieve a flag indicating a computing instance's console IP address is assigned.
getConsoleIpAddressRecord
Retrieve a record containing information about a computing instance's console IP and port number.
getContinuousDataProtectionSoftwareComponent
Retrieve a continuous data protection software component object.
getControlPanel
Retrieve 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
Retrieve 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
Retrieve the datacenter that a virtual guest resides in.
getDedicatedHost
Retrieve the dedicated host associated with this guest.
getDriveRetentionItemPrice
Return a drive retention SoftLayer_Item_Price object for a guest.
getEvaultNetworkStorage
Retrieve 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
Retrieve a computing instance's hardware firewall services.
getFrontendNetworkComponents
Retrieve a guest's frontend network components.
getFrontendRouters
Retrieve a guest's frontend or public router.
getGlobalIdentifier
Retrieve a guest's universally unique identifier.
getHost
Retrieve the virtual host on which a virtual guest resides (available only on private clouds).
getHostIpsSoftwareComponent
Retrieve a host IPS software component object.
getHourlyBillingFlag
Retrieve a guest's hourly billing status.
getInboundPrivateBandwidthUsage
Retrieve the total private inbound bandwidth for this computing instance for the current billing cycle.
getInboundPublicBandwidthUsage
Retrieve 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
Retrieve 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
Retrieve the last transaction that a cloud server's operating system was loaded.
getLastTransaction
Retrieve the last transaction a cloud server had performed.
getLatestNetworkMonitorIncident
Retrieve a virtual guest's latest network monitoring incident.
getLocalDiskFlag
Retrieve 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
Retrieve where guest is located within SoftLayer's location hierarchy.
getManagedResourceFlag
Retrieve 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
Retrieve a guest's metric tracking object.
getMetricTrackingObjectId
Retrieve the metric tracking object id for this guest.
getMonitoringActiveAlarms
Returns open monitoring alarms for a given time period
getMonitoringClosedAlarms
Returns closed monitoring alarms for a given time period
getMonitoringServiceComponent
Retrieve a virtual guest's network monitoring services.
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
getNetworkComponentFirewallProtectableIpAddresses
Get the IP addresses associated with this CloudLayer computing instance that are protectable by a network component firewall.
getNetworkComponents
Retrieve a guests's network components.
getNetworkMonitorIncidents
Retrieve all of a virtual guest's network monitoring incidents.
getNetworkMonitors
Retrieve a guests's network monitors.
getNetworkStorage
Retrieve a guest's associated network storage accounts.
getNetworkVlans
Retrieve the network Vlans that a guest's network components are associated with.
getObject
Retrieve a SoftLayer_Virtual_Guest record.
getOpenCancellationTicket
Retrieve an open ticket requesting cancellation of this server, if one exists.
getOperatingSystem
Retrieve a guest's operating system.
getOperatingSystemReferenceCode
Retrieve 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
Retrieve the original package id provided with the order for a Cloud Computing Instance.
getOutboundPrivateBandwidthUsage
Retrieve the total private outbound bandwidth for this computing instance for the current billing cycle.
getOutboundPublicBandwidthUsage
Retrieve the total public outbound bandwidth for this computing instance for the current billing cycle.
getOverBandwidthAllocationFlag
Retrieve whether the bandwidth usage for this computing instance for the current billing cycle exceeds the allocation.
getPendingMigrationFlag
Retrieve when true this virtual guest must be migrated using SoftLayer_Virtual_Guest::migrate.
getPlacementGroup
Retrieve the placement group that a virtual guest belongs to.
getPowerState
Retrieve the current power state of a virtual guest.
getPrimaryBackendIpAddress
Retrieve a guest's primary private IP address.
getPrimaryBackendNetworkComponent
Retrieve a guest's primary backend network component.
getPrimaryIpAddress
Retrieve the guest's primary public IP address.
getPrimaryNetworkComponent
Retrieve a guest's primary public network component.
getPrivateNetworkOnlyFlag
Retrieve whether the computing instance only has access to the private network.
getProjectedOverBandwidthAllocationFlag
Retrieve whether the bandwidth usage for this computing instance for the current billing cycle is projected to exceed the allocation.
getProjectedPublicBandwidthUsage
Retrieve the projected public outbound bandwidth for this computing instance for the current billing cycle.
getRecentEvents
Retrieve recent events that impact this computing instance.
getRecentMetricData
Recent metric data for a guest
getRegionalGroup
Retrieve the regional group this guest is in.
getRemoteMonitoringActiveAlarms
Returns open monitoring alarms for a given time period
getRemoteMonitoringClosedAlarms
Returns closed monitoring alarms for a given time period
getReservedCapacityGroup
Retrieve the reserved capacity group the guest is associated with.
getReservedCapacityGroupFlag
Retrieve flag to indicate whether or not a guest is part of a reserved capacity group.
getReservedCapacityGroupInstance
Retrieve the reserved capacity group instance the guest is associated with.
getReverseDomainRecords
Retrieve the reverse domain records associated with a server.
getScaleAssets
Retrieve collection of scale assets this guest corresponds to.
getScaleMember
Retrieve the scale member for this guest, if applicable.
getScaledFlag
Retrieve whether or not this guest is a member of a scale group and was automatically created as part of a scale group action.
getSecurityScanRequests
Retrieve a guest's vulnerability scan requests.
getServerRoom
Retrieve the server room that a guest is located at. There may be more than one server room for every data center.
getSoftwareComponents
Retrieve a guest's installed software.
getSshKeys
Retrieve sSH keys to be installed on the server during provisioning or an OS reload.
getStatus
Retrieve a computing instance's status.
getTransientGuestFlag
Retrieve whether or not a computing instance is a Transient Instance.
getTransientWebhookURI
Retrieve the endpoint used to notify customers their transient guest is terminating.
getType
Retrieve the type of this virtual guest.
getUpgradeItemPrices
Retrieve a computing instance's upgradeable items.
getUpgradeRequest
Retrieve a computing instance's associated upgrade request object if any.
getUserData
Retrieve a base64 encoded string containing custom user data for a Cloud Computing Instance order.
getUsers
Retrieve 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
Retrieve the name of the bandwidth allotment that a hardware belongs too.
getVirtualRackId
Retrieve the id of the bandwidth allotment that a computing instance belongs too.
getVirtualRackName
Retrieve the name of the bandwidth allotment that a computing instance belongs too.
isBackendPingable
Verifies if a guest's backend ip address is pingable.
isPingable
Verifies if guest is pingable.
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.

/reference/services/SoftLayer_Virtual_Guest/