Items with tag virtual

    go

    java

    reference

    • activatePrivatePort
      Activate the private network port
    • activatePublicPort
      Activate the public network port
    • addByolAttribute
      This method allows you to mark this image template as customer managed software license (BYOL)
    • addCloudInitAttribute
      This method allows you to mark this image template as cloud init
    • addLocations
      This method will create transaction(s) to add available locations to an archive image template.
    • addSupportedBootMode
      This method allows you to mark this image's supported boot modes as 'HVM' or 'PV'.
    • allowAccessToNetworkStorage
      This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.
    • allowAccessToNetworkStorageList
      This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.
    • attachDiskImage
      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.
    • cancelIsolationForDestructiveAction
      Reopens the public and/or private ports to reverse the changes made when the server was isolated for a destructive action.
    • captureImage
      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.
    • checkHostDiskAvailability
      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
      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.
    • copyToExternalSource
      Create a transaction to export/copy a template to an external source.
    • copyToIcos
      Create a transaction to export/copy a template to an ICOS.
    • createArchiveTemplate
      Create a transaction to archive a computing instance's block devices
    • createArchiveTransaction
      Create a transaction to archive a computing instance's block devices
    • createFromExternalSource
      Create a transaction to import a disk image from an external source and create a standard image template.
    • createFromIcos
      Create a process to import a disk image from ICOS and create a standard
    • createObject
      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](/reference/services/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](/reference/services/SoftLayer_Virtual_Guest/generateOrderTemplate). ### Required Input [SoftLayer_Virtual_Guest](/reference/datatypes/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](/reference/services/SoftLayer_Virtual_Guest/getCreateObjectOptions) for available options. - `maxMemory` Integer **Required** + The amount of memory to allocate in megabytes. + See [SoftLayer_Virtual_Guest::getCreateObjectOptions](/reference/services/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](/reference/services/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](/reference/services/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](/reference/services/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](/reference/services/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](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getPublicImages) + A list of private images may be obtained via a request to [SoftLayer_Account::getPrivateBlockDeviceTemplateGroups](/reference/services/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](/reference/datatypes/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](/reference/services/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](/reference/datatypes/SoftLayer_Virtual_Guest_Network_Component) structure with the `networkVlan` property populated with a i [SoftLayer_Network_Vlan](/reference/datatypes/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](/reference/datatypes/SoftLayer_Virtual_Guest_Network_Component) structure with the `networkVlan` property populated with a [SoftLayer_Network_Vlan](/reference/datatypes/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](/reference/datatypes/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](/reference/datatypes/SoftLayer_Virtual_Guest_Network_Component) structure with the `securityGroupBindings` property populated with an array of [SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding](/reference/datatypes/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](/reference/datatypes/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](/reference/datatypes/SoftLayer_Virtual_Guest_Network_Component) structure with the `securityGroupBindings` property populated with an array of [SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding](/reference/datatypes/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](/reference/datatypes/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](/reference/datatypes/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](/reference/datatypes/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](/reference/services/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](/reference/datatypes/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](/reference/services/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](/reference/datatypes/SoftLayer_Security_Ssh_Key)[] + The `sshKeys` property is an array of [SoftLayer_Security_Ssh_Key](/reference/datatypes/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](/reference/services/SoftLayer_Security_Ssh_Key/createObject). + To obtain a list of existing SSH keys, call [SoftLayer_Account::getSshKeys](/reference/services/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' } ```
    • createObject
      Create a boot parameter record to be used at next boot
    • createObject
      Add a placement group to your account for use during VSI provisioning.
    • createObjects
      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. <b>Warning:</b> Computing instances created via this method will incur charges on your account. See [SoftLayer_Virtual_Guest::createObject](/reference/services/SoftLayer_Virtual_Guest/createObject) for specifics on the requirements of each template object. <h1>Example</h1> <http title='Request'>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> <http title='Response'>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' } ] </http>
    • createPostSoftwareInstallTransaction
    • createPublicArchiveTransaction
      Create a transaction to copy archived block devices into public repository
    • deleteByolAttribute
      This method allows you to remove BYOL attribute for a given image template.
    • deleteCloudInitAttribute
      This method allows you to remove cloud init attribute for a given image template.
    • deleteObject
      This method will cancel a dedicated host immediately.
    • deleteObject
      This method will cancel a computing instance effective immediately. For instances billed hourly, the charges will stop immediately after the method returns.
    • deleteObject
      Deleting a block device template group is different from the deletion of other objects. A block device template group can contain several gigabytes of data in its disk images. This may take some time to delete and requires a transaction to be created. This method creates a transaction that will delete all resources associated with the block device template group.
    • deleteObject
      Removes a boot parameter
    • deleteObject
      Delete a placement group from your account.
    • deleteTag
      Delete a tag
    • deleteTransientWebhook
    • denySharingAccess
      This method will deny another SoftLayer customer account's previously given access to provision CloudLayer Computing Instances from an image template group. Template access should only be removed from the parent template group object, not the child.
    • detachDiskImage
      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.
    • disable
      Completely restrict all incoming and outgoing bandwidth traffic to a network component
    • editObject
      Edit a dedicated host's properties.
    • editObject
    • editObject
      Edit a computing instance's properties
    • editObject
      Edit an image template group's associated name and note. All other properties in the SoftLayer_Virtual_Guest_Block_Device_Template_Group data type are read-only.
    • editObject
      Edits a single boot parameter
    • editObject
      Update a placement group.
    • editObject
      Update a reserved capacity group.
    • enable
      Allow incoming and outgoing bandwidth traffic to a network component
    • executeIderaBareMetalRestore
      Reboot a guest into the Idera Bare Metal Restore image.
    • executeR1SoftBareMetalRestore
      Reboot a guest into the R1Soft Bare Metal Restore image.
    • executeRemoteScript
      Download and run remote script from uri on virtual guests.
    • executeRescueLayer
      Reboot a Linux guest into the Xen rescue image.
    • findByHostname
      Find VSIs by hostname.
    • findByIpAddress
      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.
    • findGcImagesByCurrentUser
      Find block device template groups containing a GC enabled cloudinit image for the current active user. A sorted collection of groups is returned. The Caller can optionally specify data center or region names to retrieve GC images from only those locations.
    • generateOrderTemplate
      Obtain an [SoftLayer_Container_Product_Order_Virtual_Guest](/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest) that can be sent to [SoftLayer_Product_Order::verifyOrder](/reference/services/SoftLayer_Product_Order/verifyOrder) or [SoftLayer_Product_Order::placeOrder](/reference/services/SoftLayer_Product_Order/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](/reference/services/SoftLayer_Virtual_Guest/createObject) for specifics on the requirements of the template object parameter.
    • getAccount
      The account that the dedicated host belongs to.
    • getAccount
      The account that a virtual guest belongs to.
    • getAccount
      A block device template group's [SoftLayer_Account](/reference/datatypes/SoftLayer_Account).
    • getAccount
      The account which a virtual host belongs to.
    • getAccount
      The account that the placement group is implemented on.
    • getAccount
      The account that the reserved capacity group is implemented on.
    • getAccount
      The [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) that a storage repository belongs to.
    • getAccountContacts
    • getAccountOwnedPoolFlag
    • getAccountReferences
      The accounts which may have read-only access to an image template group. Will only be populated for parent template group objects.
    • getActiveNetworkMonitorIncident
      A virtual guest's currently active network monitoring incidents.
    • getActiveTickets
    • getActiveTransaction
      A transaction that is still be performed on a cloud server.
    • getActiveTransactions
      Any active transaction(s) that are currently running for the server (example: os reload).
    • getAdditionalRequiredPricesForOsReload
      Return a collection of SoftLayer_Item_Price objects for an OS reload
    • getAllAvailableCompatiblePlatformNames
      Get all available compatible platform names that can be added to a template group.
    • getAllObjects
    • getAllObjects
      Get all placement group rules.
    • getAllocationStatus
      The container that represents allocations on the dedicated host.
    • getAllowedHost
      The SoftLayer_Network_Storage_Allowed_Host information to connect this Virtual Guest to Network Storage volumes that require access control lists.
    • getAllowedNetworkStorage
      The SoftLayer_Network_Storage objects that this SoftLayer_Virtual_Guest has access to.
    • getAllowedNetworkStorageReplicas
      The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Virtual_Guest has access to.
    • getAntivirusSpywareSoftwareComponent
      A antivirus / spyware software component object.
    • getApplicationDeliveryController
    • getArchiveDiskUsageRatePerGb
      Returns the archive storage disk usage fee rate per gigabyte.
    • getAttachedNetworkStorages
      This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Virtual_Guest.
    • getAttributes
    • getAvailableBlockDevicePositions
    • getAvailableBootModes
      Returns a collection of boot modes that are supported for primary disks.
    • getAvailableFlag
      Flag to indecate whether or not the reserved instance is available or not.
    • getAvailableInstances
      The instances available for guest provisions on this reserved capacity group.
    • getAvailableMonitoring
      An object that stores the maximum level for the monitoring query types and response types.
    • getAvailableNetworkStorages
      This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Virtual_Guest.
    • getAvailableRouters
      This method will get the available backend routers to order a dedicated host.
    • getAvailableRouters
      Returns all routers available for use with placement groups. If a datacenter location ID is provided, this method will further restrict the list of routers to ones contained within that datacenter.
    • getAverageDailyPrivateBandwidthUsage
      The average daily private bandwidth usage for the current billing cycle.
    • getAverageDailyPublicBandwidthUsage
      The average daily public bandwidth usage for the current billing cycle.
    • getAverageDiskUsageMetricDataFromInfluxByDate
      Returns the average disk space usage for a storage repository.
    • getAverageUsageMetricDataByDate
      Returns the average disk space usage for a storage repository.
    • getBackendNetworkComponents
      A guests's backend network components.
    • getBackendRouter
      The backend router behind dedicated host's pool of resources.
    • getBackendRouter
      The router the placement group is implemented on.
    • getBackendRouter
      The router the reserved capacity group is implemented on.
    • getBackendRouters
      A guest's backend or private router.
    • getBandwidthAllocation
      A computing instance's allotted bandwidth (measured in GB).
    • getBandwidthAllotmentDetail
      A computing instance's allotted detail record. Allotment details link bandwidth allocation with allotments.
    • getBandwidthDataByDate
      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
      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
      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
      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
      Returns the total amount of bandwidth used during the time specified for a computing instance.
    • 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
      The raw private bandwidth usage data for the current billing cycle.
    • getBillingCyclePublicBandwidthUsage
      The raw public bandwidth usage data for the current billing cycle.
    • getBillingItem
      The billing item for the dedicated host.
    • getBillingItem
      The billing item for a virtual disk image.
    • getBillingItem
      The billing item for a CloudLayer Compute Instance.
    • getBillingItem
      The billing item for the reserved capacity group instance.
    • getBillingItem
      The current billing item for a storage repository.
    • getBlockCancelBecauseDisconnectedFlag
      Determines whether the instance is ineligible for cancellation because it is disconnected.
    • getBlockDevices
      The block devices that a disk image is attached to. Block devices connect computing instances to disk images.
    • getBlockDevices
      A computing instance's block devices. Block devices link [SoftLayer_Virtual_Disk_Image](/reference/datatypes/SoftLayer_Virtual_Disk_Image) to computing instances.
    • getBlockDevices
      The block devices that are part of an image template group
    • getBlockDevicesDiskSpaceTotal
      The total disk space of all images in a image template group.
    • getBlockDeviceTemplateGroup
      The global identifier for the image template that was used to provision or reload a guest.
    • getBootableVolumeFlag
    • getBootMode
      Retrieves the boot mode of the VSI.
    • getBootMode
      This method returns the boot mode, if any, set on a given image template.
    • getBootOrder
    • getBrowserConsoleAccessLogs
      A virtual guest's browser access logs.
    • getByolFlag
      A flag indicating that customer is providing the software licenses.
    • getChildren
      The image template groups that are clones of an image template group.
    • getCloudInitFlag
      Check if cloud-init is enabled.
    • getCoalescedDiskImages
    • getConsoleAccessLog
      Gets the console access logs for a computing instance
    • getConsoleData
      A container for a guest's console data
    • getConsoleIpAddressFlag
      [DEPRECATED] A flag indicating a computing instance's console IP address is assigned.
    • getConsoleIpAddressRecord
      [DEPRECATED] A record containing information about a computing instance's console IP and port number.
    • getContinuousDataProtectionSoftwareComponent
      A continuous data protection software component object.
    • getControlPanel
      A guest's control panel.
    • getCopyOnWriteFlag
    • 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
      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
      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
      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
      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](/reference/datatypes/SoftLayer_Container_Virtual_Guest_Configuration).
    • getCurrentBandwidthSummary
      An object that provides commonly used bandwidth summary components for the current billing cycle.
    • getCurrentBillingDetail
      Get the billing detail for this instance for the current billing period. This does not include bandwidth usage.
    • 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.
    • getCurrentCompatiblePlatformNames
      Get compatible platform names currently set on the template group.
    • getDatacenter
      The datacenter that the dedicated host resides in.
    • getDatacenter
      The datacenter that a virtual guest resides in.
    • getDatacenter
      The location containing this image template group. Will only be populated for child template group objects.
    • getDatacenter
      The datacenter that a virtual storage repository resides in.
    • getDatacenters
      A collection of locations containing a copy of this image template group. Will only be populated for parent template group objects.
    • getDedicatedHost
      The dedicated host associated with this guest.
    • getDefaultBootMode
      This method returns the default boot mode set by the software description
    • getDeviceStatus
      The device status of this virtual guest.
    • getDiskFileExtension
      Return disk file extension
    • getDiskImages
      The [SoftLayer_Virtual_Disk_Image](/reference/datatypes/SoftLayer_Virtual_Disk_Image) that are in a storage repository. Disk images are the virtual hard drives for a virtual guest.
    • getDiskImageStorageGroup
    • getDriveRetentionItemPrice
      Return a drive retention SoftLayer_Item_Price object for a guest.
    • getEncryptionAttributes
      This method returns an array of encryption values, or empty array if none are found
    • getEvaultNetworkStorage
      A guest's associated EVault network storage service account.
    • getFirewallProtectableSubnets
      Get the subnets associated with this CloudLayer computing instance that are protectable by a network component firewall.
    • getFirewallServiceComponent
      A computing instance's hardware firewall services.
    • getFirstAvailableBlockDevicePosition
    • getFirstChild
      The first clone of the image template group
    • getFlexImageFlag
      A flag indicating if this is a flex image.
    • getFrontendNetworkComponents
      A guest's frontend network components.
    • getFrontendRouters
      A guest's frontend or public router.
    • getGlobalIdentifier
      A guest's universally unique identifier.
    • getGlobalIdentifier
      An image template's universally unique identifier.
    • getGpuCount
      The number of GPUs attached to the guest.
    • getGpuType
      The name of the GPU type attached to the guest.
    • getGuest
    • getGuest
      The computing instance that this network component exists on.
    • getGuest
      The virtual guest associated with this reserved capacity group instance.
    • getGuestBootParameter
    • getGuestBootParameterType
    • getGuests
      The guests associated with the dedicated host.
    • getGuests
      The virtual guests that are members of the placement group.
    • getGuests
      The computing instances that have disk images in a storage repository.
    • getHardware
      The hardware record which a virtual host resides on.
    • getHardwareFunctionDescription
      The object's function.
    • getHighAvailabilityFirewallFlag
    • getHost
      The virtual host on which a virtual guest resides (available only on private clouds).
    • getHostIpsSoftwareComponent
      A host IPS software component object.
    • getHourlyBillingFlag
      A guest's hourly billing status.
    • getIcpBinding
    • getImageType
      The virtual disk image type of this template. Value will be populated on parent and child, but only supports object filtering on the parent.
    • getImageTypeKeyName
      The virtual disk image type keyname (e.g. SYSTEM, DISK_CAPTURE, ISO, etc) of this template. Value will be populated on parent and child, but only supports object filtering on the parent.
    • getImportedDiskType
      Return imported disk type
    • getInboundPrivateBandwidthUsage
      The total private inbound bandwidth for this computing instance for the current billing cycle.
    • getInboundPublicBandwidthUsage
      The total public inbound bandwidth for this computing instance for the current billing cycle.
    • getInstances
      The guest instances that are members of this reserved capacity group.
    • getInstancesCount
      The number of instances that are members of this reserved capacity group.
    • getInternalTagReferences
    • getInternalTagReferences
    • getIpAddressBindings
      The records of all IP addresses bound to a computing instance's network component.
    • getIsEncrypted
      Return if image is encrypted
    • getIsoBootImage
    • getItemPricesFromSoftwareDescriptions
      Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description
    • 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
      The last transaction that a cloud server's operating system was loaded.
    • getLastTransaction
      The last transaction a cloud server had performed.
    • getLatestNetworkMonitorIncident
      A virtual guest's latest network monitoring incident.
    • getLocalDiskFlag
    • 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
      Where guest is located within SoftLayer's location hierarchy.
    • getManagedResourceFlag
      A flag indicating that the virtual guest is a managed resource.
    • getMemoryMetricDataByDate
      Use this method when needing the metric data for memory for a single computing instance.
    • getMemoryMetricImage
      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
      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
    • getMetadataFlag
      Whether this disk image is meant for storage of custom user data supplied with a Cloud Computing Instance order.
    • getMetricTrackingObject
      A guest's metric tracking object.
    • getMetricTrackingObject
      The metric tracking object for this virtual host.
    • getMetricTrackingObject
    • getMetricTrackingObjectId
      The metric tracking object id for this guest.
    • getMonitoringRobot
    • getMonitoringServiceComponent
      A virtual guest's network monitoring services.
    • getMonitoringServiceEligibilityFlag
    • 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
    • getNetworkComponentFirewall
      The upstream network component firewall.
    • 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.
    • getNetworkComponents
      A guests's network components.
    • getNetworkMonitorIncidents
      All of a virtual guest's network monitoring incidents.
    • getNetworkMonitors
      A guests's network monitors.
    • getNetworkStorage
      A guest's associated network storage accounts.
    • getNetworkVlan
      The VLAN that a computing instance network component's subnet is associated with.
    • getNetworkVlans
      The network Vlans that a guest's network components are associated with.
    • getNextGenFlag
      A flag indicating if this is a next generation image.
    • getObject
      Retrieve a SoftLayer_Virtual_DedicatedHost record.
    • getObject
      Retrieve a SoftLayer_Virtual_Disk_Image record.
    • getObject
      Retrieve a SoftLayer_Virtual_Guest record.
    • getObject
      Retrieve a SoftLayer_Virtual_Guest_Block_Device_Template_Group record.
    • getObject
      Retrieve a SoftLayer_Virtual_Guest_Boot_Parameter record.
    • getObject
      Retrieve a SoftLayer_Virtual_Guest_Boot_Parameter_Type record.
    • getObject
      Retrieve a SoftLayer_Virtual_Guest_Network_Component record.
    • getObject
      Retrieve a SoftLayer_Virtual_Host record.
    • getObject
      Retrieve a SoftLayer_Virtual_PlacementGroup record.
    • getObject
      Retrieve a SoftLayer_Virtual_PlacementGroup_Rule record.
    • getObject
      Retrieve a SoftLayer_Virtual_ReservedCapacityGroup record.
    • getObject
      Retrieve a SoftLayer_Virtual_ReservedCapacityGroup_Instance record.
    • getObject
      Retrieve a SoftLayer_Virtual_Storage_Repository record.
    • getOccupiedInstances
      The instances already occupied by a guest on this reserved capacity group.
    • getOpenCancellationTicket
      An open ticket requesting cancellation of this server, if one exists.
    • getOperatingSystem
      A guest's operating system.
    • getOperatingSystemReferenceCode
      A guest's operating system software description.
    • getOrderedPackageId
      The original package id provided with the order for a Cloud Computing Instance.
    • getOrderTemplate
      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.
    • getOutboundPrivateBandwidthUsage
      The total private outbound bandwidth for this computing instance for the current billing cycle.
    • getOutboundPublicBandwidthUsage
      The total public outbound bandwidth for this computing instance for the current billing cycle.
    • getOverBandwidthAllocationFlag
      Whether the bandwidth usage for this computing instance for the current billing cycle exceeds the allocation.
    • getParent
      The image template group that another image template group was cloned from.
    • getPciDeviceAllocationStatus
      The container that represents PCI device allocations on the dedicated host.
    • getPciDevices
      A collection of SoftLayer_Virtual_Host_PciDevice objects on the host.
    • getPciDevices
    • getPendingMaintenanceActions
      Returns a list of all the pending maintenance actions affecting this guest.
    • getPendingMigrationFlag
      When true this virtual guest must be migrated using SoftLayer_Virtual_Guest::migrate.
    • getPlacementGroup
      The placement group that a virtual guest belongs to.
    • getPowerState
      The current power state of a virtual guest.
    • getPrimaryBackendIpAddress
      A guest's primary private IP address.
    • getPrimaryBackendNetworkComponent
      A guest's primary backend network component.
    • getPrimaryIpAddress
      The guest's primary public IP address.
    • getPrimaryIpAddress
      A computing instance network component's primary IP address.
    • getPrimaryIpAddressRecord
    • getPrimaryNetworkComponent
      A guest's primary public network component.
    • getPrimarySubnet
      A network component's subnet for its primary IP address
    • getPrimaryVersion6IpAddressRecord
      A network component's primary IPv6 IP address record.
    • getPrivateNetworkOnlyFlag
      Whether the computing instance only has access to the private network.
    • getProjectedOverBandwidthAllocationFlag
      Whether the bandwidth usage for this computing instance for the current billing cycle is projected to exceed the allocation.
    • getProjectedPublicBandwidthUsage
      The projected public outbound bandwidth for this computing instance for the current billing cycle.
    • getProvisionDate
    • getPublicCustomerOwnedImages
      This method gets all public customer owned image templates that the user is allowed to see.
    • getPublicImageBillingItem
      The current billing item for a public storage repository.
    • getPublicImageDiskUsageRatePerGb
      Returns the public image storage disk usage fee rate per gigabyte.
    • getPublicImages
      This method gets all public image templates that the user is allowed to see.
    • getPublicIsoImages
      Retrieves images from the public ISO repository
    • getRecentEvents
      Recent events that impact this computing instance.
    • getRecentMetricData
      Recent metric data for a guest
    • getRegion
    • getRegionalGroup
      The regional group this guest is in.
    • getRegionalInternetRegistry
    • getRegions
    • getReservedCapacityGroup
      The reserved capacity group the guest is associated with.
    • getReservedCapacityGroup
      The reserved instances that are members of this reserved capacity group.
    • getReservedCapacityGroupFlag
      Flag to indicate whether or not a guest is part of a reserved capacity group.
    • getReservedCapacityGroupInstance
      The reserved capacity group instance the guest is associated with.
    • getReverseDomainRecords
      Retrieve the reverse domain records associated with this server.
    • getRiasAccount
    • getRouter
      A network component's routers.
    • getRule
      The placement rule that the placement group is implementing.
    • getSecurityGroupBindings
      The bindings associating security groups to this network component
    • getSecurityScanRequests
      A guest's vulnerability scan requests.
    • getServerRoom
      The server room that a guest is located at. There may be more than one server room for every data center.
    • getSoftwareComponents
      A guest's installed software.
    • getSoftwareReferences
      References to the software that resides on a disk image.
    • getSourceDiskImage
      The original disk image that the current disk image was cloned from.
    • getSshKeys
      SSH keys to be installed on the server during provisioning or an OS reload.
    • getSshKeys
      The ssh keys to be implemented on the server when provisioned or reloaded from an image template group.
    • getStatus
      A computing instance's status.
    • getStatus
      A template group's status.
    • getStorageGroupDetails
      Return storage group details for symantec disk
    • getStorageGroups
      The storage group for a virtual disk image.
    • getStorageLocations
      Returns the image storage locations.
    • getStorageLocations
      Returns the public image storage locations.
    • getStorageRepository
      The storage repository that a disk image resides in.
    • getStorageRepository
      The storage repository that an image template group resides on.
    • getStorageRepositoryType
      The type of storage repository that a disk image resides in.
    • getSubnets
      A network component's subnets. A subnet is a group of IP addresses
    • getSupportedBootModes
      This method indicates which boot modes are supported by the image.
    • getSupportedHardware
      Return supported hardware component IDs for symantec disk
    • getTagReferences
    • getTagReferences
    • getTagReferences
      The tags associated with this image template group.
    • getTemplateBlockDevice
      The template that attaches a disk image to a [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/datatypes/SoftLayer_Virtual_Guest_Block_Device_Template_Group).
    • getTemplateDataCenterName
      This method allows you to grab the first data center that the image(s) reside on so we can pull it from there.
    • getTransaction
      A transaction that is being performed on a image template group.
    • getTransientGuestFlag
      Whether or not a computing instance is a Transient Instance.
    • getTransientWebhookURI
      The endpoint used to notify customers their transient guest is terminating.
    • getType
      A virtual disk image's type.
    • getType
      The type of this virtual guest.
    • getType
      A storage repository's [SoftLayer_Virtual_Storage_Repository_Type](/reference/datatypes/SoftLayer_Virtual_Storage_Repository_Type).
    • getUpgradeItemPrices
      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.
    • getUpgradeRequest
      A computing instance's associated upgrade request object if any.
    • getUsageMetricDataByDate
      Retrieve disk usage data on a [SoftLayer_Virtual_Guest](/reference/datatypes/SoftLayer_Virtual_Guest) image for the time range you provide. Each data entry objects contain ''dateTime'' and ''counter'' properties. ''dateTime'' property indicates the time that the disk usage data was measured and ''counter'' property holds the disk usage in bytes.
    • getUsageMetricImageByDate
      Returns a disk usage image based on disk usage specified by the input parameters.
    • getUserData
      A base64 encoded string containing custom user data for a Cloud Computing Instance order.
    • getUsers
      A list of users that have access to this computing instance.
    • getValidBlockDeviceTemplateGroups
      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.
    • getVhdImportSoftwareDescriptions
      Returns an array of SoftLayer_Software_Description that are supported for VHD imports.
    • getVirtualRack
      The name of the bandwidth allotment that a hardware belongs too.
    • getVirtualRackId
      The id of the bandwidth allotment that a computing instance belongs too.
    • getVirtualRackName
      The name of the bandwidth allotment that a computing instance belongs too.
    • isBackendPingable
      Issues a ping command and returns the success (true) or failure (false) of the ping command.
    • isByol
      This method indicates whether or not this image is a customer supplied license image.
    • isByolCapableOperatingSystem
      This method indicates whether or not this image uses an operating system capable of using a customer supplied license image.
    • isByolOnlyOperatingSystem
      This method indicates whether or not this image uses an operating system that requires using a customer supplied license image
    • isCloudInit
      Determines if the virtual guest was provisioned from a cloud-init enabled image.
    • isCloudInit
      This method indicates whether or not this image is a cloud-init image.
    • isCloudInitOnlyOperatingSystem
      This method indicates whether or not this image uses an operating system that requires cloud init
    • isEncrypted
      This method indicates whether this image template contains an encrypted disk image.
    • isolateInstanceForDestructiveAction
      Closes the public or private ports to isolate the instance before a destructive action.
    • isPingable
      Issues a ping command and returns the success (true) or failure (false) of the ping command.
    • isPingable
      Issues a ping command and returns the success (true) or failure (false) of the ping command.
    • migrate
      Creates a transaction to migrate a virtual guest to a new host. NOTE: Will only migrate if SoftLayer_Virtual_Guest property pendingMigrationFlag = true
    • migrateDedicatedHost
      Create a transaction to migrate an instance from one dedicated host to another dedicated host
    • mountIsoImage
    • pause
      Pause a virtual guest. This can only be called when the specified VM is in the Running state.
    • permitSharingAccess
      This method will permit another SoftLayer customer account access to provision CloudLayer Computing Instances from an image template group. Template access should only be given to the parent template group object, not the child.
    • powerCycle
      Power cycle a virtual guest
    • powerOff
      Power off a virtual guest
    • powerOffSoft
      Power off a virtual guest
    • powerOn
      Power on a virtual guest
    • rebootDefault
      Power cycle a virtual guest
    • rebootHard
      Power cycle a guest.
    • rebootSoft
      Attempt to complete a soft reboot of a guest by shutting down the operating system.
    • reconfigureConsole
    • reloadCurrentOperatingSystemConfiguration
      Create a transaction to perform an OS reload
    • reloadOperatingSystem
      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
      This method is used to remove access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.
    • removeAccessToNetworkStorageList
      This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.
    • removeCompatiblePlatforms
      Removes compatible platforms on the template group.
    • removeLocations
      This method will create transaction(s) to remove available locations from an archive image template.
    • removeSupportedBootMode
      This method allows you to remove a supported boot mode attribute for a given image template.
    • removeTags
      Remove a tag reference
    • resume
      Resume a virtual guest, this can only be called when a VSI is in Suspended state.
    • securityGroupsReady
    • sendTestReclaimScheduledAlert
    • setAvailableLocations
      Create transaction(s) to set the archived block device available locations
    • setBootMode
      This method allows you to specify the boot mode for a given image template.
    • setCompatiblePlatforms
      Sets compatible platforms on the template group.
    • setPrivateNetworkInterfaceSpeed
      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
      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
    • setTags
    • setTags
      Set the tags for this template group.
    • setTransientWebhook
    • setUserMetadata
      Sets the data that will be written to the configuration drive.
    • shutdownPrivatePort
      Shuts down the private network port
    • shutdownPublicPort
      Shuts down the public network port
    • SoftLayer_Virtual_BrowserConsoleAccessLog
      The SoftLayer_Virtual_BrowserConsoleAccessLog data type presents the data for events associated with accessing a VSIs console via the browser interface.
    • SoftLayer_Virtual_DedicatedHost
      This data type presents the structure for a dedicated host. The data type contains relational properties to distinguish a dedicated host and associate an account to it.
    • SoftLayer_Virtual_DedicatedHost
      SoftLayer_Virtual_DedicatedHost models a single tenant virtual host dedicated to a specific account.
    • SoftLayer_Virtual_Disk_Image
      The virtual disk image data type presents the structure in which a virtual disk image will be presented. Virtual block devices are assigned to disk images.
    • SoftLayer_Virtual_Disk_Image
    • SoftLayer_Virtual_Disk_Image_Software
      A SoftLayer_Virtual_Disk_Image_Software record connects a computing instance's virtual disk images with software records. This can be useful if a disk image is directly associated with software such as operating systems.
    • SoftLayer_Virtual_Disk_Image_Software_Password
      This SoftLayer_Virtual_Disk_Image_Software_Password data type contains a password for a specific virtual disk image software instance.
    • SoftLayer_Virtual_Disk_Image_Type
      SoftLayer_Virtual_Disk_Image_Type models the types of virtual disk images available to CloudLayer Computing Instances. Virtual disk image types describe if an image's data is preservable when upgraded, whether a disk contains a suspended virtual image, or if a disk contains crash dump information.
    • SoftLayer_Virtual_Guest
      The virtual guest data type presents the structure in which all virtual guests will be presented. Internally, the structure supports various virtualization platforms with no change to external interaction. A guest, also known as a virtual server, represents an allocation of resources on a virtual host.
    • SoftLayer_Virtual_Guest
      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](/reference/datatypes/SoftLayer_Hardware_Server) service's control over physical hardware purchased form SoftLayer.
    • SoftLayer_Virtual_Guest_Attribute
    • SoftLayer_Virtual_Guest_Attribute_Type
    • SoftLayer_Virtual_Guest_Attribute_UserData
    • SoftLayer_Virtual_Guest_Block_Device
      The block device data type presents the structure in which all block devices will be presented. A block device attaches a disk image to a guest. Internally, the structure supports various virtualization platforms with no change to external interaction. A guest, also known as a virtual server, represents an allocation of resources on a virtual host.
    • SoftLayer_Virtual_Guest_Block_Device_Status
    • SoftLayer_Virtual_Guest_Block_Device_Template
      The virtual block device template data type presents the structure in which all archived image templates are presented. A virtual block device template, also known as a image template, represents the image of a virtual guest instance.
    • SoftLayer_Virtual_Guest_Block_Device_Template_Group
      The virtual block device template group data type presents the structure in which a group of archived image templates will be presented. The structure consists of a parent template group which contain multiple child template group objects. Each child template group object represents the image template in a particular location. Unless editing/deleting a specific child template group object, it is best to use the parent object. A virtual block device template group, also known as an image template group, represents an image of a virtual guest instance.
    • SoftLayer_Virtual_Guest_Block_Device_Template_Group
      The virtual guest block device template group service provides a common interface to an accounts archived image templates The interaction with various third party APIs is not needed when implementing this service to administer your guests.
    • SoftLayer_Virtual_Guest_Block_Device_Template_Group_Accounts
      The SoftLayer_Virtual_Guest_Block_Device_Template_Group_Accounts data type represents the SoftLayer customer accounts which have access to provision CloudLayer Computing Instances from an image template group. All accounts other than the image template group owner have read-only access to that image template group. It is important to note that this data type should only exist to give accounts access to the parent template group object, not the child. All image template sharing between accounts should occur on the parent object.
    • SoftLayer_Virtual_Guest_Block_Device_Template_Group_Status
      The virtual block device template group status data type represents the current status of the image template. Depending upon the status, the image template can be used for provisioning or reloading. For an operating system reload, the image template will need to have a status of 'Active' or 'Deprecated'. For a provision, the image template will need to have a status of 'Active'
    • SoftLayer_Virtual_Guest_Boot_Parameter
    • SoftLayer_Virtual_Guest_Boot_Parameter
    • SoftLayer_Virtual_Guest_Boot_Parameter_Type
      Describes a virtual guest boot parameter. In this the word class is used in the context of arguments sent to cloud computing instances such as single user mode and boot into bash.
    • SoftLayer_Virtual_Guest_Boot_Parameter_Type
    • SoftLayer_Virtual_Guest_Network_Component
      The virtual guest network component data type presents the structure in which all computing instance network components are presented. Internally, the structure supports various virtualization platforms with no change to external interaction. A guest, also known as a virtual server, represents an allocation of resources on a virtual host.
    • SoftLayer_Virtual_Guest_Network_Component
      The virtual guest network component service provides a common interface to a [SoftLayer_Virtual_Guest](/reference/datatypes/SoftLayer_Virtual_Guest) network component. Interaction with various third party APIs is not needed when implementing this service to administer your computing instances.
    • SoftLayer_Virtual_Guest_Network_Component_IcpBinding
    • SoftLayer_Virtual_Guest_Network_Component_IpAddress
      The SoftLayer_Virtual_Guest_Network_Component_IpAddress data type contains general information relating to the binding of a single network component to a single SoftLayer IP address.
    • SoftLayer_Virtual_Guest_Power_State
      The power state class provides a common set of values for which a guest's power state will be presented in the SoftLayer API.
    • SoftLayer_Virtual_Guest_Status
    • SoftLayer_Virtual_Guest_SupplementalCreateObjectOptions
    • SoftLayer_Virtual_Guest_Type
      SoftLayer_Virtual_Guest_Type models the type of a [SoftLayer_Virtual_Guest](/reference/datatypes/SoftLayer_Virtual_Guest) (PUBLIC | DEDICATED | PRIVATE)
    • SoftLayer_Virtual_Guest_Vpc_IpAllocation
    • SoftLayer_Virtual_Guest_Vpc_Subnet
    • SoftLayer_Virtual_Host
      The virtual host represents the platform on which virtual guests reside. At times a virtual host has no allocations on the physical server, however with many modern platforms it is a virtual machine with small CPU and Memory allocations that runs in the Control Domain.
    • SoftLayer_Virtual_Host
      The virtual host service provides a common interface to any virtualization platform supported by SoftLayer. Interaction with various third party APIs is not needed when implementing this service to administer your hosts.
    • SoftLayer_Virtual_Host_PciDevice
      This type represents a PCI device on a host.
    • SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding
      The SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding data type contains general information for a single binding. A binding associates a [SoftLayer_Virtual_Guest_Network_Component](/reference/datatypes/SoftLayer_Virtual_Guest_Network_Component) with a [SoftLayer_Network_SecurityGroup](/reference/datatypes/SoftLayer_Network_SecurityGroup).
    • SoftLayer_Virtual_PlacementGroup
      This data type presents the structure for a virtual guest placement group. The data type contains relational properties to the virtual guest placement group rule class.
    • SoftLayer_Virtual_PlacementGroup
      SoftLayer_Virtual_PlacementGroup is a collection of virtual guests to be placed relative to each other according to a rule.
    • SoftLayer_Virtual_PlacementGroup_Rule
      This data type presents the structure of a virtual guest placement group rule.
    • SoftLayer_Virtual_PlacementGroup_Rule
      SoftLayer_Virtual_PlacementGroup_Rule is the placement rule that a virtual guest placement group follows.
    • SoftLayer_Virtual_ReservedCapacityGroup
      This data type presents the structure for a virtual reserved capacity group.
    • SoftLayer_Virtual_ReservedCapacityGroup
      SoftLayer_Virtual_ReservedCapacityGroup reserves capacity for a group of guests that have not yet been provisioned.
    • SoftLayer_Virtual_ReservedCapacityGroup_Instance
      This data type presents the structure for a virtual reserved capacity group instance.
    • SoftLayer_Virtual_ReservedCapacityGroup_Instance
      SoftLayer_Virtual_ReservedCapacityGroup_Instance reserves capacity for a single instance of a reserved capacity group.
    • SoftLayer_Virtual_Storage_Repository
      The SoftLayer_Virtual_Storage_Repository represents a web based storage system that can be accessed through many types of devices, interfaces, and other resources.
    • SoftLayer_Virtual_Storage_Repository
      Storage Repositories are storage systems that are accessible through the internet and can be accessed through many types of devices, interfaces, and other resources such as NFS (Network File System). They can contain 1 or more [SoftLayer_Virtual_Disk_Image](/reference/datatypes/SoftLayer_Virtual_Disk_Image) and can be attached to more than one [SoftLayer_Virtual_Host](/reference/datatypes/SoftLayer_Virtual_Host).
    • SoftLayer_Virtual_Storage_Repository_Type
      SoftLayer employs many different types of repositories that computing instances use as their storage volume. SoftLayer_Virtual_Storage_Repository_Type models a single storage type. Common types of storage repositories include networked file systems, logical volume management, and local disk volumes for swap and page file management.
    • unmountIsoImage
    • validateImageTemplate
      Validate an image template for OS Reload
    • verifyReloadOperatingSystem
      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.

    ruby

    • Server Locate
      List specific physical location for virtual machines