Package com.softlayer.api.service.hardware

Interface Server.Service

  • All Superinterfaces:
    Hardware.Service, Maskable, ResultLimitable, Service
    All Known Subinterfaces:
    SecurityModule.Service, SecurityModule750.Service
    Enclosing class:
    Server
    @ApiService("SoftLayer_Hardware_Server")
public static interface Server.Service
extends Hardware.Service
    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.
    See Also:
    SoftLayer_Hardware_Server

    • Method Detail

      • activatePrivatePort

        @ApiMethod(instanceRequired=true)
Boolean activatePrivatePort()
        Activate a server's private network interface to the maximum available speed. This operation is an alias for [[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.
        See Also:
        SoftLayer_Hardware_Server::activatePrivatePort

      • activatePublicPort

        @ApiMethod(instanceRequired=true)
Boolean activatePublicPort()
        Activate a server's public network interface to the maximum available speed. This operation is an alias for [[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.
        See Also:
        SoftLayer_Hardware_Server::activatePublicPort

      • bootToRescueLayer

        @ApiMethod(instanceRequired=true)
Boolean bootToRescueLayer​(String noOsBootEnvironment)
        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.
        See Also:
        SoftLayer_Hardware_Server::bootToRescueLayer

      • createFirmwareReflashTransaction

        @ApiMethod(instanceRequired=true)
Boolean createFirmwareReflashTransaction​(Long ipmi,
                                         Long raidController,
                                         Long bios)
        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.
        See Also:
        SoftLayer_Hardware_Server::createFirmwareReflashTransaction

      • createFirmwareUpdateTransaction

        @ApiMethod(instanceRequired=true)
Boolean createFirmwareUpdateTransaction​(Long ipmi,
                                        Long raidController,
                                        Long bios,
                                        Long harddrive)
        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.
        See Also:
        SoftLayer_Hardware_Server::createFirmwareUpdateTransaction

      • createHyperThreadingUpdateTransaction

        @ApiMethod(instanceRequired=true)
Boolean createHyperThreadingUpdateTransaction​(Long disableHyperthreading)
        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.
        See Also:
        SoftLayer_Hardware_Server::createHyperThreadingUpdateTransaction

      • createObject

        @ApiMethod
Server createObject​(Server templateObject)


        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|getObject]],
        checking the provisionDate property.
        When provisionDate is not null, the server will be ready. Be sure to use the globalIdentifier
        as your initialization parameter.


        Warning: Servers created via this method will incur charges on your account. For testing input parameters see [[SoftLayer_Hardware/generateOrderTemplate|generateOrderTemplate]].


        Input - [[SoftLayer_Hardware (type)|SoftLayer_Hardware]]

        • hostname
          Hostname for the server.

          • Required

          • Type - string





        • domain
          Domain for the server.

          • Required

          • Type - string





        • processorCoreAmount
          The number of logical CPU cores to allocate.

          • Required

          • Type - int

          • See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.





        • memoryCapacity
          The amount of memory to allocate in gigabytes.

          • Required

          • Type - int

          • See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.





        • hourlyBillingFlag
          Specifies the billing type for the server.

          • Required

          • Type - boolean

          • When true the server will be billed on hourly usage, otherwise it will be billed on a monthly basis.





        • operatingSystemReferenceCode
          An identifier for the operating system to provision the server with.

          • Required

          • Type - string

          • See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.





        • datacenter.name
          Specifies which datacenter the server is to be provisioned in.

          • Required

          • Type - string

          • The datacenter property is a [[SoftLayer_Location (type)|location]] structure with the name field set.

          • See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.


          {
          "datacenter": {
          "name": "dal05"
          }
          }



        • networkComponents.maxSpeed
          Specifies the connection speed for the server's network components.

          • Optional

          • Type - int

          • Default - The highest available zero cost port speed will be used.

          • Description - The networkComponents property is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. The maxSpeed property must be set to specify the network uplink speed, in megabits per second, of the server.

          • See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.


          {
          "networkComponents": [
          {
          "maxSpeed": 1000
          }
          ]
          }



        • networkComponents.redundancyEnabledFlag
          Specifies whether or not the server's network components should be in redundancy groups.

          • Optional

          • Type - bool

          • Default - false

          • Description - The networkComponents property is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. When the redundancyEnabledFlag property is true the server's network components will be in redundancy groups.


          {
          "networkComponents": [
          {
          "redundancyEnabledFlag": false
          }
          ]
          }



        • privateNetworkOnlyFlag
          Specifies whether or not the server only has access to the private network

          • Optional

          • Type - boolean

          • Default - false

          • When true this flag specifies that a server is to only have access to the private network.





        • primaryNetworkComponent.networkVlan.id
          Specifies the network vlan which is to be used for the frontend interface of the server.

          • Optional

          • Type - int

          • Description - The primaryNetworkComponent property is a [[SoftLayer_Network_Component (type)|network component]] structure with the networkVlan property populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. The id property must be set to specify the frontend network vlan of the server.


          {
          "primaryNetworkComponent": {
          "networkVlan": {
          "id": 1
          }
          }
          }



        • primaryBackendNetworkComponent.networkVlan.id
          Specifies the network vlan which is to be used for the backend interface of the server.

          • Optional

          • Type - int

          • Description - The primaryBackendNetworkComponent property is a [[SoftLayer_Network_Component (type)|network component]] structure with the networkVlan property populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. The id property must be set to specify the backend network vlan of the server.


          {
          "primaryBackendNetworkComponent": {
          "networkVlan": {
          "id": 2
          }
          }
          }



        • fixedConfigurationPreset.keyName

          • Optional

          • Type - string

          • Description - The fixedConfigurationPreset property is a [[SoftLayer_Product_Package_Preset (type)|fixed configuration preset]] structure. The keyName property must be set to specify preset to use.

          • If a fixed configuration preset is used processorCoreAmount, memoryCapacity and hardDrives properties must not be set.

          • See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.


          {
          "fixedConfigurationPreset": {
          "keyName": "SOME_KEY_NAME"
          }
          }



        • userData.value
          Arbitrary data to be made available to the server.

          • Optional

          • Type - string

          • Description - The userData property is an array with a single [[SoftLayer_Hardware_Attribute (type)|attribute]] structure with the value property set to an arbitrary value.

          • This value can be retrieved via the [[SoftLayer_Resource_Metadata/getUserMetadata|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.


          {
          "userData": [
          {
          "value": "someValue"
          }
          ]
          }



        • hardDrives
          Hard drive settings for the server

          • Optional

          • Type - SoftLayer_Hardware_Component

          • Default - The largest available capacity for a zero cost primary disk will be used.

          • Description - The hardDrives property is an array of [[SoftLayer_Hardware_Component (type)|hardware component]] structures.
          • Each hard drive must specify the capacity property.

          • See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.


          {
          "hardDrives": [
          {
          "capacity": 500
          }
          ]
          }



        • sshKeys
          SSH keys to install on the server upon provisioning.

          • Optional

          • Type - array of [[SoftLayer_Security_Ssh_Key (type)|SoftLayer_Security_Ssh_Key]]

          • Description - The sshKeys property is an array of [[SoftLayer_Security_Ssh_Key (type)|SSH Key]] structures with the id property set to the value of an existing SSH key.

          • To create a new SSH key, call [[SoftLayer_Security_Ssh_Key/createObject|createObject]] on the [[SoftLayer_Security_Ssh_Key]] service.

          • To obtain a list of existing SSH keys, call [[SoftLayer_Account/getSshKeys|getSshKeys]] on the [[SoftLayer_Account]] service.

          {
          "sshKeys": [
          {
          "id": 123
          }
          ]
          }



        • postInstallScriptUri
          Specifies the uri location of the script to be downloaded and run after installation is complete.

          • Optional

          • Type - string








        REST Example


        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/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
        }
        See Also:
        SoftLayer_Hardware_Server::createObject

      • getObjectForServer

        @ApiMethod(value="getObject",
           instanceRequired=true)
Server getObjectForServer()
        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.
        See Also:
        SoftLayer_Hardware_Server::getObject

      • getPMInfo

        @ApiMethod(instanceRequired=true)
List<PmInfo> 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.
        See Also:
        SoftLayer_Hardware_Server::getPMInfo

      • getPrivateBandwidthDataSummary

        @ApiMethod(instanceRequired=true)
Summary 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.
        See Also:
        SoftLayer_Hardware_Server::getPrivateBandwidthDataSummary

      • getPrivateBandwidthGraphImage

        @ApiMethod(instanceRequired=true)
byte[] getPrivateBandwidthGraphImage​(String startTime,
                                     String endTime)
        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
        See Also:
        SoftLayer_Hardware_Server::getPrivateBandwidthGraphImage

      • getPublicBandwidthDataSummary

        @ApiMethod(instanceRequired=true)
Summary 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.
        See Also:
        SoftLayer_Hardware_Server::getPublicBandwidthDataSummary

      • getPublicBandwidthGraphImage

        @ApiMethod(instanceRequired=true)
byte[] getPublicBandwidthGraphImage​(GregorianCalendar startTime,
                                    GregorianCalendar endTime)
        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.
        See Also:
        SoftLayer_Hardware_Server::getPublicBandwidthGraphImage

      • getSensorDataForServer

        @ApiMethod(value="getSensorData",
           instanceRequired=true)
List<SensorReading> getSensorDataForServer()
        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.
        See Also:
        SoftLayer_Hardware_Server::getSensorData

      • getServerDetails

        @ApiMethod(instanceRequired=true)
Details 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]], [[SoftLayer_Hardware_Server::getSoftware]], and [[SoftLayer_Hardware_Server::getNetworkComponents]] in a single container.
        See Also:
        SoftLayer_Hardware_Server::getServerDetails

      • massFirmwareReflash

        @ApiMethod
List<Request> massFirmwareReflash​(List<Long> hardwareIds,
                                  Boolean ipmi,
                                  Boolean raidController,
                                  Boolean bios)
        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.
        See Also:
        SoftLayer_Hardware_Server::massFirmwareReflash

      • massFirmwareUpdate

        @ApiMethod
List<Request> massFirmwareUpdate​(List<Long> hardwareIds,
                                 Boolean ipmi,
                                 Boolean raidController,
                                 Boolean bios,
                                 Boolean harddrive)
        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.
        See Also:
        SoftLayer_Hardware_Server::massFirmwareUpdate

      • massHyperThreadingUpdate

        @ApiMethod
List<Request> massHyperThreadingUpdate​(List<Long> hardwareIds,
                                       Boolean disableHyperthreading)
        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.
        See Also:
        SoftLayer_Hardware_Server::massHyperThreadingUpdate

      • massReloadOperatingSystem

        @ApiMethod
String massReloadOperatingSystem​(List<String> hardwareIds,
                                 String token,
                                 Configuration config)
        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.
        See Also:
        SoftLayer_Hardware_Server::massReloadOperatingSystem

      • powerCycleForServer

        @ApiMethod(value="powerCycle",
           instanceRequired=true)
Boolean powerCycleForServer()
        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.
        See Also:
        SoftLayer_Hardware_Server::powerCycle

      • powerOnForServer

        @ApiMethod(value="powerOn",
           instanceRequired=true)
Boolean powerOnForServer()
        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.
        See Also:
        SoftLayer_Hardware_Server::powerOn

      • rebootDefaultForServer

        @ApiMethod(value="rebootDefault",
           instanceRequired=true)
Boolean rebootDefaultForServer()
        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.
        See Also:
        SoftLayer_Hardware_Server::rebootDefault

      • rebootHardForServer

        @ApiMethod(value="rebootHard",
           instanceRequired=true)
Boolean rebootHardForServer()
        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.
        See Also:
        SoftLayer_Hardware_Server::rebootHard

      • rebootSoftForServer

        @ApiMethod(value="rebootSoft",
           instanceRequired=true)
Boolean rebootSoftForServer()
        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.
        See Also:
        SoftLayer_Hardware_Server::rebootSoft

      • reloadCurrentOperatingSystemConfiguration

        @ApiMethod(instanceRequired=true)
String reloadCurrentOperatingSystemConfiguration​(String token)
        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.
        See Also:
        SoftLayer_Hardware_Server::reloadCurrentOperatingSystemConfiguration

      • reloadOperatingSystem

        @ApiMethod(instanceRequired=true)
String reloadOperatingSystem​(String token,
                             Configuration config)
        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.
        See Also:
        SoftLayer_Hardware_Server::reloadOperatingSystem

      • runPassmarkCertificationBenchmark

        @ApiMethod(instanceRequired=true)
Boolean 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.
        See Also:
        SoftLayer_Hardware_Server::runPassmarkCertificationBenchmark

      • setPrivateNetworkInterfaceSpeed

        @ApiMethod(instanceRequired=true)
Boolean setPrivateNetworkInterfaceSpeed​(Long newSpeed,
                                        String redundancy)
        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.

        Backwards Compatibility Until February 27th, 2019



        In order to provide a period of transition to the new API, some backwards compatible behaviors will be active during this period.
        • 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.
        • A non-doubled (eg. 100) speed value without a redundancy value will be translated to a redundancy value of "degraded".
        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.
        See Also:
        SoftLayer_Hardware_Server::setPrivateNetworkInterfaceSpeed

      • setPublicNetworkInterfaceSpeed

        @ApiMethod(instanceRequired=true)
Boolean setPublicNetworkInterfaceSpeed​(Long newSpeed,
                                       String redundancy)
        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.

        Backwards Compatibility Until February 27th, 2019



        In order to provide a period of transition to the new API, some backwards compatible behaviors will be active during this period.
        • 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.
        • A non-doubled (eg. 100) speed value without a redundancy value will be translated to a redundancy value of "degraded".
        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.
        See Also:
        SoftLayer_Hardware_Server::setPublicNetworkInterfaceSpeed

      • shutdownPrivatePort

        @ApiMethod(instanceRequired=true)
Boolean shutdownPrivatePort()
        Disconnect a server's private network interface. This operation is an alias for calling [[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.
        See Also:
        SoftLayer_Hardware_Server::shutdownPrivatePort

      • shutdownPublicPort

        @ApiMethod(instanceRequired=true)
Boolean shutdownPublicPort()
        Disconnect a server's public network interface. This operation is an alias for [[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.
        See Also:
        SoftLayer_Hardware_Server::shutdownPublicPort