Items with tag softlayer_hardware_securitymodule

    reference

    • 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.
    • 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.
    • 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.
    • 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.
    • 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>
    • createPostSoftwareInstallTransaction
    • 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.
    • deleteTag
      Delete an existing tag. If there are any references on the tag, an exception will be thrown.
    • editObject
      Edit a server's properties
    • 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.
    • 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.
    • getAccount
      The account associated with a piece of hardware.
    • getActiveComponents
      A piece of hardware's active physical components.
    • getActiveNetworkFirewallBillingItem
      The billing item for a server's attached network firewall.
    • getActiveNetworkMonitorIncident
      A piece of hardware's active network monitoring incidents.
    • getActiveTickets
    • getActiveTransaction
      Transaction currently running for server.
    • getActiveTransactions
      Any active transaction(s) that are currently running for the server (example: os reload).
    • 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.
    • getAllowedNetworkStorageReplicas
      The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.
    • getAllPowerComponents
    • getAntivirusSpywareSoftwareComponent
      Information regarding an antivirus/spyware software component object.
    • 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.
    • 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.
    • 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.
    • getAverageDailyPrivateBandwidthUsage
      The average daily private 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
    • 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.
    • 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.
    • getBandwidthAllocation
      A hardware's allotted bandwidth (measured in GB).
    • 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.
    • 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.
    • getBillingCycleBandwidthUsage
      The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to.
    • getBillingCyclePrivateBandwidthUsage
      The raw private bandwidth usage data for the current billing cycle.
    • getBillingCyclePublicBandwidthUsage
      The raw public bandwidth usage data for the current billing cycle.
    • getBillingItem
      Information regarding the billing item for a server.
    • getBillingItemFlag
      A flag indicating that a billing item exists.
    • getBiosPasswordNullFlag
      Determine if BIOS password should be left as null.
    • getBlockCancelBecauseDisconnectedFlag
      Determines whether the hardware is ineligible for cancellation because it is disconnected.
    • getBootModeOptions
      Retrieve the valid boot modes for this server
    • getBusinessContinuanceInsuranceFlag
      Status indicating whether or not a piece of hardware has business continuance insurance.
    • getCaptureEnabledFlag
      Determine if the server is able to be image captured. If unable to image capture a reason will be provided.
    • getChildrenHardware
      Child hardware.
    • getComponentDetailsXML
    • getComponents
      A piece of hardware's components.
    • getContainsSolidStateDrivesFlag
    • getContinuousDataProtectionSoftwareComponent
      A continuous data protection/server backup software component object.
    • getControlPanel
      A server's control panel.
    • 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).
    • 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.
    • 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.
    • 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
    • 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.
    • 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.
    • 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.
    • 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.
    • getDownlinkVirtualGuests
      Information regarding all virtual guests attached to a piece of network hardware.
    • getDownstreamHardwareBindings
      All hardware downstream from a network device.
    • 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]
    • 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.
    • getDriveControllers
      The drive controllers contained within a piece of hardware.
    • getEvaultNetworkStorage
      Information regarding a piece of hardware's associated EVault network storage service account.
    • 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.
    • 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
    • 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.
    • 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.
    • getFutureBillingItem
      Information regarding the future billing item for a server.
    • getGlobalIdentifier
      A hardware's universally unique identifier.
    • getHardDrives
      The hard drives contained within a piece of hardware.
    • getHardwareByIpAddress
      Retrieve a server by searching for the primary IP address.
    • getHardwareChassis
      The chassis that a piece of hardware is housed in.
    • getHardwareFunction
      A hardware's function.
    • getHardwareFunctionDescription
      A hardware's function.
    • getHardwareState
      A hardware's power/transaction state.
    • getHardwareStatus
      A hardware's status.
    • getHasSingleRootVirtualizationBillingItemFlag
      Determine if hardware has Single Root IO VIrtualization (SR-IOV) billing item.
    • getHasTrustedPlatformModuleBillingItemFlag
      Determine in hardware object has TPM enabled.
    • 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.
    • getHourlyBillingFlag
      A server's hourly billing status.
    • 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.
    • getInboundPublicBandwidthUsage
      The total public inbound bandwidth for this hardware for the current billing cycle.
    • 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.
    • getIsIpmiDisabled
      Determine if remote management has been disabled due to port speed.
    • getIsQeInternalServer
      Determine if hardware object has the QE_INTERNAL_SERVER attribute.
    • 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
    • getLastOperatingSystemReload
      The last transaction that a server's operating system was loaded.
    • getLastTransaction
      Information regarding the last transaction a server performed.
    • getLatestNetworkMonitorIncident
      A piece of hardware's latest network monitoring incident.
    • getLocation
      Where a piece of hardware is located within SoftLayer's location hierarchy.
    • getLocationPathString
    • getLockboxNetworkStorage
      Information regarding a lockbox account associated with a server.
    • getLogicalVolumeStorageGroups
      Returns a list of logical volumes on the physical machine.
    • getManagedResourceFlag
      A flag indicating that the hardware is a managed resource.
    • getManagementNetworkComponent
      Retrieve the remote management network component attached with this server.
    • getMemory
      Information regarding a piece of hardware's memory.
    • getMemoryCapacity
      The amount of memory a piece of hardware has, measured in gigabytes.
    • getMetricTrackingObject
      A piece of hardware's metric tracking object.
    • getMetricTrackingObjectId
      The metric tracking object id for this server.
    • getModules
    • getMonitoringRobot
    • getMonitoringServiceComponent
      Information regarding a piece of hardware's network monitoring services.
    • 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
    • getMotherboard
      Information regarding a piece of hardware's motherboard.
    • 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.
    • getNetworkComponents
      Returns a hardware's network components.
    • 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.
    • 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.
    • 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.
    • getNetworkMonitors
      Information regarding a piece of hardware's network monitors.
    • getNetworkStatus
      The value of a hardware's 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.
    • 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).
    • getNotesHistory
    • getNvRamCapacity
      The amount of non-volatile memory a piece of hardware has, measured in gigabytes.
    • getNvRamComponentModels
    • getObject
      Retrieve a SoftLayer_Hardware_SecurityModule record.
    • getOpenCancellationTicket
      An open ticket requesting cancellation of this server, if one exists.
    • getOperatingSystem
      Information regarding a piece of hardware's operating system.
    • getOperatingSystemReferenceCode
      A hardware's operating system software description.
    • 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.
    • 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.
    • getParentBay
      Blade Bay
    • getParentHardware
      Parent Hardware.
    • getPartitions
    • 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.
    • getPowerComponents
      The power components for a hardware object.
    • getPowerSupply
      Information regarding a piece of hardware's power supply.
    • getPrimaryBackendIpAddress
      The hardware's primary private IP address.
    • getPrimaryBackendNetworkComponent
      Information regarding the hardware's primary back-end network component.
    • getPrimaryDriveSize
    • getPrimaryIpAddress
      The hardware's primary public IP address.
    • getPrimaryNetworkComponent
      Information regarding the hardware's primary public network component.
    • 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.
    • 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
    • getPrivateIpAddress
      A server's primary private IP address.
    • getPrivateNetworkComponent
      Retrieve the private network component attached with this server.
    • getPrivateNetworkOnlyFlag
      Whether the hardware only has access to the private network.
    • 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
    • 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
    • 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.
    • getProjectedPublicBandwidthUsage
      The projected public outbound bandwidth for this hardware for the current billing cycle.
    • 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.
    • 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.
    • 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.
    • 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
    • getRack
    • getRaidControllers
      The RAID controllers contained within a piece of hardware.
    • getReadyNodeFlag
      Determine if hardware object is vSan Ready Node.
    • getRecentEvents
      Recent events that impact this hardware.
    • getRecentRemoteManagementCommands
      The last five commands issued to the server's remote management card.
    • getRegionalInternetRegistry
    • getRemoteManagement
      A 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.
    • getRemoteManagementUsers
      User(s) who have access to issue commands and/or interact with the server's remote management card.
    • getResourceConfigurations
    • getResourceGroupMemberReferences
    • getResourceGroupRoles
    • getResourceGroups
      The resource groups in which this hardware is a member.
    • getReverseDomainRecords
      Retrieve the reverse domain records associated with this server.
    • getRouters
      A hardware's routers.
    • getSecurityScanRequests
      Information regarding a piece of hardware's vulnerability scan requests.
    • 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
      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.
    • 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.
    • 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.
    • 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.
    • getSoftwareComponents
      Information regarding a piece of hardware's installed software.
    • getSoftwareGuardExtensionEnabled
      Determine if hardware object has Software Guard Extension (SGX) enabled.
    • 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.
    • getStatisticsRemoteManagement
      A server's remote management card used for statistics.
    • getStorageGroups
    • getStorageNetworkComponents
      A piece of hardware's private storage network components. [Deprecated]
    • getTagReferences
    • getTopLevelLocation
    • getTransactionHistory
      This method will query transaction history for a piece of hardware.
    • getUefiBootFlag
      Whether to use UEFI boot instead of BIOS.
    • 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.
    • getUpgradeRequest
      An account's associated upgrade request object, if any.
    • 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.
    • 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.
    • 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.
    • getVirtualChassisSiblings
      Information regarding the virtual chassis siblings for a piece of hardware.
    • getVirtualGuests
      [DEPRECATED] A hardware server's virtual servers.
    • getVirtualHost
      A piece of hardware's virtual host record.
    • getVirtualizationPlatform
      A piece of hardware's virtualization platform software.
    • getVirtualLicenses
      Information regarding a piece of hardware's virtual software licenses.
    • 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.
    • getVirtualRackName
      The name of the bandwidth allotment belonging to a piece of hardware.
    • 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.
    • 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.
    • 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.
    • isBackendPingable
      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.
    • 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.
    • 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.
    • 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.
    • populateServerRam
    • 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.
    • 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
      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
      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
      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
    • 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.
    • 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.
    • 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.
    • 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.
    • 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
    • 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.
    • 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_SecurityModule
    • SoftLayer_Hardware_SecurityModule
    • 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.
    • 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.
    • validatePartitionsForOperatingSystem
      Validates a collection of partitions for an operating system
    • validateSecurityLevel

Open Source SDKs

softlayer-python
 softlayer-java
 softlayer-go
 softlayer-perl
 softlayer-php
 softlayer-ruby

SL CLI

Standalone SoftLayer CLI
Installation
Documentation
Feature Request
Bug Report
Changelog

SL Plugin

Classic Infrastructure Plugin for ibmcloud CLI
Installation
Documentation
Feature Request
Bug Report
Changelog