Language: English

Virtual
SoftLayer_Virtual_Guest

Overview

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.

Local Properties

accountId

A computing instance's associated account id

Type:

integer

createDate

The date a virtual computing instance was created.

Type:

dateTime

dedicatedAccountHostOnlyFlag

When true this flag specifies that a compute instance is to run on hosts that only have guests from the same account.

Type:

boolean

domain

A computing instance's domain name

Type:

string

fullyQualifiedDomainName

A name reflecting the hostname and domain of the computing instance.

Type:

string

hostname

A virtual computing instance's hostname

Type:

string

id

Unique ID for a computing instance.

Type:

integer

lastPowerStateId
Type:

integer

lastVerifiedDate

The last timestamp of when the guest was verified as a resident virtual machine on the host's hypervisor platform.

Type:

dateTime

maxCpu

The maximum amount of CPU resources a computing instance may utilize.

Type:

integer

maxCpuUnits

The unit of the maximum amount of CPU resources a computing instance may utilize.

Type:

string

maxMemory

The maximum amount of memory a computing instance may utilize.

Type:

integer

metricPollDate

The date of the most recent metric tracking poll performed.

Type:

dateTime

modifyDate

The date a virtual computing instance was last modified.

Type:

dateTime

notes

A note of up to 1,000 characters about a virtual server.

Type:

string

postInstallScriptUri

URI of the script to be downloaded and executed after installation is complete. This is deprecated in favor of supplementalCreateObjectOptions' postInstallScriptUri.

Type:

string

provisionDate
Type:

dateTime

startCpus

The number of CPUs available to a computing instance upon startup.

Type:

integer

statusId

A computing instances status ID

Type:

integer

supplementalCreateObjectOptions

Extra options needed for createObject and createObjects.

typeId

Gives the type of guest categorized as PUBLIC, DEDICATED or PRIVATE.

Type:

integer

uuid

Unique ID for a computing instance's record on a virtualization platform.

Type:

string

Relational & Count Properties

Relational Properties can be queried by object mask
account

The account that a virtual guest belongs to.

accountOwnedPoolFlag
Type:

boolean

activeNetworkMonitorIncident

A virtual guest's currently active network monitoring incidents.

activeNetworkMonitorIncidentCount

A count of a virtual guest's currently active network monitoring incidents.

Type:

unsignedLong

activeTicketCount

A count of

Type:

unsignedLong

activeTickets
activeTransaction

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

activeTransactionCount

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

Type:

unsignedLong

activeTransactions

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

allowedHost

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

allowedNetworkStorage

The SoftLayer_Network_Storage objects that this SoftLayer_Virtual_Guest has access to.

allowedNetworkStorageCount

A count of the SoftLayer_Network_Storage objects that this SoftLayer_Virtual_Guest has access to.

Type:

unsignedLong

allowedNetworkStorageReplicaCount

A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Virtual_Guest has access to.

Type:

unsignedLong

allowedNetworkStorageReplicas

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

antivirusSpywareSoftwareComponent

A antivirus / spyware software component object.

applicationDeliveryController
attributeCount

A count of

Type:

unsignedLong

availableMonitoring

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

availableMonitoringCount

A count of an object that stores the maximum level for the monitoring query types and response types.

Type:

unsignedLong

averageDailyPrivateBandwidthUsage

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

Type:

float

averageDailyPublicBandwidthUsage

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

Type:

float

backendNetworkComponentCount

A count of a guests's backend network components.

Type:

unsignedLong

backendNetworkComponents

A guests's backend network components.

backendRouterCount

A count of a guest's backend or private router.

Type:

unsignedLong

backendRouters

A guest's backend or private router.

bandwidthAllocation

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

Type:

decimal

bandwidthAllotmentDetail

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

billingCycleBandwidthUsage

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

billingCycleBandwidthUsageCount

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

billingCyclePrivateBandwidthUsage

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

billingCyclePublicBandwidthUsage

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

billingItem

The billing item for a CloudLayer Compute Instance.

blockCancelBecauseDisconnectedFlag

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

Type:

boolean

blockDeviceCount

A count of a computing instance's block devices. Block devices link disk images to computing instances.

Type:

unsignedLong

blockDevices

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

blockDeviceTemplateGroup

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

consoleIpAddressFlag

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

Type:

boolean

consoleIpAddressRecord

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

continuousDataProtectionSoftwareComponent

A continuous data protection software component object.

controlPanel

A guest's control panel.

currentBandwidthSummary

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

datacenter

The datacenter that a virtual guest resides in.

dedicatedHost

The dedicated host associated with this guest.

evaultNetworkStorage

A guest's associated EVault network storage service account.

evaultNetworkStorageCount

A count of a guest's associated EVault network storage service account.

Type:

unsignedLong

firewallServiceComponent

A computing instance's hardware firewall services.

frontendNetworkComponentCount

A count of a guest's frontend network components.

Type:

unsignedLong

frontendNetworkComponents

A guest's frontend network components.

frontendRouters

A guest's frontend or public router.

globalIdentifier

A guest's universally unique identifier.

Type:

string

guestBootParameter
host

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

hostIpsSoftwareComponent

A host IPS software component object.

hourlyBillingFlag

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

Type:

boolean

inboundPrivateBandwidthUsage

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

Type:

decimal

inboundPublicBandwidthUsage

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

Type:

decimal

internalTagReferenceCount

A count of

Type:

unsignedLong

internalTagReferences
lastKnownPowerState

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

lastOperatingSystemReload

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

lastTransaction

The last transaction a cloud server had performed.

latestNetworkMonitorIncident

A virtual guest's latest network monitoring incident.

localDiskFlag

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

location

Where guest is located within SoftLayer's location hierarchy.

managedResourceFlag

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

Type:

boolean

metricTrackingObject

A guest's metric tracking object.

metricTrackingObjectId

The metric tracking object id for this guest.

Type:

integer

monitoringAgentCount

A count of

Type:

unsignedLong

monitoringAgents
monitoringRobot
monitoringServiceComponent

A virtual guest's network monitoring services.

monitoringServiceEligibilityFlag
Type:

boolean

monitoringServiceFlag
Type:

boolean

monitoringUserNotification

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

monitoringUserNotificationCount

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

networkComponentCount

A count of a guests's network components.

Type:

unsignedLong

networkComponents

A guests's network components.

networkMonitorCount

A count of a guests's network monitors.

Type:

unsignedLong

networkMonitorIncidentCount

A count of all of a virtual guest's network monitoring incidents.

Type:

unsignedLong

networkMonitorIncidents

All of a virtual guest's network monitoring incidents.

networkMonitors

A guests's network monitors.

networkStorage

A guest's associated network storage accounts.

networkStorageCount

A count of a guest's associated network storage accounts.

Type:

unsignedLong

networkVlanCount

A count of the network Vlans that a guest's network components are associated with.

Type:

unsignedLong

networkVlans

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

openCancellationTicket

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

operatingSystem

A guest's operating system.

operatingSystemReferenceCode

A guest's operating system software description.

Type:

string

orderedPackageId

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

Type:

string

outboundPrivateBandwidthUsage

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

Type:

decimal

outboundPublicBandwidthUsage

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

Type:

decimal

overBandwidthAllocationFlag

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

Type:

integer

pendingMigrationFlag

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

Type:

boolean

powerState

The current power state of a virtual guest.

primaryBackendIpAddress

A guest's primary private IP address.

Type:

string

primaryBackendNetworkComponent

A guest's primary backend network component.

primaryIpAddress

The guest's primary public IP address.

Type:

string

primaryNetworkComponent

A guest's primary public network component.

privateNetworkOnlyFlag

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

Type:

boolean

projectedOverBandwidthAllocationFlag

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

Type:

integer

projectedPublicBandwidthUsage

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

Type:

float

recentEventCount

A count of recent events that impact this computing instance.

Type:

unsignedLong

recentEvents

Recent events that impact this computing instance.

regionalGroup

The regional group this guest is in.

regionalInternetRegistry
scaleAssetCount

A count of collection of scale assets this guest corresponds to.

Type:

unsignedLong

scaleAssets

Collection of scale assets this guest corresponds to.

scaledFlag

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

Type:

boolean

scaleMember

The scale member for this guest, if applicable.

securityScanRequestCount

A count of a guest's vulnerability scan requests.

Type:

unsignedLong

securityScanRequests

A guest's vulnerability scan requests.

serverRoom

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

softwareComponentCount

A count of a guest's installed software.

Type:

unsignedLong

softwareComponents

A guest's installed software.

sshKeyCount

A count of sSH keys to be installed on the server during provisioning or an OS reload.

Type:

unsignedLong

sshKeys

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

status

A computing instance's status.

tagReferenceCount

A count of

Type:

unsignedLong

tagReferences
type

The type of this virtual guest.

upgradeRequest

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

userCount

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

Type:

unsignedLong

userData

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

userDataCount

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

Type:

unsignedLong

users

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

virtualRack

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

virtualRackId

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

Type:

integer

virtualRackName

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

Type:

string