Interface Guest.Service
-
- All Superinterfaces:
Maskable
,ResultLimitable
,Service
- Enclosing class:
- Guest
@ApiService("SoftLayer_Virtual_Guest") public static interface Guest.Service extends Service
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.- See Also:
- SoftLayer_Virtual_Guest
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description Boolean
activatePrivatePort()
Activate the private network portBoolean
activatePublicPort()
Activate the public network portBoolean
allowAccessToNetworkStorage(Storage networkStorageTemplateObject)
This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.Boolean
allowAccessToNetworkStorageList(List<Storage> networkStorageTemplateObjects)
This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.Guest.ServiceAsync
asAsync()
Get an async version of this serviceTransaction
attachDiskImage(Long imageId)
Creates a transaction to attach a guest's disk image.Void
cancelIsolationForDestructiveAction()
Reopens the public and/or private ports to reverse the changes made when the server was isolated for a destructive action.Group
captureImage(Template captureTemplate)
Captures a Flex Image of the hard disk on the virtual machine, based on the capture template parameter.Boolean
checkHostDiskAvailability(Long diskCapacity)
Checks the associated host for available disk space to determine if guest migration is necessary.Transaction
configureMetadataDisk()
Creates a transaction to configure the guest's metadata disk.Group
createArchiveTemplate(String groupName, List<Device> blockDevices, String note)
Create a transaction to archive a computing instance's block devicesTransaction
createArchiveTransaction(String groupName, List<Device> blockDevices, String note)
Deprecated.Guest
createObject(Guest templateObject)
createObject() enables the creation of computing instances on an account.List<Guest>
createObjects(List<Guest> templateObjects)
createObjects() enables the creation of multiple computing instances on an account in a single call.Boolean
createPostSoftwareInstallTransaction(String data, Boolean returnBoolean)
Boolean
deleteObject()
This method will cancel a computing instance effective immediately.Boolean
deleteTag(String tagName)
Void
deleteTransientWebhook()
Transaction
detachDiskImage(Long imageId)
Creates a transaction to detach a guest's disk image.Boolean
editObject(Guest templateObject)
Edit a computing instance's propertiesBoolean
executeIderaBareMetalRestore()
Reboot a guest into the Idera Bare Metal Restore image.Boolean
executeR1SoftBareMetalRestore()
Reboot a guest into the R1Soft Bare Metal Restore image.Void
executeRemoteScript(String uri)
Download and run remote script from uri on virtual guests.Boolean
executeRescueLayer()
Reboot a Linux guest into the Xen rescue image.List<Guest>
findByHostname(String hostname)
Find VSIs by hostname.Guest
findByIpAddress(String ipAddress)
Find CCI by only its primary public or private IP address.Order
generateOrderTemplate(Guest templateObject)
Obtain an [[SoftLayer_Container_Product_Order_Virtual_Guest (type)|order container]] that can be sent to [[SoftLayer_Product_Order/verifyOrder|verifyOrder]] or [[SoftLayer_Product_Order/placeOrder|placeOrder]].Account
getAccount()
The account that a virtual guest belongs to.Boolean
getAccountOwnedPoolFlag()
List<Incident>
getActiveNetworkMonitorIncident()
A virtual guest's currently active network monitoring incidents.List<Ticket>
getActiveTickets()
Transaction
getActiveTransaction()
A transaction that is still be performed on a cloud server.List<Transaction>
getActiveTransactions()
Any active transaction(s) that are currently running for the server (example: os reload).List<Price>
getAdditionalRequiredPricesForOsReload(Configuration config)
Return a collection of SoftLayer_Item_Price objects for an OS reloadHost
getAllowedHost()
The SoftLayer_Network_Storage_Allowed_Host information to connect this Virtual Guest to Network Storage volumes that require access control lists.List<Storage>
getAllowedNetworkStorage()
The SoftLayer_Network_Storage objects that this SoftLayer_Virtual_Guest has access to.List<Storage>
getAllowedNetworkStorageReplicas()
The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Virtual_Guest has access to.Component
getAntivirusSpywareSoftwareComponent()
A antivirus / spyware software component object.Controller
getApplicationDeliveryController()
List<Storage>
getAttachedNetworkStorages(String nasType)
This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Virtual_Guest.List<Attribute>
getAttributes()
List<String>
getAvailableBlockDevicePositions()
List<Stratum>
getAvailableMonitoring()
An object that stores the maximum level for the monitoring query types and response types.List<Storage>
getAvailableNetworkStorages(String nasType)
This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Virtual_Guest.BigDecimal
getAverageDailyPrivateBandwidthUsage()
The average daily private bandwidth usage for the current billing cycle.BigDecimal
getAverageDailyPublicBandwidthUsage()
The average daily public bandwidth usage for the current billing cycle.List<Component>
getBackendNetworkComponents()
A guests's backend network components.List<Hardware>
getBackendRouters()
A guest's backend or private router.BigDecimal
getBandwidthAllocation()
A computing instance's allotted bandwidth (measured in GB).Detail
getBandwidthAllotmentDetail()
A computing instance's allotted detail record.List<Data>
getBandwidthDataByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime, String networkType)
Use this method when needing the metric data for bandwidth for a single guest.List<Data>
getBandwidthForDateRange(GregorianCalendar startDate, GregorianCalendar endDate)
Retrieve a collection of bandwidth data from an individual public or private network tracking object.GraphOutputs
getBandwidthImage(String networkType, String snapshotRange, GregorianCalendar dateSpecified, GregorianCalendar dateSpecifiedEnd)
Use this method when needing a bandwidth image for a single guest.GraphOutputs
getBandwidthImageByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime, String networkType)
Use this method when needing a bandwidth image for a single guest.Long
getBandwidthTotal(GregorianCalendar startDateTime, GregorianCalendar endDateTime, String direction, String side)
Returns the total amount of bandwidth used during the time specified for a computing instance.List<Usage>
getBillingCycleBandwidthUsage()
The raw bandwidth usage data for the current billing cycle.Usage
getBillingCyclePrivateBandwidthUsage()
The raw private bandwidth usage data for the current billing cycle.Usage
getBillingCyclePublicBandwidthUsage()
The raw public bandwidth usage data for the current billing cycle.Guest
getBillingItem()
The billing item for a CloudLayer Compute Instance.Boolean
getBlockCancelBecauseDisconnectedFlag()
Determines whether the instance is ineligible for cancellation because it is disconnected.List<Device>
getBlockDevices()
A computing instance's block devices.Group
getBlockDeviceTemplateGroup()
The global identifier for the image template that was used to provision or reload a guest.String
getBootMode()
Retrieves the boot mode of the VSI.String
getBootOrder()
List<BrowserConsoleAccessLog>
getBrowserConsoleAccessLogs()
A virtual guest's browser access logs.List<Syslog>
getConsoleAccessLog()
Gets the console access logs for a computing instanceConsoleData
getConsoleData()
A container for a guest's console dataBoolean
getConsoleIpAddressFlag()
A flag indicating a computing instance's console IP address is assigned.IpAddress
getConsoleIpAddressRecord()
A record containing information about a computing instance's console IP and port number.Component
getContinuousDataProtectionSoftwareComponent()
A continuous data protection software component object.Component
getControlPanel()
A guest's control panel.Price
getCoreRestrictedOperatingSystemPrice()
If the virtual server currently has an operating system that has a core capacity restriction, return the associated core-restricted operating system item price.List<Data>
getCpuMetricDataByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime, List<Long> cpuIndexes)
Use this method when needing the metric data for a single guest's CPUs.GraphOutputs
getCpuMetricImage(String snapshotRange, GregorianCalendar dateSpecified)
Use this method when needing a cpu usage image for a single guest.GraphOutputs
getCpuMetricImageByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime, List<Long> cpuIndexes)
Use this method when needing a CPU usage image for a single guest.Configuration
getCreateObjectOptions()
There are many options that may be provided while ordering a computing instance, this method can be used to determine what these options are.Summary
getCurrentBandwidthSummary()
An object that provides commonly used bandwidth summary components for the current billing cycle.List<Item>
getCurrentBillingDetail()
Get the billing detail for this instance for the current billing period.BigDecimal
getCurrentBillingTotal()
Get the total bill amount in US Dollars ($) for this instance in the current billing period.Graph
getCustomBandwidthDataByDate(Graph graphData)
Retrieve bandwidth graph by date.Graph
getCustomMetricDataByDate(Graph graphData)
Retrieve bandwidth graph by date.Location
getDatacenter()
The datacenter that a virtual guest resides in.DedicatedHost
getDedicatedHost()
The dedicated host associated with this guest.Status
getDeviceStatus()
The device status of this virtual guest.Price
getDriveRetentionItemPrice()
Return a drive retention SoftLayer_Item_Price object for a guest.List<Storage>
getEvaultNetworkStorage()
A guest's associated EVault network storage service account.List<Subnet>
getFirewallProtectableSubnets()
Get the subnets associated with this CloudLayer computing instance that are protectable by a network component firewall.Firewall
getFirewallServiceComponent()
A computing instance's hardware firewall services.String
getFirstAvailableBlockDevicePosition()
List<Component>
getFrontendNetworkComponents()
A guest's frontend network components.Hardware
getFrontendRouters()
A guest's frontend or public router.String
getGlobalIdentifier()
A guest's universally unique identifier.Long
getGpuCount()
The number of GPUs attached to the guest.String
getGpuType()
The name of the GPU type attached to the guest.Parameter
getGuestBootParameter()
String
getHardwareFunctionDescription()
The object's function.Host
getHost()
The virtual host on which a virtual guest resides (available only on private clouds).Component
getHostIpsSoftwareComponent()
A host IPS software component object.Boolean
getHourlyBillingFlag()
A guest's hourly billing status.BigDecimal
getInboundPrivateBandwidthUsage()
The total private inbound bandwidth for this computing instance for the current billing cycle.BigDecimal
getInboundPublicBandwidthUsage()
The total public inbound bandwidth for this computing instance for the current billing cycle.List<Reference>
getInternalTagReferences()
Image
getIsoBootImage()
List<Item>
getItemPricesFromSoftwareDescriptions(List<Description> softwareDescriptions, Boolean includeTranslationsFlag, Boolean returnAllPricesFlag)
Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_DescriptionState
getLastKnownPowerState()
The last known power state of a virtual guest in the event the guest is turned off outside of IMS or has gone offline.Transaction
getLastOperatingSystemReload()
The last transaction that a cloud server's operating system was loaded.Transaction
getLastTransaction()
The last transaction a cloud server had performed.Incident
getLatestNetworkMonitorIncident()
A virtual guest's latest network monitoring incident.Boolean
getLocalDiskFlag()
A flag indicating that the virtual guest has at least one disk which is local to the host it runs on.Location
getLocation()
Where guest is located within SoftLayer's location hierarchy.Boolean
getManagedResourceFlag()
A flag indicating that the virtual guest is a managed resource.List<Data>
getMemoryMetricDataByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime)
Use this method when needing the metric data for memory for a single computing instance.GraphOutputs
getMemoryMetricImage(String snapshotRange, GregorianCalendar dateSpecified)
Use this method when needing a memory usage image for a single guest.GraphOutputs
getMemoryMetricImageByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime)
Use this method when needing a image displaying the amount of memory used over time for a single computing instance.Object
getMetricTrackingObject()
A guest's metric tracking object.Long
getMetricTrackingObjectId()
The metric tracking object id for this guest.Robot
getMonitoringRobot()
Stratum
getMonitoringServiceComponent()
A virtual guest's network monitoring services.Boolean
getMonitoringServiceEligibilityFlag()
List<Guest>
getMonitoringUserNotification()
The monitoring notification objects for this guest.List<IpAddress>
getNetworkComponentFirewallProtectableIpAddresses()
Get the IP addresses associated with this CloudLayer computing instance that are protectable by a network component firewall.List<Component>
getNetworkComponents()
A guests's network components.List<Incident>
getNetworkMonitorIncidents()
All of a virtual guest's network monitoring incidents.List<Host>
getNetworkMonitors()
A guests's network monitors.List<Storage>
getNetworkStorage()
A guest's associated network storage accounts.List<Vlan>
getNetworkVlans()
The network Vlans that a guest's network components are associated with.Guest
getObject()
Ticket
getOpenCancellationTicket()
An open ticket requesting cancellation of this server, if one exists.OperatingSystem
getOperatingSystem()
A guest's operating system.String
getOperatingSystemReferenceCode()
A guest's operating system software description.String
getOrderedPackageId()
The original package id provided with the order for a Cloud Computing Instance.Order
getOrderTemplate(String billingType, List<Price> orderPrices)
Obtain an order container that is ready to be sent to the [[SoftLayer_Product_Order#placeOrder|SoftLayer_Product_Order::placeOrder]] method.BigDecimal
getOutboundPrivateBandwidthUsage()
The total private outbound bandwidth for this computing instance for the current billing cycle.BigDecimal
getOutboundPublicBandwidthUsage()
The total public outbound bandwidth for this computing instance for the current billing cycle.Long
getOverBandwidthAllocationFlag()
Whether the bandwidth usage for this computing instance for the current billing cycle exceeds the allocation.List<PendingMaintenanceAction>
getPendingMaintenanceActions()
Returns a list of all the pending maintenance actions affecting this guest.Boolean
getPendingMigrationFlag()
When true this virtual guest must be migrated using SoftLayer_Virtual_Guest::migrate.PlacementGroup
getPlacementGroup()
The placement group that a virtual guest belongs to.State
getPowerState()
The current power state of a virtual guest.String
getPrimaryBackendIpAddress()
A guest's primary private IP address.Component
getPrimaryBackendNetworkComponent()
A guest's primary backend network component.String
getPrimaryIpAddress()
The guest's primary public IP address.Component
getPrimaryNetworkComponent()
A guest's primary public network component.Boolean
getPrivateNetworkOnlyFlag()
Whether the computing instance only has access to the private network.Long
getProjectedOverBandwidthAllocationFlag()
Whether the bandwidth usage for this computing instance for the current billing cycle is projected to exceed the allocation.BigDecimal
getProjectedPublicBandwidthUsage()
The projected public outbound bandwidth for this computing instance for the current billing cycle.GregorianCalendar
getProvisionDate()
List<Event>
getRecentEvents()
Recent events that impact this computing instance.List<Object>
getRecentMetricData(Long time)
Recent metric data for a guestRegional
getRegionalGroup()
The regional group this guest is in.Registry
getRegionalInternetRegistry()
ReservedCapacityGroup
getReservedCapacityGroup()
The reserved capacity group the guest is associated with.Boolean
getReservedCapacityGroupFlag()
Flag to indicate whether or not a guest is part of a reserved capacity group.Instance
getReservedCapacityGroupInstance()
The reserved capacity group instance the guest is associated with.List<Domain>
getReverseDomainRecords()
Retrieve the reverse domain records associated with this server.List<Asset>
getScaleAssets()
Collection of scale assets this guest corresponds to.Boolean
getScaledFlag()
Whether or not this guest is a member of a scale group and was automatically created as part of a scale group action.Guest
getScaleMember()
The scale member for this guest, if applicable.List<Request>
getSecurityScanRequests()
A guest's vulnerability scan requests.Location
getServerRoom()
The server room that a guest is located at.List<Component>
getSoftwareComponents()
A guest's installed software.List<Key>
getSshKeys()
SSH keys to be installed on the server during provisioning or an OS reload.Status
getStatus()
A computing instance's status.List<Reference>
getTagReferences()
Boolean
getTransientGuestFlag()
Whether or not a computing instance is a Transient Instance.Attribute
getTransientWebhookURI()
The endpoint used to notify customers their transient guest is terminating.Type
getType()
The type of this virtual guest.List<Price>
getUpgradeItemPrices(Boolean includeDowngradeItemPrices)
Retrieves a list of all upgrades available to a virtual server.Request
getUpgradeRequest()
A computing instance's associated upgrade request object if any.List<Attribute>
getUserData()
A base64 encoded string containing custom user data for a Cloud Computing Instance order.List<Customer>
getUsers()
A list of users that have access to this computing instance.List<Group>
getValidBlockDeviceTemplateGroups(String visibility)
This method will return the list of block device template groups that are valid to the host.Allotment
getVirtualRack()
The name of the bandwidth allotment that a hardware belongs too.Long
getVirtualRackId()
The id of the bandwidth allotment that a computing instance belongs too.String
getVirtualRackName()
The name of the bandwidth allotment that a computing instance belongs too.Boolean
isBackendPingable()
Issues a ping command and returns the success (true) or failure (false) of the ping command.Boolean
isCloudInit()
Determines if the virtual guest was provisioned from a cloud-init enabled image.Void
isolateInstanceForDestructiveAction()
Closes the public or private ports to isolate the instance before a destructive action.Boolean
isPingable()
Issues a ping command and returns the success (true) or failure (false) of the ping command.Transaction
migrate()
Creates a transaction to migrate a virtual guest to a new host.Void
migrateDedicatedHost(Long destinationHostId)
Create a transaction to migrate an instance from one dedicated host to another dedicated hostTransaction
mountIsoImage(Long diskImageId)
Boolean
pause()
Pause a virtual guest.Boolean
powerCycle()
Power cycle a virtual guestBoolean
powerOff()
Power off a virtual guestBoolean
powerOffSoft()
Power off a virtual guestBoolean
powerOn()
Power on a virtual guestBoolean
rebootDefault()
Power cycle a virtual guestBoolean
rebootHard()
Power cycle a guest.Boolean
rebootSoft()
Attempt to complete a soft reboot of a guest by shutting down the operating system.Transaction
reloadCurrentOperatingSystemConfiguration()
Create a transaction to perform an OS reloadString
reloadOperatingSystem(String token, Configuration config)
Reloads current operating system configuration.Boolean
removeAccessToNetworkStorage(Storage networkStorageTemplateObject)
This method is used to remove access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.Boolean
removeAccessToNetworkStorageList(List<Storage> networkStorageTemplateObjects)
This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.Boolean
removeTags(String tags)
Boolean
resume()
Resume a virtual guest, this can only be called when a VSI is in Suspended state.Void
sendTestReclaimScheduledAlert()
void
setMask(Guest.Mask mask)
Boolean
setPrivateNetworkInterfaceSpeed(Long newSpeed)
Sets the private network interface speed to the new speed.Boolean
setPublicNetworkInterfaceSpeed(Long newSpeed)
Sets the public network interface speed to the new speed.Boolean
setTags(String tags)
Void
setTransientWebhook(String uri, String secret)
Boolean
setUserMetadata(List<String> metadata)
Sets the data that will be written to the configuration drive.Boolean
shutdownPrivatePort()
Shuts down the private network portBoolean
shutdownPublicPort()
Shuts down the public network portTransaction
unmountIsoImage()
Boolean
validateImageTemplate(Long imageTemplateId)
Validate an image template for OS ReloadBoolean
verifyReloadOperatingSystem(Configuration config)
Verify that a virtual server can go through the operating system reload process.Guest.Mask
withMask()
Use the existing mask on this service or create it if not presentGuest.Mask
withNewMask()
Overwrite the existing mask on this service with a new one and return it-
Methods inherited from interface com.softlayer.api.ResultLimitable
getLastResponseTotalItemCount, getResultLimit, setResultLimit
-
-
-
-
Method Detail
-
asAsync
Guest.ServiceAsync asAsync()
Description copied from interface:Service
Get an async version of this service
-
withNewMask
Guest.Mask withNewMask()
Description copied from interface:Maskable
Overwrite the existing mask on this service with a new one and return it- Specified by:
withNewMask
in interfaceMaskable
-
withMask
Guest.Mask withMask()
Description copied from interface:Maskable
Use the existing mask on this service or create it if not present
-
setMask
void setMask(Guest.Mask mask)
-
activatePrivatePort
@ApiMethod(instanceRequired=true) Boolean activatePrivatePort()
Activate the private network port
-
activatePublicPort
@ApiMethod(instanceRequired=true) Boolean activatePublicPort()
Activate the public network port
-
allowAccessToNetworkStorage
@ApiMethod(instanceRequired=true) Boolean allowAccessToNetworkStorage(Storage networkStorageTemplateObject)
This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.
-
allowAccessToNetworkStorageList
@ApiMethod(instanceRequired=true) Boolean allowAccessToNetworkStorageList(List<Storage> networkStorageTemplateObjects)
This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.
-
attachDiskImage
@ApiMethod(instanceRequired=true) Transaction attachDiskImage(Long imageId)
Creates a transaction to attach a guest's disk image. If the disk image is already attached it will be ignored.
WARNING: SoftLayer_Virtual_Guest::checkHostDiskAvailability should be called before this method. If the SoftLayer_Virtual_Guest::checkHostDiskAvailability method is not called before this method, the guest migration will happen automatically.- See Also:
- SoftLayer_Virtual_Guest::attachDiskImage
-
cancelIsolationForDestructiveAction
@ApiMethod(instanceRequired=true) Void cancelIsolationForDestructiveAction()
Reopens the public and/or private ports to reverse the changes made when the server was isolated for a destructive action.
-
captureImage
@ApiMethod(instanceRequired=true) Group captureImage(Template captureTemplate)
Captures a Flex Image of the hard disk on the virtual machine, based on the capture template parameter. Returns the image template group containing the disk image.- See Also:
- SoftLayer_Virtual_Guest::captureImage
-
checkHostDiskAvailability
@ApiMethod(instanceRequired=true) Boolean checkHostDiskAvailability(Long diskCapacity)
Checks the associated host for available disk space to determine if guest migration is necessary. This method is only used with local disks. If this method returns false, calling attachDiskImage($imageId) will automatically migrate the destination guest to a new host before attaching the portable volume.
-
configureMetadataDisk
@ApiMethod(instanceRequired=true) Transaction configureMetadataDisk()
Creates a transaction to configure the guest's metadata disk. If the guest has user data associated with it, the transaction will create a small virtual drive and write the metadata to a file on the drive; if the drive already exists, the metadata will be rewritten. If the guest has no user data associated with it, the transaction will remove the virtual drive if it exists.
WARNING: The transaction created by this service will shut down the guest while the metadata disk is configured. The guest will be turned back on once this process is complete.
-
createArchiveTemplate
@ApiMethod(instanceRequired=true) Group createArchiveTemplate(String groupName, List<Device> blockDevices, String note)
Create a transaction to archive a computing instance's block devices
-
createArchiveTransaction
@Deprecated @ApiMethod(instanceRequired=true) Transaction createArchiveTransaction(String groupName, List<Device> blockDevices, String note)
Deprecated.Create a transaction to archive a computing instance's block devices
-
createObject
@ApiMethod Guest createObject(Guest templateObject)
createObject() enables the creation of computing instances on an account. This method is a simplified alternative to interacting with the ordering system directly.
In order to create a computing instance, a template object must be sent in with a few required values.
When this method returns an order will have been placed for a computing instance of the specified configuration.
To determine when the instance is available you can poll the instance via [[SoftLayer_Virtual_Guest/getObject]], with an object mask requesting the `provisionDate` relational property. When `provisionDate` is not `null`, the instance will be ready.
> **Warning:** Computing instances created via this method will incur charges on your account. For testing input parameters see [[SoftLayer_Virtual_Guest/generateOrderTemplate]].
### Required Input [[SoftLayer_Virtual_Guest]]
- `Hostname` String **Required**
+ Hostname for the computing instance.
- `Domain` String **Required**
+ Domain for the computing instance.
- `startCpus` Integer **Required**
+ The number of CPU cores to allocate.
+ See [[SoftLayer_Virtual_Guest/getCreateObjectOptions]] for available options.
- `maxMemory` Integer **Required**
+ The amount of memory to allocate in megabytes.
+ See [[SoftLayer_Virtual_Guest/getCreateObjectOptions]] for available options.
- `datacenter.name` *String* **Required**
+ Specifies which datacenter the instance is to be provisioned in. Needs to be a nested object.
+ Example: `"datacenter": {"name": "dal05"}`
+ See [[SoftLayer_Virtual_Guest/getCreateObjectOptions]] for available options.
- `hourlyBillingFlag` Boolean **Required**
+ Specifies the billing type for the instance.
+ True for hourly billing, False for monthly billing.
- `localDiskFlag` Boolean **Required**
+ Specifies the disk type for the instance.
+ True for local to the instance disks, False for SAN disks.
- `dedicatedAccountHostOnlyFlag` Boolean
+ When true this flag specifies that a compute instance is to run on hosts that only have guests from the same account.
+ Default: False
- `operatingSystemReferenceCode` String **Conditionally required**
+ An identifier for the operating system to provision the computing instance with.
+ Not required when using a `blockDeviceTemplateGroup.globalIdentifier`, as the template will have its own operating system.
+ See [[SoftLayer_Virtual_Guest/getCreateObjectOptions]] for available options.
+ **Notice**: Some operating systems are billed based on the number of CPUs the guest has. The price which is used can be determined by calling
[[SoftLayer_Virtual_Guest/generateOrderTemplate]] with your desired device specifications.
- `blockDeviceTemplateGroup.globalIdentifier` String
+ The GUID for the template to be used to provision the computing instance.
+ Conflicts with `operatingSystemReferenceCode`
+ **Notice**: Some operating systems are billed based on the number of CPUs the guest has. The price which is used can be determined by calling
[[SoftLayer_Virtual_Guest/generateOrderTemplate]] with your desired device specifications.
+ A list of public images may be obtained via a request to [[SoftLayer_Virtual_Guest_Block_Device_Template_Group/getPublicImages]]
+ A list of private images may be obtained via a request to [[SoftLayer_Account/getPrivateBlockDeviceTemplateGroups]]
+ Example: `"blockDeviceTemplateGroup": { globalIdentifier": "07beadaa-1e11-476e-a188-3f7795feb9fb"`
- `networkComponents.maxSpeed` Integer
+ Specifies the connection speed for the instance's network components.
+ The `networkComponents` property is an array with a single [[SoftLayer_Virtual_Guest_Network_Component]] structure.
The `maxSpeed` property must be set to specify the network uplink speed, in megabits per second, of the computing instance.
+ See [[SoftLayer_Virtual_Guest/getCreateObjectOptions]] for available options.
+ Default: 10
+ Example: `"networkComponents": [{"maxSpeed": 1000}]`
- `privateNetworkOnlyFlag` Boolean
+ When true this flag specifies that a compute instance is to only have access to the private network.
+ Default: False
- `primaryNetworkComponent.networkVlan.id` Integer
+ Specifies the network vlan which is to be used for the frontend interface of the computing instance.
+ The `primaryNetworkComponent` property is a [[SoftLayer_Virtual_Guest_Network_Component]] structure with the `networkVlan` property populated with a i
[[SoftLayer_Network_Vlan]] structure. The `id` property must be set to specify the frontend network vlan of the computing instance.
+ *NOTE* This is the VLAN `id`, NOT the vlan number.
+ Example: `"primaryNetworkComponent":{"networkVlan": {"id": 1234567}}`
- `backendNetworkComponent.networkVlan.id` Integer
+ Specifies the network vlan which is to be used for the backend interface of the computing instance.
+ The `backendNetworkComponent` property is a [[SoftLayer_Virtual_Guest_Network_Component]] structure with the `networkVlan` property populated with a
[[SoftLayer_Network_Vlan]] structure. The `id` property must be set to specify the backend network vlan of the computing instance.
+ *NOTE* This is the VLAN `id`, NOT the vlan number.
+ Example: `"backendNetworkComponent":{"networkVlan": {"id": 1234567}}`
- `primaryNetworkComponent.securityGroupBindings` [[SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding]][]
+ Specifies the security groups to be attached to this VSI's frontend network adapter
+ The `primaryNetworkComponent` property is a [[SoftLayer_Virtual_Guest_Network_Component]] structure with the `securityGroupBindings` property populated
with an array of [[SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding]] structures. The `securityGroup` property in each must be set to
specify the security group to be attached to the primary frontend network component.
+ Example:
```
"primaryNetworkComponent": {
"securityGroupBindings": [
{"securityGroup":{"id": 5555555}},
{"securityGroup":{"id": 1112223}},
]
}
```
- `primaryBackendNetworkComponent.securityGroupBindings` [[SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding]][]
+ Specifies the security groups to be attached to this VSI's backend network adapter
+ The `primaryNetworkComponent` property is a [[SoftLayer_Virtual_Guest_Network_Component]] structure with the `securityGroupBindings` property populated
with an array of [[SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding]] structures. The `securityGroup` property in each must be set to
specify the security group to be attached to the primary frontend network component.
+ Example:
```
"primaryBackendNetworkComponent": {
"securityGroupBindings": [
{"securityGroup":{"id": 33322211}},
{"securityGroup":{"id": 77777222}},
]
}
```
- `blockDevices` [[SoftLayer_Virtual_Guest_Block_Device]][]
+ Block device and disk image settings for the computing instance
+ The `blockDevices` property is an array of [[SoftLayer_Virtual_Guest_Block_Device]] structures. Each block device must specify the `device` property
along with the `diskImage` property, which is a [[SoftLayer_Virtual_Disk_Image]] structure with the `capacity` property set. The `device` number `'1'`
is reserved for the SWAP disk attached to the computing instance.
+ Default: The smallest available capacity for the primary disk will be used. If an image template is specified the disk capacity will be be provided by the template.
+ Example:
```
"blockDevices":[{"device": "0", "diskImage": {"capacity": 100}}],
"localDiskFlag": true
```
+ See [[SoftLayer_Virtual_Guest/getCreateObjectOptions]] for available options.
- `userData.value` String
+ Arbitrary data to be made available to the computing instance.
+ The `userData` property is an array with a single [[SoftLayer_Virtual_Guest_Attribute]] structure with the `value` property set to an arbitrary value.
This value can be retrieved via the [[SoftLayer_Resource_Metadata/getUserMetadata]] method from a request originating from the computing instance.
This is primarily useful for providing data to software that may be on the instance and configured to execute upon first boot.
+ Example: `"userData":[{"value": "testData"}]`
- `sshKeys` [[SoftLayer_Security_Ssh_Key]][]
+ The `sshKeys` property is an array of [[SoftLayer_Security_Ssh_Key]] structures with the `id` property set to the value of an existing SSH key.
+ To create a new SSH key, call [[SoftLayer_Security_Ssh_Key/createObject|createObject]].
+ To obtain a list of existing SSH keys, call [[SoftLayer_Account/getSshKeys]]
+ Example: `"sshKeys":[{"id": 1234567}]`
- `postInstallScriptUri` String
+ Specifies the uri location of the script to be downloaded and run after installation is complete. Only scripts from HTTPS servers are executed on startup.
REST Example:
```
curl -X POST -d '{
"parameters":[
{
"hostname": "host1",
"domain": "example.com",
"startCpus": 1,
"maxMemory": 1024,
"hourlyBillingFlag": true,
"localDiskFlag": true,
"operatingSystemReferenceCode": "UBUNTU_LATEST"
}
}' https://api.softlayer.com/rest/v3.1/SoftLayer_Virtual_Guest/createObject.json
HTTP/1.1 201 Created
Location: https://api.softlayer.com/rest/v3.1/SoftLayer_Virtual_Guest/1301396/getObject
{
"accountId": 232298,
"createDate": "2012-11-30T16:28:17-06:00",
"dedicatedAccountHostOnlyFlag": false,
"domain": "example.com",
"hostname": "host1",
"id": 1301396,
"lastPowerStateId": null,
"lastVerifiedDate": null,
"maxCpu": 1,
"maxCpuUnits": "CORE",
"maxMemory": 1024,
"metricPollDate": null,
"modifyDate": null,
"privateNetworkOnlyFlag": false,
"startCpus": 1,
"statusId": 1001,
"globalIdentifier": "2d203774-0ee1-49f5-9599-6ef67358dd31"
}
```- See Also:
- SoftLayer_Virtual_Guest::createObject
-
createObjects
@ApiMethod List<Guest> createObjects(List<Guest> templateObjects)
createObjects() enables the creation of multiple computing instances on an account in a single call. This
method is a simplified alternative to interacting with the ordering system directly.
In order to create a computing instance a set of template objects must be sent in with a few required
values.
Warning: Computing instances created via this method will incur charges on your account.
See [[SoftLayer_Virtual_Guest/createObject|createObject]] for specifics on the requirements of each template object.
Example
curl -X POST -d '{
"parameters":[
[
{
"hostname": "host1",
"domain": "example.com",
"startCpus": 1,
"maxMemory": 1024,
"hourlyBillingFlag": true,
"localDiskFlag": true,
"operatingSystemReferenceCode": "UBUNTU_LATEST"
},
{
"hostname": "host2",
"domain": "example.com",
"startCpus": 1,
"maxMemory": 1024,
"hourlyBillingFlag": true,
"localDiskFlag": true,
"operatingSystemReferenceCode": "UBUNTU_LATEST"
}
]
]
}' https://api.softlayer.com/rest/v3/SoftLayer_Virtual_Guest/createObjects.json
HTTP/1.1 200 OK
[
{
"accountId": 232298,
"createDate": "2012-11-30T23:56:48-06:00",
"dedicatedAccountHostOnlyFlag": false,
"domain": "softlayer.com",
"hostname": "ubuntu1",
"id": 1301456,
"lastPowerStateId": null,
"lastVerifiedDate": null,
"maxCpu": 1,
"maxCpuUnits": "CORE",
"maxMemory": 1024,
"metricPollDate": null,
"modifyDate": null,
"privateNetworkOnlyFlag": false,
"startCpus": 1,
"statusId": 1001,
"globalIdentifier": "fed4c822-48c0-45d0-85e2-90476aa0c542"
},
{
"accountId": 232298,
"createDate": "2012-11-30T23:56:49-06:00",
"dedicatedAccountHostOnlyFlag": false,
"domain": "softlayer.com",
"hostname": "ubuntu2",
"id": 1301457,
"lastPowerStateId": null,
"lastVerifiedDate": null,
"maxCpu": 1,
"maxCpuUnits": "CORE",
"maxMemory": 1024,
"metricPollDate": null,
"modifyDate": null,
"privateNetworkOnlyFlag": false,
"startCpus": 1,
"statusId": 1001,
"globalIdentifier": "bed4c686-9562-4ade-9049-dc4d5b6b200c"
}
]
- See Also:
- SoftLayer_Virtual_Guest::createObjects
-
createPostSoftwareInstallTransaction
@ApiMethod(instanceRequired=true) Boolean createPostSoftwareInstallTransaction(String data, Boolean returnBoolean)
-
deleteObject
@ApiMethod(instanceRequired=true) Boolean deleteObject()
This method will cancel a computing instance effective immediately. For instances billed hourly, the charges will stop immediately after the method returns.- See Also:
- SoftLayer_Virtual_Guest::deleteObject
-
deleteTag
@ApiMethod(instanceRequired=true) Boolean deleteTag(String tagName)
- See Also:
- SoftLayer_Virtual_Guest::deleteTag
-
deleteTransientWebhook
@ApiMethod(instanceRequired=true) Void deleteTransientWebhook()
-
detachDiskImage
@ApiMethod(instanceRequired=true) Transaction detachDiskImage(Long imageId)
Creates a transaction to detach a guest's disk image. If the disk image is already detached it will be ignored.
WARNING: The transaction created by this service will shut down the guest while the disk image is attached. The guest will be turned back on once this process is complete.- See Also:
- SoftLayer_Virtual_Guest::detachDiskImage
-
editObject
@ApiMethod(instanceRequired=true) Boolean editObject(Guest templateObject)
Edit a computing instance's properties- See Also:
- SoftLayer_Virtual_Guest::editObject
-
executeIderaBareMetalRestore
@ApiMethod(instanceRequired=true) Boolean executeIderaBareMetalRestore()
Reboot a guest into the Idera Bare Metal Restore image.
-
executeR1SoftBareMetalRestore
@ApiMethod(instanceRequired=true) Boolean executeR1SoftBareMetalRestore()
Reboot a guest into the R1Soft Bare Metal Restore image.
-
executeRemoteScript
@ApiMethod(instanceRequired=true) Void executeRemoteScript(String uri)
Download and run remote script from uri on virtual guests.
-
executeRescueLayer
@ApiMethod(instanceRequired=true) Boolean executeRescueLayer()
Reboot a Linux guest into the Xen rescue image.
-
findByHostname
@ApiMethod List<Guest> findByHostname(String hostname)
Find VSIs by hostname.- See Also:
- SoftLayer_Virtual_Guest::findByHostname
-
findByIpAddress
@ApiMethod Guest findByIpAddress(String ipAddress)
Find CCI by only its primary public or private IP address. IP addresses within secondary subnets tied to the CCI will not return the CCI. If no CCI is found, no errors are generated and no data is returned.- See Also:
- SoftLayer_Virtual_Guest::findByIpAddress
-
generateOrderTemplate
@ApiMethod Order generateOrderTemplate(Guest templateObject)
Obtain an [[SoftLayer_Container_Product_Order_Virtual_Guest (type)|order container]] that can be sent to [[SoftLayer_Product_Order/verifyOrder|verifyOrder]] or [[SoftLayer_Product_Order/placeOrder|placeOrder]].
This is primarily useful when there is a necessity to confirm the price which will be charged for an order.
See [[SoftLayer_Virtual_Guest/createObject|createObject]] for specifics on the requirements of the template object parameter.
-
getAdditionalRequiredPricesForOsReload
@ApiMethod(instanceRequired=true) List<Price> getAdditionalRequiredPricesForOsReload(Configuration config)
Return a collection of SoftLayer_Item_Price objects for an OS reload
-
getAttachedNetworkStorages
@ApiMethod(instanceRequired=true) List<Storage> getAttachedNetworkStorages(String nasType)
This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Virtual_Guest.
-
getAvailableBlockDevicePositions
@ApiMethod(instanceRequired=true) List<String> getAvailableBlockDevicePositions()
-
getAvailableNetworkStorages
@ApiMethod(instanceRequired=true) List<Storage> getAvailableNetworkStorages(String nasType)
This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Virtual_Guest.
-
getBandwidthDataByDate
@ApiMethod(instanceRequired=true) List<Data> getBandwidthDataByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime, String networkType)
Use this method when needing the metric data for bandwidth for a single guest. It will gather the correct input parameters based on the date ranges
-
getBandwidthForDateRange
@ApiMethod(instanceRequired=true) List<Data> getBandwidthForDateRange(GregorianCalendar startDate, GregorianCalendar endDate)
Retrieve a collection of bandwidth data from an individual public or private network tracking object. Data is ideal if you with to employ your own traffic storage and graphing systems.
-
getBandwidthImage
@ApiMethod(instanceRequired=true) GraphOutputs getBandwidthImage(String networkType, String snapshotRange, GregorianCalendar dateSpecified, GregorianCalendar dateSpecifiedEnd)
Use this method when needing a bandwidth image for a single guest. It will gather the correct input parameters for the generic graphing utility automatically based on the snapshot specified.
-
getBandwidthImageByDate
@ApiMethod(instanceRequired=true) GraphOutputs getBandwidthImageByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime, String networkType)
Use this method when needing a bandwidth image for a single guest. It will gather the correct input parameters for the generic graphing utility based on the date ranges
-
getBandwidthTotal
@ApiMethod(instanceRequired=true) Long getBandwidthTotal(GregorianCalendar startDateTime, GregorianCalendar endDateTime, String direction, String side)
Returns the total amount of bandwidth used during the time specified for a computing instance.
-
getBootMode
@ApiMethod(instanceRequired=true) String getBootMode()
Retrieves the boot mode of the VSI.- See Also:
- SoftLayer_Virtual_Guest::getBootMode
-
getBootOrder
@ApiMethod(instanceRequired=true) String getBootOrder()
- See Also:
- SoftLayer_Virtual_Guest::getBootOrder
-
getConsoleAccessLog
@ApiMethod(instanceRequired=true) List<Syslog> getConsoleAccessLog()
Gets the console access logs for a computing instance
-
getCoreRestrictedOperatingSystemPrice
@ApiMethod(instanceRequired=true) Price getCoreRestrictedOperatingSystemPrice()
If the virtual server currently has an operating system that has a core capacity restriction, return the associated core-restricted operating system item price. Some operating systems (e.g., Red Hat Enterprise Linux) may be billed by the number of processor cores, so therefore require that a certain number of cores be present on the server.
-
getCpuMetricDataByDate
@ApiMethod(instanceRequired=true) List<Data> getCpuMetricDataByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime, List<Long> cpuIndexes)
Use this method when needing the metric data for a single guest's CPUs. It will gather the correct input parameters based on the date ranges
-
getCpuMetricImage
@ApiMethod(instanceRequired=true) GraphOutputs getCpuMetricImage(String snapshotRange, GregorianCalendar dateSpecified)
Use this method when needing a cpu usage image for a single guest. It will gather the correct input parameters for the generic graphing utility automatically based on the snapshot specified.
-
getCpuMetricImageByDate
@ApiMethod(instanceRequired=true) GraphOutputs getCpuMetricImageByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime, List<Long> cpuIndexes)
Use this method when needing a CPU usage image for a single guest. It will gather the correct input parameters for the generic graphing utility based on the date ranges
-
getCreateObjectOptions
@ApiMethod Configuration getCreateObjectOptions()
There are many options that may be provided while ordering a computing instance, this method can be used to determine what these options are.
Detailed information on the return value can be found on the data type page for [[SoftLayer_Container_Virtual_Guest_Configuration (type)]].
-
getCurrentBillingDetail
@ApiMethod(instanceRequired=true) List<Item> getCurrentBillingDetail()
Get the billing detail for this instance for the current billing period. This does not include bandwidth usage.
-
getCurrentBillingTotal
@ApiMethod(instanceRequired=true) BigDecimal getCurrentBillingTotal()
Get the total bill amount in US Dollars ($) for this instance in the current billing period. This includes all bandwidth used up to the point this method is called on the instance.
-
getCustomBandwidthDataByDate
@ApiMethod(instanceRequired=true) Graph getCustomBandwidthDataByDate(Graph graphData)
Retrieve bandwidth graph by date.
-
getCustomMetricDataByDate
@ApiMethod(instanceRequired=true) Graph getCustomMetricDataByDate(Graph graphData)
Retrieve bandwidth graph by date.
-
getDriveRetentionItemPrice
@ApiMethod(instanceRequired=true) Price getDriveRetentionItemPrice()
Return a drive retention SoftLayer_Item_Price object for a guest.
-
getFirewallProtectableSubnets
@ApiMethod(instanceRequired=true) List<Subnet> getFirewallProtectableSubnets()
Get the subnets associated with this CloudLayer computing instance that are protectable by a network component firewall.
-
getFirstAvailableBlockDevicePosition
@ApiMethod(instanceRequired=true) String getFirstAvailableBlockDevicePosition()
-
getIsoBootImage
@ApiMethod(instanceRequired=true) Image getIsoBootImage()
- See Also:
- SoftLayer_Virtual_Guest::getIsoBootImage
-
getItemPricesFromSoftwareDescriptions
@ApiMethod(instanceRequired=true) List<Item> getItemPricesFromSoftwareDescriptions(List<Description> softwareDescriptions, Boolean includeTranslationsFlag, Boolean returnAllPricesFlag)
Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description
-
getMemoryMetricDataByDate
@ApiMethod(instanceRequired=true) List<Data> getMemoryMetricDataByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime)
Use this method when needing the metric data for memory for a single computing instance.
-
getMemoryMetricImage
@ApiMethod(instanceRequired=true) GraphOutputs getMemoryMetricImage(String snapshotRange, GregorianCalendar dateSpecified)
Use this method when needing a memory usage image for a single guest. It will gather the correct input parameters for the generic graphing utility automatically based on the snapshot specified.
-
getMemoryMetricImageByDate
@ApiMethod(instanceRequired=true) GraphOutputs getMemoryMetricImageByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime)
Use this method when needing a image displaying the amount of memory used over time for a single computing instance. It will gather the correct input parameters for the generic graphing utility based on the date ranges
-
getNetworkComponentFirewallProtectableIpAddresses
@ApiMethod(instanceRequired=true) List<IpAddress> getNetworkComponentFirewallProtectableIpAddresses()
Get the IP addresses associated with this CloudLayer computing instance that are protectable by a network component firewall. Note, this may not return all values for IPv6 subnets for this CloudLayer computing instance. Please use getFirewallProtectableSubnets to get all protectable subnets.
-
getObject
@ApiMethod(instanceRequired=true) Guest getObject()
- See Also:
- SoftLayer_Virtual_Guest::getObject
-
getOrderTemplate
@ApiMethod(instanceRequired=true) Order getOrderTemplate(String billingType, List<Price> orderPrices)
Obtain an order container that is ready to be sent to the [[SoftLayer_Product_Order#placeOrder|SoftLayer_Product_Order::placeOrder]] method. This container will include all services that the selected computing instance has. If desired you may remove prices which were returned.
-
getPendingMaintenanceActions
@ApiMethod(instanceRequired=true) List<PendingMaintenanceAction> getPendingMaintenanceActions()
Returns a list of all the pending maintenance actions affecting this guest.
-
getProvisionDate
@ApiMethod(instanceRequired=true) GregorianCalendar getProvisionDate()
-
getRecentMetricData
@ApiMethod(instanceRequired=true) List<Object> getRecentMetricData(Long time)
Recent metric data for a guest
-
getReverseDomainRecords
@ApiMethod(instanceRequired=true) List<Domain> getReverseDomainRecords()
Retrieve the reverse domain records associated with this server.
-
getUpgradeItemPrices
@ApiMethod(instanceRequired=true) List<Price> getUpgradeItemPrices(Boolean includeDowngradeItemPrices)
Retrieves a list of all upgrades available to a virtual server. Upgradeable items include, but are not limited to, number of cores, amount of RAM, storage configuration, and network port speed.
This method exclude downgrade item prices by default. You can set the "includeDowngradeItemPrices" parameter to true so that it can include downgrade item prices.
-
getValidBlockDeviceTemplateGroups
@ApiMethod(instanceRequired=true) List<Group> getValidBlockDeviceTemplateGroups(String visibility)
This method will return the list of block device template groups that are valid to the host. For instance, it will validate that the template groups returned are compatible with the size and number of disks on the host.
-
isBackendPingable
@ApiMethod(instanceRequired=true) Boolean isBackendPingable()
Issues a ping command and returns the success (true) or failure (false) of the ping command.
-
isCloudInit
@ApiMethod(instanceRequired=true) Boolean isCloudInit()
Determines if the virtual guest was provisioned from a cloud-init enabled image.- See Also:
- SoftLayer_Virtual_Guest::isCloudInit
-
isPingable
@ApiMethod(instanceRequired=true) Boolean isPingable()
Issues a ping command and returns the success (true) or failure (false) of the ping command.- See Also:
- SoftLayer_Virtual_Guest::isPingable
-
isolateInstanceForDestructiveAction
@ApiMethod(instanceRequired=true) Void isolateInstanceForDestructiveAction()
Closes the public or private ports to isolate the instance before a destructive action.
-
migrate
@ApiMethod(instanceRequired=true) Transaction migrate()
Creates a transaction to migrate a virtual guest to a new host. NOTE: Will only migrate if SoftLayer_Virtual_Guest property pendingMigrationFlag = true- See Also:
- SoftLayer_Virtual_Guest::migrate
-
migrateDedicatedHost
@ApiMethod(instanceRequired=true) Void migrateDedicatedHost(Long destinationHostId)
Create a transaction to migrate an instance from one dedicated host to another dedicated host
-
mountIsoImage
@ApiMethod(instanceRequired=true) Transaction mountIsoImage(Long diskImageId)
- See Also:
- SoftLayer_Virtual_Guest::mountIsoImage
-
pause
@ApiMethod(instanceRequired=true) Boolean pause()
Pause a virtual guest. This can only be called when the specified VM is in the Running state.- See Also:
- SoftLayer_Virtual_Guest::pause
-
powerCycle
@ApiMethod(instanceRequired=true) Boolean powerCycle()
Power cycle a virtual guest- See Also:
- SoftLayer_Virtual_Guest::powerCycle
-
powerOff
@ApiMethod(instanceRequired=true) Boolean powerOff()
Power off a virtual guest- See Also:
- SoftLayer_Virtual_Guest::powerOff
-
powerOffSoft
@ApiMethod(instanceRequired=true) Boolean powerOffSoft()
Power off a virtual guest- See Also:
- SoftLayer_Virtual_Guest::powerOffSoft
-
powerOn
@ApiMethod(instanceRequired=true) Boolean powerOn()
Power on a virtual guest- See Also:
- SoftLayer_Virtual_Guest::powerOn
-
rebootDefault
@ApiMethod(instanceRequired=true) Boolean rebootDefault()
Power cycle a virtual guest- See Also:
- SoftLayer_Virtual_Guest::rebootDefault
-
rebootHard
@ApiMethod(instanceRequired=true) Boolean rebootHard()
Power cycle a guest.- See Also:
- SoftLayer_Virtual_Guest::rebootHard
-
rebootSoft
@ApiMethod(instanceRequired=true) Boolean rebootSoft()
Attempt to complete a soft reboot of a guest by shutting down the operating system.- See Also:
- SoftLayer_Virtual_Guest::rebootSoft
-
reloadCurrentOperatingSystemConfiguration
@ApiMethod(instanceRequired=true) Transaction reloadCurrentOperatingSystemConfiguration()
Create a transaction to perform an OS reload
-
reloadOperatingSystem
@ApiMethod(instanceRequired=true) String reloadOperatingSystem(String token, Configuration config)
Reloads current operating system configuration.
This service has a confirmation protocol for proceeding with the reload. To proceed with the reload without confirmation, simply pass in 'FORCE' as the token parameter. To proceed with the reload with confirmation, simply call the service with no parameter. A token string will be returned by this service. The token will remain active for 10 minutes. Use this token as the parameter to confirm that a reload is to be performed for the server.
As a precaution, we strongly recommend backing up all data before reloading the operating system. The reload will format the primary disk and will reconfigure the computing instance to the current specifications on record.
If reloading from an image template, we recommend first getting the list of valid private block device template groups, by calling the getOperatingSystemReloadImages method.
-
removeAccessToNetworkStorage
@ApiMethod(instanceRequired=true) Boolean removeAccessToNetworkStorage(Storage networkStorageTemplateObject)
This method is used to remove access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.
-
removeAccessToNetworkStorageList
@ApiMethod(instanceRequired=true) Boolean removeAccessToNetworkStorageList(List<Storage> networkStorageTemplateObjects)
This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.
-
removeTags
@ApiMethod(instanceRequired=true) Boolean removeTags(String tags)
- See Also:
- SoftLayer_Virtual_Guest::removeTags
-
resume
@ApiMethod(instanceRequired=true) Boolean resume()
Resume a virtual guest, this can only be called when a VSI is in Suspended state.- See Also:
- SoftLayer_Virtual_Guest::resume
-
sendTestReclaimScheduledAlert
@ApiMethod(instanceRequired=true) Void sendTestReclaimScheduledAlert()
-
setPrivateNetworkInterfaceSpeed
@ApiMethod(instanceRequired=true) Boolean setPrivateNetworkInterfaceSpeed(Long newSpeed)
Sets the private network interface speed to the new speed. Speed values can only be 0 (Disconnect), 10, 100, or 1000. The new speed must be equal to or less than the max speed of the interface.
It will take less than a minute to update the port speed.
-
setPublicNetworkInterfaceSpeed
@ApiMethod(instanceRequired=true) Boolean setPublicNetworkInterfaceSpeed(Long newSpeed)
Sets the public network interface speed to the new speed. Speed values can only be 0 (Disconnect), 10, 100, or 1000. The new speed must be equal to or less than the max speed of the interface.
It will take less than a minute to update the port speed.
-
setTags
@ApiMethod(instanceRequired=true) Boolean setTags(String tags)
- See Also:
- SoftLayer_Virtual_Guest::setTags
-
setTransientWebhook
@ApiMethod(instanceRequired=true) Void setTransientWebhook(String uri, String secret)
-
setUserMetadata
@ApiMethod(instanceRequired=true) Boolean setUserMetadata(List<String> metadata)
Sets the data that will be written to the configuration drive.- See Also:
- SoftLayer_Virtual_Guest::setUserMetadata
-
shutdownPrivatePort
@ApiMethod(instanceRequired=true) Boolean shutdownPrivatePort()
Shuts down the private network port
-
shutdownPublicPort
@ApiMethod(instanceRequired=true) Boolean shutdownPublicPort()
Shuts down the public network port
-
unmountIsoImage
@ApiMethod(instanceRequired=true) Transaction unmountIsoImage()
- See Also:
- SoftLayer_Virtual_Guest::unmountIsoImage
-
validateImageTemplate
@ApiMethod(instanceRequired=true) Boolean validateImageTemplate(Long imageTemplateId)
Validate an image template for OS Reload
-
verifyReloadOperatingSystem
@ApiMethod(instanceRequired=true) Boolean verifyReloadOperatingSystem(Configuration config)
Verify that a virtual server can go through the operating system reload process. It may be useful to call this method before attempting to actually reload the operating system just to verify that the reload will go smoothly. If the server configuration is not setup correctly or there is some other issue, an exception will be thrown indicating the error. If there were no issues, this will just return true.
-
getAccount
@ApiMethod(instanceRequired=true) Account getAccount()
The account that a virtual guest belongs to.- See Also:
- SoftLayer_Virtual_Guest::getAccount
-
getAccountOwnedPoolFlag
@ApiMethod(instanceRequired=true) Boolean getAccountOwnedPoolFlag()
-
getActiveNetworkMonitorIncident
@ApiMethod(instanceRequired=true) List<Incident> getActiveNetworkMonitorIncident()
A virtual guest's currently active network monitoring incidents.
-
getActiveTickets
@ApiMethod(instanceRequired=true) List<Ticket> getActiveTickets()
-
getActiveTransaction
@ApiMethod(instanceRequired=true) Transaction getActiveTransaction()
A transaction that is still be performed on a cloud server.
-
getActiveTransactions
@ApiMethod(instanceRequired=true) List<Transaction> getActiveTransactions()
Any active transaction(s) that are currently running for the server (example: os reload).
-
getAllowedHost
@ApiMethod(instanceRequired=true) Host getAllowedHost()
The SoftLayer_Network_Storage_Allowed_Host information to connect this Virtual Guest to Network Storage volumes that require access control lists.- See Also:
- SoftLayer_Virtual_Guest::getAllowedHost
-
getAllowedNetworkStorage
@ApiMethod(instanceRequired=true) List<Storage> getAllowedNetworkStorage()
The SoftLayer_Network_Storage objects that this SoftLayer_Virtual_Guest has access to.
-
getAllowedNetworkStorageReplicas
@ApiMethod(instanceRequired=true) List<Storage> getAllowedNetworkStorageReplicas()
The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Virtual_Guest has access to.
-
getAntivirusSpywareSoftwareComponent
@ApiMethod(instanceRequired=true) Component getAntivirusSpywareSoftwareComponent()
A antivirus / spyware software component object.
-
getApplicationDeliveryController
@ApiMethod(instanceRequired=true) Controller getApplicationDeliveryController()
-
getAttributes
@ApiMethod(instanceRequired=true) List<Attribute> getAttributes()
- See Also:
- SoftLayer_Virtual_Guest::getAttributes
-
getAvailableMonitoring
@ApiMethod(instanceRequired=true) List<Stratum> getAvailableMonitoring()
An object that stores the maximum level for the monitoring query types and response types.
-
getAverageDailyPrivateBandwidthUsage
@ApiMethod(instanceRequired=true) BigDecimal getAverageDailyPrivateBandwidthUsage()
The average daily private bandwidth usage for the current billing cycle.
-
getAverageDailyPublicBandwidthUsage
@ApiMethod(instanceRequired=true) BigDecimal getAverageDailyPublicBandwidthUsage()
The average daily public bandwidth usage for the current billing cycle.
-
getBackendNetworkComponents
@ApiMethod(instanceRequired=true) List<Component> getBackendNetworkComponents()
A guests's backend network components.
-
getBackendRouters
@ApiMethod(instanceRequired=true) List<Hardware> getBackendRouters()
A guest's backend or private router.
-
getBandwidthAllocation
@ApiMethod(instanceRequired=true) BigDecimal getBandwidthAllocation()
A computing instance's allotted bandwidth (measured in GB).
-
getBandwidthAllotmentDetail
@ApiMethod(instanceRequired=true) Detail getBandwidthAllotmentDetail()
A computing instance's allotted detail record. Allotment details link bandwidth allocation with allotments.
-
getBillingCycleBandwidthUsage
@ApiMethod(instanceRequired=true) List<Usage> getBillingCycleBandwidthUsage()
The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to.
-
getBillingCyclePrivateBandwidthUsage
@ApiMethod(instanceRequired=true) Usage getBillingCyclePrivateBandwidthUsage()
The raw private bandwidth usage data for the current billing cycle.
-
getBillingCyclePublicBandwidthUsage
@ApiMethod(instanceRequired=true) Usage getBillingCyclePublicBandwidthUsage()
The raw public bandwidth usage data for the current billing cycle.
-
getBillingItem
@ApiMethod(instanceRequired=true) Guest getBillingItem()
The billing item for a CloudLayer Compute Instance.- See Also:
- SoftLayer_Virtual_Guest::getBillingItem
-
getBlockCancelBecauseDisconnectedFlag
@ApiMethod(instanceRequired=true) Boolean getBlockCancelBecauseDisconnectedFlag()
Determines whether the instance is ineligible for cancellation because it is disconnected.
-
getBlockDeviceTemplateGroup
@ApiMethod(instanceRequired=true) Group getBlockDeviceTemplateGroup()
The global identifier for the image template that was used to provision or reload a guest.
-
getBlockDevices
@ApiMethod(instanceRequired=true) List<Device> getBlockDevices()
A computing instance's block devices. Block devices link [[SoftLayer_Virtual_Disk_Image|disk images]] to computing instances.- See Also:
- SoftLayer_Virtual_Guest::getBlockDevices
-
getBrowserConsoleAccessLogs
@ApiMethod(instanceRequired=true) List<BrowserConsoleAccessLog> getBrowserConsoleAccessLogs()
A virtual guest's browser access logs.
-
getConsoleData
@ApiMethod(instanceRequired=true) ConsoleData getConsoleData()
A container for a guest's console data- See Also:
- SoftLayer_Virtual_Guest::getConsoleData
-
getConsoleIpAddressFlag
@ApiMethod(instanceRequired=true) Boolean getConsoleIpAddressFlag()
A flag indicating a computing instance's console IP address is assigned.
-
getConsoleIpAddressRecord
@ApiMethod(instanceRequired=true) IpAddress getConsoleIpAddressRecord()
A record containing information about a computing instance's console IP and port number.
-
getContinuousDataProtectionSoftwareComponent
@ApiMethod(instanceRequired=true) Component getContinuousDataProtectionSoftwareComponent()
A continuous data protection software component object.
-
getControlPanel
@ApiMethod(instanceRequired=true) Component getControlPanel()
A guest's control panel.- See Also:
- SoftLayer_Virtual_Guest::getControlPanel
-
getCurrentBandwidthSummary
@ApiMethod(instanceRequired=true) Summary getCurrentBandwidthSummary()
An object that provides commonly used bandwidth summary components for the current billing cycle.
-
getDatacenter
@ApiMethod(instanceRequired=true) Location getDatacenter()
The datacenter that a virtual guest resides in.- See Also:
- SoftLayer_Virtual_Guest::getDatacenter
-
getDedicatedHost
@ApiMethod(instanceRequired=true) DedicatedHost getDedicatedHost()
The dedicated host associated with this guest.
-
getDeviceStatus
@ApiMethod(instanceRequired=true) Status getDeviceStatus()
The device status of this virtual guest.- See Also:
- SoftLayer_Virtual_Guest::getDeviceStatus
-
getEvaultNetworkStorage
@ApiMethod(instanceRequired=true) List<Storage> getEvaultNetworkStorage()
A guest's associated EVault network storage service account.
-
getFirewallServiceComponent
@ApiMethod(instanceRequired=true) Firewall getFirewallServiceComponent()
A computing instance's hardware firewall services.
-
getFrontendNetworkComponents
@ApiMethod(instanceRequired=true) List<Component> getFrontendNetworkComponents()
A guest's frontend network components.
-
getFrontendRouters
@ApiMethod(instanceRequired=true) Hardware getFrontendRouters()
A guest's frontend or public router.
-
getGlobalIdentifier
@ApiMethod(instanceRequired=true) String getGlobalIdentifier()
A guest's universally unique identifier.
-
getGpuCount
@ApiMethod(instanceRequired=true) Long getGpuCount()
The number of GPUs attached to the guest.- See Also:
- SoftLayer_Virtual_Guest::getGpuCount
-
getGpuType
@ApiMethod(instanceRequired=true) String getGpuType()
The name of the GPU type attached to the guest.- See Also:
- SoftLayer_Virtual_Guest::getGpuType
-
getGuestBootParameter
@ApiMethod(instanceRequired=true) Parameter getGuestBootParameter()
-
getHardwareFunctionDescription
@ApiMethod(instanceRequired=true) String getHardwareFunctionDescription()
The object's function.
-
getHost
@ApiMethod(instanceRequired=true) Host getHost()
The virtual host on which a virtual guest resides (available only on private clouds).- See Also:
- SoftLayer_Virtual_Guest::getHost
-
getHostIpsSoftwareComponent
@ApiMethod(instanceRequired=true) Component getHostIpsSoftwareComponent()
A host IPS software component object.
-
getHourlyBillingFlag
@ApiMethod(instanceRequired=true) Boolean getHourlyBillingFlag()
A guest's hourly billing status.
-
getInboundPrivateBandwidthUsage
@ApiMethod(instanceRequired=true) BigDecimal getInboundPrivateBandwidthUsage()
The total private inbound bandwidth for this computing instance for the current billing cycle.
-
getInboundPublicBandwidthUsage
@ApiMethod(instanceRequired=true) BigDecimal getInboundPublicBandwidthUsage()
The total public inbound bandwidth for this computing instance for the current billing cycle.
-
getInternalTagReferences
@ApiMethod(instanceRequired=true) List<Reference> getInternalTagReferences()
-
getLastKnownPowerState
@ApiMethod(instanceRequired=true) State getLastKnownPowerState()
The last known power state of a virtual guest in the event the guest is turned off outside of IMS or has gone offline.
-
getLastOperatingSystemReload
@ApiMethod(instanceRequired=true) Transaction getLastOperatingSystemReload()
The last transaction that a cloud server's operating system was loaded.
-
getLastTransaction
@ApiMethod(instanceRequired=true) Transaction getLastTransaction()
The last transaction a cloud server had performed.
-
getLatestNetworkMonitorIncident
@ApiMethod(instanceRequired=true) Incident getLatestNetworkMonitorIncident()
A virtual guest's latest network monitoring incident.
-
getLocalDiskFlag
@ApiMethod(instanceRequired=true) Boolean getLocalDiskFlag()
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.
-
getLocation
@ApiMethod(instanceRequired=true) Location getLocation()
Where guest is located within SoftLayer's location hierarchy.- See Also:
- SoftLayer_Virtual_Guest::getLocation
-
getManagedResourceFlag
@ApiMethod(instanceRequired=true) Boolean getManagedResourceFlag()
A flag indicating that the virtual guest is a managed resource.
-
getMetricTrackingObject
@ApiMethod(instanceRequired=true) Object getMetricTrackingObject()
A guest's metric tracking object.
-
getMetricTrackingObjectId
@ApiMethod(instanceRequired=true) Long getMetricTrackingObjectId()
The metric tracking object id for this guest.
-
getMonitoringRobot
@ApiMethod(instanceRequired=true) Robot getMonitoringRobot()
-
getMonitoringServiceComponent
@ApiMethod(instanceRequired=true) Stratum getMonitoringServiceComponent()
A virtual guest's network monitoring services.
-
getMonitoringServiceEligibilityFlag
@ApiMethod(instanceRequired=true) Boolean getMonitoringServiceEligibilityFlag()
-
getMonitoringUserNotification
@ApiMethod(instanceRequired=true) List<Guest> getMonitoringUserNotification()
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
-
getNetworkComponents
@ApiMethod(instanceRequired=true) List<Component> getNetworkComponents()
A guests's network components.
-
getNetworkMonitorIncidents
@ApiMethod(instanceRequired=true) List<Incident> getNetworkMonitorIncidents()
All of a virtual guest's network monitoring incidents.
-
getNetworkMonitors
@ApiMethod(instanceRequired=true) List<Host> getNetworkMonitors()
A guests's network monitors.
-
getNetworkStorage
@ApiMethod(instanceRequired=true) List<Storage> getNetworkStorage()
A guest's associated network storage accounts.
-
getNetworkVlans
@ApiMethod(instanceRequired=true) List<Vlan> getNetworkVlans()
The network Vlans that a guest's network components are associated with.- See Also:
- SoftLayer_Virtual_Guest::getNetworkVlans
-
getOpenCancellationTicket
@ApiMethod(instanceRequired=true) Ticket getOpenCancellationTicket()
An open ticket requesting cancellation of this server, if one exists.
-
getOperatingSystem
@ApiMethod(instanceRequired=true) OperatingSystem getOperatingSystem()
A guest's operating system.
-
getOperatingSystemReferenceCode
@ApiMethod(instanceRequired=true) String getOperatingSystemReferenceCode()
A guest's operating system software description.
-
getOrderedPackageId
@ApiMethod(instanceRequired=true) String getOrderedPackageId()
The original package id provided with the order for a Cloud Computing Instance.
-
getOutboundPrivateBandwidthUsage
@ApiMethod(instanceRequired=true) BigDecimal getOutboundPrivateBandwidthUsage()
The total private outbound bandwidth for this computing instance for the current billing cycle.
-
getOutboundPublicBandwidthUsage
@ApiMethod(instanceRequired=true) BigDecimal getOutboundPublicBandwidthUsage()
The total public outbound bandwidth for this computing instance for the current billing cycle.
-
getOverBandwidthAllocationFlag
@ApiMethod(instanceRequired=true) Long getOverBandwidthAllocationFlag()
Whether the bandwidth usage for this computing instance for the current billing cycle exceeds the allocation.
-
getPendingMigrationFlag
@ApiMethod(instanceRequired=true) Boolean getPendingMigrationFlag()
When true this virtual guest must be migrated using SoftLayer_Virtual_Guest::migrate.
-
getPlacementGroup
@ApiMethod(instanceRequired=true) PlacementGroup getPlacementGroup()
The placement group that a virtual guest belongs to.
-
getPowerState
@ApiMethod(instanceRequired=true) State getPowerState()
The current power state of a virtual guest.- See Also:
- SoftLayer_Virtual_Guest::getPowerState
-
getPrimaryBackendIpAddress
@ApiMethod(instanceRequired=true) String getPrimaryBackendIpAddress()
A guest's primary private IP address.
-
getPrimaryBackendNetworkComponent
@ApiMethod(instanceRequired=true) Component getPrimaryBackendNetworkComponent()
A guest's primary backend network component.
-
getPrimaryIpAddress
@ApiMethod(instanceRequired=true) String getPrimaryIpAddress()
The guest's primary public IP address.
-
getPrimaryNetworkComponent
@ApiMethod(instanceRequired=true) Component getPrimaryNetworkComponent()
A guest's primary public network component.
-
getPrivateNetworkOnlyFlag
@ApiMethod(instanceRequired=true) Boolean getPrivateNetworkOnlyFlag()
Whether the computing instance only has access to the private network.
-
getProjectedOverBandwidthAllocationFlag
@ApiMethod(instanceRequired=true) Long getProjectedOverBandwidthAllocationFlag()
Whether the bandwidth usage for this computing instance for the current billing cycle is projected to exceed the allocation.
-
getProjectedPublicBandwidthUsage
@ApiMethod(instanceRequired=true) BigDecimal getProjectedPublicBandwidthUsage()
The projected public outbound bandwidth for this computing instance for the current billing cycle.
-
getRecentEvents
@ApiMethod(instanceRequired=true) List<Event> getRecentEvents()
Recent events that impact this computing instance.- See Also:
- SoftLayer_Virtual_Guest::getRecentEvents
-
getRegionalGroup
@ApiMethod(instanceRequired=true) Regional getRegionalGroup()
The regional group this guest is in.
-
getRegionalInternetRegistry
@ApiMethod(instanceRequired=true) Registry getRegionalInternetRegistry()
-
getReservedCapacityGroup
@ApiMethod(instanceRequired=true) ReservedCapacityGroup getReservedCapacityGroup()
The reserved capacity group the guest is associated with.
-
getReservedCapacityGroupFlag
@ApiMethod(instanceRequired=true) Boolean getReservedCapacityGroupFlag()
Flag to indicate whether or not a guest is part of a reserved capacity group.
-
getReservedCapacityGroupInstance
@ApiMethod(instanceRequired=true) Instance getReservedCapacityGroupInstance()
The reserved capacity group instance the guest is associated with.
-
getScaleAssets
@ApiMethod(instanceRequired=true) List<Asset> getScaleAssets()
Collection of scale assets this guest corresponds to.- See Also:
- SoftLayer_Virtual_Guest::getScaleAssets
-
getScaleMember
@ApiMethod(instanceRequired=true) Guest getScaleMember()
The scale member for this guest, if applicable.- See Also:
- SoftLayer_Virtual_Guest::getScaleMember
-
getScaledFlag
@ApiMethod(instanceRequired=true) Boolean getScaledFlag()
Whether or not this guest is a member of a scale group and was automatically created as part of a scale group action.- See Also:
- SoftLayer_Virtual_Guest::getScaledFlag
-
getSecurityScanRequests
@ApiMethod(instanceRequired=true) List<Request> getSecurityScanRequests()
A guest's vulnerability scan requests.
-
getServerRoom
@ApiMethod(instanceRequired=true) Location getServerRoom()
The server room that a guest is located at. There may be more than one server room for every data center.- See Also:
- SoftLayer_Virtual_Guest::getServerRoom
-
getSoftwareComponents
@ApiMethod(instanceRequired=true) List<Component> getSoftwareComponents()
A guest's installed software.
-
getSshKeys
@ApiMethod(instanceRequired=true) List<Key> getSshKeys()
SSH keys to be installed on the server during provisioning or an OS reload.- See Also:
- SoftLayer_Virtual_Guest::getSshKeys
-
getStatus
@ApiMethod(instanceRequired=true) Status getStatus()
A computing instance's status.- See Also:
- SoftLayer_Virtual_Guest::getStatus
-
getTagReferences
@ApiMethod(instanceRequired=true) List<Reference> getTagReferences()
-
getTransientGuestFlag
@ApiMethod(instanceRequired=true) Boolean getTransientGuestFlag()
Whether or not a computing instance is a Transient Instance.
-
getTransientWebhookURI
@ApiMethod(instanceRequired=true) Attribute getTransientWebhookURI()
The endpoint used to notify customers their transient guest is terminating.
-
getType
@ApiMethod(instanceRequired=true) Type getType()
The type of this virtual guest.- See Also:
- SoftLayer_Virtual_Guest::getType
-
getUpgradeRequest
@ApiMethod(instanceRequired=true) Request getUpgradeRequest()
A computing instance's associated upgrade request object if any.
-
getUserData
@ApiMethod(instanceRequired=true) List<Attribute> getUserData()
A base64 encoded string containing custom user data for a Cloud Computing Instance order.- See Also:
- SoftLayer_Virtual_Guest::getUserData
-
getUsers
@ApiMethod(instanceRequired=true) List<Customer> getUsers()
A list of users that have access to this computing instance.- See Also:
- SoftLayer_Virtual_Guest::getUsers
-
getVirtualRack
@ApiMethod(instanceRequired=true) Allotment getVirtualRack()
The name of the bandwidth allotment that a hardware belongs too.- See Also:
- SoftLayer_Virtual_Guest::getVirtualRack
-
getVirtualRackId
@ApiMethod(instanceRequired=true) Long getVirtualRackId()
The id of the bandwidth allotment that a computing instance belongs too.
-
getVirtualRackName
@ApiMethod(instanceRequired=true) String getVirtualRackName()
The name of the bandwidth allotment that a computing instance belongs too.
-
-