SoftLayer_Virtual_Guest


SoftLayer_Virtual_Guest

Description

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.

associatedMethods

Local


accountId

A computing instance's associated SoftLayer_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


placementGroupId

The placement group ID that the virtual guest belongs to.
Type: integer


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 SoftLayer_Virtual_Guest_Status ID
Type: integer


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


account

The account that a virtual guest belongs to.
Type: SoftLayer_Account


accountOwnedPoolFlag

Type: boolean


activeNetworkMonitorIncident

A virtual guest's currently active network monitoring incidents.
Type: SoftLayer_Network_Monitor_Version1_Incident[]


activeTransaction

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


activeTransactions

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


allowedHost

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


allowedNetworkStorage

The SoftLayer_Network_Storage objects that this SoftLayer_Virtual_Guest has access to.
Type: SoftLayer_Network_Storage[]


allowedNetworkStorageReplicas

The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Virtual_Guest has access to.
Type: SoftLayer_Network_Storage[]


antivirusSpywareSoftwareComponent

A antivirus / spyware software component object.
Type: SoftLayer_Software_Component


availableMonitoring

An object that stores the maximum level for the monitoring query types and response types.
Type: SoftLayer_Network_Monitor_Version1_Query_Host_Stratum[]


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


backendNetworkComponents

A guests's backend network components.
Type: SoftLayer_Virtual_Guest_Network_Component[]


backendRouters

A guest's backend or private router.
Type: SoftLayer_Hardware[]


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.
Type: SoftLayer_Network_Bandwidth_Version1_Allotment_Detail


billingCycleBandwidthUsage

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[]


billingCyclePrivateBandwidthUsage

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


billingCyclePublicBandwidthUsage

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


billingItem

The billing item for a CloudLayer Compute Instance.
Type: SoftLayer_Billing_Item_Virtual_Guest


blockCancelBecauseDisconnectedFlag

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


blockDeviceTemplateGroup

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


blockDevices

A computing instance's block devices. Block devices link SoftLayer_Virtual_Disk_Image to computing instances.
Type: SoftLayer_Virtual_Guest_Block_Device[]


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.
Type: SoftLayer_Virtual_Guest_Network_Component_IpAddress


continuousDataProtectionSoftwareComponent

A continuous data protection software component object.
Type: SoftLayer_Software_Component


controlPanel

A guest's control panel.
Type: SoftLayer_Software_Component


currentBandwidthSummary

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


datacenter

The datacenter that a virtual guest resides in.
Type: SoftLayer_Location


dedicatedHost

The dedicated host associated with this guest.
Type: SoftLayer_Virtual_DedicatedHost


evaultNetworkStorage

A guest's associated EVault network storage service account.
Type: SoftLayer_Network_Storage[]


firewallServiceComponent

A computing instance's hardware firewall services.
Type: SoftLayer_Network_Component_Firewall


frontendNetworkComponents

A guest's frontend network components.
Type: SoftLayer_Virtual_Guest_Network_Component[]


frontendRouters

A guest's frontend or public router.
Type: SoftLayer_Hardware


globalIdentifier

A guest's universally unique identifier.
Type: string


gpuCount

The number of GPUs attached to the guest.
Type: integer


gpuType

The name of the GPU type attached to the guest.
Type: string


host

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


hostIpsSoftwareComponent

A host IPS software component object.
Type: SoftLayer_Software_Component


hourlyBillingFlag

A guest's hourly billing status.
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


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.
Type: SoftLayer_Virtual_Guest_Power_State


lastOperatingSystemReload

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


lastTransaction

The last transaction a cloud server had performed.
Type: SoftLayer_Provisioning_Version1_Transaction


latestNetworkMonitorIncident

A virtual guest's latest network monitoring incident.
Type: SoftLayer_Network_Monitor_Version1_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.
Type: SoftLayer_Location


managedResourceFlag

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


metricTrackingObject

A guest's metric tracking object.
Type: SoftLayer_Metric_Tracking_Object


metricTrackingObjectId

The metric tracking object id for this guest.
Type: integer


monitoringServiceComponent

A virtual guest's network monitoring services.
Type: SoftLayer_Network_Monitor_Version1_Query_Host_Stratum


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
Type: SoftLayer_User_Customer_Notification_Virtual_Guest[]


networkMonitorIncidents

All of a virtual guest's network monitoring incidents.
Type: SoftLayer_Network_Monitor_Version1_Incident[]


networkStorage

A guest's associated network storage accounts.
Type: SoftLayer_Network_Storage[]


networkVlans

The network Vlans that a guest's network components are associated with.
Type: SoftLayer_Network_Vlan[]


openCancellationTicket

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


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


placementGroup

The placement group that a virtual guest belongs to.
Type: SoftLayer_Virtual_PlacementGroup


powerState

The current power state of a virtual guest.
Type: SoftLayer_Virtual_Guest_Power_State


primaryBackendIpAddress

A guest's primary private IP address.
Type: string


primaryBackendNetworkComponent

A guest's primary backend network component.
Type: SoftLayer_Virtual_Guest_Network_Component


primaryIpAddress

The guest's primary public IP address.
Type: string


primaryNetworkComponent

A guest's primary public network component.
Type: SoftLayer_Virtual_Guest_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


recentEvents

Recent events that impact this computing instance.
Type: SoftLayer_Notification_Occurrence_Event[]


regionalGroup

The regional group this guest is in.
Type: SoftLayer_Location_Group_Regional


reservedCapacityGroup

The reserved capacity group the guest is associated with.
Type: SoftLayer_Virtual_ReservedCapacityGroup


reservedCapacityGroupFlag

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


reservedCapacityGroupInstance

The reserved capacity group instance the guest is associated with.
Type: SoftLayer_Virtual_ReservedCapacityGroup_Instance


scaleAssets

Collection of scale assets this guest corresponds to.
Type: SoftLayer_Scale_Asset[]


scaleMember

The scale member for this guest, if applicable.
Type: SoftLayer_Scale_Member_Virtual_Guest


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


securityScanRequests

A guest's vulnerability scan requests.
Type: SoftLayer_Network_Security_Scanner_Request[]


serverRoom

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


softwareComponents

A guest's installed software.
Type: SoftLayer_Software_Component[]


sshKeys

SSH keys to be installed on the server during provisioning or an OS reload.
Type: SoftLayer_Security_Ssh_Key[]


status

A computing instance's status.
Type: SoftLayer_Virtual_Guest_Status


transientGuestFlag

Whether or not a computing instance is a Transient Instance.
Type: boolean


transientWebhookURI

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


type

The type of this virtual guest.
Type: SoftLayer_Virtual_Guest_Type


upgradeRequest

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


userData

A base64 encoded string containing custom user data for a Cloud Computing Instance order.
Type: SoftLayer_Virtual_Guest_Attribute[]


users

A list of users that have access to this computing instance.
Type: SoftLayer_User_Customer[]


virtualRack

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


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

Count


activeNetworkMonitorIncidentCount

A count of a virtual guest's currently active network monitoring incidents.
Type: unsigned long


activeTicketCount

A count of
Type: unsigned long


activeTransactionCount

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


allowedNetworkStorageCount

A count of the SoftLayer_Network_Storage objects that this SoftLayer_Virtual_Guest has access to.
Type: unsigned long


allowedNetworkStorageReplicaCount

A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Virtual_Guest has access to.
Type: unsigned long


attributeCount

A count of
Type: unsigned long


availableMonitoringCount

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


backendNetworkComponentCount

A count of a guests's backend network components.
Type: unsigned long


backendRouterCount

A count of a guest's backend or private router.
Type: unsigned long


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: unsigned long


blockDeviceCount

A count of a computing instance's block devices. Block devices link SoftLayer_Virtual_Disk_Image to computing instances.
Type: unsigned long


evaultNetworkStorageCount

A count of a guest's associated EVault network storage service account.
Type: unsigned long


frontendNetworkComponentCount

A count of a guest's frontend network components.
Type: unsigned long


internalTagReferenceCount

A count of
Type: unsigned long


monitoringAgentCount

A count of
Type: unsigned long


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: unsigned long


networkComponentCount

A count of a guests's network components.
Type: unsigned long


networkMonitorCount

A count of a guests's network monitors.
Type: unsigned long


networkMonitorIncidentCount

A count of all of a virtual guest's network monitoring incidents.
Type: unsigned long


networkStorageCount

A count of a guest's associated network storage accounts.
Type: unsigned long


networkVlanCount

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


recentEventCount

A count of recent events that impact this computing instance.
Type: unsigned long


scaleAssetCount

A count of collection of scale assets this guest corresponds to.
Type: unsigned long


securityScanRequestCount

A count of a guest's vulnerability scan requests.
Type: unsigned long


softwareComponentCount

A count of a guest's installed software.
Type: unsigned long


sshKeyCount

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


tagReferenceCount

A count of
Type: unsigned long


userCount

A count of a list of users that have access to this computing instance.
Type: unsigned long


userDataCount

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



© SoftLayer 2015
Built with Hugo