primaryBackendIpAddress
A guest's primary private IP address.
@ApiType("SoftLayer_Virtual_Guest") public class Guest extends Entity
Modifier and Type | Class | Description |
---|---|---|
static class |
Guest.Mask |
|
static interface |
Guest.Service |
The virtual guest service provides a common interface to any virtualization platform supported by SoftLayer.
|
static interface |
Guest.ServiceAsync |
Modifier and Type | Field | Description |
---|---|---|
protected Account |
account |
The account that a virtual guest belongs to.
|
protected Long |
accountId |
A computing instance's associated [[SoftLayer_Account|account]] id
|
protected boolean |
accountIdSpecified |
|
protected Boolean |
accountOwnedPoolFlag |
|
protected List<Incident> |
activeNetworkMonitorIncident |
A virtual guest's currently active network monitoring incidents.
|
protected Long |
activeNetworkMonitorIncidentCount |
A count of a virtual guest's currently active network monitoring incidents.
|
protected Long |
activeTicketCount |
A count of
|
protected List<Ticket> |
activeTickets |
|
protected Transaction |
activeTransaction |
A transaction that is still be performed on a cloud server.
|
protected Long |
activeTransactionCount |
A count of any active transaction(s) that are currently running for the server (example: os reload).
|
protected List<Transaction> |
activeTransactions |
Any active transaction(s) that are currently running for the server (example: os reload).
|
protected Host |
allowedHost |
The SoftLayer_Network_Storage_Allowed_Host information to connect this Virtual Guest to Network Storage volumes that require access control lists.
|
protected List<Storage> |
allowedNetworkStorage |
The SoftLayer_Network_Storage objects that this SoftLayer_Virtual_Guest has access to.
|
protected Long |
allowedNetworkStorageCount |
A count of the SoftLayer_Network_Storage objects that this SoftLayer_Virtual_Guest has access to.
|
protected Long |
allowedNetworkStorageReplicaCount |
A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Virtual_Guest has access to.
|
protected List<Storage> |
allowedNetworkStorageReplicas |
The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Virtual_Guest has access to.
|
protected Component |
antivirusSpywareSoftwareComponent |
A antivirus / spyware software component object.
|
protected Controller |
applicationDeliveryController |
|
protected Long |
attributeCount |
A count of
|
protected List<Attribute> |
attributes |
|
protected List<Stratum> |
availableMonitoring |
An object that stores the maximum level for the monitoring query types and response types.
|
protected Long |
availableMonitoringCount |
A count of an object that stores the maximum level for the monitoring query types and response types.
|
protected BigDecimal |
averageDailyPrivateBandwidthUsage |
The average daily private bandwidth usage for the current billing cycle.
|
protected BigDecimal |
averageDailyPublicBandwidthUsage |
The average daily public bandwidth usage for the current billing cycle.
|
protected Long |
backendNetworkComponentCount |
A count of a guests's backend network components.
|
protected List<Component> |
backendNetworkComponents |
A guests's backend network components.
|
protected Long |
backendRouterCount |
A count of a guest's backend or private router.
|
protected List<Hardware> |
backendRouters |
A guest's backend or private router.
|
protected BigDecimal |
bandwidthAllocation |
A computing instance's allotted bandwidth (measured in GB).
|
protected Detail |
bandwidthAllotmentDetail |
A computing instance's allotted detail record.
|
protected List<Usage> |
billingCycleBandwidthUsage |
The raw bandwidth usage data for the current billing cycle.
|
protected Long |
billingCycleBandwidthUsageCount |
A count of the raw bandwidth usage data for the current billing cycle.
|
protected Usage |
billingCyclePrivateBandwidthUsage |
The raw private bandwidth usage data for the current billing cycle.
|
protected Usage |
billingCyclePublicBandwidthUsage |
The raw public bandwidth usage data for the current billing cycle.
|
protected Guest |
billingItem |
The billing item for a CloudLayer Compute Instance.
|
protected Boolean |
blockCancelBecauseDisconnectedFlag |
Determines whether the instance is ineligible for cancellation because it is disconnected.
|
protected Long |
blockDeviceCount |
A count of a computing instance's block devices.
|
protected List<Device> |
blockDevices |
A computing instance's block devices.
|
protected Group |
blockDeviceTemplateGroup |
The global identifier for the image template that was used to provision or reload a guest.
|
protected Boolean |
consoleIpAddressFlag |
A flag indicating a computing instance's console IP address is assigned.
|
protected IpAddress |
consoleIpAddressRecord |
A record containing information about a computing instance's console IP and port number.
|
protected Component |
continuousDataProtectionSoftwareComponent |
A continuous data protection software component object.
|
protected Component |
controlPanel |
A guest's control panel.
|
protected GregorianCalendar |
createDate |
The date a virtual computing instance was created.
|
protected boolean |
createDateSpecified |
|
protected Summary |
currentBandwidthSummary |
An object that provides commonly used bandwidth summary components for the current billing cycle.
|
protected Location |
datacenter |
The datacenter that a virtual guest resides in.
|
protected Boolean |
dedicatedAccountHostOnlyFlag |
When true this flag specifies that a compute instance is to run on hosts that only have guests from the same account.
|
protected boolean |
dedicatedAccountHostOnlyFlagSpecified |
|
protected DedicatedHost |
dedicatedHost |
The dedicated host associated with this guest.
|
protected String |
domain |
A computing instance's domain name
|
protected boolean |
domainSpecified |
|
protected List<Storage> |
evaultNetworkStorage |
A guest's associated EVault network storage service account.
|
protected Long |
evaultNetworkStorageCount |
A count of a guest's associated EVault network storage service account.
|
protected Firewall |
firewallServiceComponent |
A computing instance's hardware firewall services.
|
protected Long |
frontendNetworkComponentCount |
A count of a guest's frontend network components.
|
protected List<Component> |
frontendNetworkComponents |
A guest's frontend network components.
|
protected Hardware |
frontendRouters |
A guest's frontend or public router.
|
protected String |
fullyQualifiedDomainName |
A name reflecting the hostname and domain of the computing instance.
|
protected boolean |
fullyQualifiedDomainNameSpecified |
|
protected String |
globalIdentifier |
A guest's universally unique identifier.
|
protected Long |
gpuCount |
The number of GPUs attached to the guest.
|
protected String |
gpuType |
The name of the GPU type attached to the guest.
|
protected Parameter |
guestBootParameter |
|
protected Host |
host |
The virtual host on which a virtual guest resides (available only on private clouds).
|
protected Component |
hostIpsSoftwareComponent |
A host IPS software component object.
|
protected String |
hostname |
A virtual computing instance's hostname
|
protected boolean |
hostnameSpecified |
|
protected Boolean |
hourlyBillingFlag |
A guest's hourly billing status.
|
protected Long |
id |
Unique ID for a computing instance.
|
protected boolean |
idSpecified |
|
protected BigDecimal |
inboundPrivateBandwidthUsage |
The total private inbound bandwidth for this computing instance for the current billing cycle.
|
protected BigDecimal |
inboundPublicBandwidthUsage |
The total public inbound bandwidth for this computing instance for the current billing cycle.
|
protected Long |
internalTagReferenceCount |
A count of
|
protected List<Reference> |
internalTagReferences |
|
protected State |
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.
|
protected Transaction |
lastOperatingSystemReload |
The last transaction that a cloud server's operating system was loaded.
|
protected Long |
lastPowerStateId |
|
protected boolean |
lastPowerStateIdSpecified |
|
protected Transaction |
lastTransaction |
The last transaction a cloud server had performed.
|
protected GregorianCalendar |
lastVerifiedDate |
The last timestamp of when the guest was verified as a resident virtual machine on the host's hypervisor platform.
|
protected boolean |
lastVerifiedDateSpecified |
|
protected Incident |
latestNetworkMonitorIncident |
A virtual guest's latest network monitoring incident.
|
protected Boolean |
localDiskFlag |
A flag indicating that the virtual guest has at least one disk which is local to the host it runs on.
|
protected Location |
location |
Where guest is located within SoftLayer's location hierarchy.
|
protected Boolean |
managedResourceFlag |
A flag indicating that the virtual guest is a managed resource.
|
protected Long |
maxCpu |
The maximum amount of CPU resources a computing instance may utilize.
|
protected boolean |
maxCpuSpecified |
|
protected String |
maxCpuUnits |
The unit of the maximum amount of CPU resources a computing instance may utilize.
|
protected boolean |
maxCpuUnitsSpecified |
|
protected Long |
maxMemory |
The maximum amount of memory a computing instance may utilize.
|
protected boolean |
maxMemorySpecified |
|
protected GregorianCalendar |
metricPollDate |
The date of the most recent metric tracking poll performed.
|
protected boolean |
metricPollDateSpecified |
|
protected Object |
metricTrackingObject |
A guest's metric tracking object.
|
protected Long |
metricTrackingObjectId |
The metric tracking object id for this guest.
|
protected GregorianCalendar |
modifyDate |
The date a virtual computing instance was last modified.
|
protected boolean |
modifyDateSpecified |
|
protected Robot |
monitoringRobot |
|
protected Stratum |
monitoringServiceComponent |
A virtual guest's network monitoring services.
|
protected Boolean |
monitoringServiceEligibilityFlag |
|
protected List<Guest> |
monitoringUserNotification |
The monitoring notification objects for this guest.
|
protected Long |
monitoringUserNotificationCount |
A count of the monitoring notification objects for this guest.
|
protected Long |
networkComponentCount |
A count of a guests's network components.
|
protected List<Component> |
networkComponents |
A guests's network components.
|
protected Long |
networkMonitorCount |
A count of a guests's network monitors.
|
protected Long |
networkMonitorIncidentCount |
A count of all of a virtual guest's network monitoring incidents.
|
protected List<Incident> |
networkMonitorIncidents |
All of a virtual guest's network monitoring incidents.
|
protected List<Host> |
networkMonitors |
A guests's network monitors.
|
protected List<Storage> |
networkStorage |
A guest's associated network storage accounts.
|
protected Long |
networkStorageCount |
A count of a guest's associated network storage accounts.
|
protected Long |
networkVlanCount |
A count of the network Vlans that a guest's network components are associated with.
|
protected List<Vlan> |
networkVlans |
The network Vlans that a guest's network components are associated with.
|
protected String |
notes |
A note of up to 1,000 characters about a virtual server.
|
protected boolean |
notesSpecified |
|
protected Ticket |
openCancellationTicket |
An open ticket requesting cancellation of this server, if one exists.
|
protected OperatingSystem |
operatingSystem |
A guest's operating system.
|
protected String |
operatingSystemReferenceCode |
A guest's operating system software description.
|
protected String |
orderedPackageId |
The original package id provided with the order for a Cloud Computing Instance.
|
protected BigDecimal |
outboundPrivateBandwidthUsage |
The total private outbound bandwidth for this computing instance for the current billing cycle.
|
protected BigDecimal |
outboundPublicBandwidthUsage |
The total public outbound bandwidth for this computing instance for the current billing cycle.
|
protected Long |
overBandwidthAllocationFlag |
Whether the bandwidth usage for this computing instance for the current billing cycle exceeds the allocation.
|
protected Boolean |
pendingMigrationFlag |
When true this virtual guest must be migrated using SoftLayer_Virtual_Guest::migrate.
|
protected PlacementGroup |
placementGroup |
The placement group that a virtual guest belongs to.
|
protected Long |
placementGroupId |
The placement group ID that the virtual guest belongs to.
|
protected boolean |
placementGroupIdSpecified |
|
protected String |
postInstallScriptUri |
URI of the script to be downloaded and executed after installation is complete.
|
protected boolean |
postInstallScriptUriSpecified |
|
protected State |
powerState |
The current power state of a virtual guest.
|
protected String |
primaryBackendIpAddress |
A guest's primary private IP address.
|
protected Component |
primaryBackendNetworkComponent |
A guest's primary backend network component.
|
protected String |
primaryIpAddress |
The guest's primary public IP address.
|
protected Component |
primaryNetworkComponent |
A guest's primary public network component.
|
protected Boolean |
privateNetworkOnlyFlag |
Whether the computing instance only has access to the private network.
|
protected Long |
projectedOverBandwidthAllocationFlag |
Whether the bandwidth usage for this computing instance for the current billing cycle is projected to exceed the allocation.
|
protected BigDecimal |
projectedPublicBandwidthUsage |
The projected public outbound bandwidth for this computing instance for the current billing cycle.
|
protected GregorianCalendar |
provisionDate |
|
protected boolean |
provisionDateSpecified |
|
protected Long |
recentEventCount |
A count of recent events that impact this computing instance.
|
protected List<Event> |
recentEvents |
Recent events that impact this computing instance.
|
protected Regional |
regionalGroup |
The regional group this guest is in.
|
protected Registry |
regionalInternetRegistry |
|
protected ReservedCapacityGroup |
reservedCapacityGroup |
The reserved capacity group the guest is associated with.
|
protected Boolean |
reservedCapacityGroupFlag |
Flag to indicate whether or not a guest is part of a reserved capacity group.
|
protected Instance |
reservedCapacityGroupInstance |
The reserved capacity group instance the guest is associated with.
|
protected Long |
scaleAssetCount |
A count of collection of scale assets this guest corresponds to.
|
protected List<Asset> |
scaleAssets |
Collection of scale assets this guest corresponds to.
|
protected Boolean |
scaledFlag |
Whether or not this guest is a member of a scale group and was automatically created as part of a scale group action.
|
protected Guest |
scaleMember |
The scale member for this guest, if applicable.
|
protected Long |
securityScanRequestCount |
A count of a guest's vulnerability scan requests.
|
protected List<Request> |
securityScanRequests |
A guest's vulnerability scan requests.
|
protected Location |
serverRoom |
The server room that a guest is located at.
|
protected Long |
softwareComponentCount |
A count of a guest's installed software.
|
protected List<Component> |
softwareComponents |
A guest's installed software.
|
protected Long |
sshKeyCount |
A count of sSH keys to be installed on the server during provisioning or an OS reload.
|
protected List<Key> |
sshKeys |
SSH keys to be installed on the server during provisioning or an OS reload.
|
protected Long |
startCpus |
The number of CPUs available to a computing instance upon startup.
|
protected boolean |
startCpusSpecified |
|
protected Status |
status |
A computing instance's status.
|
protected Long |
statusId |
A computing instances [[SoftLayer_Virtual_Guest_Status|status]] ID
|
protected boolean |
statusIdSpecified |
|
protected SupplementalCreateObjectOptions |
supplementalCreateObjectOptions |
Extra options needed for [[SoftLayer_Virtual_Guest/createObject|createObject]] and [[SoftLayer_Virtual_Guest/createObjects|createObjects]].
|
protected boolean |
supplementalCreateObjectOptionsSpecified |
|
protected Long |
tagReferenceCount |
A count of
|
protected List<Reference> |
tagReferences |
|
protected Boolean |
transientGuestFlag |
Whether or not a computing instance is a Transient Instance.
|
protected Attribute |
transientWebhookURI |
The endpoint used to notify customers their transient guest is terminating.
|
protected Type |
type |
The type of this virtual guest.
|
protected Long |
typeId |
Gives the type of guest categorized as PUBLIC, DEDICATED or PRIVATE.
|
protected boolean |
typeIdSpecified |
|
protected Request |
upgradeRequest |
A computing instance's associated upgrade request object if any.
|
protected Long |
userCount |
A count of a list of users that have access to this computing instance.
|
protected List<Attribute> |
userData |
A base64 encoded string containing custom user data for a Cloud Computing Instance order.
|
protected Long |
userDataCount |
A count of a base64 encoded string containing custom user data for a Cloud Computing Instance order.
|
protected List<Customer> |
users |
A list of users that have access to this computing instance.
|
protected String |
uuid |
Unique ID for a computing instance's record on a virtualization platform.
|
protected boolean |
uuidSpecified |
|
protected Allotment |
virtualRack |
The name of the bandwidth allotment that a hardware belongs too.
|
protected Long |
virtualRackId |
The id of the bandwidth allotment that a computing instance belongs too.
|
protected String |
virtualRackName |
The name of the bandwidth allotment that a computing instance belongs too.
|
unknownProperties
Constructor | Description |
---|---|
Guest() |
getUnknownProperties, setUnknownProperties