"SoftLayer_" prefix removed for readability.
The virtual guest data type presents the structure in which all virtual guests will be presented. Internally, the structure supports various virtualization platforms with no change to external interaction.
A guest, also known as a virtual server, represents an allocation of resources on a virtual host.
When true this flag specifies that a compute instance is to run on hosts that only have guests from the same account.
Type:
boolean
A name reflecting the hostname and domain of the computing instance.
Type:
string
The last timestamp of when the guest was verified as a resident virtual machine on the host’s hypervisor platform.
Type:
dateTime
The unit of the maximum amount of CPU resources a computing instance may utilize.
Type:
string
URI of the script to be downloaded and executed after installation is complete. This is deprecated in favor of supplementalCreateObjectOptions’ postInstallScriptUri.
Type:
string
Deprecated
A virtual guest’s currently active network monitoring incidents.
Type:
SoftLayer_Network_Monitor_Version1_Incident[]
A transaction that is still be performed on a cloud server.
Type:
SoftLayer_Provisioning_Version1_Transaction
Any active transaction(s) that are currently running for the server (example: os reload).
Type:
SoftLayer_Provisioning_Version1_Transaction[]
The SoftLayer_Network_Storage_Allowed_Host information to connect this Virtual Guest to Network Storage volumes that require access control lists.
Type:
SoftLayer_Network_Storage_Allowed_Host
The SoftLayer_Network_Storage objects that this SoftLayer_Virtual_Guest has access to.
Type:
SoftLayer_Network_Storage[]
The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Virtual_Guest has access to.
Type:
SoftLayer_Network_Storage[]
A antivirus / spyware software component object.
Type:
SoftLayer_Software_Component
An object that stores the maximum level for the monitoring query types and response types.
Type:
SoftLayer_Network_Monitor_Version1_Query_Host_Stratum[]
The average daily private bandwidth usage for the current billing cycle.
Type:
float
The average daily public bandwidth usage for the current billing cycle.
Type:
float
A guests’s backend network components.
Type:
SoftLayer_Virtual_Guest_Network_Component[]
A computing instance’s allotted detail record. Allotment details link bandwidth allocation with allotments.
Type:
SoftLayer_Network_Bandwidth_Version1_Allotment_Detail
The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to.
Type:
SoftLayer_Network_Bandwidth_Usage[]
The raw private bandwidth usage data for the current billing cycle.
Type:
SoftLayer_Network_Bandwidth_Usage
The raw public bandwidth usage data for the current billing cycle.
Type:
SoftLayer_Network_Bandwidth_Usage
The billing item for a CloudLayer Compute Instance.
Type:
SoftLayer_Billing_Item_Virtual_Guest
Determines whether the instance is ineligible for cancellation because it is disconnected.
Type:
boolean
The global identifier for the image template that was used to provision or reload a guest.
Type:
SoftLayer_Virtual_Guest_Block_Device_Template_Group
A computing instance’s block devices. Block devices link SoftLayer_Virtual_Disk_Image to computing instances.
Type:
SoftLayer_Virtual_Guest_Block_Device[]
A virtual guest’s browser access logs.
Type:
SoftLayer_Virtual_BrowserConsoleAccessLog[]
A flag indicating a computing instance’s console IP address is assigned.
Type:
boolean
A record containing information about a computing instance’s console IP and port number.
Type:
SoftLayer_Virtual_Guest_Network_Component_IpAddress
A continuous data protection software component object.
Type:
SoftLayer_Software_Component
An object that provides commonly used bandwidth summary components for the current billing cycle.
Type:
SoftLayer_Metric_Tracking_Object_Bandwidth_Summary
A guest’s associated EVault network storage service account.
Type:
SoftLayer_Network_Storage[]
A computing instance’s hardware firewall services.
Type:
SoftLayer_Network_Component_Firewall
A guest’s frontend network components.
Type:
SoftLayer_Virtual_Guest_Network_Component[]
The virtual host on which a virtual guest resides (available only on private clouds).
Type:
SoftLayer_Virtual_Host
The total private inbound bandwidth for this computing instance for the current billing cycle.
Type:
decimal
The total public inbound bandwidth for this computing instance for the current billing cycle.
Type:
decimal
The last known power state of a virtual guest in the event the guest is turned off outside of IMS or has gone offline.
Type:
SoftLayer_Virtual_Guest_Power_State
The last transaction that a cloud server’s operating system was loaded.
Type:
SoftLayer_Provisioning_Version1_Transaction
The last transaction a cloud server had performed.
Type:
SoftLayer_Provisioning_Version1_Transaction
A virtual guest’s latest network monitoring incident.
Type:
SoftLayer_Network_Monitor_Version1_Incident
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.
Type:
boolean
A virtual guest’s network monitoring services.
Type:
SoftLayer_Network_Monitor_Version1_Query_Host_Stratum
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
Type:
SoftLayer_User_Customer_Notification_Virtual_Guest[]
All of a virtual guest’s network monitoring incidents.
Type:
SoftLayer_Network_Monitor_Version1_Incident[]
The network Vlans that a guest’s network components are associated with.
Type:
SoftLayer_Network_Vlan[]
An open ticket requesting cancellation of this server, if one exists.
Type:
SoftLayer_Ticket
The original package id provided with the order for a Cloud Computing Instance.
Type:
string
The total private outbound bandwidth for this computing instance for the current billing cycle.
Type:
decimal
The total public outbound bandwidth for this computing instance for the current billing cycle.
Type:
decimal
Whether the bandwidth usage for this computing instance for the current billing cycle exceeds the allocation.
Type:
int
When true this virtual guest must be migrated using SoftLayer_Virtual_Guest::migrate.
Type:
boolean
The placement group that a virtual guest belongs to.
Type:
SoftLayer_Virtual_PlacementGroup
A guest’s primary backend network component.
Type:
SoftLayer_Virtual_Guest_Network_Component
A guest’s primary public network component.
Type:
SoftLayer_Virtual_Guest_Network_Component
Whether the computing instance only has access to the private network.
Type:
boolean
Whether the bandwidth usage for this computing instance for the current billing cycle is projected to exceed the allocation.
Type:
int
The projected public outbound bandwidth for this computing instance for the current billing cycle.
Type:
float
Recent events that impact this computing instance.
Type:
SoftLayer_Notification_Occurrence_Event[]
The reserved capacity group the guest is associated with.
Type:
SoftLayer_Virtual_ReservedCapacityGroup
Flag to indicate whether or not a guest is part of a reserved capacity group.
Type:
boolean
The reserved capacity group instance the guest is associated with.
Type:
SoftLayer_Virtual_ReservedCapacityGroup_Instance
A guest’s vulnerability scan requests.
Type:
SoftLayer_Network_Security_Scanner_Request[]
The server room that a guest is located at. There may be more than one server room for every data center.
Type:
SoftLayer_Location
SSH keys to be installed on the server during provisioning or an OS reload.
Type:
SoftLayer_Security_Ssh_Key[]
The endpoint used to notify customers their transient guest is terminating.
Type:
SoftLayer_Virtual_Guest_Attribute
A computing instance’s associated upgrade request object if any.
Type:
SoftLayer_Product_Upgrade_Request
A base64 encoded string containing custom user data for a Cloud Computing Instance order.
Type:
SoftLayer_Virtual_Guest_Attribute[]
The name of the bandwidth allotment that a hardware belongs too.
Type:
SoftLayer_Network_Bandwidth_Version1_Allotment
The name of the bandwidth allotment that a computing instance belongs too.
Type:
string
A count of a virtual guest’s currently active network monitoring incidents.
Type:
unsignedLong
A count of any active transaction(s) that are currently running for the server (example: os reload).
Type:
unsignedLong
A count of the SoftLayer_Network_Storage objects that this SoftLayer_Virtual_Guest has access to.
Type:
unsignedLong
A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Virtual_Guest has access to.
Type:
unsignedLong
A count of an object that stores the maximum level for the monitoring query types and response types.
Type:
unsignedLong
A count of the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to.
Type:
unsignedLong
A count of a computing instance’s block devices. Block devices link SoftLayer_Virtual_Disk_Image to computing instances.
Type:
unsignedLong
A count of a guest’s associated EVault network storage service account.
Type:
unsignedLong
A count of 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
Type:
unsignedLong
A count of all of a virtual guest’s network monitoring incidents.
Type:
unsignedLong
A count of the network Vlans that a guest’s network components are associated with.
Type:
unsignedLong
A count of sSH keys to be installed on the server during provisioning or an OS reload.
Type:
unsignedLong
A count of a list of users that have access to this computing instance.
Type:
unsignedLong
A count of a base64 encoded string containing custom user data for a Cloud Computing Instance order.
Type:
unsignedLong