-
activatePrivatePort
Activate a server's private network interface to the maximum available speed. This operation is an alias for [SoftLayer_Hardware_Server::setPrivateNetworkInterfaceSpeed](/reference/services/SoftLayer_Hardware_Server/setPrivateNetworkInterfaceSpeed) with a $newSpeed of -1 and a $redundancy of 'redundant' or unspecified (which results in the best available redundancy state).
Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.
A response of true indicates a change was required to activate the interface; thus changes are pending. A response of false indicates the interface was already active, and thus no changes are pending.
-
activatePrivatePort
Activate a server's private network interface to the maximum available speed. This operation is an alias for [SoftLayer_Hardware_Server::setPrivateNetworkInterfaceSpeed](/reference/services/SoftLayer_Hardware_Server/setPrivateNetworkInterfaceSpeed) with a $newSpeed of -1 and a $redundancy of 'redundant' or unspecified (which results in the best available redundancy state).
Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.
A response of true indicates a change was required to activate the interface; thus changes are pending. A response of false indicates the interface was already active, and thus no changes are pending.
-
activatePrivatePort
Activate a server's private network interface to the maximum available speed. This operation is an alias for [SoftLayer_Hardware_Server::setPrivateNetworkInterfaceSpeed](/reference/services/SoftLayer_Hardware_Server/setPrivateNetworkInterfaceSpeed) with a $newSpeed of -1 and a $redundancy of 'redundant' or unspecified (which results in the best available redundancy state).
Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.
A response of true indicates a change was required to activate the interface; thus changes are pending. A response of false indicates the interface was already active, and thus no changes are pending.
-
activatePublicPort
Activate a server's public network interface to the maximum available speed. This operation is an alias for [SoftLayer_Hardware_Server::setPublicNetworkInterfaceSpeed](/reference/services/SoftLayer_Hardware_Server/setPublicNetworkInterfaceSpeed) with a $newSpeed of -1 and a $redundancy of 'redundant' or unspecified (which results in the best available redundancy state).
Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.
A response of true indicates a change was required to activate the interface; thus changes are pending. A response of false indicates the interface was already active, and thus no changes are pending.
-
activatePublicPort
Activate a server's public network interface to the maximum available speed. This operation is an alias for [SoftLayer_Hardware_Server::setPublicNetworkInterfaceSpeed](/reference/services/SoftLayer_Hardware_Server/setPublicNetworkInterfaceSpeed) with a $newSpeed of -1 and a $redundancy of 'redundant' or unspecified (which results in the best available redundancy state).
Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.
A response of true indicates a change was required to activate the interface; thus changes are pending. A response of false indicates the interface was already active, and thus no changes are pending.
-
activatePublicPort
Activate a server's public network interface to the maximum available speed. This operation is an alias for [SoftLayer_Hardware_Server::setPublicNetworkInterfaceSpeed](/reference/services/SoftLayer_Hardware_Server/setPublicNetworkInterfaceSpeed) with a $newSpeed of -1 and a $redundancy of 'redundant' or unspecified (which results in the best available redundancy state).
Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.
A response of true indicates a change was required to activate the interface; thus changes are pending. A response of false indicates the interface was already active, and thus no changes are pending.
-
allowAccessToNetworkStorage
This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.
-
allowAccessToNetworkStorage
This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.
-
allowAccessToNetworkStorage
This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.
-
allowAccessToNetworkStorage
This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.
-
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.
-
allowAccessToNetworkStorageList
This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support 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.
-
allowAccessToNetworkStorageList
This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support 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.
-
bootToRescueLayer
The Rescue Kernel is designed to provide you with the ability to bring a server online in order to troubleshoot system problems that would normally only be resolved by an OS Reload. The correct Rescue Kernel will be selected based upon the currently installed operating system. When the rescue kernel process is initiated, the server will shutdown and reboot on to the public network with the same IP's assigned to the server to allow for remote connections. It will bring your server offline for approximately 10 minutes while the rescue is in progress. The root/administrator password will be the same as what is listed in the portal for the server.
-
bootToRescueLayer
The Rescue Kernel is designed to provide you with the ability to bring a server online in order to troubleshoot system problems that would normally only be resolved by an OS Reload. The correct Rescue Kernel will be selected based upon the currently installed operating system. When the rescue kernel process is initiated, the server will shutdown and reboot on to the public network with the same IP's assigned to the server to allow for remote connections. It will bring your server offline for approximately 10 minutes while the rescue is in progress. The root/administrator password will be the same as what is listed in the portal for the server.
-
bootToRescueLayer
The Rescue Kernel is designed to provide you with the ability to bring a server online in order to troubleshoot system problems that would normally only be resolved by an OS Reload. The correct Rescue Kernel will be selected based upon the currently installed operating system. When the rescue kernel process is initiated, the server will shutdown and reboot on to the public network with the same IP's assigned to the server to allow for remote connections. It will bring your server offline for approximately 10 minutes while the rescue is in progress. The root/administrator password will be the same as what is listed in the portal for the server.
-
captureImage
Captures an Image of the hard disk on the physical machine, based on the capture template parameter. Returns the image template group containing the disk image.
-
captureImage
Captures an Image of the hard disk on the physical machine, based on the capture template parameter. Returns the image template group containing the disk image.
-
captureImage
Captures an Image of the hard disk on the physical machine, based on the capture template parameter. Returns the image template group containing the disk image.
-
captureImage
Captures an Image of the hard disk on the physical machine, based on the capture template parameter. Returns the image template group containing the disk image.
-
captureImage
Captures an Image of the hard disk on the physical machine, based on the capture template parameter. Returns the image template group containing the disk image.
-
changeRedfishPowerState
Changes the power state for the server. The server's power status is changed from its remote management card.
-
changeRedfishPowerState
Changes the power state for the server. The server's power status is changed from its remote management card.
-
changeRedfishPowerState
Changes the power state for the server. The server's power status is changed from its remote management card.
-
createFirmwareReflashTransaction
You can launch firmware reflash by selecting from your server list. It will bring your server offline for approximately 60 minutes while the flashes are in progress.
In the event of a hardware failure during this our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.
-
createFirmwareReflashTransaction
You can launch firmware reflash by selecting from your server list. It will bring your server offline for approximately 60 minutes while the flashes are in progress.
In the event of a hardware failure during this our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.
-
createFirmwareReflashTransaction
You can launch firmware reflash by selecting from your server list. It will bring your server offline for approximately 60 minutes while the flashes are in progress.
In the event of a hardware failure during this our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.
-
createFirmwareUpdateTransaction
You can launch firmware updates by selecting from your server list. It will bring your server offline for approximately 20 minutes while the updates are in progress.
In the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.
-
createFirmwareUpdateTransaction
You can launch firmware updates by selecting from your server list. It will bring your server offline for approximately 20 minutes while the updates are in progress.
In the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.
-
createFirmwareUpdateTransaction
You can launch firmware updates by selecting from your server list. It will bring your server offline for approximately 20 minutes while the updates are in progress.
In the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.
-
createHyperThreadingUpdateTransaction
You can launch hyper-threading update by selecting from your server list. It will bring your server offline for approximately 60 minutes while the update is in progress.
In the event of a hardware failure during this our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.
-
createHyperThreadingUpdateTransaction
You can launch hyper-threading update by selecting from your server list. It will bring your server offline for approximately 60 minutes while the update is in progress.
In the event of a hardware failure during this our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.
-
createHyperThreadingUpdateTransaction
You can launch hyper-threading update by selecting from your server list. It will bring your server offline for approximately 60 minutes while the update is in progress.
In the event of a hardware failure during this our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.
-
createObject
<style type='text/css'>.create_object > li > div { padding-top: .5em; padding-bottom: .5em}</style> createObject() enables the creation of servers on an account. This method is a simplified alternative to interacting with the ordering system directly.
In order to create a server, a template object must be sent in with a few required values.
When this method returns an order will have been placed for a server of the specified configuration.
To determine when the server is available you can poll the server via [SoftLayer_Hardware::getObject](/reference/services/SoftLayer_Hardware/getObject), checking the <code>provisionDate</code> property. When <code>provisionDate</code> is not null, the server will be ready. Be sure to use the <code>globalIdentifier</code> as your initialization parameter.
<b>Warning:</b> Servers created via this method will incur charges on your account. For testing input parameters see [SoftLayer_Hardware::generateOrderTemplate](/reference/services/SoftLayer_Hardware/generateOrderTemplate).
<b>Input</b> - [SoftLayer_Hardware](/reference/datatypes/SoftLayer_Hardware) <ul class='create_object'> <li><code>hostname</code> <div>Hostname for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> <li><code>domain</code> <div>Domain for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> <li><code>processorCoreAmount</code> <div>The number of logical CPU cores to allocate.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - int</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>memoryCapacity</code> <div>The amount of memory to allocate in gigabytes.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - int</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>hourlyBillingFlag</code> <div>Specifies the billing type for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - boolean</li> <li>When true the server will be billed on hourly usage, otherwise it will be billed on a monthly basis.</li> </ul> <br /> </li> <li><code>operatingSystemReferenceCode</code> <div>An identifier for the operating system to provision the server with.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>datacenter.name</code> <div>Specifies which datacenter the server is to be provisioned in.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> <li>The <code>datacenter</code> property is a [SoftLayer_Location](/reference/datatypes/SoftLayer_Location) structure with the <code>name</code> field set.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'datacenter': { 'name': 'dal05' } }</http> <br /> </li> <li><code>networkComponents.maxSpeed</code> <div>Specifies the connection speed for the server's network components.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Default</b> - The highest available zero cost port speed will be used.</li> <li><b>Description</b> - The <code>networkComponents</code> property is an array with a single [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure. The <code>maxSpeed</code> property must be set to specify the network uplink speed, in megabits per second, of the server.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'networkComponents': [ { 'maxSpeed': 1000 } ] }</http> <br /> </li> <li><code>networkComponents.redundancyEnabledFlag</code> <div>Specifies whether or not the server's network components should be in redundancy groups.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - bool</li> <li><b>Default</b> - <code>false</code></li> <li><b>Description</b> - The <code>networkComponents</code> property is an array with a single [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure. When the <code>redundancyEnabledFlag</code> property is true the server's network components will be in redundancy groups.</li> </ul> <http title='Example'>{ 'networkComponents': [ { 'redundancyEnabledFlag': false } ] }</http> <br /> </li> <li><code>privateNetworkOnlyFlag</code> <div>Specifies whether or not the server only has access to the private network</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - boolean</li> <li><b>Default</b> - <code>false</code></li> <li>When true this flag specifies that a server is to only have access to the private network.</li> </ul> <br /> </li> <li><code>primaryNetworkComponent.networkVlan.id</code> <div>Specifies the network vlan which is to be used for the frontend interface of the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Description</b> - The <code>primaryNetworkComponent</code> property is a [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure with the <code>networkVlan</code> property populated with a [SoftLayer_Network_Vlan](/reference/datatypes/SoftLayer_Network_Vlan) structure. The <code>id</code> property must be set to specify the frontend network vlan of the server.</li> </ul> <http title='Example'>{ 'primaryNetworkComponent': { 'networkVlan': { 'id': 1 } } }</http> <br /> </li> <li><code>primaryBackendNetworkComponent.networkVlan.id</code> <div>Specifies the network vlan which is to be used for the backend interface of the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Description</b> - The <code>primaryBackendNetworkComponent</code> property is a [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure with the <code>networkVlan</code> property populated with a [SoftLayer_Network_Vlan](/reference/datatypes/SoftLayer_Network_Vlan) structure. The <code>id</code> property must be set to specify the backend network vlan of the server.</li> </ul> <http title='Example'>{ 'primaryBackendNetworkComponent': { 'networkVlan': { 'id': 2 } } }</http> <br /> </li> <li><code>fixedConfigurationPreset.keyName</code> <div></div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> <li><b>Description</b> - The <code>fixedConfigurationPreset</code> property is a [SoftLayer_Product_Package_Preset](/reference/datatypes/SoftLayer_Product_Package_Preset) structure. The <code>keyName</code> property must be set to specify preset to use.</li> <li>If a fixed configuration preset is used <code>processorCoreAmount</code>, <code>memoryCapacity</code> and <code>hardDrives</code> properties must not be set.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'fixedConfigurationPreset': { 'keyName': 'SOME_KEY_NAME' } }</http> <br /> </li> <li><code>userData.value</code> <div>Arbitrary data to be made available to the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> <li><b>Description</b> - The <code>userData</code> property is an array with a single [SoftLayer_Hardware_Attribute](/reference/datatypes/SoftLayer_Hardware_Attribute) structure with the <code>value</code> property set to an arbitrary value.</li> <li>This value can be retrieved via the [SoftLayer_Resource_Metadata::getUserMetadata](/reference/services/SoftLayer_Resource_Metadata/getUserMetadata) method from a request originating from the server. This is primarily useful for providing data to software that may be on the server and configured to execute upon first boot.</li> </ul> <http title='Example'>{ 'userData': [ { 'value': 'someValue' } ] }</http> <br /> </li> <li><code>hardDrives</code> <div>Hard drive settings for the server</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - SoftLayer_Hardware_Component</li> <li><b>Default</b> - The largest available capacity for a zero cost primary disk will be used.</li> <li><b>Description</b> - The <code>hardDrives</code> property is an array of [SoftLayer_Hardware_Component](/reference/datatypes/SoftLayer_Hardware_Component) structures.</i> <li>Each hard drive must specify the <code>capacity</code> property.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'hardDrives': [ { 'capacity': 500 } ] }</http> <br /> </li> <li id='hardware-create-object-ssh-keys'><code>sshKeys</code> <div>SSH keys to install on the server upon provisioning.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - array of [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key)</li> <li><b>Description</b> - The <code>sshKeys</code> property is an array of [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key) structures with the <code>id</code> property set to the value of an existing SSH key.</li> <li>To create a new SSH key, call [SoftLayer_Security_Ssh_Key::createObject](/reference/services/SoftLayer_Security_Ssh_Key/createObject) on the [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key) service.</li> <li>To obtain a list of existing SSH keys, call [SoftLayer_Account::getSshKeys](/reference/services/SoftLayer_Account/getSshKeys) on the [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) service. </ul> <http title='Example'>{ 'sshKeys': [ { 'id': 123 } ] }</http> <br /> </li> <li><code>postInstallScriptUri</code> <div>Specifies the uri location of the script to be downloaded and run after installation is complete.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> </ul>
<h1>REST Example</h1> <http title='Request'>curl -X POST -d '{ 'parameters':[ { 'hostname': 'host1', 'domain': 'example.com', 'processorCoreAmount': 2, 'memoryCapacity': 2, 'hourlyBillingFlag': true, 'operatingSystemReferenceCode': 'UBUNTU_LATEST' } ] }' https://api.softlayer.com/rest/v3/SoftLayer_Hardware.json </http> <http title='Response'>HTTP/1.1 201 Created Location: https://api.softlayer.com/rest/v3/SoftLayer_Hardware/f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5/getObject
{ 'accountId': 232298, 'bareMetalInstanceFlag': null, 'domain': 'example.com', 'hardwareStatusId': null, 'hostname': 'host1', 'id': null, 'serviceProviderId': null, 'serviceProviderResourceId': null, 'globalIdentifier': 'f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5', 'hourlyBillingFlag': true, 'memoryCapacity': 2, 'operatingSystemReferenceCode': 'UBUNTU_LATEST', 'processorCoreAmount': 2 } </http>
-
createObject
<style type='text/css'>.create_object > li > div { padding-top: .5em; padding-bottom: .5em}</style> createObject() enables the creation of servers on an account. This method is a simplified alternative to interacting with the ordering system directly.
In order to create a server, a template object must be sent in with a few required values.
When this method returns an order will have been placed for a server of the specified configuration.
To determine when the server is available you can poll the server via [SoftLayer_Hardware::getObject](/reference/services/SoftLayer_Hardware/getObject), checking the <code>provisionDate</code> property. When <code>provisionDate</code> is not null, the server will be ready. Be sure to use the <code>globalIdentifier</code> as your initialization parameter.
<b>Warning:</b> Servers created via this method will incur charges on your account. For testing input parameters see [SoftLayer_Hardware::generateOrderTemplate](/reference/services/SoftLayer_Hardware/generateOrderTemplate).
<b>Input</b> - [SoftLayer_Hardware](/reference/datatypes/SoftLayer_Hardware) <ul class='create_object'> <li><code>hostname</code> <div>Hostname for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> <li><code>domain</code> <div>Domain for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> <li><code>processorCoreAmount</code> <div>The number of logical CPU cores to allocate.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - int</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>memoryCapacity</code> <div>The amount of memory to allocate in gigabytes.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - int</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>hourlyBillingFlag</code> <div>Specifies the billing type for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - boolean</li> <li>When true the server will be billed on hourly usage, otherwise it will be billed on a monthly basis.</li> </ul> <br /> </li> <li><code>operatingSystemReferenceCode</code> <div>An identifier for the operating system to provision the server with.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>datacenter.name</code> <div>Specifies which datacenter the server is to be provisioned in.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> <li>The <code>datacenter</code> property is a [SoftLayer_Location](/reference/datatypes/SoftLayer_Location) structure with the <code>name</code> field set.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'datacenter': { 'name': 'dal05' } }</http> <br /> </li> <li><code>networkComponents.maxSpeed</code> <div>Specifies the connection speed for the server's network components.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Default</b> - The highest available zero cost port speed will be used.</li> <li><b>Description</b> - The <code>networkComponents</code> property is an array with a single [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure. The <code>maxSpeed</code> property must be set to specify the network uplink speed, in megabits per second, of the server.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'networkComponents': [ { 'maxSpeed': 1000 } ] }</http> <br /> </li> <li><code>networkComponents.redundancyEnabledFlag</code> <div>Specifies whether or not the server's network components should be in redundancy groups.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - bool</li> <li><b>Default</b> - <code>false</code></li> <li><b>Description</b> - The <code>networkComponents</code> property is an array with a single [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure. When the <code>redundancyEnabledFlag</code> property is true the server's network components will be in redundancy groups.</li> </ul> <http title='Example'>{ 'networkComponents': [ { 'redundancyEnabledFlag': false } ] }</http> <br /> </li> <li><code>privateNetworkOnlyFlag</code> <div>Specifies whether or not the server only has access to the private network</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - boolean</li> <li><b>Default</b> - <code>false</code></li> <li>When true this flag specifies that a server is to only have access to the private network.</li> </ul> <br /> </li> <li><code>primaryNetworkComponent.networkVlan.id</code> <div>Specifies the network vlan which is to be used for the frontend interface of the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Description</b> - The <code>primaryNetworkComponent</code> property is a [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure with the <code>networkVlan</code> property populated with a [SoftLayer_Network_Vlan](/reference/datatypes/SoftLayer_Network_Vlan) structure. The <code>id</code> property must be set to specify the frontend network vlan of the server.</li> </ul> <http title='Example'>{ 'primaryNetworkComponent': { 'networkVlan': { 'id': 1 } } }</http> <br /> </li> <li><code>primaryBackendNetworkComponent.networkVlan.id</code> <div>Specifies the network vlan which is to be used for the backend interface of the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Description</b> - The <code>primaryBackendNetworkComponent</code> property is a [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure with the <code>networkVlan</code> property populated with a [SoftLayer_Network_Vlan](/reference/datatypes/SoftLayer_Network_Vlan) structure. The <code>id</code> property must be set to specify the backend network vlan of the server.</li> </ul> <http title='Example'>{ 'primaryBackendNetworkComponent': { 'networkVlan': { 'id': 2 } } }</http> <br /> </li> <li><code>fixedConfigurationPreset.keyName</code> <div></div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> <li><b>Description</b> - The <code>fixedConfigurationPreset</code> property is a [SoftLayer_Product_Package_Preset](/reference/datatypes/SoftLayer_Product_Package_Preset) structure. The <code>keyName</code> property must be set to specify preset to use.</li> <li>If a fixed configuration preset is used <code>processorCoreAmount</code>, <code>memoryCapacity</code> and <code>hardDrives</code> properties must not be set.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'fixedConfigurationPreset': { 'keyName': 'SOME_KEY_NAME' } }</http> <br /> </li> <li><code>userData.value</code> <div>Arbitrary data to be made available to the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> <li><b>Description</b> - The <code>userData</code> property is an array with a single [SoftLayer_Hardware_Attribute](/reference/datatypes/SoftLayer_Hardware_Attribute) structure with the <code>value</code> property set to an arbitrary value.</li> <li>This value can be retrieved via the [SoftLayer_Resource_Metadata::getUserMetadata](/reference/services/SoftLayer_Resource_Metadata/getUserMetadata) method from a request originating from the server. This is primarily useful for providing data to software that may be on the server and configured to execute upon first boot.</li> </ul> <http title='Example'>{ 'userData': [ { 'value': 'someValue' } ] }</http> <br /> </li> <li><code>hardDrives</code> <div>Hard drive settings for the server</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - SoftLayer_Hardware_Component</li> <li><b>Default</b> - The largest available capacity for a zero cost primary disk will be used.</li> <li><b>Description</b> - The <code>hardDrives</code> property is an array of [SoftLayer_Hardware_Component](/reference/datatypes/SoftLayer_Hardware_Component) structures.</i> <li>Each hard drive must specify the <code>capacity</code> property.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'hardDrives': [ { 'capacity': 500 } ] }</http> <br /> </li> <li id='hardware-create-object-ssh-keys'><code>sshKeys</code> <div>SSH keys to install on the server upon provisioning.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - array of [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key)</li> <li><b>Description</b> - The <code>sshKeys</code> property is an array of [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key) structures with the <code>id</code> property set to the value of an existing SSH key.</li> <li>To create a new SSH key, call [SoftLayer_Security_Ssh_Key::createObject](/reference/services/SoftLayer_Security_Ssh_Key/createObject) on the [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key) service.</li> <li>To obtain a list of existing SSH keys, call [SoftLayer_Account::getSshKeys](/reference/services/SoftLayer_Account/getSshKeys) on the [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) service. </ul> <http title='Example'>{ 'sshKeys': [ { 'id': 123 } ] }</http> <br /> </li> <li><code>postInstallScriptUri</code> <div>Specifies the uri location of the script to be downloaded and run after installation is complete.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> </ul>
<h1>REST Example</h1> <http title='Request'>curl -X POST -d '{ 'parameters':[ { 'hostname': 'host1', 'domain': 'example.com', 'processorCoreAmount': 2, 'memoryCapacity': 2, 'hourlyBillingFlag': true, 'operatingSystemReferenceCode': 'UBUNTU_LATEST' } ] }' https://api.softlayer.com/rest/v3/SoftLayer_Hardware.json </http> <http title='Response'>HTTP/1.1 201 Created Location: https://api.softlayer.com/rest/v3/SoftLayer_Hardware/f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5/getObject
{ 'accountId': 232298, 'bareMetalInstanceFlag': null, 'domain': 'example.com', 'hardwareStatusId': null, 'hostname': 'host1', 'id': null, 'serviceProviderId': null, 'serviceProviderResourceId': null, 'globalIdentifier': 'f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5', 'hourlyBillingFlag': true, 'memoryCapacity': 2, 'operatingSystemReferenceCode': 'UBUNTU_LATEST', 'processorCoreAmount': 2 } </http>
-
createObject
<style type='text/css'>.create_object > li > div { padding-top: .5em; padding-bottom: .5em}</style> createObject() enables the creation of servers on an account. This method is a simplified alternative to interacting with the ordering system directly.
In order to create a server, a template object must be sent in with a few required values.
When this method returns an order will have been placed for a server of the specified configuration.
To determine when the server is available you can poll the server via [SoftLayer_Hardware::getObject](/reference/services/SoftLayer_Hardware/getObject), checking the <code>provisionDate</code> property. When <code>provisionDate</code> is not null, the server will be ready. Be sure to use the <code>globalIdentifier</code> as your initialization parameter.
<b>Warning:</b> Servers created via this method will incur charges on your account. For testing input parameters see [SoftLayer_Hardware::generateOrderTemplate](/reference/services/SoftLayer_Hardware/generateOrderTemplate).
<b>Input</b> - [SoftLayer_Hardware](/reference/datatypes/SoftLayer_Hardware) <ul class='create_object'> <li><code>hostname</code> <div>Hostname for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> <li><code>domain</code> <div>Domain for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> <li><code>processorCoreAmount</code> <div>The number of logical CPU cores to allocate.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - int</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>memoryCapacity</code> <div>The amount of memory to allocate in gigabytes.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - int</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>hourlyBillingFlag</code> <div>Specifies the billing type for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - boolean</li> <li>When true the server will be billed on hourly usage, otherwise it will be billed on a monthly basis.</li> </ul> <br /> </li> <li><code>operatingSystemReferenceCode</code> <div>An identifier for the operating system to provision the server with.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>datacenter.name</code> <div>Specifies which datacenter the server is to be provisioned in.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> <li>The <code>datacenter</code> property is a [SoftLayer_Location](/reference/datatypes/SoftLayer_Location) structure with the <code>name</code> field set.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'datacenter': { 'name': 'dal05' } }</http> <br /> </li> <li><code>networkComponents.maxSpeed</code> <div>Specifies the connection speed for the server's network components.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Default</b> - The highest available zero cost port speed will be used.</li> <li><b>Description</b> - The <code>networkComponents</code> property is an array with a single [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure. The <code>maxSpeed</code> property must be set to specify the network uplink speed, in megabits per second, of the server.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'networkComponents': [ { 'maxSpeed': 1000 } ] }</http> <br /> </li> <li><code>networkComponents.redundancyEnabledFlag</code> <div>Specifies whether or not the server's network components should be in redundancy groups.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - bool</li> <li><b>Default</b> - <code>false</code></li> <li><b>Description</b> - The <code>networkComponents</code> property is an array with a single [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure. When the <code>redundancyEnabledFlag</code> property is true the server's network components will be in redundancy groups.</li> </ul> <http title='Example'>{ 'networkComponents': [ { 'redundancyEnabledFlag': false } ] }</http> <br /> </li> <li><code>privateNetworkOnlyFlag</code> <div>Specifies whether or not the server only has access to the private network</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - boolean</li> <li><b>Default</b> - <code>false</code></li> <li>When true this flag specifies that a server is to only have access to the private network.</li> </ul> <br /> </li> <li><code>primaryNetworkComponent.networkVlan.id</code> <div>Specifies the network vlan which is to be used for the frontend interface of the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Description</b> - The <code>primaryNetworkComponent</code> property is a [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure with the <code>networkVlan</code> property populated with a [SoftLayer_Network_Vlan](/reference/datatypes/SoftLayer_Network_Vlan) structure. The <code>id</code> property must be set to specify the frontend network vlan of the server.</li> </ul> <http title='Example'>{ 'primaryNetworkComponent': { 'networkVlan': { 'id': 1 } } }</http> <br /> </li> <li><code>primaryBackendNetworkComponent.networkVlan.id</code> <div>Specifies the network vlan which is to be used for the backend interface of the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Description</b> - The <code>primaryBackendNetworkComponent</code> property is a [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure with the <code>networkVlan</code> property populated with a [SoftLayer_Network_Vlan](/reference/datatypes/SoftLayer_Network_Vlan) structure. The <code>id</code> property must be set to specify the backend network vlan of the server.</li> </ul> <http title='Example'>{ 'primaryBackendNetworkComponent': { 'networkVlan': { 'id': 2 } } }</http> <br /> </li> <li><code>fixedConfigurationPreset.keyName</code> <div></div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> <li><b>Description</b> - The <code>fixedConfigurationPreset</code> property is a [SoftLayer_Product_Package_Preset](/reference/datatypes/SoftLayer_Product_Package_Preset) structure. The <code>keyName</code> property must be set to specify preset to use.</li> <li>If a fixed configuration preset is used <code>processorCoreAmount</code>, <code>memoryCapacity</code> and <code>hardDrives</code> properties must not be set.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'fixedConfigurationPreset': { 'keyName': 'SOME_KEY_NAME' } }</http> <br /> </li> <li><code>userData.value</code> <div>Arbitrary data to be made available to the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> <li><b>Description</b> - The <code>userData</code> property is an array with a single [SoftLayer_Hardware_Attribute](/reference/datatypes/SoftLayer_Hardware_Attribute) structure with the <code>value</code> property set to an arbitrary value.</li> <li>This value can be retrieved via the [SoftLayer_Resource_Metadata::getUserMetadata](/reference/services/SoftLayer_Resource_Metadata/getUserMetadata) method from a request originating from the server. This is primarily useful for providing data to software that may be on the server and configured to execute upon first boot.</li> </ul> <http title='Example'>{ 'userData': [ { 'value': 'someValue' } ] }</http> <br /> </li> <li><code>hardDrives</code> <div>Hard drive settings for the server</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - SoftLayer_Hardware_Component</li> <li><b>Default</b> - The largest available capacity for a zero cost primary disk will be used.</li> <li><b>Description</b> - The <code>hardDrives</code> property is an array of [SoftLayer_Hardware_Component](/reference/datatypes/SoftLayer_Hardware_Component) structures.</i> <li>Each hard drive must specify the <code>capacity</code> property.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'hardDrives': [ { 'capacity': 500 } ] }</http> <br /> </li> <li id='hardware-create-object-ssh-keys'><code>sshKeys</code> <div>SSH keys to install on the server upon provisioning.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - array of [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key)</li> <li><b>Description</b> - The <code>sshKeys</code> property is an array of [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key) structures with the <code>id</code> property set to the value of an existing SSH key.</li> <li>To create a new SSH key, call [SoftLayer_Security_Ssh_Key::createObject](/reference/services/SoftLayer_Security_Ssh_Key/createObject) on the [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key) service.</li> <li>To obtain a list of existing SSH keys, call [SoftLayer_Account::getSshKeys](/reference/services/SoftLayer_Account/getSshKeys) on the [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) service. </ul> <http title='Example'>{ 'sshKeys': [ { 'id': 123 } ] }</http> <br /> </li> <li><code>postInstallScriptUri</code> <div>Specifies the uri location of the script to be downloaded and run after installation is complete.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> </ul>
<h1>REST Example</h1> <http title='Request'>curl -X POST -d '{ 'parameters':[ { 'hostname': 'host1', 'domain': 'example.com', 'processorCoreAmount': 2, 'memoryCapacity': 2, 'hourlyBillingFlag': true, 'operatingSystemReferenceCode': 'UBUNTU_LATEST' } ] }' https://api.softlayer.com/rest/v3/SoftLayer_Hardware.json </http> <http title='Response'>HTTP/1.1 201 Created Location: https://api.softlayer.com/rest/v3/SoftLayer_Hardware/f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5/getObject
{ 'accountId': 232298, 'bareMetalInstanceFlag': null, 'domain': 'example.com', 'hardwareStatusId': null, 'hostname': 'host1', 'id': null, 'serviceProviderId': null, 'serviceProviderResourceId': null, 'globalIdentifier': 'f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5', 'hourlyBillingFlag': true, 'memoryCapacity': 2, 'operatingSystemReferenceCode': 'UBUNTU_LATEST', 'processorCoreAmount': 2 } </http>
-
createObject
<style type='text/css'>.create_object > li > div { padding-top: .5em; padding-bottom: .5em}</style> createObject() enables the creation of servers on an account. This method is a simplified alternative to interacting with the ordering system directly.
In order to create a server, a template object must be sent in with a few required values.
When this method returns an order will have been placed for a server of the specified configuration.
To determine when the server is available you can poll the server via [SoftLayer_Hardware::getObject](/reference/services/SoftLayer_Hardware/getObject), checking the <code>provisionDate</code> property. When <code>provisionDate</code> is not null, the server will be ready. Be sure to use the <code>globalIdentifier</code> as your initialization parameter.
<b>Warning:</b> Servers created via this method will incur charges on your account. For testing input parameters see [SoftLayer_Hardware::generateOrderTemplate](/reference/services/SoftLayer_Hardware/generateOrderTemplate).
<b>Input</b> - [SoftLayer_Hardware](/reference/datatypes/SoftLayer_Hardware) <ul class='create_object'> <li><code>hostname</code> <div>Hostname for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> <li><code>domain</code> <div>Domain for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> <li><code>processorCoreAmount</code> <div>The number of logical CPU cores to allocate.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - int</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>memoryCapacity</code> <div>The amount of memory to allocate in gigabytes.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - int</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>hourlyBillingFlag</code> <div>Specifies the billing type for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - boolean</li> <li>When true the server will be billed on hourly usage, otherwise it will be billed on a monthly basis.</li> </ul> <br /> </li> <li><code>operatingSystemReferenceCode</code> <div>An identifier for the operating system to provision the server with.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>datacenter.name</code> <div>Specifies which datacenter the server is to be provisioned in.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> <li>The <code>datacenter</code> property is a [SoftLayer_Location](/reference/datatypes/SoftLayer_Location) structure with the <code>name</code> field set.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'datacenter': { 'name': 'dal05' } }</http> <br /> </li> <li><code>networkComponents.maxSpeed</code> <div>Specifies the connection speed for the server's network components.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Default</b> - The highest available zero cost port speed will be used.</li> <li><b>Description</b> - The <code>networkComponents</code> property is an array with a single [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure. The <code>maxSpeed</code> property must be set to specify the network uplink speed, in megabits per second, of the server.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'networkComponents': [ { 'maxSpeed': 1000 } ] }</http> <br /> </li> <li><code>networkComponents.redundancyEnabledFlag</code> <div>Specifies whether or not the server's network components should be in redundancy groups.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - bool</li> <li><b>Default</b> - <code>false</code></li> <li><b>Description</b> - The <code>networkComponents</code> property is an array with a single [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure. When the <code>redundancyEnabledFlag</code> property is true the server's network components will be in redundancy groups.</li> </ul> <http title='Example'>{ 'networkComponents': [ { 'redundancyEnabledFlag': false } ] }</http> <br /> </li> <li><code>privateNetworkOnlyFlag</code> <div>Specifies whether or not the server only has access to the private network</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - boolean</li> <li><b>Default</b> - <code>false</code></li> <li>When true this flag specifies that a server is to only have access to the private network.</li> </ul> <br /> </li> <li><code>primaryNetworkComponent.networkVlan.id</code> <div>Specifies the network vlan which is to be used for the frontend interface of the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Description</b> - The <code>primaryNetworkComponent</code> property is a [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure with the <code>networkVlan</code> property populated with a [SoftLayer_Network_Vlan](/reference/datatypes/SoftLayer_Network_Vlan) structure. The <code>id</code> property must be set to specify the frontend network vlan of the server.</li> </ul> <http title='Example'>{ 'primaryNetworkComponent': { 'networkVlan': { 'id': 1 } } }</http> <br /> </li> <li><code>primaryBackendNetworkComponent.networkVlan.id</code> <div>Specifies the network vlan which is to be used for the backend interface of the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Description</b> - The <code>primaryBackendNetworkComponent</code> property is a [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure with the <code>networkVlan</code> property populated with a [SoftLayer_Network_Vlan](/reference/datatypes/SoftLayer_Network_Vlan) structure. The <code>id</code> property must be set to specify the backend network vlan of the server.</li> </ul> <http title='Example'>{ 'primaryBackendNetworkComponent': { 'networkVlan': { 'id': 2 } } }</http> <br /> </li> <li><code>fixedConfigurationPreset.keyName</code> <div></div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> <li><b>Description</b> - The <code>fixedConfigurationPreset</code> property is a [SoftLayer_Product_Package_Preset](/reference/datatypes/SoftLayer_Product_Package_Preset) structure. The <code>keyName</code> property must be set to specify preset to use.</li> <li>If a fixed configuration preset is used <code>processorCoreAmount</code>, <code>memoryCapacity</code> and <code>hardDrives</code> properties must not be set.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'fixedConfigurationPreset': { 'keyName': 'SOME_KEY_NAME' } }</http> <br /> </li> <li><code>userData.value</code> <div>Arbitrary data to be made available to the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> <li><b>Description</b> - The <code>userData</code> property is an array with a single [SoftLayer_Hardware_Attribute](/reference/datatypes/SoftLayer_Hardware_Attribute) structure with the <code>value</code> property set to an arbitrary value.</li> <li>This value can be retrieved via the [SoftLayer_Resource_Metadata::getUserMetadata](/reference/services/SoftLayer_Resource_Metadata/getUserMetadata) method from a request originating from the server. This is primarily useful for providing data to software that may be on the server and configured to execute upon first boot.</li> </ul> <http title='Example'>{ 'userData': [ { 'value': 'someValue' } ] }</http> <br /> </li> <li><code>hardDrives</code> <div>Hard drive settings for the server</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - SoftLayer_Hardware_Component</li> <li><b>Default</b> - The largest available capacity for a zero cost primary disk will be used.</li> <li><b>Description</b> - The <code>hardDrives</code> property is an array of [SoftLayer_Hardware_Component](/reference/datatypes/SoftLayer_Hardware_Component) structures.</i> <li>Each hard drive must specify the <code>capacity</code> property.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'hardDrives': [ { 'capacity': 500 } ] }</http> <br /> </li> <li id='hardware-create-object-ssh-keys'><code>sshKeys</code> <div>SSH keys to install on the server upon provisioning.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - array of [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key)</li> <li><b>Description</b> - The <code>sshKeys</code> property is an array of [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key) structures with the <code>id</code> property set to the value of an existing SSH key.</li> <li>To create a new SSH key, call [SoftLayer_Security_Ssh_Key::createObject](/reference/services/SoftLayer_Security_Ssh_Key/createObject) on the [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key) service.</li> <li>To obtain a list of existing SSH keys, call [SoftLayer_Account::getSshKeys](/reference/services/SoftLayer_Account/getSshKeys) on the [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) service. </ul> <http title='Example'>{ 'sshKeys': [ { 'id': 123 } ] }</http> <br /> </li> <li><code>postInstallScriptUri</code> <div>Specifies the uri location of the script to be downloaded and run after installation is complete.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> </ul>
<h1>REST Example</h1> <http title='Request'>curl -X POST -d '{ 'parameters':[ { 'hostname': 'host1', 'domain': 'example.com', 'processorCoreAmount': 2, 'memoryCapacity': 2, 'hourlyBillingFlag': true, 'operatingSystemReferenceCode': 'UBUNTU_LATEST' } ] }' https://api.softlayer.com/rest/v3/SoftLayer_Hardware.json </http> <http title='Response'>HTTP/1.1 201 Created Location: https://api.softlayer.com/rest/v3/SoftLayer_Hardware/f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5/getObject
{ 'accountId': 232298, 'bareMetalInstanceFlag': null, 'domain': 'example.com', 'hardwareStatusId': null, 'hostname': 'host1', 'id': null, 'serviceProviderId': null, 'serviceProviderResourceId': null, 'globalIdentifier': 'f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5', 'hourlyBillingFlag': true, 'memoryCapacity': 2, 'operatingSystemReferenceCode': 'UBUNTU_LATEST', 'processorCoreAmount': 2 } </http>
-
createObject
<style type='text/css'>.create_object > li > div { padding-top: .5em; padding-bottom: .5em}</style> createObject() enables the creation of servers on an account. This method is a simplified alternative to interacting with the ordering system directly.
In order to create a server, a template object must be sent in with a few required values.
When this method returns an order will have been placed for a server of the specified configuration.
To determine when the server is available you can poll the server via [SoftLayer_Hardware::getObject](/reference/services/SoftLayer_Hardware/getObject), checking the <code>provisionDate</code> property. When <code>provisionDate</code> is not null, the server will be ready. Be sure to use the <code>globalIdentifier</code> as your initialization parameter.
<b>Warning:</b> Servers created via this method will incur charges on your account. For testing input parameters see [SoftLayer_Hardware::generateOrderTemplate](/reference/services/SoftLayer_Hardware/generateOrderTemplate).
<b>Input</b> - [SoftLayer_Hardware](/reference/datatypes/SoftLayer_Hardware) <ul class='create_object'> <li><code>hostname</code> <div>Hostname for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> <li><code>domain</code> <div>Domain for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> <li><code>processorCoreAmount</code> <div>The number of logical CPU cores to allocate.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - int</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>memoryCapacity</code> <div>The amount of memory to allocate in gigabytes.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - int</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>hourlyBillingFlag</code> <div>Specifies the billing type for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - boolean</li> <li>When true the server will be billed on hourly usage, otherwise it will be billed on a monthly basis.</li> </ul> <br /> </li> <li><code>operatingSystemReferenceCode</code> <div>An identifier for the operating system to provision the server with.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>datacenter.name</code> <div>Specifies which datacenter the server is to be provisioned in.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> <li>The <code>datacenter</code> property is a [SoftLayer_Location](/reference/datatypes/SoftLayer_Location) structure with the <code>name</code> field set.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'datacenter': { 'name': 'dal05' } }</http> <br /> </li> <li><code>networkComponents.maxSpeed</code> <div>Specifies the connection speed for the server's network components.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Default</b> - The highest available zero cost port speed will be used.</li> <li><b>Description</b> - The <code>networkComponents</code> property is an array with a single [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure. The <code>maxSpeed</code> property must be set to specify the network uplink speed, in megabits per second, of the server.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'networkComponents': [ { 'maxSpeed': 1000 } ] }</http> <br /> </li> <li><code>networkComponents.redundancyEnabledFlag</code> <div>Specifies whether or not the server's network components should be in redundancy groups.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - bool</li> <li><b>Default</b> - <code>false</code></li> <li><b>Description</b> - The <code>networkComponents</code> property is an array with a single [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure. When the <code>redundancyEnabledFlag</code> property is true the server's network components will be in redundancy groups.</li> </ul> <http title='Example'>{ 'networkComponents': [ { 'redundancyEnabledFlag': false } ] }</http> <br /> </li> <li><code>privateNetworkOnlyFlag</code> <div>Specifies whether or not the server only has access to the private network</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - boolean</li> <li><b>Default</b> - <code>false</code></li> <li>When true this flag specifies that a server is to only have access to the private network.</li> </ul> <br /> </li> <li><code>primaryNetworkComponent.networkVlan.id</code> <div>Specifies the network vlan which is to be used for the frontend interface of the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Description</b> - The <code>primaryNetworkComponent</code> property is a [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure with the <code>networkVlan</code> property populated with a [SoftLayer_Network_Vlan](/reference/datatypes/SoftLayer_Network_Vlan) structure. The <code>id</code> property must be set to specify the frontend network vlan of the server.</li> </ul> <http title='Example'>{ 'primaryNetworkComponent': { 'networkVlan': { 'id': 1 } } }</http> <br /> </li> <li><code>primaryBackendNetworkComponent.networkVlan.id</code> <div>Specifies the network vlan which is to be used for the backend interface of the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Description</b> - The <code>primaryBackendNetworkComponent</code> property is a [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure with the <code>networkVlan</code> property populated with a [SoftLayer_Network_Vlan](/reference/datatypes/SoftLayer_Network_Vlan) structure. The <code>id</code> property must be set to specify the backend network vlan of the server.</li> </ul> <http title='Example'>{ 'primaryBackendNetworkComponent': { 'networkVlan': { 'id': 2 } } }</http> <br /> </li> <li><code>fixedConfigurationPreset.keyName</code> <div></div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> <li><b>Description</b> - The <code>fixedConfigurationPreset</code> property is a [SoftLayer_Product_Package_Preset](/reference/datatypes/SoftLayer_Product_Package_Preset) structure. The <code>keyName</code> property must be set to specify preset to use.</li> <li>If a fixed configuration preset is used <code>processorCoreAmount</code>, <code>memoryCapacity</code> and <code>hardDrives</code> properties must not be set.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'fixedConfigurationPreset': { 'keyName': 'SOME_KEY_NAME' } }</http> <br /> </li> <li><code>userData.value</code> <div>Arbitrary data to be made available to the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> <li><b>Description</b> - The <code>userData</code> property is an array with a single [SoftLayer_Hardware_Attribute](/reference/datatypes/SoftLayer_Hardware_Attribute) structure with the <code>value</code> property set to an arbitrary value.</li> <li>This value can be retrieved via the [SoftLayer_Resource_Metadata::getUserMetadata](/reference/services/SoftLayer_Resource_Metadata/getUserMetadata) method from a request originating from the server. This is primarily useful for providing data to software that may be on the server and configured to execute upon first boot.</li> </ul> <http title='Example'>{ 'userData': [ { 'value': 'someValue' } ] }</http> <br /> </li> <li><code>hardDrives</code> <div>Hard drive settings for the server</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - SoftLayer_Hardware_Component</li> <li><b>Default</b> - The largest available capacity for a zero cost primary disk will be used.</li> <li><b>Description</b> - The <code>hardDrives</code> property is an array of [SoftLayer_Hardware_Component](/reference/datatypes/SoftLayer_Hardware_Component) structures.</i> <li>Each hard drive must specify the <code>capacity</code> property.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'hardDrives': [ { 'capacity': 500 } ] }</http> <br /> </li> <li id='hardware-create-object-ssh-keys'><code>sshKeys</code> <div>SSH keys to install on the server upon provisioning.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - array of [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key)</li> <li><b>Description</b> - The <code>sshKeys</code> property is an array of [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key) structures with the <code>id</code> property set to the value of an existing SSH key.</li> <li>To create a new SSH key, call [SoftLayer_Security_Ssh_Key::createObject](/reference/services/SoftLayer_Security_Ssh_Key/createObject) on the [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key) service.</li> <li>To obtain a list of existing SSH keys, call [SoftLayer_Account::getSshKeys](/reference/services/SoftLayer_Account/getSshKeys) on the [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) service. </ul> <http title='Example'>{ 'sshKeys': [ { 'id': 123 } ] }</http> <br /> </li> <li><code>postInstallScriptUri</code> <div>Specifies the uri location of the script to be downloaded and run after installation is complete.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> </ul>
<h1>REST Example</h1> <http title='Request'>curl -X POST -d '{ 'parameters':[ { 'hostname': 'host1', 'domain': 'example.com', 'processorCoreAmount': 2, 'memoryCapacity': 2, 'hourlyBillingFlag': true, 'operatingSystemReferenceCode': 'UBUNTU_LATEST' } ] }' https://api.softlayer.com/rest/v3/SoftLayer_Hardware.json </http> <http title='Response'>HTTP/1.1 201 Created Location: https://api.softlayer.com/rest/v3/SoftLayer_Hardware/f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5/getObject
{ 'accountId': 232298, 'bareMetalInstanceFlag': null, 'domain': 'example.com', 'hardwareStatusId': null, 'hostname': 'host1', 'id': null, 'serviceProviderId': null, 'serviceProviderResourceId': null, 'globalIdentifier': 'f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5', 'hourlyBillingFlag': true, 'memoryCapacity': 2, 'operatingSystemReferenceCode': 'UBUNTU_LATEST', 'processorCoreAmount': 2 } </http>
-
createPostSoftwareInstallTransaction
-
createPostSoftwareInstallTransaction
-
createPostSoftwareInstallTransaction
-
deleteObject
This method will cancel a server effective immediately. For servers billed hourly, the charges will stop immediately after the method returns.
-
deleteObject
This method will cancel a server effective immediately. For servers billed hourly, the charges will stop immediately after the method returns.
-
deleteObject
This method will cancel a server effective immediately. For servers billed hourly, the charges will stop immediately after the method returns.
-
deleteObject
This method will cancel a server effective immediately. For servers billed hourly, the charges will stop immediately after the method returns.
-
deleteObject
This method will cancel a server effective immediately. For servers billed hourly, the charges will stop immediately after the method returns.
-
deleteSoftwareComponentPasswords
Delete software component passwords.
-
deleteSoftwareComponentPasswords
Delete software component passwords.
-
deleteSoftwareComponentPasswords
Delete software component passwords.
-
deleteSoftwareComponentPasswords
Delete software component passwords.
-
deleteSoftwareComponentPasswords
Delete software component passwords.
-
deleteTag
Delete an existing tag. If there are any references on the tag, an exception will be thrown.
-
deleteTag
Delete an existing tag. If there are any references on the tag, an exception will be thrown.
-
deleteTag
Delete an existing tag. If there are any references on the tag, an exception will be thrown.
-
deleteTag
Delete an existing tag. If there are any references on the tag, an exception will be thrown.
-
deleteTag
Delete an existing tag. If there are any references on the tag, an exception will be thrown.
-
editObject
Edit a server's properties
-
editObject
Edit a server's properties
-
editObject
Edit a server's properties
-
editSoftwareComponentPasswords
Edit the properties of a software component password such as the username, password, and notes.
-
editSoftwareComponentPasswords
Edit the properties of a software component password such as the username, password, and notes.
-
editSoftwareComponentPasswords
Edit the properties of a software component password such as the username, password, and notes.
-
editSoftwareComponentPasswords
Edit the properties of a software component password such as the username, password, and notes.
-
editSoftwareComponentPasswords
Edit the properties of a software component password such as the username, password, and notes.
-
executeRemoteScript
Download and run remote script from uri on the hardware.
-
executeRemoteScript
Download and run remote script from uri on the hardware.
-
executeRemoteScript
Download and run remote script from uri on the hardware.
-
executeRemoteScript
Download and run remote script from uri on the hardware.
-
executeRemoteScript
Download and run remote script from uri on the hardware.
-
findByIpAddress
The '''findByIpAddress''' method finds hardware using its primary public or private IP address. IP addresses that have a secondary subnet tied to the hardware will not return the hardware. If no hardware is found, no errors are generated and no data is returned.
-
findByIpAddress
The '''findByIpAddress''' method finds hardware using its primary public or private IP address. IP addresses that have a secondary subnet tied to the hardware will not return the hardware. If no hardware is found, no errors are generated and no data is returned.
-
findByIpAddress
The '''findByIpAddress''' method finds hardware using its primary public or private IP address. IP addresses that have a secondary subnet tied to the hardware will not return the hardware. If no hardware is found, no errors are generated and no data is returned.
-
findByIpAddress
The '''findByIpAddress''' method finds hardware using its primary public or private IP address. IP addresses that have a secondary subnet tied to the hardware will not return the hardware. If no hardware is found, no errors are generated and no data is returned.
-
findByIpAddress
The '''findByIpAddress''' method finds hardware using its primary public or private IP address. IP addresses that have a secondary subnet tied to the hardware will not return the hardware. If no hardware is found, no errors are generated and no data is returned.
-
generateOrderTemplate
Obtain an [SoftLayer_Container_Product_Order_Hardware_Server](/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server) 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_Hardware::createObject](/reference/services/SoftLayer_Hardware/createObject) for specifics on the requirements of the template object parameter.
-
generateOrderTemplate
Obtain an [SoftLayer_Container_Product_Order_Hardware_Server](/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server) 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_Hardware::createObject](/reference/services/SoftLayer_Hardware/createObject) for specifics on the requirements of the template object parameter.
-
generateOrderTemplate
Obtain an [SoftLayer_Container_Product_Order_Hardware_Server](/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server) 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_Hardware::createObject](/reference/services/SoftLayer_Hardware/createObject) for specifics on the requirements of the template object parameter.
-
generateOrderTemplate
Obtain an [SoftLayer_Container_Product_Order_Hardware_Server](/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server) 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_Hardware::createObject](/reference/services/SoftLayer_Hardware/createObject) for specifics on the requirements of the template object parameter.
-
generateOrderTemplate
Obtain an [SoftLayer_Container_Product_Order_Hardware_Server](/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server) 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_Hardware::createObject](/reference/services/SoftLayer_Hardware/createObject) for specifics on the requirements of the template object parameter.
-
getAccount
The account associated with a piece of hardware.
-
getAccount
Information regarding a benchmark certification result's associated SoftLayer customer account.
-
getAccount
A partition template's associated [SoftLayer_Account](/reference/datatypes/SoftLayer_Account).
-
getAccount
The account associated with a piece of hardware.
-
getAccount
The account associated with a piece of hardware.
-
getAccount
The account associated with a piece of hardware.
-
getAccount
The account associated with a piece of hardware.
-
getActiveComponents
A piece of hardware's active physical components.
-
getActiveComponents
A piece of hardware's active physical components.
-
getActiveComponents
A piece of hardware's active physical components.
-
getActiveComponents
A piece of hardware's active physical components.
-
getActiveComponents
A piece of hardware's active physical components.
-
getActiveNetworkFirewallBillingItem
The billing item for a server's attached network firewall.
-
getActiveNetworkFirewallBillingItem
The billing item for a server's attached network firewall.
-
getActiveNetworkFirewallBillingItem
The billing item for a server's attached network firewall.
-
getActiveNetworkMonitorIncident
A piece of hardware's active network monitoring incidents.
-
getActiveNetworkMonitorIncident
A piece of hardware's active network monitoring incidents.
-
getActiveNetworkMonitorIncident
A piece of hardware's active network monitoring incidents.
-
getActiveNetworkMonitorIncident
A piece of hardware's active network monitoring incidents.
-
getActiveNetworkMonitorIncident
A piece of hardware's active network monitoring incidents.
-
getActiveTickets
-
getActiveTickets
-
getActiveTickets
-
getActiveTransaction
Transaction currently running for server.
-
getActiveTransaction
Transaction currently running for server.
-
getActiveTransaction
Transaction currently running for server.
-
getActiveTransactions
Any active transaction(s) that are currently running for the server (example: os reload).
-
getActiveTransactions
Any active transaction(s) that are currently running for the server (example: os reload).
-
getActiveTransactions
Any active transaction(s) that are currently running for the server (example: os reload).
-
getAllObjects
-
getAllowedHost
The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists.
-
getAllowedHost
The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists.
-
getAllowedHost
The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists.
-
getAllowedHost
The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists.
-
getAllowedHost
The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists.
-
getAllowedNetworkStorage
The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.
-
getAllowedNetworkStorage
The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.
-
getAllowedNetworkStorage
The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.
-
getAllowedNetworkStorage
The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.
-
getAllowedNetworkStorage
The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.
-
getAllowedNetworkStorageReplicas
The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.
-
getAllowedNetworkStorageReplicas
The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.
-
getAllowedNetworkStorageReplicas
The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.
-
getAllowedNetworkStorageReplicas
The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.
-
getAllowedNetworkStorageReplicas
The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.
-
getAllPowerComponents
-
getAllPowerComponents
-
getAllPowerComponents
-
getAllPowerComponents
-
getAllPowerComponents
-
getAntivirusSpywareSoftwareComponent
Information regarding an antivirus/spyware software component object.
-
getAntivirusSpywareSoftwareComponent
Information regarding an antivirus/spyware software component object.
-
getAntivirusSpywareSoftwareComponent
Information regarding an antivirus/spyware software component object.
-
getAntivirusSpywareSoftwareComponent
Information regarding an antivirus/spyware software component object.
-
getAntivirusSpywareSoftwareComponent
Information regarding an antivirus/spyware software component object.
-
getArchitectureType
-
getAttachedNetworkStorages
This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Hardware.
-
getAttachedNetworkStorages
This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Hardware.
-
getAttachedNetworkStorages
This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Hardware.
-
getAttachedNetworkStorages
This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Hardware.
-
getAttachedNetworkStorages
This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Hardware.
-
getAttributes
Information regarding a piece of hardware's specific attributes.
-
getAttributes
-
getAttributes
Information regarding a piece of hardware's specific attributes.
-
getAttributes
Information regarding a piece of hardware's specific attributes.
-
getAttributes
Information regarding a piece of hardware's specific attributes.
-
getAttributes
Information regarding a piece of hardware's specific attributes.
-
getAvailableBillingTermChangePrices
Retrieves a list of available term prices to this hardware. Currently, price terms are only available for increasing term length to monthly billed servers.
-
getAvailableBillingTermChangePrices
Retrieves a list of available term prices to this hardware. Currently, price terms are only available for increasing term length to monthly billed servers.
-
getAvailableBillingTermChangePrices
Retrieves a list of available term prices to this hardware. Currently, price terms are only available for increasing term length to monthly billed servers.
-
getAvailableBillingTermChangePrices
Retrieves a list of available term prices to this hardware. Currently, price terms are only available for increasing term length to monthly billed servers.
-
getAvailableBillingTermChangePrices
Retrieves a list of available term prices to this hardware. Currently, price terms are only available for increasing term length to monthly billed servers.
-
getAvailableMonitoring
An object that stores the maximum level for the monitoring query types and response types.
-
getAvailableMonitoring
An object that stores the maximum level for the monitoring query types and response types.
-
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_Hardware.
-
getAvailableNetworkStorages
This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Hardware.
-
getAvailableNetworkStorages
This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Hardware.
-
getAvailableNetworkStorages
This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Hardware.
-
getAvailableNetworkStorages
This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Hardware.
-
getAverageDailyBandwidthUsage
The average daily total bandwidth usage for the current billing cycle.
-
getAverageDailyBandwidthUsage
The average daily total bandwidth usage for the current billing cycle.
-
getAverageDailyBandwidthUsage
The average daily total bandwidth usage for the current billing cycle.
-
getAverageDailyPrivateBandwidthUsage
The average daily private bandwidth usage for the current billing cycle.
-
getAverageDailyPrivateBandwidthUsage
The average daily private bandwidth usage for the current billing cycle.
-
getAverageDailyPrivateBandwidthUsage
The average daily private bandwidth usage for the current billing cycle.
-
getAverageDailyPublicBandwidthUsage
The average daily public bandwidth usage for the current billing cycle.
-
getAverageDailyPublicBandwidthUsage
The average daily public bandwidth usage for the current billing cycle.
-
getAverageDailyPublicBandwidthUsage
The average daily public bandwidth usage for the current billing cycle.
-
getAverageDailyPublicBandwidthUsage
The average daily public bandwidth usage for the current billing cycle.
-
getAverageDailyPublicBandwidthUsage
The average daily public bandwidth usage for the current billing cycle.
-
getBackendBandwidthUsage
Use this method to return an array of private bandwidth utilization records between a given date range.
This method represents the NEW version of getFrontendBandwidthUse
-
getBackendBandwidthUsage
Use this method to return an array of private bandwidth utilization records between a given date range.
This method represents the NEW version of getFrontendBandwidthUse
-
getBackendBandwidthUsage
Use this method to return an array of private bandwidth utilization records between a given date range.
This method represents the NEW version of getFrontendBandwidthUse
-
getBackendIncomingBandwidth
The '''getBackendIncomingBandwidth''' method retrieves the amount of incoming private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.
-
getBackendIncomingBandwidth
The '''getBackendIncomingBandwidth''' method retrieves the amount of incoming private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.
-
getBackendIncomingBandwidth
The '''getBackendIncomingBandwidth''' method retrieves the amount of incoming private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.
-
getBackendIncomingBandwidth
The '''getBackendIncomingBandwidth''' method retrieves the amount of incoming private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.
-
getBackendIncomingBandwidth
The '''getBackendIncomingBandwidth''' method retrieves the amount of incoming private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.
-
getBackendNetworkComponents
A piece of hardware's back-end or private network components.
-
getBackendNetworkComponents
A piece of hardware's back-end or private network components.
-
getBackendNetworkComponents
A piece of hardware's back-end or private network components.
-
getBackendNetworkComponents
A piece of hardware's back-end or private network components.
-
getBackendNetworkComponents
A piece of hardware's back-end or private network components.
-
getBackendOutgoingBandwidth
The '''getBackendOutgoingBandwidth''' method retrieves the amount of outgoing private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.
-
getBackendOutgoingBandwidth
The '''getBackendOutgoingBandwidth''' method retrieves the amount of outgoing private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.
-
getBackendOutgoingBandwidth
The '''getBackendOutgoingBandwidth''' method retrieves the amount of outgoing private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.
-
getBackendOutgoingBandwidth
The '''getBackendOutgoingBandwidth''' method retrieves the amount of outgoing private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.
-
getBackendOutgoingBandwidth
The '''getBackendOutgoingBandwidth''' method retrieves the amount of outgoing private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.
-
getBackendRouters
A hardware's backend or private router.
-
getBackendRouters
A hardware's backend or private router.
-
getBackendRouters
A hardware's backend or private router.
-
getBackendRouters
A hardware's backend or private router.
-
getBackendRouters
A hardware's backend or private router.
-
getBandwidthAllocation
A hardware's allotted bandwidth (measured in GB).
-
getBandwidthAllocation
A hardware's allotted bandwidth (measured in GB).
-
getBandwidthAllocation
A hardware's allotted bandwidth (measured in GB).
-
getBandwidthAllocation
A hardware's allotted bandwidth (measured in GB).
-
getBandwidthAllocation
A hardware's allotted bandwidth (measured in GB).
-
getBandwidthAllotmentDetail
A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments.
-
getBandwidthAllotmentDetail
A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments.
-
getBandwidthAllotmentDetail
A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments.
-
getBandwidthAllotmentDetail
A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments.
-
getBandwidthAllotmentDetail
A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments.
-
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.
-
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.
-
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 server. It will gather the correct input parameters for the generic graphing utility automatically based on the snapshot specified. Use the $draw flag to suppress the generation of the actual binary PNG image.
-
getBandwidthImage
Use this method when needing a bandwidth image for a single server. It will gather the correct input parameters for the generic graphing utility automatically based on the snapshot specified. Use the $draw flag to suppress the generation of the actual binary PNG image.
-
getBandwidthImage
Use this method when needing a bandwidth image for a single server. It will gather the correct input parameters for the generic graphing utility automatically based on the snapshot specified. Use the $draw flag to suppress the generation of the actual binary PNG image.
-
getBenchmarkCertifications
Information regarding a piece of hardware's benchmark certifications.
-
getBenchmarkCertifications
Information regarding a piece of hardware's benchmark certifications.
-
getBenchmarkCertifications
Information regarding a piece of hardware's benchmark certifications.
-
getBenchmarkCertifications
Information regarding a piece of hardware's benchmark certifications.
-
getBenchmarkCertifications
Information regarding a piece of hardware's benchmark certifications.
-
getBillingCycleBandwidthUsage
The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to.
-
getBillingCycleBandwidthUsage
The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to.
-
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.
-
getBillingCyclePrivateBandwidthUsage
The raw private bandwidth usage data for the current billing cycle.
-
getBillingCyclePrivateBandwidthUsage
The raw private bandwidth usage data for the current billing cycle.
-
getBillingCyclePublicBandwidthUsage
The raw public bandwidth usage data for the current billing cycle.
-
getBillingCyclePublicBandwidthUsage
The raw public bandwidth usage data for the current billing cycle.
-
getBillingCyclePublicBandwidthUsage
The raw public bandwidth usage data for the current billing cycle.
-
getBillingItem
Information regarding the billing item for a server.
-
getBillingItem
Information regarding the billing item for a server.
-
getBillingItem
Information regarding the billing item for a server.
-
getBillingItem
Information regarding the billing item for a server.
-
getBillingItem
Information regarding the billing item for a server.
-
getBillingItemFlag
A flag indicating that a billing item exists.
-
getBillingItemFlag
A flag indicating that a billing item exists.
-
getBillingItemFlag
A flag indicating that a billing item exists.
-
getBillingItemFlag
A flag indicating that a billing item exists.
-
getBillingItemFlag
A flag indicating that a billing item exists.
-
getBiosPasswordNullFlag
Determine if BIOS password should be left as null.
-
getBiosPasswordNullFlag
Determine if BIOS password should be left as null.
-
getBiosPasswordNullFlag
Determine if BIOS password should be left as null.
-
getBlockCancelBecauseDisconnectedFlag
Determines whether the hardware is ineligible for cancellation because it is disconnected.
-
getBlockCancelBecauseDisconnectedFlag
Determines whether the hardware is ineligible for cancellation because it is disconnected.
-
getBlockCancelBecauseDisconnectedFlag
Determines whether the hardware is ineligible for cancellation because it is disconnected.
-
getBlockCancelBecauseDisconnectedFlag
Determines whether the hardware is ineligible for cancellation because it is disconnected.
-
getBlockCancelBecauseDisconnectedFlag
Determines whether the hardware is ineligible for cancellation because it is disconnected.
-
getBootModeOptions
Retrieve the valid boot modes for this server
-
getBootModeOptions
Retrieve the valid boot modes for this server
-
getBootModeOptions
Retrieve the valid boot modes for this server
-
getBoundSubnets
Associated subnets for a router object.
-
getBusinessContinuanceInsuranceFlag
Status indicating whether or not a piece of hardware has business continuance insurance.
-
getBusinessContinuanceInsuranceFlag
Status indicating whether or not a piece of hardware has business continuance insurance.
-
getBusinessContinuanceInsuranceFlag
Status indicating whether or not a piece of hardware has business continuance insurance.
-
getBusinessContinuanceInsuranceFlag
Status indicating whether or not a piece of hardware has business continuance insurance.
-
getBusinessContinuanceInsuranceFlag
Status indicating whether or not a piece of hardware has business continuance insurance.
-
getByDescription
The '''getByDescription''' method retrieves all possible partition templates based on the description (required parameter) entered when calling the method. The description is typically the operating system's name. Current recognized values include 'linux', 'windows', 'freebsd', and 'Debian'.
-
getCaptureEnabledFlag
Determine if the server is able to be image captured. If unable to image capture a reason will be provided.
-
getCaptureEnabledFlag
Determine if the server is able to be image captured. If unable to image capture a reason will be provided.
-
getCaptureEnabledFlag
Determine if the server is able to be image captured. If unable to image capture a reason will be provided.
-
getChildrenHardware
Child hardware.
-
getChildrenHardware
Child hardware.
-
getChildrenHardware
Child hardware.
-
getChildrenHardware
Child hardware.
-
getChildrenHardware
Child hardware.
-
getCompatibleArrayTypes
-
getCompatibleChildComponentModels
All the component models that are compatible with a hardware component model.
-
getCompatibleParentComponentModels
All the component models that a hardware component model is compatible with.
-
getComponentDetailsXML
-
getComponentDetailsXML
-
getComponentDetailsXML
-
getComponentDetailsXML
-
getComponentDetailsXML
-
getComponents
A piece of hardware's components.
-
getComponents
A piece of hardware's components.
-
getComponents
A piece of hardware's components.
-
getComponents
A piece of hardware's components.
-
getComponents
A piece of hardware's components.
-
getContainsSolidStateDrivesFlag
-
getContainsSolidStateDrivesFlag
-
getContainsSolidStateDrivesFlag
-
getContinuousDataProtectionSoftwareComponent
A continuous data protection/server backup software component object.
-
getContinuousDataProtectionSoftwareComponent
A continuous data protection/server backup software component object.
-
getContinuousDataProtectionSoftwareComponent
A continuous data protection/server backup software component object.
-
getContinuousDataProtectionSoftwareComponent
A continuous data protection/server backup software component object.
-
getContinuousDataProtectionSoftwareComponent
A continuous data protection/server backup software component object.
-
getControlPanel
A server's control panel.
-
getControlPanel
A server's control panel.
-
getControlPanel
A server's control panel.
-
getCost
The total cost of a server, measured in US Dollars ($USD).
-
getCost
The total cost of a server, measured in US Dollars ($USD).
-
getCost
The total cost of a server, measured in US Dollars ($USD).
-
getCreateObjectOptions
There are many options that may be provided while ordering a server, 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_Hardware_Configuration](/reference/datatypes/SoftLayer_Container_Hardware_Configuration).
-
getCreateObjectOptions
There are many options that may be provided while ordering a server, 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_Hardware_Configuration](/reference/datatypes/SoftLayer_Container_Hardware_Configuration).
-
getCreateObjectOptions
There are many options that may be provided while ordering a server, 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_Hardware_Configuration](/reference/datatypes/SoftLayer_Container_Hardware_Configuration).
-
getCreateObjectOptions
There are many options that may be provided while ordering a server, 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_Hardware_Configuration](/reference/datatypes/SoftLayer_Container_Hardware_Configuration).
-
getCreateObjectOptions
There are many options that may be provided while ordering a server, 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_Hardware_Configuration](/reference/datatypes/SoftLayer_Container_Hardware_Configuration).
-
getCurrentBandwidthSummary
An object that provides commonly used bandwidth summary components for the current billing cycle.
-
getCurrentBandwidthSummary
An object that provides commonly used bandwidth summary components for the current billing cycle.
-
getCurrentBandwidthSummary
An object that provides commonly used bandwidth summary components for the current billing cycle.
-
getCurrentBenchmarkCertificationResultFile
Attempt to retrieve the file associated with the current benchmark certification result, if such a file exists. If there is no file for this benchmark certification result, calling this method throws an exception.
-
getCurrentBenchmarkCertificationResultFile
Attempt to retrieve the file associated with the current benchmark certification result, if such a file exists. If there is no file for this benchmark certification result, calling this method throws an exception.
-
getCurrentBenchmarkCertificationResultFile
Attempt to retrieve the file associated with the current benchmark certification result, if such a file exists. If there is no file for this benchmark certification result, calling this method throws an exception.
-
getCurrentBillableBandwidthUsage
The current billable public outbound bandwidth for this hardware for the current billing cycle.
-
getCurrentBillableBandwidthUsage
The current billable public outbound bandwidth for this hardware for the current billing cycle.
-
getCurrentBillableBandwidthUsage
The current billable public outbound bandwidth for this hardware for the current billing cycle.
-
getCurrentBillableBandwidthUsage
The current billable public outbound bandwidth for this hardware for the current billing cycle.
-
getCurrentBillableBandwidthUsage
The current billable public outbound bandwidth for this hardware for the current billing cycle.
-
getCurrentBillingDetail
Get the billing detail for this hardware for the current billing period. This does not include bandwidth usage.
-
getCurrentBillingDetail
Get the billing detail for this hardware for the current billing period. This does not include bandwidth usage.
-
getCurrentBillingDetail
Get the billing detail for this hardware for the current billing period. This does not include bandwidth usage.
-
getCurrentBillingDetail
Get the billing detail for this hardware for the current billing period. This does not include bandwidth usage.
-
getCurrentBillingDetail
Get the billing detail for this hardware for the current billing period. This does not include bandwidth usage.
-
getCurrentBillingTotal
Get the total bill amount in US Dollars ($) for this hardware in the current billing period. This includes all bandwidth used up to the point the method is called on the hardware.
-
getCurrentBillingTotal
Get the total bill amount in US Dollars ($) for this hardware in the current billing period. This includes all bandwidth used up to the point the method is called on the hardware.
-
getCurrentBillingTotal
Get the total bill amount in US Dollars ($) for this hardware in the current billing period. This includes all bandwidth used up to the point the method is called on the hardware.
-
getCurrentBillingTotal
Get the total bill amount in US Dollars ($) for this hardware in the current billing period. This includes all bandwidth used up to the point the method is called on the hardware.
-
getCurrentBillingTotal
Get the total bill amount in US Dollars ($) for this hardware in the current billing period. This includes all bandwidth used up to the point the method is called on the hardware.
-
getCustomerInstalledOperatingSystemFlag
Indicates if a server has a Customer Installed OS
-
getCustomerInstalledOperatingSystemFlag
Indicates if a server has a Customer Installed OS
-
getCustomerInstalledOperatingSystemFlag
Indicates if a server has a Customer Installed OS
-
getCustomerOwnedFlag
Indicates if a server is a customer owned device.
-
getCustomerOwnedFlag
Indicates if a server is a customer owned device.
-
getCustomerOwnedFlag
Indicates if a server is a customer owned device.
-
getDailyAverage
The '''getDailyAverage''' method calculates the average daily network traffic used by the selected server. Using the required parameter ''dateTime'' to enter a start and end date, the user retrieves this average, measure in gigabytes (GB) for the specified date range. When entering parameters, only the month, day and year are required - time entries are omitted as this method defaults the time to midnight in order to account for the entire day.
-
getDailyAverage
The '''getDailyAverage''' method calculates the average daily network traffic used by the selected server. Using the required parameter ''dateTime'' to enter a start and end date, the user retrieves this average, measure in gigabytes (GB) for the specified date range. When entering parameters, only the month, day and year are required - time entries are omitted as this method defaults the time to midnight in order to account for the entire day.
-
getDailyAverage
The '''getDailyAverage''' method calculates the average daily network traffic used by the selected server. Using the required parameter ''dateTime'' to enter a start and end date, the user retrieves this average, measure in gigabytes (GB) for the specified date range. When entering parameters, only the month, day and year are required - time entries are omitted as this method defaults the time to midnight in order to account for the entire day.
-
getDailyAverage
The '''getDailyAverage''' method calculates the average daily network traffic used by the selected server. Using the required parameter ''dateTime'' to enter a start and end date, the user retrieves this average, measure in gigabytes (GB) for the specified date range. When entering parameters, only the month, day and year are required - time entries are omitted as this method defaults the time to midnight in order to account for the entire day.
-
getDailyAverage
The '''getDailyAverage''' method calculates the average daily network traffic used by the selected server. Using the required parameter ''dateTime'' to enter a start and end date, the user retrieves this average, measure in gigabytes (GB) for the specified date range. When entering parameters, only the month, day and year are required - time entries are omitted as this method defaults the time to midnight in order to account for the entire day.
-
getData
An individual partition for a partition template. This is identical to 'partitionTemplatePartition' except this will sort unix partitions.
-
getDatacenter
Information regarding the datacenter in which a piece of hardware resides.
-
getDatacenter
Information regarding the datacenter in which a piece of hardware resides.
-
getDatacenter
Information regarding the datacenter in which a piece of hardware resides.
-
getDatacenter
Information regarding the datacenter in which a piece of hardware resides.
-
getDatacenter
Information regarding the datacenter in which a piece of hardware resides.
-
getDatacenterName
The name of the datacenter in which a piece of hardware resides.
-
getDatacenterName
The name of the datacenter in which a piece of hardware resides.
-
getDatacenterName
The name of the datacenter in which a piece of hardware resides.
-
getDatacenterName
The name of the datacenter in which a piece of hardware resides.
-
getDatacenterName
The name of the datacenter in which a piece of hardware resides.
-
getDaysInSparePool
Number of day(s) a server have been in spare pool.
-
getDaysInSparePool
Number of day(s) a server have been in spare pool.
-
getDaysInSparePool
Number of day(s) a server have been in spare pool.
-
getDaysInSparePool
Number of day(s) a server have been in spare pool.
-
getDaysInSparePool
Number of day(s) a server have been in spare pool.
-
getDownlinkHardware
All hardware that has uplink network connections to a piece of hardware.
-
getDownlinkHardware
All hardware that has uplink network connections to a piece of hardware.
-
getDownlinkHardware
All hardware that has uplink network connections to a piece of hardware.
-
getDownlinkHardware
All hardware that has uplink network connections to a piece of hardware.
-
getDownlinkHardware
All hardware that has uplink network connections to a piece of hardware.
-
getDownlinkNetworkHardware
All hardware that has uplink network connections to a piece of hardware.
-
getDownlinkNetworkHardware
All hardware that has uplink network connections to a piece of hardware.
-
getDownlinkNetworkHardware
All hardware that has uplink network connections to a piece of hardware.
-
getDownlinkNetworkHardware
All hardware that has uplink network connections to a piece of hardware.
-
getDownlinkNetworkHardware
All hardware that has uplink network connections to a piece of hardware.
-
getDownlinkServers
Information regarding all servers attached to a piece of network hardware.
-
getDownlinkServers
Information regarding all servers attached to a piece of network hardware.
-
getDownlinkServers
Information regarding all servers attached to a piece of network hardware.
-
getDownlinkServers
Information regarding all servers attached to a piece of network hardware.
-
getDownlinkServers
Information regarding all servers attached to a piece of network hardware.
-
getDownlinkVirtualGuests
Information regarding all virtual guests attached to a piece of network hardware.
-
getDownlinkVirtualGuests
Information regarding all virtual guests attached to a piece of network hardware.
-
getDownlinkVirtualGuests
Information regarding all virtual guests attached to a piece of network hardware.
-
getDownlinkVirtualGuests
Information regarding all virtual guests attached to a piece of network hardware.
-
getDownlinkVirtualGuests
Information regarding all virtual guests attached to a piece of network hardware.
-
getDownstreamHardwareBindings
All hardware downstream from a network device.
-
getDownstreamHardwareBindings
All hardware downstream from a network device.
-
getDownstreamHardwareBindings
All hardware downstream from a network device.
-
getDownstreamHardwareBindings
All hardware downstream from a network device.
-
getDownstreamHardwareBindings
All hardware downstream from a network device.
-
getDownstreamNetworkHardware
All network hardware downstream from the selected piece of hardware.
-
getDownstreamNetworkHardware
All network hardware downstream from the selected piece of hardware.
-
getDownstreamNetworkHardware
All network hardware downstream from the selected piece of hardware.
-
getDownstreamNetworkHardware
All network hardware downstream from the selected piece of hardware.
-
getDownstreamNetworkHardware
All network hardware downstream from the selected piece of hardware.
-
getDownstreamNetworkHardwareWithIncidents
All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. [DEPRECATED]
-
getDownstreamNetworkHardwareWithIncidents
All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. [DEPRECATED]
-
getDownstreamNetworkHardwareWithIncidents
All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. [DEPRECATED]
-
getDownstreamNetworkHardwareWithIncidents
All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. [DEPRECATED]
-
getDownstreamNetworkHardwareWithIncidents
All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. [DEPRECATED]
-
getDownstreamServers
Information regarding all servers attached downstream to a piece of network hardware.
-
getDownstreamServers
Information regarding all servers attached downstream to a piece of network hardware.
-
getDownstreamServers
Information regarding all servers attached downstream to a piece of network hardware.
-
getDownstreamServers
Information regarding all servers attached downstream to a piece of network hardware.
-
getDownstreamServers
Information regarding all servers attached downstream to a piece of network hardware.
-
getDownstreamVirtualGuests
Information regarding all virtual guests attached to a piece of network hardware.
-
getDownstreamVirtualGuests
Information regarding all virtual guests attached to a piece of network hardware.
-
getDownstreamVirtualGuests
Information regarding all virtual guests attached to a piece of network hardware.
-
getDownstreamVirtualGuests
Information regarding all virtual guests attached to a piece of network hardware.
-
getDownstreamVirtualGuests
Information regarding all virtual guests attached to a piece of network hardware.
-
getDriveControllers
The drive controllers contained within a piece of hardware.
-
getDriveControllers
The drive controllers contained within a piece of hardware.
-
getDriveControllers
The drive controllers contained within a piece of hardware.
-
getDriveControllers
The drive controllers contained within a piece of hardware.
-
getDriveControllers
The drive controllers contained within a piece of hardware.
-
getEvaultNetworkStorage
Information regarding a piece of hardware's associated EVault network storage service account.
-
getEvaultNetworkStorage
Information regarding a piece of hardware's associated EVault network storage service account.
-
getEvaultNetworkStorage
Information regarding a piece of hardware's associated EVault network storage service account.
-
getEvaultNetworkStorage
Information regarding a piece of hardware's associated EVault network storage service account.
-
getEvaultNetworkStorage
Information regarding a piece of hardware's associated EVault network storage service account.
-
getExpireDate
-
getFirewallProtectableSubnets
Get the subnets associated with this server that are protectable by a network component firewall.
-
getFirewallProtectableSubnets
Get the subnets associated with this server that are protectable by a network component firewall.
-
getFirewallProtectableSubnets
Get the subnets associated with this server that are protectable by a network component firewall.
-
getFirewallServiceComponent
Information regarding a piece of hardware's firewall services.
-
getFirewallServiceComponent
Information regarding a piece of hardware's firewall services.
-
getFirewallServiceComponent
Information regarding a piece of hardware's firewall services.
-
getFirewallServiceComponent
Information regarding a piece of hardware's firewall services.
-
getFirewallServiceComponent
Information regarding a piece of hardware's firewall services.
-
getFirmwareQuantity
-
getFirmwares
-
getFixedConfigurationPreset
Defines the fixed components in a fixed configuration bare metal server.
-
getFixedConfigurationPreset
Defines the fixed components in a fixed configuration bare metal server.
-
getFixedConfigurationPreset
Defines the fixed components in a fixed configuration bare metal server.
-
getFixedConfigurationPreset
Defines the fixed components in a fixed configuration bare metal server.
-
getFixedConfigurationPreset
Defines the fixed components in a fixed configuration bare metal server.
-
getFrontendBandwidthUsage
Use this method to return an array of public bandwidth utilization records between a given date range.
This method represents the NEW version of getFrontendBandwidthUse
-
getFrontendBandwidthUsage
Use this method to return an array of public bandwidth utilization records between a given date range.
This method represents the NEW version of getFrontendBandwidthUse
-
getFrontendBandwidthUsage
Use this method to return an array of public bandwidth utilization records between a given date range.
This method represents the NEW version of getFrontendBandwidthUse
-
getFrontendIncomingBandwidth
The '''getFrontendIncomingBandwidth''' method retrieves the amount of incoming public network traffic used by a server between the given start and end date parameters. When entering the ''dateTime'' parameter, only the month, day and year of the start and end dates are required - the time (hour, minute and second) are set to midnight by default and cannot be changed. The amount of bandwidth retrieved is measured in gigabytes (GB).
-
getFrontendIncomingBandwidth
The '''getFrontendIncomingBandwidth''' method retrieves the amount of incoming public network traffic used by a server between the given start and end date parameters. When entering the ''dateTime'' parameter, only the month, day and year of the start and end dates are required - the time (hour, minute and second) are set to midnight by default and cannot be changed. The amount of bandwidth retrieved is measured in gigabytes (GB).
-
getFrontendIncomingBandwidth
The '''getFrontendIncomingBandwidth''' method retrieves the amount of incoming public network traffic used by a server between the given start and end date parameters. When entering the ''dateTime'' parameter, only the month, day and year of the start and end dates are required - the time (hour, minute and second) are set to midnight by default and cannot be changed. The amount of bandwidth retrieved is measured in gigabytes (GB).
-
getFrontendIncomingBandwidth
The '''getFrontendIncomingBandwidth''' method retrieves the amount of incoming public network traffic used by a server between the given start and end date parameters. When entering the ''dateTime'' parameter, only the month, day and year of the start and end dates are required - the time (hour, minute and second) are set to midnight by default and cannot be changed. The amount of bandwidth retrieved is measured in gigabytes (GB).
-
getFrontendIncomingBandwidth
The '''getFrontendIncomingBandwidth''' method retrieves the amount of incoming public network traffic used by a server between the given start and end date parameters. When entering the ''dateTime'' parameter, only the month, day and year of the start and end dates are required - the time (hour, minute and second) are set to midnight by default and cannot be changed. The amount of bandwidth retrieved is measured in gigabytes (GB).
-
getFrontendNetworkComponents
A piece of hardware's front-end or public network components.
-
getFrontendNetworkComponents
A piece of hardware's front-end or public network components.
-
getFrontendNetworkComponents
A piece of hardware's front-end or public network components.
-
getFrontendNetworkComponents
A piece of hardware's front-end or public network components.
-
getFrontendNetworkComponents
A piece of hardware's front-end or public network components.
-
getFrontendOutgoingBandwidth
The '''getFrontendOutgoingBandwidth''' method retrieves the amount of outgoing public network traffic used by a server between the given start and end date parameters. The ''dateTime'' parameter requires only the day, month and year to be entered - the time (hour, minute and second) are set to midnight be default in order to gather the data for the entire start and end date indicated in the parameter. The amount of bandwidth retrieved is measured in gigabytes (GB).
-
getFrontendOutgoingBandwidth
The '''getFrontendOutgoingBandwidth''' method retrieves the amount of outgoing public network traffic used by a server between the given start and end date parameters. The ''dateTime'' parameter requires only the day, month and year to be entered - the time (hour, minute and second) are set to midnight be default in order to gather the data for the entire start and end date indicated in the parameter. The amount of bandwidth retrieved is measured in gigabytes (GB).
-
getFrontendOutgoingBandwidth
The '''getFrontendOutgoingBandwidth''' method retrieves the amount of outgoing public network traffic used by a server between the given start and end date parameters. The ''dateTime'' parameter requires only the day, month and year to be entered - the time (hour, minute and second) are set to midnight be default in order to gather the data for the entire start and end date indicated in the parameter. The amount of bandwidth retrieved is measured in gigabytes (GB).
-
getFrontendOutgoingBandwidth
The '''getFrontendOutgoingBandwidth''' method retrieves the amount of outgoing public network traffic used by a server between the given start and end date parameters. The ''dateTime'' parameter requires only the day, month and year to be entered - the time (hour, minute and second) are set to midnight be default in order to gather the data for the entire start and end date indicated in the parameter. The amount of bandwidth retrieved is measured in gigabytes (GB).
-
getFrontendOutgoingBandwidth
The '''getFrontendOutgoingBandwidth''' method retrieves the amount of outgoing public network traffic used by a server between the given start and end date parameters. The ''dateTime'' parameter requires only the day, month and year to be entered - the time (hour, minute and second) are set to midnight be default in order to gather the data for the entire start and end date indicated in the parameter. The amount of bandwidth retrieved is measured in gigabytes (GB).
-
getFrontendRouters
A hardware's frontend or public router.
-
getFrontendRouters
A hardware's frontend or public router.
-
getFrontendRouters
A hardware's frontend or public router.
-
getFrontendRouters
A hardware's frontend or public router.
-
getFrontendRouters
A hardware's frontend or public router.
-
getFutureBillingItem
Information regarding the future billing item for a server.
-
getFutureBillingItem
Information regarding the future billing item for a server.
-
getFutureBillingItem
Information regarding the future billing item for a server.
-
getFutureBillingItem
Information regarding the future billing item for a server.
-
getFutureBillingItem
Information regarding the future billing item for a server.
-
getGenericComponentModelAvailability
An API to retrieve Generic Components Model availability at data centers
-
getGlobalIdentifier
A hardware's universally unique identifier.
-
getGlobalIdentifier
A hardware's universally unique identifier.
-
getGlobalIdentifier
A hardware's universally unique identifier.
-
getGlobalIdentifier
A hardware's universally unique identifier.
-
getGlobalIdentifier
A hardware's universally unique identifier.
-
getHardDrives
The hard drives contained within a piece of hardware.
-
getHardDrives
The hard drives contained within a piece of hardware.
-
getHardDrives
The hard drives contained within a piece of hardware.
-
getHardDrives
The hard drives contained within a piece of hardware.
-
getHardDrives
The hard drives contained within a piece of hardware.
-
getHardware
Information regarding the piece of hardware on which a benchmark certification test was performed.
-
getHardwareByIpAddress
Retrieve a server by searching for the primary IP address.
-
getHardwareByIpAddress
Retrieve a server by searching for the primary IP address.
-
getHardwareByIpAddress
Retrieve a server by searching for the primary IP address.
-
getHardwareChassis
The chassis that a piece of hardware is housed in.
-
getHardwareChassis
The chassis that a piece of hardware is housed in.
-
getHardwareChassis
The chassis that a piece of hardware is housed in.
-
getHardwareChassis
The chassis that a piece of hardware is housed in.
-
getHardwareChassis
The chassis that a piece of hardware is housed in.
-
getHardwareChild
-
getHardwareComponents
A hardware component model's physical components in inventory.
-
getHardwareFunction
A hardware's function.
-
getHardwareFunction
A hardware's function.
-
getHardwareFunction
A hardware's function.
-
getHardwareFunction
A hardware's function.
-
getHardwareFunction
A hardware's function.
-
getHardwareFunctionDescription
A hardware's function.
-
getHardwareFunctionDescription
A hardware's function.
-
getHardwareFunctionDescription
A hardware's function.
-
getHardwareFunctionDescription
A hardware's function.
-
getHardwareFunctionDescription
A hardware's function.
-
getHardwareGenericComponentModel
The non-vendor specific generic component model for a hardware component model.
-
getHardwareParent
-
getHardwareState
A hardware's power/transaction state.
-
getHardwareState
A hardware's power/transaction state.
-
getHardwareState
A hardware's power/transaction state.
-
getHardwareState
A hardware's power/transaction state.
-
getHardwareState
A hardware's power/transaction state.
-
getHardwareStatus
A hardware's status.
-
getHardwareStatus
A hardware's status.
-
getHardwareStatus
A hardware's status.
-
getHardwareStatus
A hardware's status.
-
getHardwareStatus
A hardware's status.
-
getHasSingleRootVirtualizationBillingItemFlag
Determine if hardware has Single Root IO VIrtualization (SR-IOV) billing item.
-
getHasSingleRootVirtualizationBillingItemFlag
Determine if hardware has Single Root IO VIrtualization (SR-IOV) billing item.
-
getHasSingleRootVirtualizationBillingItemFlag
Determine if hardware has Single Root IO VIrtualization (SR-IOV) billing item.
-
getHasTrustedPlatformModuleBillingItemFlag
Determine in hardware object has TPM enabled.
-
getHasTrustedPlatformModuleBillingItemFlag
Determine in hardware object has TPM enabled.
-
getHasTrustedPlatformModuleBillingItemFlag
Determine in hardware object has TPM enabled.
-
getHasTrustedPlatformModuleBillingItemFlag
Determine in hardware object has TPM enabled.
-
getHasTrustedPlatformModuleBillingItemFlag
Determine in hardware object has TPM enabled.
-
getHostIpsSoftwareComponent
Information regarding a host IPS software component object.
-
getHostIpsSoftwareComponent
Information regarding a host IPS software component object.
-
getHostIpsSoftwareComponent
Information regarding a host IPS software component object.
-
getHostIpsSoftwareComponent
Information regarding a host IPS software component object.
-
getHostIpsSoftwareComponent
Information regarding a host IPS software component object.
-
getHourlyBandwidth
The '''getHourlyBandwidth''' method retrieves all bandwidth updates hourly for the specified hardware. Because the potential number of data points can become excessive, the method limits the user to obtain data in 24-hour intervals. The required ''dateTime'' parameter is used as the starting point for the query and will be calculated for the 24-hour period starting with the specified date and time. For example, entering a parameter of
'02/01/2008 0:00'
results in a return of all bandwidth data for the entire day of February 1, 2008, as 0:00 specifies a midnight start date. Please note that the time entered should be completed using a 24-hour clock (military time, astronomical time).
For data spanning more than a single 24-hour period, refer to the getBandwidthData function on the metricTrackingObject for the piece of hardware.
-
getHourlyBandwidth
The '''getHourlyBandwidth''' method retrieves all bandwidth updates hourly for the specified hardware. Because the potential number of data points can become excessive, the method limits the user to obtain data in 24-hour intervals. The required ''dateTime'' parameter is used as the starting point for the query and will be calculated for the 24-hour period starting with the specified date and time. For example, entering a parameter of
'02/01/2008 0:00'
results in a return of all bandwidth data for the entire day of February 1, 2008, as 0:00 specifies a midnight start date. Please note that the time entered should be completed using a 24-hour clock (military time, astronomical time).
For data spanning more than a single 24-hour period, refer to the getBandwidthData function on the metricTrackingObject for the piece of hardware.
-
getHourlyBandwidth
The '''getHourlyBandwidth''' method retrieves all bandwidth updates hourly for the specified hardware. Because the potential number of data points can become excessive, the method limits the user to obtain data in 24-hour intervals. The required ''dateTime'' parameter is used as the starting point for the query and will be calculated for the 24-hour period starting with the specified date and time. For example, entering a parameter of
'02/01/2008 0:00'
results in a return of all bandwidth data for the entire day of February 1, 2008, as 0:00 specifies a midnight start date. Please note that the time entered should be completed using a 24-hour clock (military time, astronomical time).
For data spanning more than a single 24-hour period, refer to the getBandwidthData function on the metricTrackingObject for the piece of hardware.
-
getHourlyBandwidth
The '''getHourlyBandwidth''' method retrieves all bandwidth updates hourly for the specified hardware. Because the potential number of data points can become excessive, the method limits the user to obtain data in 24-hour intervals. The required ''dateTime'' parameter is used as the starting point for the query and will be calculated for the 24-hour period starting with the specified date and time. For example, entering a parameter of
'02/01/2008 0:00'
results in a return of all bandwidth data for the entire day of February 1, 2008, as 0:00 specifies a midnight start date. Please note that the time entered should be completed using a 24-hour clock (military time, astronomical time).
For data spanning more than a single 24-hour period, refer to the getBandwidthData function on the metricTrackingObject for the piece of hardware.
-
getHourlyBandwidth
The '''getHourlyBandwidth''' method retrieves all bandwidth updates hourly for the specified hardware. Because the potential number of data points can become excessive, the method limits the user to obtain data in 24-hour intervals. The required ''dateTime'' parameter is used as the starting point for the query and will be calculated for the 24-hour period starting with the specified date and time. For example, entering a parameter of
'02/01/2008 0:00'
results in a return of all bandwidth data for the entire day of February 1, 2008, as 0:00 specifies a midnight start date. Please note that the time entered should be completed using a 24-hour clock (military time, astronomical time).
For data spanning more than a single 24-hour period, refer to the getBandwidthData function on the metricTrackingObject for the piece of hardware.
-
getHourlyBillingFlag
A server's hourly billing status.
-
getHourlyBillingFlag
A server's hourly billing status.
-
getHourlyBillingFlag
A server's hourly billing status.
-
getHourlyBillingFlag
A server's hourly billing status.
-
getHourlyBillingFlag
A server's hourly billing status.
-
getInboundBandwidthUsage
The sum of all the inbound network traffic data for the last 30 days.
-
getInboundBandwidthUsage
The sum of all the inbound network traffic data for the last 30 days.
-
getInboundBandwidthUsage
The sum of all the inbound network traffic data for the last 30 days.
-
getInboundBandwidthUsage
The sum of all the inbound network traffic data for the last 30 days.
-
getInboundBandwidthUsage
The sum of all the inbound network traffic data for the last 30 days.
-
getInboundPrivateBandwidthUsage
The total private inbound bandwidth for this hardware for the current billing cycle.
-
getInboundPrivateBandwidthUsage
The total private inbound bandwidth for this hardware for the current billing cycle.
-
getInboundPrivateBandwidthUsage
The total private inbound bandwidth for this hardware for the current billing cycle.
-
getInboundPublicBandwidthUsage
The total public inbound bandwidth for this hardware for the current billing cycle.
-
getInboundPublicBandwidthUsage
The total public inbound bandwidth for this hardware for the current billing cycle.
-
getInboundPublicBandwidthUsage
The total public inbound bandwidth for this hardware for the current billing cycle.
-
getInboundPublicBandwidthUsage
The total public inbound bandwidth for this hardware for the current billing cycle.
-
getInboundPublicBandwidthUsage
The total public inbound bandwidth for this hardware for the current billing cycle.
-
getInfinibandCompatibleAttribute
-
getIsBillingTermChangeAvailableFlag
Whether or not this hardware object is eligible to change to term billing.
-
getIsBillingTermChangeAvailableFlag
Whether or not this hardware object is eligible to change to term billing.
-
getIsBillingTermChangeAvailableFlag
Whether or not this hardware object is eligible to change to term billing.
-
getIsBillingTermChangeAvailableFlag
Whether or not this hardware object is eligible to change to term billing.
-
getIsBillingTermChangeAvailableFlag
Whether or not this hardware object is eligible to change to term billing.
-
getIsCloudReadyNodeCertified
Determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute.
-
getIsCloudReadyNodeCertified
Determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute.
-
getIsCloudReadyNodeCertified
Determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute.
-
getIsCloudReadyNodeCertified
Determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute.
-
getIsCloudReadyNodeCertified
Determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute.
-
getIsFlexSkuCompatible
-
getIsInfinibandCompatible
-
getIsIpmiDisabled
Determine if remote management has been disabled due to port speed.
-
getIsIpmiDisabled
Determine if remote management has been disabled due to port speed.
-
getIsIpmiDisabled
Determine if remote management has been disabled due to port speed.
-
getIsNfsOnly
A server that has nfs only drive.
-
getIsNfsOnly
A server that has nfs only drive.
-
getIsNfsOnly
A server that has nfs only drive.
-
getIsQeInternalServer
Determine if hardware object has the QE_INTERNAL_SERVER attribute.
-
getIsQeInternalServer
Determine if hardware object has the QE_INTERNAL_SERVER attribute.
-
getIsQeInternalServer
Determine if hardware object has the QE_INTERNAL_SERVER attribute.
-
getIsVirtualPrivateCloudNode
Determine if hardware object is a Virtual Private Cloud node.
-
getIsVirtualPrivateCloudNode
Determine if hardware object is a Virtual Private Cloud node.
-
getIsVirtualPrivateCloudNode
Determine if hardware object is a Virtual Private Cloud node.
-
getItemPricesFromSoftwareDescriptions
Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description
-
getItemPricesFromSoftwareDescriptions
Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description
-
getItemPricesFromSoftwareDescriptions
Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description
-
getLastOperatingSystemReload
The last transaction that a server's operating system was loaded.
-
getLastOperatingSystemReload
The last transaction that a server's operating system was loaded.
-
getLastOperatingSystemReload
The last transaction that a server's operating system was loaded.
-
getLastTransaction
Information regarding the last transaction a server performed.
-
getLastTransaction
Information regarding the last transaction a server performed.
-
getLastTransaction
Information regarding the last transaction a server performed.
-
getLastTransaction
Information regarding the last transaction a server performed.
-
getLastTransaction
Information regarding the last transaction a server performed.
-
getLatestNetworkMonitorIncident
A piece of hardware's latest network monitoring incident.
-
getLatestNetworkMonitorIncident
A piece of hardware's latest network monitoring incident.
-
getLatestNetworkMonitorIncident
A piece of hardware's latest network monitoring incident.
-
getLatestNetworkMonitorIncident
A piece of hardware's latest network monitoring incident.
-
getLatestNetworkMonitorIncident
A piece of hardware's latest network monitoring incident.
-
getLocalDiskStorageCapabilityFlag
A flag indicating that a VLAN on the router can be assigned to a host that has local disk functionality.
-
getLocation
Where a piece of hardware is located within SoftLayer's location hierarchy.
-
getLocation
Where a piece of hardware is located within SoftLayer's location hierarchy.
-
getLocation
Where a piece of hardware is located within SoftLayer's location hierarchy.
-
getLocation
Where a piece of hardware is located within SoftLayer's location hierarchy.
-
getLocation
Where a piece of hardware is located within SoftLayer's location hierarchy.
-
getLocationPathString
-
getLocationPathString
-
getLocationPathString
-
getLocationPathString
-
getLocationPathString
-
getLockboxNetworkStorage
Information regarding a lockbox account associated with a server.
-
getLockboxNetworkStorage
Information regarding a lockbox account associated with a server.
-
getLockboxNetworkStorage
Information regarding a lockbox account associated with a server.
-
getLockboxNetworkStorage
Information regarding a lockbox account associated with a server.
-
getLockboxNetworkStorage
Information regarding a lockbox account associated with a server.
-
getLogicalVolumeStorageGroups
Returns a list of logical volumes on the physical machine.
-
getLogicalVolumeStorageGroups
Returns a list of logical volumes on the physical machine.
-
getLogicalVolumeStorageGroups
Returns a list of logical volumes on the physical machine.
-
getManagedResourceFlag
A flag indicating that the hardware is a managed resource.
-
getManagedResourceFlag
A flag indicating that the hardware is a managed resource.
-
getManagedResourceFlag
A flag indicating that the hardware is a managed resource.
-
getManagedResourceFlag
A flag indicating that the hardware is a managed resource.
-
getManagedResourceFlag
A flag indicating that the hardware is a managed resource.
-
getManagementNetworkComponent
Retrieve the remote management network component attached with this server.
-
getManagementNetworkComponent
Retrieve the remote management network component attached with this server.
-
getManagementNetworkComponent
Retrieve the remote management network component attached with this server.
-
getMemory
Information regarding a piece of hardware's memory.
-
getMemory
Information regarding a piece of hardware's memory.
-
getMemory
Information regarding a piece of hardware's memory.
-
getMemory
Information regarding a piece of hardware's memory.
-
getMemory
Information regarding a piece of hardware's memory.
-
getMemoryCapacity
The amount of memory a piece of hardware has, measured in gigabytes.
-
getMemoryCapacity
The amount of memory a piece of hardware has, measured in gigabytes.
-
getMemoryCapacity
The amount of memory a piece of hardware has, measured in gigabytes.
-
getMemoryCapacity
The amount of memory a piece of hardware has, measured in gigabytes.
-
getMemoryCapacity
The amount of memory a piece of hardware has, measured in gigabytes.
-
getMetricTrackingObject
A piece of hardware's metric tracking object.
-
getMetricTrackingObject
[DEPRECATED] - A hardware component models metric tracking object. This object records all periodic polled data available to this hardware componet model.
-
getMetricTrackingObject
A piece of hardware's metric tracking object.
-
getMetricTrackingObject
A piece of hardware's metric tracking object.
-
getMetricTrackingObject
A piece of hardware's metric tracking object.
-
getMetricTrackingObject
A piece of hardware's metric tracking object.
-
getMetricTrackingObjectId
The metric tracking object id for this server.
-
getMetricTrackingObjectId
The metric tracking object id for this server.
-
getMetricTrackingObjectId
The metric tracking object id for this server.
-
getModules
-
getModules
-
getModules
-
getModules
-
getModules
-
getMonitoringRobot
-
getMonitoringRobot
-
getMonitoringRobot
-
getMonitoringRobot
-
getMonitoringRobot
-
getMonitoringServiceComponent
Information regarding a piece of hardware's network monitoring services.
-
getMonitoringServiceComponent
Information regarding a piece of hardware's network monitoring services.
-
getMonitoringServiceComponent
Information regarding a piece of hardware's network monitoring services.
-
getMonitoringServiceComponent
Information regarding a piece of hardware's network monitoring services.
-
getMonitoringServiceComponent
Information regarding a piece of hardware's network monitoring services.
-
getMonitoringServiceEligibilityFlag
-
getMonitoringServiceEligibilityFlag
-
getMonitoringServiceEligibilityFlag
-
getMonitoringServiceEligibilityFlag
-
getMonitoringServiceEligibilityFlag
-
getMonitoringUserNotification
The monitoring notification objects for this hardware. Each object links this hardware instance to a user account that will be notified if monitoring on this hardware object fails
-
getMonitoringUserNotification
The monitoring notification objects for this hardware. Each object links this hardware instance to a user account that will be notified if monitoring on this hardware object fails
-
getMonitoringUserNotification
The monitoring notification objects for this hardware. Each object links this hardware instance to a user account that will be notified if monitoring on this hardware object fails
-
getMotherboard
Information regarding a piece of hardware's motherboard.
-
getMotherboard
Information regarding a piece of hardware's motherboard.
-
getMotherboard
Information regarding a piece of hardware's motherboard.
-
getMotherboard
Information regarding a piece of hardware's motherboard.
-
getMotherboard
Information regarding a piece of hardware's motherboard.
-
getNetworkCards
Information regarding a piece of hardware's network cards.
-
getNetworkCards
Information regarding a piece of hardware's network cards.
-
getNetworkCards
Information regarding a piece of hardware's network cards.
-
getNetworkCards
Information regarding a piece of hardware's network cards.
-
getNetworkCards
Information regarding a piece of hardware's network cards.
-
getNetworkComponentFirewallProtectableIpAddresses
Get the IP addresses associated with this server that are protectable by a network component firewall. Note, this may not return all values for IPv6 subnets for this server. Please use getFirewallProtectableSubnets to get all protectable subnets.
-
getNetworkComponentFirewallProtectableIpAddresses
Get the IP addresses associated with this server that are protectable by a network component firewall. Note, this may not return all values for IPv6 subnets for this server. Please use getFirewallProtectableSubnets to get all protectable subnets.
-
getNetworkComponentFirewallProtectableIpAddresses
Get the IP addresses associated with this server that are protectable by a network component firewall. Note, this may not return all values for IPv6 subnets for this server. Please use getFirewallProtectableSubnets to get all protectable subnets.
-
getNetworkComponents
Returns a hardware's network components.
-
getNetworkComponents
Returns a hardware's network components.
-
getNetworkComponents
Returns a hardware's network components.
-
getNetworkComponents
Returns a hardware's network components.
-
getNetworkComponents
Returns a hardware's network components.
-
getNetworkGatewayMember
The gateway member if this device is part of a network gateway.
-
getNetworkGatewayMember
The gateway member if this device is part of a network gateway.
-
getNetworkGatewayMember
The gateway member if this device is part of a network gateway.
-
getNetworkGatewayMember
The gateway member if this device is part of a network gateway.
-
getNetworkGatewayMember
The gateway member if this device is part of a network gateway.
-
getNetworkGatewayMemberFlag
Whether or not this device is part of a network gateway.
-
getNetworkGatewayMemberFlag
Whether or not this device is part of a network gateway.
-
getNetworkGatewayMemberFlag
Whether or not this device is part of a network gateway.
-
getNetworkGatewayMemberFlag
Whether or not this device is part of a network gateway.
-
getNetworkGatewayMemberFlag
Whether or not this device is part of a network gateway.
-
getNetworkManagementIpAddress
A piece of hardware's network management IP address.
-
getNetworkManagementIpAddress
A piece of hardware's network management IP address.
-
getNetworkManagementIpAddress
A piece of hardware's network management IP address.
-
getNetworkManagementIpAddress
A piece of hardware's network management IP address.
-
getNetworkManagementIpAddress
A piece of hardware's network management IP address.
-
getNetworkMonitorAttachedDownHardware
All servers with failed monitoring that are attached downstream to a piece of hardware.
-
getNetworkMonitorAttachedDownHardware
All servers with failed monitoring that are attached downstream to a piece of hardware.
-
getNetworkMonitorAttachedDownHardware
All servers with failed monitoring that are attached downstream to a piece of hardware.
-
getNetworkMonitorAttachedDownHardware
All servers with failed monitoring that are attached downstream to a piece of hardware.
-
getNetworkMonitorAttachedDownHardware
All servers with failed monitoring that are attached downstream to a piece of hardware.
-
getNetworkMonitorAttachedDownVirtualGuests
Virtual guests that are attached downstream to a hardware that have failed monitoring
-
getNetworkMonitorAttachedDownVirtualGuests
Virtual guests that are attached downstream to a hardware that have failed monitoring
-
getNetworkMonitorAttachedDownVirtualGuests
Virtual guests that are attached downstream to a hardware that have failed monitoring
-
getNetworkMonitorAttachedDownVirtualGuests
Virtual guests that are attached downstream to a hardware that have failed monitoring
-
getNetworkMonitorAttachedDownVirtualGuests
Virtual guests that are attached downstream to a hardware that have failed monitoring
-
getNetworkMonitorIncidents
The status of all of a piece of hardware's network monitoring incidents.
-
getNetworkMonitorIncidents
The status of all of a piece of hardware's network monitoring incidents.
-
getNetworkMonitorIncidents
The status of all of a piece of hardware's network monitoring incidents.
-
getNetworkMonitorIncidents
The status of all of a piece of hardware's network monitoring incidents.
-
getNetworkMonitorIncidents
The status of all of a piece of hardware's network monitoring incidents.
-
getNetworkMonitors
Information regarding a piece of hardware's network monitors.
-
getNetworkMonitors
Information regarding a piece of hardware's network monitors.
-
getNetworkMonitors
Information regarding a piece of hardware's network monitors.
-
getNetworkMonitors
Information regarding a piece of hardware's network monitors.
-
getNetworkMonitors
Information regarding a piece of hardware's network monitors.
-
getNetworkStatus
The value of a hardware's network status attribute. [DEPRECATED]
-
getNetworkStatus
The value of a hardware's network status attribute. [DEPRECATED]
-
getNetworkStatus
The value of a hardware's network status attribute. [DEPRECATED]
-
getNetworkStatus
The value of a hardware's network status attribute. [DEPRECATED]
-
getNetworkStatus
The value of a hardware's network status attribute. [DEPRECATED]
-
getNetworkStatusAttribute
The hardware's related network status attribute. [DEPRECATED]
-
getNetworkStatusAttribute
The hardware's related network status attribute. [DEPRECATED]
-
getNetworkStatusAttribute
The hardware's related network status attribute. [DEPRECATED]
-
getNetworkStatusAttribute
The hardware's related network status attribute. [DEPRECATED]
-
getNetworkStatusAttribute
The hardware's related network status attribute. [DEPRECATED]
-
getNetworkStorage
Information regarding a piece of hardware's associated network storage service account.
-
getNetworkStorage
Information regarding a piece of hardware's associated network storage service account.
-
getNetworkStorage
Information regarding a piece of hardware's associated network storage service account.
-
getNetworkStorage
Information regarding a piece of hardware's associated network storage service account.
-
getNetworkStorage
Information regarding a piece of hardware's associated network storage service account.
-
getNetworkVlans
The network virtual LANs (VLANs) associated with a piece of hardware's network components.
-
getNetworkVlans
The network virtual LANs (VLANs) associated with a piece of hardware's network components.
-
getNetworkVlans
The network virtual LANs (VLANs) associated with a piece of hardware's network components.
-
getNetworkVlans
The network virtual LANs (VLANs) associated with a piece of hardware's network components.
-
getNetworkVlans
The network virtual LANs (VLANs) associated with a piece of hardware's network components.
-
getNextBillingCycleBandwidthAllocation
A hardware's allotted bandwidth for the next billing cycle (measured in GB).
-
getNextBillingCycleBandwidthAllocation
A hardware's allotted bandwidth for the next billing cycle (measured in GB).
-
getNextBillingCycleBandwidthAllocation
A hardware's allotted bandwidth for the next billing cycle (measured in GB).
-
getNextBillingCycleBandwidthAllocation
A hardware's allotted bandwidth for the next billing cycle (measured in GB).
-
getNextBillingCycleBandwidthAllocation
A hardware's allotted bandwidth for the next billing cycle (measured in GB).
-
getNotesHistory
-
getNotesHistory
-
getNotesHistory
-
getNotesHistory
-
getNotesHistory
-
getNvRamCapacity
The amount of non-volatile memory a piece of hardware has, measured in gigabytes.
-
getNvRamCapacity
The amount of non-volatile memory a piece of hardware has, measured in gigabytes.
-
getNvRamCapacity
The amount of non-volatile memory a piece of hardware has, measured in gigabytes.
-
getNvRamCapacity
The amount of non-volatile memory a piece of hardware has, measured in gigabytes.
-
getNvRamCapacity
The amount of non-volatile memory a piece of hardware has, measured in gigabytes.
-
getNvRamComponentModels
-
getNvRamComponentModels
-
getNvRamComponentModels
-
getNvRamComponentModels
-
getNvRamComponentModels
-
getObject
getObject retrieves the SoftLayer_Hardware object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Hardware service. You can only retrieve the account that your portal user is assigned to.
-
getObject
getObject retrieves the SoftLayer_Hardware_Benchmark_Certification object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Hardware_Benchmark_Certification service.
-
getObject
Retrieve a SoftLayer_Hardware_Blade record.
-
getObject
getObject retrieves the SoftLayer_Hardware_Component_Model object.
-
getObject
getObject retrieves the SoftLayer_Hardware_Component_Partition_OperatingSystem object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Hardware_Component_Partition_OperatingSystem service.s
-
getObject
getObject retrieves the SoftLayer_Hardware_Component_Partition_Template object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Hardware_Component_Partition_Template service. You can only retrieve the partition templates that your account created or the templates predefined by SoftLayer.
-
getObject
Retrieve a SoftLayer_Hardware_Router record.
-
getObject
Retrieve a SoftLayer_Hardware_SecurityModule record.
-
getObject
Retrieve a SoftLayer_Hardware_SecurityModule750 record.
-
getObject
getObject retrieves the SoftLayer_Hardware_Server object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Hardware service. You can only retrieve servers from the account that your portal user is assigned to.
-
getOpenCancellationTicket
An open ticket requesting cancellation of this server, if one exists.
-
getOpenCancellationTicket
An open ticket requesting cancellation of this server, if one exists.
-
getOpenCancellationTicket
An open ticket requesting cancellation of this server, if one exists.
-
getOperatingSystem
Information regarding a piece of hardware's operating system.
-
getOperatingSystem
Information regarding a piece of hardware's operating system.
-
getOperatingSystem
Information regarding a piece of hardware's operating system.
-
getOperatingSystem
Information regarding a piece of hardware's operating system.
-
getOperatingSystem
Information regarding a piece of hardware's operating system.
-
getOperatingSystemReferenceCode
A hardware's operating system software description.
-
getOperatingSystemReferenceCode
A hardware's operating system software description.
-
getOperatingSystemReferenceCode
A hardware's operating system software description.
-
getOperatingSystemReferenceCode
A hardware's operating system software description.
-
getOperatingSystemReferenceCode
A hardware's operating system software description.
-
getOutboundBandwidthUsage
The sum of all the outbound network traffic data for the last 30 days.
-
getOutboundBandwidthUsage
The sum of all the outbound network traffic data for the last 30 days.
-
getOutboundBandwidthUsage
The sum of all the outbound network traffic data for the last 30 days.
-
getOutboundBandwidthUsage
The sum of all the outbound network traffic data for the last 30 days.
-
getOutboundBandwidthUsage
The sum of all the outbound network traffic data for the last 30 days.
-
getOutboundPrivateBandwidthUsage
The total private outbound bandwidth for this hardware for the current billing cycle.
-
getOutboundPrivateBandwidthUsage
The total private outbound bandwidth for this hardware for the current billing cycle.
-
getOutboundPrivateBandwidthUsage
The total private outbound bandwidth for this hardware for the current billing cycle.
-
getOutboundPublicBandwidthUsage
The total public outbound bandwidth for this hardware for the current billing cycle.
-
getOutboundPublicBandwidthUsage
The total public outbound bandwidth for this hardware for the current billing cycle.
-
getOutboundPublicBandwidthUsage
The total public outbound bandwidth for this hardware for the current billing cycle.
-
getOutboundPublicBandwidthUsage
The total public outbound bandwidth for this hardware for the current billing cycle.
-
getOutboundPublicBandwidthUsage
The total public outbound bandwidth for this hardware for the current billing cycle.
-
getOverBandwidthAllocationFlag
Whether the bandwidth usage for this hardware for the current billing cycle exceeds the allocation.
-
getOverBandwidthAllocationFlag
Whether the bandwidth usage for this hardware for the current billing cycle exceeds the allocation.
-
getOverBandwidthAllocationFlag
Whether the bandwidth usage for this hardware for the current billing cycle exceeds the allocation.
-
getPackageItemsAvailability
Retrieve availability of specified product package's GPUs and drives
-
getParentBay
Blade Bay
-
getParentBay
Blade Bay
-
getParentBay
Blade Bay
-
getParentBay
Blade Bay
-
getParentBay
Blade Bay
-
getParentHardware
Parent Hardware.
-
getParentHardware
Parent Hardware.
-
getParentHardware
Parent Hardware.
-
getParentHardware
Parent Hardware.
-
getParentHardware
Parent Hardware.
-
getPartitionOperatingSystem
A partition template's associated [SoftLayer_Hardware_Component_Partition_OperatingSystem](/reference/datatypes/SoftLayer_Hardware_Component_Partition_OperatingSystem).
-
getPartitions
-
getPartitions
-
getPartitions
-
getPartitionTemplatePartition
An individual partition for a partition template.
-
getPartitionTemplates
Information regarding an operating system's [SoftLayer_Hardware_Component_Partition_Template](/reference/datatypes/SoftLayer_Hardware_Component_Partition_Template).
-
getPMInfo
Retrieve a server's hardware state via its internal sensors. Remote sensor data is transmitted to the SoftLayer API by way of the server's remote management card. Sensor data measures system temperatures, voltages, and other local server settings. Sensor data is cached for 30 seconds. Calls made to getSensorData for the same server within 30 seconds of each other will return the same data. Subsequent calls will return new data once the cache expires.
-
getPMInfo
Retrieve a server's hardware state via its internal sensors. Remote sensor data is transmitted to the SoftLayer API by way of the server's remote management card. Sensor data measures system temperatures, voltages, and other local server settings. Sensor data is cached for 30 seconds. Calls made to getSensorData for the same server within 30 seconds of each other will return the same data. Subsequent calls will return new data once the cache expires.
-
getPMInfo
Retrieve a server's hardware state via its internal sensors. Remote sensor data is transmitted to the SoftLayer API by way of the server's remote management card. Sensor data measures system temperatures, voltages, and other local server settings. Sensor data is cached for 30 seconds. Calls made to getSensorData for the same server within 30 seconds of each other will return the same data. Subsequent calls will return new data once the cache expires.
-
getPointOfPresenceLocation
Information regarding the Point of Presence (PoP) location in which a piece of hardware resides.
-
getPointOfPresenceLocation
Information regarding the Point of Presence (PoP) location in which a piece of hardware resides.
-
getPointOfPresenceLocation
Information regarding the Point of Presence (PoP) location in which a piece of hardware resides.
-
getPointOfPresenceLocation
Information regarding the Point of Presence (PoP) location in which a piece of hardware resides.
-
getPointOfPresenceLocation
Information regarding the Point of Presence (PoP) location in which a piece of hardware resides.
-
getPowerComponents
The power components for a hardware object.
-
getPowerComponents
The power components for a hardware object.
-
getPowerComponents
The power components for a hardware object.
-
getPowerComponents
The power components for a hardware object.
-
getPowerComponents
The power components for a hardware object.
-
getPowerSupply
Information regarding a piece of hardware's power supply.
-
getPowerSupply
Information regarding a piece of hardware's power supply.
-
getPowerSupply
Information regarding a piece of hardware's power supply.
-
getPowerSupply
Information regarding a piece of hardware's power supply.
-
getPowerSupply
Information regarding a piece of hardware's power supply.
-
getPrimaryBackendIpAddress
The hardware's primary private IP address.
-
getPrimaryBackendIpAddress
The hardware's primary private IP address.
-
getPrimaryBackendIpAddress
The hardware's primary private IP address.
-
getPrimaryBackendIpAddress
The hardware's primary private IP address.
-
getPrimaryBackendIpAddress
The hardware's primary private IP address.
-
getPrimaryBackendNetworkComponent
Information regarding the hardware's primary back-end network component.
-
getPrimaryBackendNetworkComponent
Information regarding the hardware's primary back-end network component.
-
getPrimaryBackendNetworkComponent
Information regarding the hardware's primary back-end network component.
-
getPrimaryBackendNetworkComponent
Information regarding the hardware's primary back-end network component.
-
getPrimaryBackendNetworkComponent
Information regarding the hardware's primary back-end network component.
-
getPrimaryDriveSize
-
getPrimaryDriveSize
-
getPrimaryDriveSize
-
getPrimaryIpAddress
The hardware's primary public IP address.
-
getPrimaryIpAddress
The hardware's primary public IP address.
-
getPrimaryIpAddress
The hardware's primary public IP address.
-
getPrimaryIpAddress
The hardware's primary public IP address.
-
getPrimaryIpAddress
The hardware's primary public IP address.
-
getPrimaryNetworkComponent
Information regarding the hardware's primary public network component.
-
getPrimaryNetworkComponent
Information regarding the hardware's primary public network component.
-
getPrimaryNetworkComponent
Information regarding the hardware's primary public network component.
-
getPrimaryNetworkComponent
Information regarding the hardware's primary public network component.
-
getPrimaryNetworkComponent
Information regarding the hardware's primary public network component.
-
getPrivateBackendNetworkComponents
A collection of backendNetwork components
-
getPrivateBackendNetworkComponents
A collection of backendNetwork components
-
getPrivateBackendNetworkComponents
A collection of backendNetwork components
-
getPrivateBandwidthData
Retrieve a graph of a server's private network bandwidth usage over the specified timeframe. If no timeframe is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPrivateBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels.
-
getPrivateBandwidthData
Retrieve a graph of a server's private network bandwidth usage over the specified timeframe. If no timeframe is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPrivateBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels.
-
getPrivateBandwidthData
Retrieve a graph of a server's private network bandwidth usage over the specified timeframe. If no timeframe is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPrivateBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels.
-
getPrivateBandwidthData
Retrieve a graph of a server's private network bandwidth usage over the specified timeframe. If no timeframe is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPrivateBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels.
-
getPrivateBandwidthData
Retrieve a graph of a server's private network bandwidth usage over the specified timeframe. If no timeframe is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPrivateBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels.
-
getPrivateBandwidthDataSummary
Retrieve a brief summary of a server's private network bandwidth usage. getPrivateBandwidthDataSummary retrieves a server's bandwidth allocation for its billing period, its estimated usage during its billing period, and an estimation of how much bandwidth it will use during its billing period based on its current usage. A server's projected bandwidth usage increases in accuracy as it progresses through its billing period.
-
getPrivateBandwidthDataSummary
Retrieve a brief summary of a server's private network bandwidth usage. getPrivateBandwidthDataSummary retrieves a server's bandwidth allocation for its billing period, its estimated usage during its billing period, and an estimation of how much bandwidth it will use during its billing period based on its current usage. A server's projected bandwidth usage increases in accuracy as it progresses through its billing period.
-
getPrivateBandwidthDataSummary
Retrieve a brief summary of a server's private network bandwidth usage. getPrivateBandwidthDataSummary retrieves a server's bandwidth allocation for its billing period, its estimated usage during its billing period, and an estimation of how much bandwidth it will use during its billing period based on its current usage. A server's projected bandwidth usage increases in accuracy as it progresses through its billing period.
-
getPrivateBandwidthGraphImage
Retrieve a graph of a server's private network bandwidth usage over the specified time frame. If no time frame is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image
-
getPrivateBandwidthGraphImage
Retrieve a graph of a server's private network bandwidth usage over the specified time frame. If no time frame is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image
-
getPrivateBandwidthGraphImage
Retrieve a graph of a server's private network bandwidth usage over the specified time frame. If no time frame is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image
-
getPrivateIpAddress
A server's primary private IP address.
-
getPrivateIpAddress
A server's primary private IP address.
-
getPrivateIpAddress
A server's primary private IP address.
-
getPrivateNetworkComponent
Retrieve the private network component attached with this server.
-
getPrivateNetworkComponent
Retrieve the private network component attached with this server.
-
getPrivateNetworkComponent
Retrieve the private network component attached with this server.
-
getPrivateNetworkOnlyFlag
Whether the hardware only has access to the private network.
-
getPrivateNetworkOnlyFlag
Whether the hardware only has access to the private network.
-
getPrivateNetworkOnlyFlag
Whether the hardware only has access to the private network.
-
getPrivateNetworkOnlyFlag
Whether the hardware only has access to the private network.
-
getPrivateNetworkOnlyFlag
Whether the hardware only has access to the private network.
-
getPrivateVlan
Retrieve the backend VLAN for the primary IP address of the server
-
getPrivateVlan
Retrieve the backend VLAN for the primary IP address of the server
-
getPrivateVlan
Retrieve the backend VLAN for the primary IP address of the server
-
getPrivateVlanByIpAddress
*** DEPRECATED *** Retrieve a backend network VLAN by searching for an IP address
-
getPrivateVlanByIpAddress
*** DEPRECATED *** Retrieve a backend network VLAN by searching for an IP address
-
getPrivateVlanByIpAddress
*** DEPRECATED *** Retrieve a backend network VLAN by searching for an IP address
-
getProcessorCoreAmount
The total number of processor cores, summed from all processors that are attached to a piece of hardware
-
getProcessorCoreAmount
The total number of processor cores, summed from all processors that are attached to a piece of hardware
-
getProcessorCoreAmount
The total number of processor cores, summed from all processors that are attached to a piece of hardware
-
getProcessorCoreAmount
The total number of processor cores, summed from all processors that are attached to a piece of hardware
-
getProcessorCoreAmount
The total number of processor cores, summed from all processors that are attached to a piece of hardware
-
getProcessorPhysicalCoreAmount
The total number of physical processor cores, summed from all processors that are attached to a piece of hardware
-
getProcessorPhysicalCoreAmount
The total number of physical processor cores, summed from all processors that are attached to a piece of hardware
-
getProcessorPhysicalCoreAmount
The total number of physical processor cores, summed from all processors that are attached to a piece of hardware
-
getProcessorPhysicalCoreAmount
The total number of physical processor cores, summed from all processors that are attached to a piece of hardware
-
getProcessorPhysicalCoreAmount
The total number of physical processor cores, summed from all processors that are attached to a piece of hardware
-
getProcessors
Information regarding a piece of hardware's processors.
-
getProcessors
Information regarding a piece of hardware's processors.
-
getProcessors
Information regarding a piece of hardware's processors.
-
getProcessors
Information regarding a piece of hardware's processors.
-
getProcessors
Information regarding a piece of hardware's processors.
-
getProjectedOverBandwidthAllocationFlag
Whether the bandwidth usage for this hardware for the current billing cycle is projected to exceed the allocation.
-
getProjectedOverBandwidthAllocationFlag
Whether the bandwidth usage for this hardware for the current billing cycle is projected to exceed the allocation.
-
getProjectedOverBandwidthAllocationFlag
Whether the bandwidth usage for this hardware for the current billing cycle is projected to exceed the allocation.
-
getProjectedPublicBandwidthUsage
The projected public outbound bandwidth for this hardware for the current billing cycle.
-
getProjectedPublicBandwidthUsage
The projected public outbound bandwidth for this hardware for the current billing cycle.
-
getProjectedPublicBandwidthUsage
The projected public outbound bandwidth for this hardware for the current billing cycle.
-
getProvisionDate
-
getProvisionDate
-
getProvisionDate
-
getPublicBandwidthData
Retrieve a graph of a server's public network bandwidth usage over the specified timeframe. If no timeframe is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels.
-
getPublicBandwidthData
Retrieve a graph of a server's public network bandwidth usage over the specified timeframe. If no timeframe is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels.
-
getPublicBandwidthData
Retrieve a graph of a server's public network bandwidth usage over the specified timeframe. If no timeframe is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels.
-
getPublicBandwidthData
Retrieve a graph of a server's public network bandwidth usage over the specified timeframe. If no timeframe is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels.
-
getPublicBandwidthData
Retrieve a graph of a server's public network bandwidth usage over the specified timeframe. If no timeframe is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels.
-
getPublicBandwidthDataSummary
Retrieve a brief summary of a server's public network bandwidth usage. getPublicBandwidthDataSummary retrieves a server's bandwidth allocation for its billing period, its estimated usage during its billing period, and an estimation of how much bandwidth it will use during its billing period based on its current usage. A server's projected bandwidth usage increases in accuracy as it progresses through its billing period.
-
getPublicBandwidthDataSummary
Retrieve a brief summary of a server's public network bandwidth usage. getPublicBandwidthDataSummary retrieves a server's bandwidth allocation for its billing period, its estimated usage during its billing period, and an estimation of how much bandwidth it will use during its billing period based on its current usage. A server's projected bandwidth usage increases in accuracy as it progresses through its billing period.
-
getPublicBandwidthDataSummary
Retrieve a brief summary of a server's public network bandwidth usage. getPublicBandwidthDataSummary retrieves a server's bandwidth allocation for its billing period, its estimated usage during its billing period, and an estimation of how much bandwidth it will use during its billing period based on its current usage. A server's projected bandwidth usage increases in accuracy as it progresses through its billing period.
-
getPublicBandwidthGraphImage
Retrieve a graph of a server's public network bandwidth usage over the specified time frame. If no time frame is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels. THIS METHOD GENERATES GRAPHS BASED ON THE NEW DATA WAREHOUSE REPOSITORY.
-
getPublicBandwidthGraphImage
Retrieve a graph of a server's public network bandwidth usage over the specified time frame. If no time frame is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels. THIS METHOD GENERATES GRAPHS BASED ON THE NEW DATA WAREHOUSE REPOSITORY.
-
getPublicBandwidthGraphImage
Retrieve a graph of a server's public network bandwidth usage over the specified time frame. If no time frame is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels. THIS METHOD GENERATES GRAPHS BASED ON THE NEW DATA WAREHOUSE REPOSITORY.
-
getPublicBandwidthTotal
Retrieve the total number of bytes used by a server over a specified time period via the data warehouse tracking objects for this hardware.
-
getPublicBandwidthTotal
Retrieve the total number of bytes used by a server over a specified time period via the data warehouse tracking objects for this hardware.
-
getPublicBandwidthTotal
Retrieve the total number of bytes used by a server over a specified time period via the data warehouse tracking objects for this hardware.
-
getPublicNetworkComponent
Retrieve a SoftLayer server's public network component. Some servers are only connected to the private network and may not have a public network component. In that case getPublicNetworkComponent returns a null object.
-
getPublicNetworkComponent
Retrieve a SoftLayer server's public network component. Some servers are only connected to the private network and may not have a public network component. In that case getPublicNetworkComponent returns a null object.
-
getPublicNetworkComponent
Retrieve a SoftLayer server's public network component. Some servers are only connected to the private network and may not have a public network component. In that case getPublicNetworkComponent returns a null object.
-
getPublicVlan
Retrieve the frontend VLAN for the primary IP address of the server
-
getPublicVlan
Retrieve the frontend VLAN for the primary IP address of the server
-
getPublicVlan
Retrieve the frontend VLAN for the primary IP address of the server
-
getPublicVlanByHostname
Retrieve the frontend network Vlan by searching the hostname of a server
-
getPublicVlanByHostname
Retrieve the frontend network Vlan by searching the hostname of a server
-
getPublicVlanByHostname
Retrieve the frontend network Vlan by searching the hostname of a server
-
getQualifiedFirmwares
-
getRack
-
getRack
-
getRack
-
getRack
-
getRack
-
getRaidControllers
The RAID controllers contained within a piece of hardware.
-
getRaidControllers
The RAID controllers contained within a piece of hardware.
-
getRaidControllers
The RAID controllers contained within a piece of hardware.
-
getRaidControllers
The RAID controllers contained within a piece of hardware.
-
getRaidControllers
The RAID controllers contained within a piece of hardware.
-
getReadyNodeFlag
Determine if hardware object is vSan Ready Node.
-
getReadyNodeFlag
Determine if hardware object is vSan Ready Node.
-
getReadyNodeFlag
Determine if hardware object is vSan Ready Node.
-
getRebootTime
A motherboard's average reboot time.
-
getRecentEvents
Recent events that impact this hardware.
-
getRecentEvents
Recent events that impact this hardware.
-
getRecentEvents
Recent events that impact this hardware.
-
getRecentEvents
Recent events that impact this hardware.
-
getRecentEvents
Recent events that impact this hardware.
-
getRecentRemoteManagementCommands
The last five commands issued to the server's remote management card.
-
getRecentRemoteManagementCommands
The last five commands issued to the server's remote management card.
-
getRecentRemoteManagementCommands
The last five commands issued to the server's remote management card.
-
getRedfishPowerState
Retrieves the power state for the server. The server's power status is retrieved from its remote management card. This will return 'on' or 'off'.
-
getRedfishPowerState
Retrieves the power state for the server. The server's power status is retrieved from its remote management card. This will return 'on' or 'off'.
-
getRedfishPowerState
Retrieves the power state for the server. The server's power status is retrieved from its remote management card. This will return 'on' or 'off'.
-
getRegionalInternetRegistry
-
getRegionalInternetRegistry
-
getRegionalInternetRegistry
-
getRemoteManagement
A server's remote management card.
-
getRemoteManagement
A server's remote management card.
-
getRemoteManagement
A server's remote management card.
-
getRemoteManagementAccounts
User credentials to issue commands and/or interact with the server's remote management card.
-
getRemoteManagementAccounts
User credentials to issue commands and/or interact with the server's remote management card.
-
getRemoteManagementAccounts
User credentials to issue commands and/or interact with the server's remote management card.
-
getRemoteManagementAccounts
User credentials to issue commands and/or interact with the server's remote management card.
-
getRemoteManagementAccounts
User credentials to issue commands and/or interact with the server's remote management card.
-
getRemoteManagementComponent
A hardware's associated remote management component. This is normally IPMI.
-
getRemoteManagementComponent
A hardware's associated remote management component. This is normally IPMI.
-
getRemoteManagementComponent
A hardware's associated remote management component. This is normally IPMI.
-
getRemoteManagementComponent
A hardware's associated remote management component. This is normally IPMI.
-
getRemoteManagementComponent
A hardware's associated remote management component. This is normally IPMI.
-
getRemoteManagementUsers
User(s) who have access to issue commands and/or interact with the server's remote management card.
-
getRemoteManagementUsers
User(s) who have access to issue commands and/or interact with the server's remote management card.
-
getRemoteManagementUsers
User(s) who have access to issue commands and/or interact with the server's remote management card.
-
getResourceConfigurations
-
getResourceConfigurations
-
getResourceConfigurations
-
getResourceConfigurations
-
getResourceConfigurations
-
getResourceGroupMemberReferences
-
getResourceGroupMemberReferences
-
getResourceGroupMemberReferences
-
getResourceGroupMemberReferences
-
getResourceGroupMemberReferences
-
getResourceGroupRoles
-
getResourceGroupRoles
-
getResourceGroupRoles
-
getResourceGroupRoles
-
getResourceGroupRoles
-
getResourceGroups
The resource groups in which this hardware is a member.
-
getResourceGroups
The resource groups in which this hardware is a member.
-
getResourceGroups
The resource groups in which this hardware is a member.
-
getResourceGroups
The resource groups in which this hardware is a member.
-
getResourceGroups
The resource groups in which this hardware is a member.
-
getResultFile
Attempt to retrieve the file associated with a benchmark certification result, if such a file exists. If there is no file for this benchmark certification result, calling this method throws an exception. The 'getResultFile' method attempts to retrieve the file associated with a benchmark certification result, if such a file exists. If no file exists for the benchmark certification, an exception is thrown.
-
getReverseDomainRecords
Retrieve the reverse domain records associated with this server.
-
getReverseDomainRecords
Retrieve the reverse domain records associated with this server.
-
getReverseDomainRecords
Retrieve the reverse domain records associated with this server.
-
getRouters
A hardware's routers.
-
getRouters
A hardware's routers.
-
getRouters
A hardware's routers.
-
getRouters
A hardware's routers.
-
getRouters
A hardware's routers.
-
getSanStorageCapabilityFlag
A flag indicating that a VLAN on the router can be assigned to a host that has SAN disk functionality.
-
getSecurityScanRequests
Information regarding a piece of hardware's vulnerability scan requests.
-
getSecurityScanRequests
Information regarding a piece of hardware's vulnerability scan requests.
-
getSecurityScanRequests
Information regarding a piece of hardware's vulnerability scan requests.
-
getSecurityScanRequests
Information regarding a piece of hardware's vulnerability scan requests.
-
getSecurityScanRequests
Information regarding a piece of hardware's vulnerability scan requests.
-
getSensorData
The '''getSensorData''' method retrieves a server's hardware state via its internal sensors. Remote sensor data is transmitted to the SoftLayer API by way of the server's remote management card. Sensor data measures various information, including system temperatures, voltages and other local server settings. Sensor data is cached for 30 second; calls made to this method for the same server within 30 seconds of each other will result in the same data being returned. To ensure that the data retrieved retrieves snapshot of varied data, make calls greater than 30 seconds apart.
-
getSensorData
The '''getSensorData''' method retrieves a server's hardware state via its internal sensors. Remote sensor data is transmitted to the SoftLayer API by way of the server's remote management card. Sensor data measures various information, including system temperatures, voltages and other local server settings. Sensor data is cached for 30 second; calls made to this method for the same server within 30 seconds of each other will result in the same data being returned. To ensure that the data retrieved retrieves snapshot of varied data, make calls greater than 30 seconds apart.
-
getSensorData
Retrieve a server's hardware state via its internal sensors. Remote sensor data is transmitted to the SoftLayer API by way of the server's remote management card. Sensor data measures system temperatures, voltages, and other local server settings. Sensor data is cached for 30 seconds. Calls made to getSensorData for the same server within 30 seconds of each other will return the same data. Subsequent calls will return new data once the cache expires.
-
getSensorData
Retrieve a server's hardware state via its internal sensors. Remote sensor data is transmitted to the SoftLayer API by way of the server's remote management card. Sensor data measures system temperatures, voltages, and other local server settings. Sensor data is cached for 30 seconds. Calls made to getSensorData for the same server within 30 seconds of each other will return the same data. Subsequent calls will return new data once the cache expires.
-
getSensorData
Retrieve a server's hardware state via its internal sensors. Remote sensor data is transmitted to the SoftLayer API by way of the server's remote management card. Sensor data measures system temperatures, voltages, and other local server settings. Sensor data is cached for 30 seconds. Calls made to getSensorData for the same server within 30 seconds of each other will return the same data. Subsequent calls will return new data once the cache expires.
-
getSensorDataWithGraphs
The '''getSensorDataWithGraphs''' method retrieves the raw data returned from the server's remote management card. Along with raw data, graphs for the CPU and system temperatures and fan speeds are also returned. For more details on what information is returned, refer to the ''getSensorData'' method.
-
getSensorDataWithGraphs
The '''getSensorDataWithGraphs''' method retrieves the raw data returned from the server's remote management card. Along with raw data, graphs for the CPU and system temperatures and fan speeds are also returned. For more details on what information is returned, refer to the ''getSensorData'' method.
-
getSensorDataWithGraphs
Retrieves the raw data returned from the server's remote management card. For more details of what is returned please refer to the getSensorData method. Along with the raw data, graphs for the cpu and system temperatures and fan speeds are also returned.
-
getSensorDataWithGraphs
Retrieves the raw data returned from the server's remote management card. For more details of what is returned please refer to the getSensorData method. Along with the raw data, graphs for the cpu and system temperatures and fan speeds are also returned.
-
getSensorDataWithGraphs
Retrieves the raw data returned from the server's remote management card. For more details of what is returned please refer to the getSensorData method. Along with the raw data, graphs for the cpu and system temperatures and fan speeds are also returned.
-
getServerDetails
Retrieve a server's hardware components, software, and network components. getServerDetails is an aggregation function that combines the results of [SoftLayer_Hardware_Server::getComponents](/reference/datatypes/$1/#$2), [SoftLayer_Hardware_Server::getSoftware](/reference/datatypes/$1/#$2), and [SoftLayer_Hardware_Server::getNetworkComponents](/reference/datatypes/$1/#$2) in a single container.
-
getServerDetails
Retrieve a server's hardware components, software, and network components. getServerDetails is an aggregation function that combines the results of [SoftLayer_Hardware_Server::getComponents](/reference/datatypes/$1/#$2), [SoftLayer_Hardware_Server::getSoftware](/reference/datatypes/$1/#$2), and [SoftLayer_Hardware_Server::getNetworkComponents](/reference/datatypes/$1/#$2) in a single container.
-
getServerDetails
Retrieve a server's hardware components, software, and network components. getServerDetails is an aggregation function that combines the results of [SoftLayer_Hardware_Server::getComponents](/reference/datatypes/$1/#$2), [SoftLayer_Hardware_Server::getSoftware](/reference/datatypes/$1/#$2), and [SoftLayer_Hardware_Server::getNetworkComponents](/reference/datatypes/$1/#$2) in a single container.
-
getServerFanSpeedGraphs
The '''getServerFanSpeedGraphs''' method retrieves the server's fan speeds and displays the speeds using tachometer graphs. data used to construct these graphs is retrieved from the server's remote management card. Each graph returned will have an associated title.
-
getServerFanSpeedGraphs
The '''getServerFanSpeedGraphs''' method retrieves the server's fan speeds and displays the speeds using tachometer graphs. data used to construct these graphs is retrieved from the server's remote management card. Each graph returned will have an associated title.
-
getServerFanSpeedGraphs
Retrieve the server's fan speeds and displays them using tachometer graphs. Data used to construct graphs is retrieved from the server's remote management card. All graphs returned will have a title associated with it.
-
getServerFanSpeedGraphs
Retrieve the server's fan speeds and displays them using tachometer graphs. Data used to construct graphs is retrieved from the server's remote management card. All graphs returned will have a title associated with it.
-
getServerFanSpeedGraphs
Retrieve the server's fan speeds and displays them using tachometer graphs. Data used to construct graphs is retrieved from the server's remote management card. All graphs returned will have a title associated with it.
-
getServerPackageAvailability
An API to retrieve server package availability at data centers
-
getServerPowerState
The '''getPowerState''' method retrieves the power state for the selected server. The server's power status is retrieved from its remote management card. This method returns 'on', for a server that has been powered on, or 'off' for servers powered off.
-
getServerPowerState
The '''getPowerState''' method retrieves the power state for the selected server. The server's power status is retrieved from its remote management card. This method returns 'on', for a server that has been powered on, or 'off' for servers powered off.
-
getServerPowerState
Retrieves the power state for the server. The server's power status is retrieved from its remote management card. This will return 'on' or 'off'.
-
getServerPowerState
Retrieves the power state for the server. The server's power status is retrieved from its remote management card. This will return 'on' or 'off'.
-
getServerPowerState
Retrieves the power state for the server. The server's power status is retrieved from its remote management card. This will return 'on' or 'off'.
-
getServerRoom
Information regarding the server room in which the hardware is located.
-
getServerRoom
Information regarding the server room in which the hardware is located.
-
getServerRoom
Information regarding the server room in which the hardware is located.
-
getServerRoom
Information regarding the server room in which the hardware is located.
-
getServerRoom
Information regarding the server room in which the hardware is located.
-
getServerTemperatureGraphs
The '''getServerTemperatureGraphs''' retrieves the server's temperatures and displays the various temperatures using thermometer graphs. Temperatures retrieved are CPU temperature(s) and system temperatures. Data used to construct the graphs is retrieved from the server's remote management card. All graphs returned will have an associated title.
-
getServerTemperatureGraphs
The '''getServerTemperatureGraphs''' retrieves the server's temperatures and displays the various temperatures using thermometer graphs. Temperatures retrieved are CPU temperature(s) and system temperatures. Data used to construct the graphs is retrieved from the server's remote management card. All graphs returned will have an associated title.
-
getServerTemperatureGraphs
Retrieve the server's temperature and displays them using thermometer graphs. Temperatures retrieved are CPU(s) and system temperatures. Data used to construct graphs is retrieved from the server's remote management card. All graphs returned will have a title associated with it.
-
getServerTemperatureGraphs
Retrieve the server's temperature and displays them using thermometer graphs. Temperatures retrieved are CPU(s) and system temperatures. Data used to construct graphs is retrieved from the server's remote management card. All graphs returned will have a title associated with it.
-
getServerTemperatureGraphs
Retrieve the server's temperature and displays them using thermometer graphs. Temperatures retrieved are CPU(s) and system temperatures. Data used to construct graphs is retrieved from the server's remote management card. All graphs returned will have a title associated with it.
-
getServiceProvider
Information regarding the piece of hardware's service provider.
-
getServiceProvider
Information regarding the piece of hardware's service provider.
-
getServiceProvider
Information regarding the piece of hardware's service provider.
-
getServiceProvider
Information regarding the piece of hardware's service provider.
-
getServiceProvider
Information regarding the piece of hardware's service provider.
-
getSoftwareComponents
Information regarding a piece of hardware's installed software.
-
getSoftwareComponents
Information regarding a piece of hardware's installed software.
-
getSoftwareComponents
Information regarding a piece of hardware's installed software.
-
getSoftwareComponents
Information regarding a piece of hardware's installed software.
-
getSoftwareComponents
Information regarding a piece of hardware's installed software.
-
getSoftwareGuardExtensionEnabled
Determine if hardware object has Software Guard Extension (SGX) enabled.
-
getSoftwareGuardExtensionEnabled
Determine if hardware object has Software Guard Extension (SGX) enabled.
-
getSoftwareGuardExtensionEnabled
Determine if hardware object has Software Guard Extension (SGX) enabled.
-
getSparePoolBillingItem
Information regarding the billing item for a spare pool server.
-
getSparePoolBillingItem
Information regarding the billing item for a spare pool server.
-
getSparePoolBillingItem
Information regarding the billing item for a spare pool server.
-
getSparePoolBillingItem
Information regarding the billing item for a spare pool server.
-
getSparePoolBillingItem
Information regarding the billing item for a spare pool server.
-
getSshKeys
SSH keys to be installed on the server during provisioning or an OS reload.
-
getSshKeys
SSH keys to be installed on the server during provisioning or an OS reload.
-
getSshKeys
SSH keys to be installed on the server during provisioning or an OS reload.
-
getSshKeys
SSH keys to be installed on the server during provisioning or an OS reload.
-
getSshKeys
SSH keys to be installed on the server during provisioning or an OS reload.
-
getStatisticsRemoteManagement
A server's remote management card used for statistics.
-
getStatisticsRemoteManagement
A server's remote management card used for statistics.
-
getStatisticsRemoteManagement
A server's remote management card used for statistics.
-
getStorageGroups
-
getStorageGroups
-
getStorageGroups
-
getStorageGroups
-
getStorageGroups
-
getStorageNetworkComponents
A piece of hardware's private storage network components. [Deprecated]
-
getStorageNetworkComponents
A piece of hardware's private storage network components. [Deprecated]
-
getStorageNetworkComponents
A piece of hardware's private storage network components. [Deprecated]
-
getStorageNetworkComponents
A piece of hardware's private storage network components. [Deprecated]
-
getStorageNetworkComponents
A piece of hardware's private storage network components. [Deprecated]
-
getTagReferences
-
getTagReferences
-
getTagReferences
-
getTagReferences
-
getTagReferences
-
getTopLevelLocation
-
getTopLevelLocation
-
getTopLevelLocation
-
getTopLevelLocation
-
getTopLevelLocation
-
getTransactionHistory
This method will query transaction history for a piece of hardware.
-
getTransactionHistory
This method will query transaction history for a piece of hardware.
-
getTransactionHistory
This method will query transaction history for a piece of hardware.
-
getTransactionHistory
This method will query transaction history for a piece of hardware.
-
getTransactionHistory
This method will query transaction history for a piece of hardware.
-
getType
A hardware component model's type.
-
getUefiBootFlag
Whether to use UEFI boot instead of BIOS.
-
getUefiBootFlag
Whether to use UEFI boot instead of BIOS.
-
getUefiBootFlag
Whether to use UEFI boot instead of BIOS.
-
getUpgradeableActiveComponents
A piece of hardware's active upgradeable physical components.
-
getUpgradeableActiveComponents
A piece of hardware's active upgradeable physical components.
-
getUpgradeableActiveComponents
A piece of hardware's active upgradeable physical components.
-
getUpgradeableActiveComponents
A piece of hardware's active upgradeable physical components.
-
getUpgradeableActiveComponents
A piece of hardware's active upgradeable physical components.
-
getUpgradeItemPrices
Retrieve a list of upgradeable items available to this piece of hardware. Currently, getUpgradeItemPrices retrieves upgrades available for a server's memory, hard drives, network port speed, bandwidth allocation and GPUs.
-
getUpgradeItemPrices
Retrieve a list of upgradeable items available to this piece of hardware. Currently, getUpgradeItemPrices retrieves upgrades available for a server's memory, hard drives, network port speed, bandwidth allocation and GPUs.
-
getUpgradeItemPrices
Retrieve a list of upgradeable items available to this piece of hardware. Currently, getUpgradeItemPrices retrieves upgrades available for a server's memory, hard drives, network port speed, bandwidth allocation and GPUs.
-
getUpgradeItemPrices
Retrieve a list of upgradeable items available to this piece of hardware. Currently, getUpgradeItemPrices retrieves upgrades available for a server's memory, hard drives, network port speed, bandwidth allocation and GPUs.
-
getUpgradeItemPrices
Retrieve a list of upgradeable items available to this piece of hardware. Currently, getUpgradeItemPrices retrieves upgrades available for a server's memory, hard drives, network port speed, bandwidth allocation and GPUs.
-
getUpgradeRequest
An account's associated upgrade request object, if any.
-
getUpgradeRequest
An account's associated upgrade request object, if any.
-
getUpgradeRequest
An account's associated upgrade request object, if any.
-
getUpgradeRequest
An account's associated upgrade request object, if any.
-
getUpgradeRequest
An account's associated upgrade request object, if any.
-
getUplinkHardware
The network device connected to a piece of hardware.
-
getUplinkHardware
The network device connected to a piece of hardware.
-
getUplinkHardware
The network device connected to a piece of hardware.
-
getUplinkHardware
The network device connected to a piece of hardware.
-
getUplinkHardware
The network device connected to a piece of hardware.
-
getUplinkNetworkComponents
Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure.
-
getUplinkNetworkComponents
Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure.
-
getUplinkNetworkComponents
Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure.
-
getUplinkNetworkComponents
Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure.
-
getUplinkNetworkComponents
Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure.
-
getUserData
An array containing a single string of custom user data for a hardware order. Max size is 16 kb.
-
getUserData
An array containing a single string of custom user data for a hardware order. Max size is 16 kb.
-
getUserData
An array containing a single string of custom user data for a hardware order. Max size is 16 kb.
-
getUserData
An array containing a single string of custom user data for a hardware order. Max size is 16 kb.
-
getUserData
An array containing a single string of custom user data for a hardware order. Max size is 16 kb.
-
getUsers
A list of users that have access to this computing instance.
-
getUsers
A list of users that have access to this computing instance.
-
getUsers
A list of users that have access to this computing instance.
-
getValidAttributeTypes
The types of attributes that are allowed for a given hardware component model.
-
getValidBlockDeviceTemplateGroups
This method will return the list of block device template groups that are valid to the host. For instance, it will only retrieve FLEX images.
-
getValidBlockDeviceTemplateGroups
This method will return the list of block device template groups that are valid to the host. For instance, it will only retrieve FLEX images.
-
getValidBlockDeviceTemplateGroups
This method will return the list of block device template groups that are valid to the host. For instance, it will only retrieve FLEX images.
-
getVirtualChassis
Information regarding the virtual chassis for a piece of hardware.
-
getVirtualChassis
Information regarding the virtual chassis for a piece of hardware.
-
getVirtualChassis
Information regarding the virtual chassis for a piece of hardware.
-
getVirtualChassis
Information regarding the virtual chassis for a piece of hardware.
-
getVirtualChassis
Information regarding the virtual chassis for a piece of hardware.
-
getVirtualChassisSiblings
Information regarding the virtual chassis siblings for a piece of hardware.
-
getVirtualChassisSiblings
Information regarding the virtual chassis siblings for a piece of hardware.
-
getVirtualChassisSiblings
Information regarding the virtual chassis siblings for a piece of hardware.
-
getVirtualChassisSiblings
Information regarding the virtual chassis siblings for a piece of hardware.
-
getVirtualChassisSiblings
Information regarding the virtual chassis siblings for a piece of hardware.
-
getVirtualGuests
[DEPRECATED] A hardware server's virtual servers.
-
getVirtualGuests
[DEPRECATED] A hardware server's virtual servers.
-
getVirtualGuests
[DEPRECATED] A hardware server's virtual servers.
-
getVirtualHost
A piece of hardware's virtual host record.
-
getVirtualHost
A piece of hardware's virtual host record.
-
getVirtualHost
A piece of hardware's virtual host record.
-
getVirtualHost
A piece of hardware's virtual host record.
-
getVirtualHost
A piece of hardware's virtual host record.
-
getVirtualizationPlatform
A piece of hardware's virtualization platform software.
-
getVirtualizationPlatform
A piece of hardware's virtualization platform software.
-
getVirtualizationPlatform
A piece of hardware's virtualization platform software.
-
getVirtualizationPlatform
A piece of hardware's virtualization platform software.
-
getVirtualizationPlatform
A piece of hardware's virtualization platform software.
-
getVirtualLicenses
Information regarding a piece of hardware's virtual software licenses.
-
getVirtualLicenses
Information regarding a piece of hardware's virtual software licenses.
-
getVirtualLicenses
Information regarding a piece of hardware's virtual software licenses.
-
getVirtualLicenses
Information regarding a piece of hardware's virtual software licenses.
-
getVirtualLicenses
Information regarding a piece of hardware's virtual software licenses.
-
getVirtualRack
Information regarding the bandwidth allotment to which a piece of hardware belongs.
-
getVirtualRack
Information regarding the bandwidth allotment to which a piece of hardware belongs.
-
getVirtualRack
Information regarding the bandwidth allotment to which a piece of hardware belongs.
-
getVirtualRack
Information regarding the bandwidth allotment to which a piece of hardware belongs.
-
getVirtualRack
Information regarding the bandwidth allotment to which a piece of hardware belongs.
-
getVirtualRackId
The name of the bandwidth allotment belonging to a piece of hardware.
-
getVirtualRackId
The name of the bandwidth allotment belonging to a piece of hardware.
-
getVirtualRackId
The name of the bandwidth allotment belonging to a piece of hardware.
-
getVirtualRackId
The name of the bandwidth allotment belonging to a piece of hardware.
-
getVirtualRackId
The name of the bandwidth allotment belonging to a piece of hardware.
-
getVirtualRackName
The name of the bandwidth allotment belonging to a piece of hardware.
-
getVirtualRackName
The name of the bandwidth allotment belonging to a piece of hardware.
-
getVirtualRackName
The name of the bandwidth allotment belonging to a piece of hardware.
-
getVirtualRackName
The name of the bandwidth allotment belonging to a piece of hardware.
-
getVirtualRackName
The name of the bandwidth allotment belonging to a piece of hardware.
-
getVmwareQualifiedFirmwares
-
getWindowsUpdateAvailableUpdates
Retrieve a list of Windows updates available for a server from the local SoftLayer Windows Server Update Services (WSUS) server. Windows servers provisioned by SoftLayer are configured to use the local WSUS server via the private network by default.
-
getWindowsUpdateAvailableUpdates
Retrieve a list of Windows updates available for a server from the local SoftLayer Windows Server Update Services (WSUS) server. Windows servers provisioned by SoftLayer are configured to use the local WSUS server via the private network by default.
-
getWindowsUpdateAvailableUpdates
Retrieve a list of Windows updates available for a server from the local SoftLayer Windows Server Update Services (WSUS) server. Windows servers provisioned by SoftLayer are configured to use the local WSUS server via the private network by default.
-
getWindowsUpdateInstalledUpdates
Retrieve a list of Windows updates installed on a server as reported by the local SoftLayer Windows Server Update Services (WSUS) server. Windows servers provisioned by SoftLayer are configured to use the local WSUS server via the private network by default.
-
getWindowsUpdateInstalledUpdates
Retrieve a list of Windows updates installed on a server as reported by the local SoftLayer Windows Server Update Services (WSUS) server. Windows servers provisioned by SoftLayer are configured to use the local WSUS server via the private network by default.
-
getWindowsUpdateInstalledUpdates
Retrieve a list of Windows updates installed on a server as reported by the local SoftLayer Windows Server Update Services (WSUS) server. Windows servers provisioned by SoftLayer are configured to use the local WSUS server via the private network by default.
-
getWindowsUpdateStatus
This method returns an update status record for this server. That record will specify if the server is missing updates, or has updates that must be reinstalled or require a reboot to go into affect.
-
getWindowsUpdateStatus
This method returns an update status record for this server. That record will specify if the server is missing updates, or has updates that must be reinstalled or require a reboot to go into affect.
-
getWindowsUpdateStatus
This method returns an update status record for this server. That record will specify if the server is missing updates, or has updates that must be reinstalled or require a reboot to go into affect.
-
importVirtualHost
The '''importVirtualHost''' method attempts to import the host record for the virtualization platform running on a server.
-
importVirtualHost
The '''importVirtualHost''' method attempts to import the host record for the virtualization platform running on a server.
-
importVirtualHost
The '''importVirtualHost''' method attempts to import the host record for the virtualization platform running on a server.
-
importVirtualHost
The '''importVirtualHost''' method attempts to import the host record for the virtualization platform running on a server.
-
importVirtualHost
The '''importVirtualHost''' method attempts to import the host record for the virtualization platform running on a server.
-
initiateIderaBareMetalRestore
Idera Bare Metal Server Restore is a backup agent designed specifically for making full system restores made with Idera Server Backup.
-
initiateIderaBareMetalRestore
Idera Bare Metal Server Restore is a backup agent designed specifically for making full system restores made with Idera Server Backup.
-
initiateIderaBareMetalRestore
Idera Bare Metal Server Restore is a backup agent designed specifically for making full system restores made with Idera Server Backup.
-
initiateR1SoftBareMetalRestore
R1Soft Bare Metal Server Restore is an R1Soft disk agent designed specifically for making full system restores made with R1Soft CDP Server backup.
-
initiateR1SoftBareMetalRestore
R1Soft Bare Metal Server Restore is an R1Soft disk agent designed specifically for making full system restores made with R1Soft CDP Server backup.
-
initiateR1SoftBareMetalRestore
R1Soft Bare Metal Server Restore is an R1Soft disk agent designed specifically for making full system restores made with R1Soft CDP Server backup.
-
isBackendPingable
Issues a ping command and returns the success (true) or failure (false) of the ping command.
-
isBackendPingable
Issues a ping command and returns the success (true) or failure (false) of the ping command.
-
isBackendPingable
Issues a ping command and returns the success (true) or failure (false) of the ping command.
-
isPingable
The '''isPingable''' method issues a ping command to the selected server and returns the result of the ping command. This boolean return value displays ''true'' upon successful ping or ''false'' for a failed ping.
-
isPingable
The '''isPingable''' method issues a ping command to the selected server and returns the result of the ping command. This boolean return value displays ''true'' upon successful ping or ''false'' for a failed ping.
-
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.
-
isPingable
Issues a ping command and returns the success (true) or failure (false) of the ping command.
-
isWindowsServer
Determine if the server runs any version of the Microsoft Windows operating systems. Return ''true'' if it does and ''false if otherwise.
-
isWindowsServer
Determine if the server runs any version of the Microsoft Windows operating systems. Return ''true'' if it does and ''false if otherwise.
-
isWindowsServer
Determine if the server runs any version of the Microsoft Windows operating systems. Return ''true'' if it does and ''false if otherwise.
-
massFirmwareReflash
You can launch firmware reflashes by selecting from your server list. It will bring your server offline for approximately 60 minutes while the reflashes are in progress.
In the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online. They will be contact you to ensure that impact on your server is minimal.
-
massFirmwareReflash
You can launch firmware reflashes by selecting from your server list. It will bring your server offline for approximately 60 minutes while the reflashes are in progress.
In the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online. They will be contact you to ensure that impact on your server is minimal.
-
massFirmwareReflash
You can launch firmware reflashes by selecting from your server list. It will bring your server offline for approximately 60 minutes while the reflashes are in progress.
In the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online. They will be contact you to ensure that impact on your server is minimal.
-
massFirmwareUpdate
You can launch firmware updates by selecting from your server list. It will bring your server offline for approximately 20 minutes while the updates are in progress.
In the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.
-
massFirmwareUpdate
You can launch firmware updates by selecting from your server list. It will bring your server offline for approximately 20 minutes while the updates are in progress.
In the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.
-
massFirmwareUpdate
You can launch firmware updates by selecting from your server list. It will bring your server offline for approximately 20 minutes while the updates are in progress.
In the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.
-
massHyperThreadingUpdate
You can launch hyper-threading update by selecting from your server list. It will bring your server offline for approximately 60 minutes while the updates are in progress.
In the event of a hardware failure during this update our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online. They will be in contact with you to ensure that impact on your server is minimal.
-
massHyperThreadingUpdate
You can launch hyper-threading update by selecting from your server list. It will bring your server offline for approximately 60 minutes while the updates are in progress.
In the event of a hardware failure during this update our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online. They will be in contact with you to ensure that impact on your server is minimal.
-
massHyperThreadingUpdate
You can launch hyper-threading update by selecting from your server list. It will bring your server offline for approximately 60 minutes while the updates are in progress.
In the event of a hardware failure during this update our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online. They will be in contact with you to ensure that impact on your server is minimal.
-
massReloadOperatingSystem
Reloads current or customer specified 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 server to the current specifications on record.
The reload will take AT MINIMUM 66 minutes.
-
massReloadOperatingSystem
Reloads current or customer specified 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 server to the current specifications on record.
The reload will take AT MINIMUM 66 minutes.
-
massReloadOperatingSystem
Reloads current or customer specified 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 server to the current specifications on record.
The reload will take AT MINIMUM 66 minutes.
-
massSparePool
The ability to place multiple bare metal servers in a state where they are powered down and ports closed yet still allocated to the customer as a part of the Spare Pool program.
-
massSparePool
The ability to place multiple bare metal servers in a state where they are powered down and ports closed yet still allocated to the customer as a part of the Spare Pool program.
-
massSparePool
The ability to place multiple bare metal servers in a state where they are powered down and ports closed yet still allocated to the customer as a part of the Spare Pool program.
-
ping
Issues a ping command to the server and returns the ping response.
-
ping
Issues a ping command to the server and returns the ping response.
-
ping
Issues a ping command to the server and returns the ping response.
-
ping
Issues a ping command to the server and returns the ping response.
-
ping
Issues a ping command to the server and returns the ping response.
-
populateServerRam
-
populateServerRam
-
populateServerRam
-
powerCycle
The '''powerCycle''' method completes a power off and power on of the server successively in one command. The power cycle command is equivalent to unplugging the server from the power strip and then plugging the server back in. '''This method should only be used when all other options have been exhausted'''. Additional remote management commands may not be executed if this command was successfully issued within the last 20 minutes to avoid server failure. Remote management commands include:
rebootSoft rebootHard powerOn powerOff powerCycle
-
powerCycle
The '''powerCycle''' method completes a power off and power on of the server successively in one command. The power cycle command is equivalent to unplugging the server from the power strip and then plugging the server back in. '''This method should only be used when all other options have been exhausted'''. Additional remote management commands may not be executed if this command was successfully issued within the last 20 minutes to avoid server failure. Remote management commands include:
rebootSoft rebootHard powerOn powerOff powerCycle
-
powerCycle
Power off then power on the server via powerstrip. The power cycle command is equivalent to unplugging the server from the powerstrip and then plugging the server back into the powerstrip. This should only be used as a last resort. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.
-
powerCycle
Power off then power on the server via powerstrip. The power cycle command is equivalent to unplugging the server from the powerstrip and then plugging the server back into the powerstrip. This should only be used as a last resort. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.
-
powerCycle
Power off then power on the server via powerstrip. The power cycle command is equivalent to unplugging the server from the powerstrip and then plugging the server back into the powerstrip. This should only be used as a last resort. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.
-
powerOff
This method will power off the server via the server's remote management card.
-
powerOff
This method will power off the server via the server's remote management card.
-
powerOff
This method will power off the server via the server's remote management card.
-
powerOff
This method will power off the server via the server's remote management card.
-
powerOff
This method will power off the server via the server's remote management card.
-
powerOn
The '''powerOn''' method powers on a server via its remote management card. This boolean return value returns ''true'' upon successful execution and ''false'' if unsuccessful. Other remote management commands may not be issued in this command was successfully completed within the last 20 minutes to avoid server failure. Remote management commands include:
rebootSoft rebootHard powerOn powerOff powerCycle
-
powerOn
The '''powerOn''' method powers on a server via its remote management card. This boolean return value returns ''true'' upon successful execution and ''false'' if unsuccessful. Other remote management commands may not be issued in this command was successfully completed within the last 20 minutes to avoid server failure. Remote management commands include:
rebootSoft rebootHard powerOn powerOff powerCycle
-
powerOn
Power on server via its remote management card. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.
-
powerOn
Power on server via its remote management card. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.
-
powerOn
Power on server via its remote management card. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.
-
rebootDefault
The '''rebootDefault''' method attempts to reboot the server by issuing a soft reboot, or reset, command to the server's remote management card. if the reset attempt is unsuccessful, a power cycle command will be issued via the power strip. The power cycle command is equivalent to unplugging the server from the power strip and then plugging the server back in. If the reset was successful within the last 20 minutes, another remote management command cannot be completed to avoid server failure. Remote management commands include:
rebootSoft rebootHard powerOn powerOff powerCycle
-
rebootDefault
The '''rebootDefault''' method attempts to reboot the server by issuing a soft reboot, or reset, command to the server's remote management card. if the reset attempt is unsuccessful, a power cycle command will be issued via the power strip. The power cycle command is equivalent to unplugging the server from the power strip and then plugging the server back in. If the reset was successful within the last 20 minutes, another remote management command cannot be completed to avoid server failure. Remote management commands include:
rebootSoft rebootHard powerOn powerOff powerCycle
-
rebootDefault
Attempts to reboot the server by issuing a reset (soft reboot) command to the server's remote management card. If the reset (soft reboot) attempt is unsuccessful, a power cycle command will be issued via the powerstrip. The power cycle command is equivalent to unplugging the server from the powerstrip and then plugging the server back into the powerstrip. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.
-
rebootDefault
Attempts to reboot the server by issuing a reset (soft reboot) command to the server's remote management card. If the reset (soft reboot) attempt is unsuccessful, a power cycle command will be issued via the powerstrip. The power cycle command is equivalent to unplugging the server from the powerstrip and then plugging the server back into the powerstrip. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.
-
rebootDefault
Attempts to reboot the server by issuing a reset (soft reboot) command to the server's remote management card. If the reset (soft reboot) attempt is unsuccessful, a power cycle command will be issued via the powerstrip. The power cycle command is equivalent to unplugging the server from the powerstrip and then plugging the server back into the powerstrip. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.
-
rebootHard
The '''rebootHard''' method reboots the server by issuing a cycle command to the server's remote management card. A hard reboot is equivalent to pressing the ''Reset'' button on a server - it is issued immediately and will not allow processes to shut down prior to the reboot. Completing a hard reboot may initiate system disk checks upon server reboot, causing the boot up to take longer than normally expected.
Remote management commands are unable to be executed if a reboot has been issued successfully within the last 20 minutes to avoid server failure. Remote management commands include:
rebootSoft rebootHard powerOn powerOff powerCycle
-
rebootHard
The '''rebootHard''' method reboots the server by issuing a cycle command to the server's remote management card. A hard reboot is equivalent to pressing the ''Reset'' button on a server - it is issued immediately and will not allow processes to shut down prior to the reboot. Completing a hard reboot may initiate system disk checks upon server reboot, causing the boot up to take longer than normally expected.
Remote management commands are unable to be executed if a reboot has been issued successfully within the last 20 minutes to avoid server failure. Remote management commands include:
rebootSoft rebootHard powerOn powerOff powerCycle
-
rebootHard
Reboot the server by issuing a cycle command to the server's remote management card. This is equivalent to pressing the 'Reset' button on the server. This command is issued immediately and will not wait for processes to shutdown. After this command is issued, the server may take a few moments to boot up as server may run system disks checks. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.
-
rebootHard
Reboot the server by issuing a cycle command to the server's remote management card. This is equivalent to pressing the 'Reset' button on the server. This command is issued immediately and will not wait for processes to shutdown. After this command is issued, the server may take a few moments to boot up as server may run system disks checks. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.
-
rebootHard
Reboot the server by issuing a cycle command to the server's remote management card. This is equivalent to pressing the 'Reset' button on the server. This command is issued immediately and will not wait for processes to shutdown. After this command is issued, the server may take a few moments to boot up as server may run system disks checks. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.
-
rebootSoft
The '''rebootSoft''' method reboots the server by issuing a reset command to the server's remote management card via soft reboot. When executing a soft reboot, servers allow all processes to shut down completely before rebooting. Remote management commands are unable to be issued within 20 minutes of issuing a successful soft reboot in order to avoid server failure. Remote management commands include:
rebootSoft rebootHard powerOn powerOff powerCycle
-
rebootSoft
The '''rebootSoft''' method reboots the server by issuing a reset command to the server's remote management card via soft reboot. When executing a soft reboot, servers allow all processes to shut down completely before rebooting. Remote management commands are unable to be issued within 20 minutes of issuing a successful soft reboot in order to avoid server failure. Remote management commands include:
rebootSoft rebootHard powerOn powerOff powerCycle
-
rebootSoft
Reboot the server by issuing a reset command to the server's remote management card. This is a graceful reboot. The servers will allow all process to shutdown gracefully before rebooting. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.
-
rebootSoft
Reboot the server by issuing a reset command to the server's remote management card. This is a graceful reboot. The servers will allow all process to shutdown gracefully before rebooting. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.
-
rebootSoft
Reboot the server by issuing a reset command to the server's remote management card. This is a graceful reboot. The servers will allow all process to shutdown gracefully before rebooting. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.
-
refreshDeviceStatus
-
refreshDeviceStatus
-
refreshDeviceStatus
-
refreshDeviceStatus
-
refreshDeviceStatus
-
reloadCurrentOperatingSystemConfiguration
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 server to the current specifications on record.
The reload will take AT MINIMUM 66 minutes.
-
reloadCurrentOperatingSystemConfiguration
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 server to the current specifications on record.
The reload will take AT MINIMUM 66 minutes.
-
reloadCurrentOperatingSystemConfiguration
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 server to the current specifications on record.
The reload will take AT MINIMUM 66 minutes.
-
reloadOperatingSystem
Reloads current or customer specified 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 server to the current specifications on record.
The reload will take AT MINIMUM 66 minutes.
-
reloadOperatingSystem
Reloads current or customer specified 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 server to the current specifications on record.
The reload will take AT MINIMUM 66 minutes.
-
reloadOperatingSystem
Reloads current or customer specified 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 server to the current specifications on record.
The reload will take AT MINIMUM 66 minutes.
-
removeAccessToNetworkStorage
This method is used to remove access to s SoftLayer_Network_Storage volumes that supports host- or network-level access control.
-
removeAccessToNetworkStorage
This method is used to remove access to s SoftLayer_Network_Storage volumes that supports host- or network-level access control.
-
removeAccessToNetworkStorage
This method is used to remove access to s SoftLayer_Network_Storage volumes that supports host- or network-level access control.
-
removeAccessToNetworkStorage
This method is used to remove access to s SoftLayer_Network_Storage volumes that supports host- or network-level access control.
-
removeAccessToNetworkStorage
This method is used to remove access to s SoftLayer_Network_Storage volumes 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.
-
removeAccessToNetworkStorageList
This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support 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.
-
removeAccessToNetworkStorageList
This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support 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.
-
removeTags
Remove a tag reference
-
removeTags
Remove a tag reference
-
removeTags
Remove a tag reference
-
removeTags
Remove a tag reference
-
removeTags
Remove a tag reference
-
runPassmarkCertificationBenchmark
You can launch a new Passmark hardware test by selecting from your server list. It will bring your server offline for approximately 20 minutes while the testing is in progress, and will publish a certificate with the results to your hardware details page.
While the hard drives are tested for the initial deployment, the Passmark Certificate utility will not test the hard drives on your live server. This is to ensure that no data is overwritten. If you would like to test the server's hard drives, you can have the full Passmark suite installed to your server free of charge through a new Support ticket.
While the test itself does not overwrite any data on the server, it is recommended that you make full off-server backups of all data prior to launching the test. The Passmark hardware test is designed to force any latent hardware issues to the surface, so hardware failure is possible.
In the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.
-
runPassmarkCertificationBenchmark
You can launch a new Passmark hardware test by selecting from your server list. It will bring your server offline for approximately 20 minutes while the testing is in progress, and will publish a certificate with the results to your hardware details page.
While the hard drives are tested for the initial deployment, the Passmark Certificate utility will not test the hard drives on your live server. This is to ensure that no data is overwritten. If you would like to test the server's hard drives, you can have the full Passmark suite installed to your server free of charge through a new Support ticket.
While the test itself does not overwrite any data on the server, it is recommended that you make full off-server backups of all data prior to launching the test. The Passmark hardware test is designed to force any latent hardware issues to the surface, so hardware failure is possible.
In the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.
-
runPassmarkCertificationBenchmark
You can launch a new Passmark hardware test by selecting from your server list. It will bring your server offline for approximately 20 minutes while the testing is in progress, and will publish a certificate with the results to your hardware details page.
While the hard drives are tested for the initial deployment, the Passmark Certificate utility will not test the hard drives on your live server. This is to ensure that no data is overwritten. If you would like to test the server's hard drives, you can have the full Passmark suite installed to your server free of charge through a new Support ticket.
While the test itself does not overwrite any data on the server, it is recommended that you make full off-server backups of all data prior to launching the test. The Passmark hardware test is designed to force any latent hardware issues to the surface, so hardware failure is possible.
In the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.
-
setOperatingSystemPassword
Changes the password that we have stored in our database for a servers' Operating System
-
setOperatingSystemPassword
Changes the password that we have stored in our database for a servers' Operating System
-
setOperatingSystemPassword
Changes the password that we have stored in our database for a servers' Operating System
-
setPrivateNetworkInterfaceSpeed
Set the private network interface speed and redundancy configuration.
Possible $newSpeed values are -1 (maximum available), 0 (disconnect), 10, 100, 1000, and 10000; not all values are available to every server. The maximum speed is limited by the speed requested during provisioning. All intermediate speeds are limited by the capability of the pod the server is deployed in. No guarantee is made that a speed other than what was requested during provisioning will be available.
If specified, possible $redundancy values are either 'redundant' or 'degraded'. Not specifying a redundancy mode will use the best possible redundancy available to the server. However, specifying a redundacy mode that is not available to the server will result in an error. 'redundant' indicates all available interfaces should be active. 'degraded' indicates only the primary interface should be active. Irrespective of the number of interfaces available to a server, it is only possible to have either a single interface or all interfaces active.
Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.
A response of true indicates a change was required to achieve the desired interface configuration; thus changes are pending. A response of false indicates the current interface configuration matches the desired configuration, and thus no changes are pending.
<h4>Backwards Compatibility Until February 27th, 2019</h4>
In order to provide a period of transition to the new API, some backwards compatible behaviors will be active during this period. <ul> <li> A 'doubled' (eg. 200) speed value will be translated to a redundancy value of 'redundant'. If a redundancy value is specified, it is assumed no translation is needed and will result in an error due to doubled speeds no longer being valid.</li> <li> A non-doubled (eg. 100) speed value <i>without</i> a redundancy value will be translated to a redundancy value of 'degraded'.</li> </ul> After the compatibility period, a doubled speed value will result in an error, and a non-doubled speed value without a redundancy value specified will result in the best available redundancy state. An exception is made for the new relative speed value -1. When using -1 without a redundancy value, the best possible redundancy will be used. Please transition away from using doubled speed values in favor of specifying redundancy (when applicable) or using relative speed values 0 and -1.
-
setPrivateNetworkInterfaceSpeed
Set the private network interface speed and redundancy configuration.
Possible $newSpeed values are -1 (maximum available), 0 (disconnect), 10, 100, 1000, and 10000; not all values are available to every server. The maximum speed is limited by the speed requested during provisioning. All intermediate speeds are limited by the capability of the pod the server is deployed in. No guarantee is made that a speed other than what was requested during provisioning will be available.
If specified, possible $redundancy values are either 'redundant' or 'degraded'. Not specifying a redundancy mode will use the best possible redundancy available to the server. However, specifying a redundacy mode that is not available to the server will result in an error. 'redundant' indicates all available interfaces should be active. 'degraded' indicates only the primary interface should be active. Irrespective of the number of interfaces available to a server, it is only possible to have either a single interface or all interfaces active.
Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.
A response of true indicates a change was required to achieve the desired interface configuration; thus changes are pending. A response of false indicates the current interface configuration matches the desired configuration, and thus no changes are pending.
<h4>Backwards Compatibility Until February 27th, 2019</h4>
In order to provide a period of transition to the new API, some backwards compatible behaviors will be active during this period. <ul> <li> A 'doubled' (eg. 200) speed value will be translated to a redundancy value of 'redundant'. If a redundancy value is specified, it is assumed no translation is needed and will result in an error due to doubled speeds no longer being valid.</li> <li> A non-doubled (eg. 100) speed value <i>without</i> a redundancy value will be translated to a redundancy value of 'degraded'.</li> </ul> After the compatibility period, a doubled speed value will result in an error, and a non-doubled speed value without a redundancy value specified will result in the best available redundancy state. An exception is made for the new relative speed value -1. When using -1 without a redundancy value, the best possible redundancy will be used. Please transition away from using doubled speed values in favor of specifying redundancy (when applicable) or using relative speed values 0 and -1.
-
setPrivateNetworkInterfaceSpeed
Set the private network interface speed and redundancy configuration.
Possible $newSpeed values are -1 (maximum available), 0 (disconnect), 10, 100, 1000, and 10000; not all values are available to every server. The maximum speed is limited by the speed requested during provisioning. All intermediate speeds are limited by the capability of the pod the server is deployed in. No guarantee is made that a speed other than what was requested during provisioning will be available.
If specified, possible $redundancy values are either 'redundant' or 'degraded'. Not specifying a redundancy mode will use the best possible redundancy available to the server. However, specifying a redundacy mode that is not available to the server will result in an error. 'redundant' indicates all available interfaces should be active. 'degraded' indicates only the primary interface should be active. Irrespective of the number of interfaces available to a server, it is only possible to have either a single interface or all interfaces active.
Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.
A response of true indicates a change was required to achieve the desired interface configuration; thus changes are pending. A response of false indicates the current interface configuration matches the desired configuration, and thus no changes are pending.
<h4>Backwards Compatibility Until February 27th, 2019</h4>
In order to provide a period of transition to the new API, some backwards compatible behaviors will be active during this period. <ul> <li> A 'doubled' (eg. 200) speed value will be translated to a redundancy value of 'redundant'. If a redundancy value is specified, it is assumed no translation is needed and will result in an error due to doubled speeds no longer being valid.</li> <li> A non-doubled (eg. 100) speed value <i>without</i> a redundancy value will be translated to a redundancy value of 'degraded'.</li> </ul> After the compatibility period, a doubled speed value will result in an error, and a non-doubled speed value without a redundancy value specified will result in the best available redundancy state. An exception is made for the new relative speed value -1. When using -1 without a redundancy value, the best possible redundancy will be used. Please transition away from using doubled speed values in favor of specifying redundancy (when applicable) or using relative speed values 0 and -1.
-
setPublicNetworkInterfaceSpeed
Set the public network interface speed and redundancy configuration.
Possible $newSpeed values are -1 (maximum available), 0 (disconnect), 10, 100, 1000, and 10000; not all values are available to every server. The maximum speed is limited by the speed requested during provisioning. All intermediate speeds are limited by the capability of the pod the server is deployed in. No guarantee is made that a speed other than what was requested during provisioning will be available.
If specified, possible $redundancy values are either 'redundant' or 'degraded'. Not specifying a redundancy mode will use the best possible redundancy available to the server. However, specifying a redundacy mode that is not available to the server will result in an error. 'redundant' indicates all available interfaces should be active. 'degraded' indicates only the primary interface should be active. Irrespective of the number of interfaces available to a server, it is only possible to have either a single interface or all interfaces active.
Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.
A response of true indicates a change was required to achieve the desired interface configuration; thus changes are pending. A response of false indicates the current interface configuration matches the desired configuration, and thus no changes are pending.
<h4>Backwards Compatibility Until February 27th, 2019</h4>
In order to provide a period of transition to the new API, some backwards compatible behaviors will be active during this period. <ul> <li> A 'doubled' (eg. 200) speed value will be translated to a redundancy value of 'redundant'. If a redundancy value is specified, it is assumed no translation is needed and will result in an error due to doubled speeds no longer being valid.</li> <li> A non-doubled (eg. 100) speed value <i>without</i> a redundancy value will be translated to a redundancy value of 'degraded'.</li> </ul> After the compatibility period, a doubled speed value will result in an error, and a non-doubled speed value without a redundancy value specified will result in the best available redundancy state. An exception is made for the new relative speed value -1. When using -1 without a redundancy value, the best possible redundancy will be used. Please transition away from using doubled speed values in favor of specifying redundancy (when applicable) or using relative speed values 0 and -1.
-
setPublicNetworkInterfaceSpeed
Set the public network interface speed and redundancy configuration.
Possible $newSpeed values are -1 (maximum available), 0 (disconnect), 10, 100, 1000, and 10000; not all values are available to every server. The maximum speed is limited by the speed requested during provisioning. All intermediate speeds are limited by the capability of the pod the server is deployed in. No guarantee is made that a speed other than what was requested during provisioning will be available.
If specified, possible $redundancy values are either 'redundant' or 'degraded'. Not specifying a redundancy mode will use the best possible redundancy available to the server. However, specifying a redundacy mode that is not available to the server will result in an error. 'redundant' indicates all available interfaces should be active. 'degraded' indicates only the primary interface should be active. Irrespective of the number of interfaces available to a server, it is only possible to have either a single interface or all interfaces active.
Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.
A response of true indicates a change was required to achieve the desired interface configuration; thus changes are pending. A response of false indicates the current interface configuration matches the desired configuration, and thus no changes are pending.
<h4>Backwards Compatibility Until February 27th, 2019</h4>
In order to provide a period of transition to the new API, some backwards compatible behaviors will be active during this period. <ul> <li> A 'doubled' (eg. 200) speed value will be translated to a redundancy value of 'redundant'. If a redundancy value is specified, it is assumed no translation is needed and will result in an error due to doubled speeds no longer being valid.</li> <li> A non-doubled (eg. 100) speed value <i>without</i> a redundancy value will be translated to a redundancy value of 'degraded'.</li> </ul> After the compatibility period, a doubled speed value will result in an error, and a non-doubled speed value without a redundancy value specified will result in the best available redundancy state. An exception is made for the new relative speed value -1. When using -1 without a redundancy value, the best possible redundancy will be used. Please transition away from using doubled speed values in favor of specifying redundancy (when applicable) or using relative speed values 0 and -1.
-
setPublicNetworkInterfaceSpeed
Set the public network interface speed and redundancy configuration.
Possible $newSpeed values are -1 (maximum available), 0 (disconnect), 10, 100, 1000, and 10000; not all values are available to every server. The maximum speed is limited by the speed requested during provisioning. All intermediate speeds are limited by the capability of the pod the server is deployed in. No guarantee is made that a speed other than what was requested during provisioning will be available.
If specified, possible $redundancy values are either 'redundant' or 'degraded'. Not specifying a redundancy mode will use the best possible redundancy available to the server. However, specifying a redundacy mode that is not available to the server will result in an error. 'redundant' indicates all available interfaces should be active. 'degraded' indicates only the primary interface should be active. Irrespective of the number of interfaces available to a server, it is only possible to have either a single interface or all interfaces active.
Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.
A response of true indicates a change was required to achieve the desired interface configuration; thus changes are pending. A response of false indicates the current interface configuration matches the desired configuration, and thus no changes are pending.
<h4>Backwards Compatibility Until February 27th, 2019</h4>
In order to provide a period of transition to the new API, some backwards compatible behaviors will be active during this period. <ul> <li> A 'doubled' (eg. 200) speed value will be translated to a redundancy value of 'redundant'. If a redundancy value is specified, it is assumed no translation is needed and will result in an error due to doubled speeds no longer being valid.</li> <li> A non-doubled (eg. 100) speed value <i>without</i> a redundancy value will be translated to a redundancy value of 'degraded'.</li> </ul> After the compatibility period, a doubled speed value will result in an error, and a non-doubled speed value without a redundancy value specified will result in the best available redundancy state. An exception is made for the new relative speed value -1. When using -1 without a redundancy value, the best possible redundancy will be used. Please transition away from using doubled speed values in favor of specifying redundancy (when applicable) or using relative speed values 0 and -1.
-
setTags
-
setTags
-
setTags
-
setTags
-
setTags
-
setUserMetadata
Sets the data that will be written to the configuration drive.
-
setUserMetadata
Sets the data that will be written to the configuration drive.
-
setUserMetadata
Sets the data that will be written to the configuration drive.
-
shutdownPrivatePort
Disconnect a server's private network interface. This operation is an alias for calling [SoftLayer_Hardware_Server::setPrivateNetworkInterfaceSpeed](/reference/services/SoftLayer_Hardware_Server/setPrivateNetworkInterfaceSpeed) with a $newSpeed of 0 and unspecified $redundancy.
Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.
A response of true indicates a change was required to disconnect the interface; thus changes are pending. A response of false indicates the interface was already disconnected, and thus no changes are pending.
-
shutdownPrivatePort
Disconnect a server's private network interface. This operation is an alias for calling [SoftLayer_Hardware_Server::setPrivateNetworkInterfaceSpeed](/reference/services/SoftLayer_Hardware_Server/setPrivateNetworkInterfaceSpeed) with a $newSpeed of 0 and unspecified $redundancy.
Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.
A response of true indicates a change was required to disconnect the interface; thus changes are pending. A response of false indicates the interface was already disconnected, and thus no changes are pending.
-
shutdownPrivatePort
Disconnect a server's private network interface. This operation is an alias for calling [SoftLayer_Hardware_Server::setPrivateNetworkInterfaceSpeed](/reference/services/SoftLayer_Hardware_Server/setPrivateNetworkInterfaceSpeed) with a $newSpeed of 0 and unspecified $redundancy.
Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.
A response of true indicates a change was required to disconnect the interface; thus changes are pending. A response of false indicates the interface was already disconnected, and thus no changes are pending.
-
shutdownPublicPort
Disconnect a server's public network interface. This operation is an alias for [SoftLayer_Hardware_Server::setPublicNetworkInterfaceSpeed](/reference/services/SoftLayer_Hardware_Server/setPublicNetworkInterfaceSpeed) with a $newSpeed of 0 and unspecified $redundancy.
Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.
A response of true indicates a change was required to disconnect the interface; thus changes are pending. A response of false indicates the interface was already disconnected, and thus no changes are pending.
-
shutdownPublicPort
Disconnect a server's public network interface. This operation is an alias for [SoftLayer_Hardware_Server::setPublicNetworkInterfaceSpeed](/reference/services/SoftLayer_Hardware_Server/setPublicNetworkInterfaceSpeed) with a $newSpeed of 0 and unspecified $redundancy.
Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.
A response of true indicates a change was required to disconnect the interface; thus changes are pending. A response of false indicates the interface was already disconnected, and thus no changes are pending.
-
shutdownPublicPort
Disconnect a server's public network interface. This operation is an alias for [SoftLayer_Hardware_Server::setPublicNetworkInterfaceSpeed](/reference/services/SoftLayer_Hardware_Server/setPublicNetworkInterfaceSpeed) with a $newSpeed of 0 and unspecified $redundancy.
Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.
A response of true indicates a change was required to disconnect the interface; thus changes are pending. A response of false indicates the interface was already disconnected, and thus no changes are pending.
-
SoftLayer_Hardware
The SoftLayer_Hardware data type contains general information relating to a single SoftLayer hardware.
-
SoftLayer_Hardware
Every SoftLayer hardware is defined in the SoftLayer_Hardware service. SoftLayer hardware has network components, software, monitoring services such as network monitoring, and hardware components such as hard drives. The SoftLayer_Hardware service is a convenient way to obtain general information about your SoftLayer hardware. Use the data returned by these methods with other API services to get more detailed information about your services and to make changes to your servers and services.
-
SoftLayer_Hardware_Attribute
The SoftLayer_Hardware_Attribute type contains general information for a hardware attribute. Hardware attributes can be assigned to specific hardware objects to describe relatively arbitrary information.
-
SoftLayer_Hardware_Attribute_Type
Retrieve attributes associated with a hardware object.
-
SoftLayer_Hardware_Attribute_UserData
-
SoftLayer_Hardware_Benchmark_Certification
The SoftLayer_Hardware_Benchmark_Certification data type contains general information relating to a single SoftLayer hardware benchmark certification document.
-
SoftLayer_Hardware_Benchmark_Certification
This certification is used to indicate the date, time and validity of the benchmark certification process. The certification process includes running a battery of tests on all major sub-systems of a server in order to verify that all components of the server are functioning up to specification. Only after a server has passed each and every hardware and configuration test will it be provisioned for a customer. The 'SoftLayer_Hardware_Benchmark_Certification' class is used to indicate the date, time and validity of the benchmark certification process. This process includes running a battery of tests on all major sub-systems of a server to verify that all components of the server are functioning according to their specifications. Once each server has passed all hardware and configurations tests, it is provisioned to a SoftLayer customer.
-
SoftLayer_Hardware_Blade
The SoftLayer_Hardware_Blade service provides specific information about blade servers.
-
SoftLayer_Hardware_Blade
The SoftLayer_Hardware_Blade service provides specific information about blade servers.
-
SoftLayer_Hardware_Chassis
Every piece of hardware in SoftLayer's datacenters, including customer servers, are housed in one of many hardware chassis. The SoftLayer_Hardware_Chassis data type defines these chassis.
-
SoftLayer_Hardware_Component
The SoftLayer_Hardware_Component data type abstracts information related to a hardware component.
-
SoftLayer_Hardware_Component_Attribute
The SoftLayer_Hardware_Component_Attribute data type contains general information relating to a single hardware setting or attribute for a component model. For Example: A RAID controller may be setup for many different RAID configurations. A RAID controller with a configuration of RAID-1 will have a single attribute for this RAID setting.
-
SoftLayer_Hardware_Component_Attribute_Type
The SoftLayer_Hardware_Component_Attribute_Type data type contains general information for the type of an attribute for a hardware component.
-
SoftLayer_Hardware_Component_DriveController
The SoftLayer_Hardware_Component_DriveController data type abstracts information related to a drive controller.
-
SoftLayer_Hardware_Component_Firmware
-
SoftLayer_Hardware_Component_Firmware_Attribute
The SoftLayer_Hardware_Component_Firmware_Attribute data type contains general information for a hardware model's firmware.
-
SoftLayer_Hardware_Component_Firmware_Attribute_Type
The SoftLayer_Hardware_Component_Firmware_Attribute_Type data type defines attribute types for a hardware component model's firmware.
-
SoftLayer_Hardware_Component_Firmware_QualificationTypes
The SoftLayer_Hardware_Component_Firmware_QualificationTypes data type describes the current qualification status for a particular firmware.
-
SoftLayer_Hardware_Component_HardDrive
The SoftLayer_Hardware_Component_HardDrive data type abstracts information related to a hard drive.
-
SoftLayer_Hardware_Component_Locator
SoftLayer public API to determine the availability of generic hardware component models at data centers
-
SoftLayer_Hardware_Component_Locator
SoftLayer public API to determine the availability of generic hardware component models at data centers
-
SoftLayer_Hardware_Component_Locator_Result
This object holds a generic component model id and the list of datacenter names where it is available.
-
SoftLayer_Hardware_Component_Model
The SoftLayer_Hardware_Component_Model data type contains general information relating to a single SoftLayer component model. A component model represents a vendor specific representation of a hardware component. Every piece of hardware on a server will have a specific hardware component model.
-
SoftLayer_Hardware_Component_Model
Every hardware component is associated with a model. A hardware component model defines the type of hardware component to which it is associated. The '''SoftLayer_Hardware_Component_Model''' class provides detailed information regarding the hardware component.
-
SoftLayer_Hardware_Component_Model_Architecture_Type
-
SoftLayer_Hardware_Component_Model_Attribute
The SoftLayer_Hardware_Component__Model_Attribute data type contains general information relating to a single hardware setting or attribute for a component model.
-
SoftLayer_Hardware_Component_Model_Attribute_Type
The SoftLayer_Hardware_Component_Model_Attribute_Type data type contains general information for the type of an attribute for a hardware component model.
-
SoftLayer_Hardware_Component_Model_Generic
The SoftLayer_Hardware_Component_Model_Generic data type contains general information relating to a single SoftLayer generic component model. A generic component model represents a non-vendor specific representation of a hardware component. Frequently SoftLayer utilizes components from various vendors in the servers they provision. For Example: Several different vendors produce 6GB DDR2 memory. The generic component model for the 6GB stick of RAM encompasses every instance of this component regardless of make and model.
-
SoftLayer_Hardware_Component_Model_Generic_Attribute
The SoftLayer_Hardware_Component_Model_Generic_Attribute data type contains information relating to a single SoftLayer generic component model. Generic component model attributes can hold any information to describe functionality of the model. For Example: The number of cores that a processor has.
-
SoftLayer_Hardware_Component_Model_Generic_MarketingFeature
The SoftLayer_Hardware_Component_Model_Generic_MarketingFeature data type contains general information relating to all the advertising features of a single SoftLayer hardware generic component model.
-
SoftLayer_Hardware_Component_Motherboard
The SoftLayer_Hardware_Component_DriveController data type abstracts information related to a motherboard.
-
SoftLayer_Hardware_Component_Motherboard_Reboot_Time
The SoftLayer_Hardware_Component_Motherboard_Reboot_Time contains the average reboot times for motherboards. There are two types of average times. One is for motherboards without raid, and the other is for motherboards with raid. These times are based on averages and have been gathered through numerous test cases.
-
SoftLayer_Hardware_Component_NetworkCard
The SoftLayer_Hardware_Component_NetworkCard data type abstracts information related to a network card.
-
SoftLayer_Hardware_Component_Partition
The SoftLayer_Hardware_Component_Partition data type contains general information relating to a single hard drive partition.
-
SoftLayer_Hardware_Component_Partition_OperatingSystem
The SoftLayer_Hardware_Component_Partition_OperatingSystem data type contains general information relating to a single SoftLayer Operating System Partition Template.
-
SoftLayer_Hardware_Component_Partition_OperatingSystem
Every SoftLayer Operating System Partition Template is defined in the '''SoftLayer_Hardware_Component_Partition_OperatingSystem''' service. SoftLayer Operating System Partition Templates indicate which operating system a partition template may be used with to configure a hard drive.
-
SoftLayer_Hardware_Component_Partition_Template
The SoftLayer_Hardware_Component_Partition_Template data type contains general information relating to a single SoftLayer partition template. Partition templates group 1 or more partition configurations that can be used to predefine how a hard drive's partitions will be configured.
-
SoftLayer_Hardware_Component_Partition_Template
Every SoftLayer Partition Template is defined in the SoftLayer_Hardware_Component_Partition_Template service. The '''SoftLayer_Hardware_Component_Partition_Template''' service defines all SoftLayer Partition Templates that exist. SoftLayer Partition Templates group together several partitions that define a configuration of templates for a particular hard drive.
-
SoftLayer_Hardware_Component_Partition_Template_Partition
The SoftLayer_Hardware_Component_Partition_Template_Partition data type contains general information relating to a single SoftLayer Template Partition.
-
SoftLayer_Hardware_Component_Processor
The SoftLayer_Hardware_Component_Processor data type abstracts information related to a processor.
-
SoftLayer_Hardware_Component_PSID_Xref
The SoftLayer_Hardware_Component_PSID_Xref data type holds physical security ID information for hard drives
-
SoftLayer_Hardware_Component_Ram
The SoftLayer_Hardware_Component_Ram data type abstracts information related to RAM.
-
SoftLayer_Hardware_Component_RemoteManagement
This class adds functionality to the base SoftLayer_Hardware class for web servers (all server hardware)
-
SoftLayer_Hardware_Component_RemoteManagement_Command
The SoftLayer_Network_Storage_Evault_Version6 contains the names of the remote management commands. Currently, only the reboot and power commands for the remote management card exist.
-
SoftLayer_Hardware_Component_RemoteManagement_Command_Request
The SoftLayer_Hardware_Component_RemoteManagement_Command_Request contains details for remote management commands issued to a server's remote management card. Details for remote management commands such as powerOn, powerOff, powerCycle, rebootDefault, rebootSoft, rebootHard can be retrieved. Details such as the user who issued the command, the id of the remote management card the command was issued, when the command was issued may be retrieved.
-
SoftLayer_Hardware_Component_RemoteManagement_User
The credentials used for remote management such as username, password, etc...
-
SoftLayer_Hardware_Component_Revision
-
SoftLayer_Hardware_Component_SecurityDevice
The SoftLayer_Hardware_Component_SecurityDevice is used to determine the security devices attached to the hardware component.
-
SoftLayer_Hardware_Component_SecurityDevice_Infineon
The SoftLayer_Hardware_Component_SecurityDevice_Infineon is used to determine the Infineon security device attached to the hardware component.
-
SoftLayer_Hardware_Component_Type
The SoftLayer_Hardware_Component_Type data type provides details on the type of component requested
-
SoftLayer_Hardware_Firewall
The SoftLayer_Hardware_Firewall data type contains general information relating to a single SoftLayer firewall.
-
SoftLayer_Hardware_Function
The SoftLayer_Hardware_Function data type contains a generic object type for a piece of hardware, like switch, firewall, server, etc..
-
SoftLayer_Hardware_Group
-
SoftLayer_Hardware_LoadBalancer
-
SoftLayer_Hardware_Note
-
SoftLayer_Hardware_Note_Type
-
SoftLayer_Hardware_Power_Component
-
SoftLayer_Hardware_Resource_Configuration
-
SoftLayer_Hardware_Resource_Configuration_Property
-
SoftLayer_Hardware_Resource_Configuration_Property_Type
-
SoftLayer_Hardware_Resource_Configuration_Type
-
SoftLayer_Hardware_Router
The SoftLayer_Hardware_Router data type contains general information relating to a single SoftLayer router.
-
SoftLayer_Hardware_Router
This service provides access to the device responsible for routing a particular SoftLayer Router.
-
SoftLayer_Hardware_Router_Backend
The SoftLayer_Hardware_Router_Backend data type contains general information relating to a single SoftLayer router item for hardware.
-
SoftLayer_Hardware_Router_Frontend
The SoftLayer_Hardware_Router_Frontend data type contains general information relating to a single SoftLayer router item for hardware.
-
SoftLayer_Hardware_SecurityModule
-
SoftLayer_Hardware_SecurityModule
-
SoftLayer_Hardware_SecurityModule750
-
SoftLayer_Hardware_SecurityModule750
-
SoftLayer_Hardware_Server
The SoftLayer_Hardware_Server data type contains general information relating to a single SoftLayer server.
-
SoftLayer_Hardware_Server
Every SoftLayer server is defined in the SoftLayer_Hardware_Server service. SoftLayer servers have all the functionality of SoftLayer_Hardware with the of server specific data and functionality such as Operating System reload dates and motherboard components. The SoftLayer_Hardware service is a convenient way to obtain general information about your SoftLayer server. Use the data returned by these methods with other API services to get more detailed information about your services and to make changes to your servers and services.
-
SoftLayer_Hardware_Server_Partition
-
SoftLayer_Hardware_Server_Partition_Network_Attribute
-
SoftLayer_Hardware_State
The SoftLayer_Hardware_State type contains general information about the current state of it's associated hardware, including the current power state (i.e. Running or Stopped), and it's current transitioning state (e.g. Provisioning, Reloading).
-
SoftLayer_Hardware_Status
SoftLayer_Hardware_Status models the inventory state of any piece of hardware in SoftLayer's inventory. Most of these statuses are used by SoftLayer while a server is not provisioned or undergoing provisioning. SoftLayer uses the following status codes:
*'''ACTIVE''': This server is active and in use. *'''DEPLOY''': Used during server provisioning. *'''DEPLOY2''': Used during server provisioning. *'''MACWAIT''': Used during server provisioning. *'''RECLAIM''': This server has been reclaimed by SoftLayer and is awaiting de-provisioning.
Servers in production and in use should stay in the ACTIVE state. If a server's status ever reads anything else then please contact SoftLayer support.
-
SoftLayer_Hardware_Switch
The SoftLayer_Hardware_Switch object extends the base functionality of the SoftLayer_Hardware service.
-
sparePool
The ability to place bare metal servers in a state where they are powered down, and ports closed yet still allocated to the customer as a part of the Spare Pool program.
-
sparePool
The ability to place bare metal servers in a state where they are powered down, and ports closed yet still allocated to the customer as a part of the Spare Pool program.
-
sparePool
The ability to place bare metal servers in a state where they are powered down, and ports closed yet still allocated to the customer as a part of the Spare Pool program.
-
testRaidAlertService
Test the RAID Alert service by sending the service a request to store a test email for this server. The server must have an account ID and MAC address. A RAID controller must also be installed.
-
testRaidAlertService
Test the RAID Alert service by sending the service a request to store a test email for this server. The server must have an account ID and MAC address. A RAID controller must also be installed.
-
testRaidAlertService
Test the RAID Alert service by sending the service a request to store a test email for this server. The server must have an account ID and MAC address. A RAID controller must also be installed.
-
toggleManagementInterface
Attempt to toggle the IPMI interface. If there is an active transaction on the server, it will throw an exception. This method creates a job to toggle the interface. It is not instant.
-
toggleManagementInterface
Attempt to toggle the IPMI interface. If there is an active transaction on the server, it will throw an exception. This method creates a job to toggle the interface. It is not instant.
-
toggleManagementInterface
Attempt to toggle the IPMI interface. If there is an active transaction on the server, it will throw an exception. This method creates a job to toggle the interface. It is not instant.
-
updateIpmiPassword
This method will update the root IPMI password on this SoftLayer_Hardware.
-
updateIpmiPassword
This method will update the root IPMI password on this SoftLayer_Hardware.
-
updateIpmiPassword
This method will update the root IPMI password on this SoftLayer_Hardware.
-
updateIpmiPassword
This method will update the root IPMI password on this SoftLayer_Hardware.
-
updateIpmiPassword
This method will update the root IPMI password on this SoftLayer_Hardware.
-
validatePartitionsForOperatingSystem
Validates a collection of partitions for an operating system
-
validatePartitionsForOperatingSystem
Validates a collection of partitions for an operating system
-
validatePartitionsForOperatingSystem
Validates a collection of partitions for an operating system
-
validateSecurityLevel
-
validateSecurityLevel
-
validateSecurityLevel