Virtual
SoftLayer_Virtual_Guest

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.

Methods

Activate the private port

Activate the public port

Allow access to a SoftLayer_Network_Storage volume from this device.

Allow access to multiple SoftLayer_Network_Storage volumes from this device.

Attaches a disk image.

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

Returns monitoring alarm detailed history

Configures the guest's metadata disk.

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.

Create a new computing instance

Create new computing instances

Delete a computing instance

Detaches a disk image.

Edit a computing instance's properties

Reboot a guest into the Idera Bare Metal Restore image.

Reboot a guest into the R1Soft Bare Metal Restore image.

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

Reboot a Linux guest into the Xen rescue image.

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

Obtain an order container for a given template object

Retrieve the account that a virtual guest belongs to.

Retrieve a virtual guest's currently active network monitoring incidents.

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

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

Return a collection of SoftLayer_Item_Price objects for an OS reload

Returns monitoring alarm detailed history

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

Retrieve the SoftLayer_Network_Storage objects that this SoftLayer_Virtual_Guest has access to.

Retrieve the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Virtual_Guest has access to.

Retrieve a antivirus / spyware software component object.

Return a list of SoftLayer_Network_Storage volumes authorized to this device.

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

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

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

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

Retrieve a guests's backend network components.

Retrieve a guest's backend or private router.

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

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

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

Retrieve bandwidth data from a tracking object.

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

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

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

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

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

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

Retrieve the billing item for a CloudLayer Compute Instance.

Retrieve determines whether the instance is ineligible for cancellation because it is disconnected.

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

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

get console access logs

Retrieve a flag indicating a computing instance's console IP address is assigned.

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

Retrieve a continuous data protection software component object.

Retrieve a guest's control panel.

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

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.

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.

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.

Determine options available when creating a computing instance

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

Retrieve a computing instance's upgradeable items.

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

Retrieve bandwidth graph by date.

Retrieve bandwidth graph by date.

Retrieve the datacenter that a virtual guest resides in.

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

Return a drive retention SoftLayer_Item_Price object for a guest.

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

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

Retrieve a computing instance's hardware firewall services.

Retrieve a guest's frontend network components.

Retrieve a guest's frontend or public router.

Retrieve a guest's universally unique identifier.

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

Retrieve a host IPS software component object.

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

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

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

Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description

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.

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

Retrieve the last transaction a cloud server had performed.

Retrieve a virtual guest's latest network monitoring incident.

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.

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

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

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

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

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

Retrieve a guest's metric tracking object.

Retrieve the metric tracking object id for this guest.

Returns open monitoring alarms for a given time period

Returns closed monitoring alarms for a given time period

Retrieve a virtual guest's network monitoring services.

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

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

Retrieve a guests's network components.

Retrieve all of a virtual guest's network monitoring incidents.

Retrieve a guests's network monitors.

Retrieve a guest's associated network storage accounts.

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

Retrieve a SoftLayer_Virtual_Guest record.

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

Retrieve a guest's operating system.

Retrieve a guest's operating system software description.

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

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

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

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

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

Retrieve the current power state of a virtual guest.

Retrieve a guest's primary private IP address.

Retrieve a guest's primary backend network component.

Retrieve the guest's primary public IP address.

Retrieve a guest's primary public network component.

Retrieve whether the computing instance only has access to the private network.

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

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

Retrieve recent events that impact this computing instance.

Recent metric data for a guest

Retrieve the regional group this guest is in.

Returns open monitoring alarms for a given time period

Returns closed monitoring alarms for a given time period

Retrieve the reverse domain records associated with a server.

Retrieve collection of scale assets this guest corresponds to.

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

Retrieve the scale member for this guest, if applicable.

Retrieve a guest's vulnerability scan requests.

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

Retrieve a guest's installed software.

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

Retrieve a computing instance's status.

Retrieve a computing instance's upgradeable items.

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

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

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

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

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

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

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

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

Verifies if guest is pingable.

Pause a guest.

Power cycle a guest.

Power off a guest.

Cleanly shut down a guest and disable power

Power on a guest.

Power cycle a guest.

Power cycle a guest.

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

Reloads operating system configuration.

Remove access to a SoftLayer_Network_Storage volume from this device.

Remove access to multiple SoftLayer_Network_Storage volumes from this device.

Resume a guest.

Updates the private network interface (eth0) speed.

Updates the public network interface (eth1) speed.

Configures the guest's metadata disk.

Shuts down the private port

Shuts down the public port

Validates an image template for OS Reload

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