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 Details

    • asAsync

      Server.ServiceAsync asAsync()
      Description copied from interface: Service
      Get an async version of this service
      Specified by:
      asAsync in interface Hardware.Service
      Specified by:
      asAsync in interface Service

    • withNewMask

      Server.Mask withNewMask()
      Description copied from interface: Maskable
      Overwrite the existing mask on this service with a new one and return it
      Specified by:
      withNewMask in interface Hardware.Service
      Specified by:
      withNewMask in interface Maskable

    • withMask

      Server.Mask withMask()
      Description copied from interface: Maskable
      Use the existing mask on this service or create it if not present
      Specified by:
      withMask in interface Hardware.Service
      Specified by:
      withMask in interface Maskable

    • setMask

      void setMask​(Server.Mask mask)

    • 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

    • createPostSoftwareInstallTransaction

      @ApiMethod(instanceRequired=true) Boolean createPostSoftwareInstallTransaction​(List<String> installCodes, Boolean returnBoolean)
      See Also:
      SoftLayer_Hardware_Server::createPostSoftwareInstallTransaction

    • editObject

      @ApiMethod(instanceRequired=true) Boolean editObject​(Server templateObject)
      Edit a server's properties
      See Also:
      SoftLayer_Hardware_Server::editObject

    • getBackendBandwidthUsage

      @ApiMethod(instanceRequired=true) List<Data> getBackendBandwidthUsage​(GregorianCalendar startDate, GregorianCalendar endDate)
      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
      See Also:
      SoftLayer_Hardware_Server::getBackendBandwidthUsage

    • getBackendBandwidthUse

      @ApiMethod(instanceRequired=true) List<Detail> getBackendBandwidthUse​(GregorianCalendar startDate, GregorianCalendar endDate)
      Use this method to return an array of private bandwidth utilization records between a given date range.
      See Also:
      SoftLayer_Hardware_Server::getBackendBandwidthUse

    • getBandwidthForDateRange

      @ApiMethod(instanceRequired=true) List<Data> getBandwidthForDateRange​(GregorianCalendar startDate, GregorianCalendar endDate)
      Retrieve a collection of bandwidth data from an individual public or private network tracking object. Data is ideal if you with to employ your own traffic storage and graphing systems.
      See Also:
      SoftLayer_Hardware_Server::getBandwidthForDateRange

    • getBandwidthImage

      @ApiMethod(instanceRequired=true) GraphOutputs getBandwidthImage​(String networkType, String snapshotRange, Boolean draw, GregorianCalendar dateSpecified, GregorianCalendar dateSpecifiedEnd)
      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.
      See Also:
      SoftLayer_Hardware_Server::getBandwidthImage

    • getBootModeOptions

      @ApiMethod(instanceRequired=true) List<String> getBootModeOptions()
      Retrieve the valid boot modes for this server
      See Also:
      SoftLayer_Hardware_Server::getBootModeOptions

    • getCurrentBenchmarkCertificationResultFile

      @ApiMethod(instanceRequired=true) byte[] 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.
      See Also:
      SoftLayer_Hardware_Server::getCurrentBenchmarkCertificationResultFile

    • getCustomBandwidthDataByDate

      @ApiMethod(instanceRequired=true) Graph getCustomBandwidthDataByDate​(Graph graphData)
      Retrieve bandwidth graph by date.
      See Also:
      SoftLayer_Hardware_Server::getCustomBandwidthDataByDate

    • getFirewallProtectableSubnets

      @ApiMethod(instanceRequired=true) List<Subnet> getFirewallProtectableSubnets()
      Get the subnets associated with this server that are protectable by a network component firewall.
      See Also:
      SoftLayer_Hardware_Server::getFirewallProtectableSubnets

    • getFrontendBandwidthUsage

      @ApiMethod(instanceRequired=true) List<Data> getFrontendBandwidthUsage​(GregorianCalendar startDate, GregorianCalendar endDate)
      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
      See Also:
      SoftLayer_Hardware_Server::getFrontendBandwidthUsage

    • getFrontendBandwidthUse

      @ApiMethod(instanceRequired=true) List<Detail> getFrontendBandwidthUse​(GregorianCalendar startDate, GregorianCalendar endDate)
      Use this method to return an array of public bandwidth utilization records between a given date range.
      See Also:
      SoftLayer_Hardware_Server::getFrontendBandwidthUse

    • getHardwareByIpAddress

      @ApiMethod Server getHardwareByIpAddress​(String ipAddress)
      Retrieve a server by searching for the primary IP address.
      See Also:
      SoftLayer_Hardware_Server::getHardwareByIpAddress

    • getItemPricesFromSoftwareDescriptions

      @ApiMethod(instanceRequired=true) List<Item> getItemPricesFromSoftwareDescriptions​(List<Description> softwareDescriptions, Boolean includeTranslationsFlag, Boolean returnAllPricesFlag)
      Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description
      See Also:
      SoftLayer_Hardware_Server::getItemPricesFromSoftwareDescriptions

    • getManagementNetworkComponent

      @ApiMethod(instanceRequired=true) Component getManagementNetworkComponent()
      Retrieve the remote management network component attached with this server.
      See Also:
      SoftLayer_Hardware_Server::getManagementNetworkComponent

    • getNetworkComponentFirewallProtectableIpAddresses

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

    • 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

    • getPrimaryDriveSize

      @ApiMethod(instanceRequired=true) Long getPrimaryDriveSize()
      See Also:
      SoftLayer_Hardware_Server::getPrimaryDriveSize

    • 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

    • getPrivateNetworkComponent

      @ApiMethod(instanceRequired=true) Component getPrivateNetworkComponent()
      Retrieve the private network component attached with this server.
      See Also:
      SoftLayer_Hardware_Server::getPrivateNetworkComponent

    • getPrivateVlan

      @ApiMethod(instanceRequired=true) Vlan getPrivateVlan()
      Retrieve the backend VLAN for the primary IP address of the server
      See Also:
      SoftLayer_Hardware_Server::getPrivateVlan

    • getPrivateVlanByIpAddress

      @ApiMethod Vlan getPrivateVlanByIpAddress​(String ipAddress)

      *** DEPRECATED ***
      Retrieve a backend network VLAN by searching for an IP address
      See Also:
      SoftLayer_Hardware_Server::getPrivateVlanByIpAddress

    • getProvisionDate

      @ApiMethod(instanceRequired=true) GregorianCalendar getProvisionDate()
      See Also:
      SoftLayer_Hardware_Server::getProvisionDate

    • 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

    • getPublicBandwidthTotal

      @ApiMethod(instanceRequired=true) Long getPublicBandwidthTotal​(Long startTime, Long endTime)
      Retrieve the total number of bytes used by a server over a specified time period via the data warehouse tracking objects for this hardware.
      See Also:
      SoftLayer_Hardware_Server::getPublicBandwidthTotal

    • getPublicNetworkComponent

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

    • getPublicVlan

      @ApiMethod(instanceRequired=true) Vlan getPublicVlan()
      Retrieve the frontend VLAN for the primary IP address of the server
      See Also:
      SoftLayer_Hardware_Server::getPublicVlan

    • getPublicVlanByHostname

      @ApiMethod Vlan getPublicVlanByHostname​(String hostname)
      Retrieve the frontend network Vlan by searching the hostname of a server
      See Also:
      SoftLayer_Hardware_Server::getPublicVlanByHostname

    • getReverseDomainRecords

      @ApiMethod(instanceRequired=true) List<Domain> getReverseDomainRecords()
      Retrieve the reverse domain records associated with this server.
      See Also:
      SoftLayer_Hardware_Server::getReverseDomainRecords

    • 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

    • getSensorDataWithGraphsForServer

      @ApiMethod(value="getSensorDataWithGraphs", instanceRequired=true) SensorReadingsWithGraphs getSensorDataWithGraphsForServer()
      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.
      See Also:
      SoftLayer_Hardware_Server::getSensorDataWithGraphs

    • 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

    • getServerFanSpeedGraphsForServer

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

    • getServerPowerStateForServer

      @ApiMethod(value="getServerPowerState", instanceRequired=true) String getServerPowerStateForServer()
      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'.
      See Also:
      SoftLayer_Hardware_Server::getServerPowerState

    • getServerTemperatureGraphsForServer

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

    • getValidBlockDeviceTemplateGroups

      @ApiMethod(instanceRequired=true) List<Group> getValidBlockDeviceTemplateGroups​(String visibility)
      This method will return the list of block device template groups that are valid to the host. For instance, it will only retrieve FLEX images.
      See Also:
      SoftLayer_Hardware_Server::getValidBlockDeviceTemplateGroups

    • getWindowsUpdateAvailableUpdates

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

    • getWindowsUpdateInstalledUpdates

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

    • getWindowsUpdateStatus

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

    • initiateIderaBareMetalRestore

      @ApiMethod(instanceRequired=true) Boolean initiateIderaBareMetalRestore()
      Idera Bare Metal Server Restore is a backup agent designed specifically for making full system restores made with Idera Server Backup.
      See Also:
      SoftLayer_Hardware_Server::initiateIderaBareMetalRestore

    • initiateR1SoftBareMetalRestore

      @ApiMethod(instanceRequired=true) Boolean initiateR1SoftBareMetalRestore()
      R1Soft Bare Metal Server Restore is an R1Soft disk agent designed specifically for making full system restores made with R1Soft CDP Server backup.
      See Also:
      SoftLayer_Hardware_Server::initiateR1SoftBareMetalRestore

    • isBackendPingable

      @ApiMethod(instanceRequired=true) Boolean isBackendPingable()
      Issues a ping command and returns the success (true) or failure (false) of the ping command.
      See Also:
      SoftLayer_Hardware_Server::isBackendPingable

    • isPingableForServer

      @ApiMethod(value="isPingable", instanceRequired=true) Boolean isPingableForServer()
      Issues a ping command and returns the success (true) or failure (false) of the ping command.
      See Also:
      SoftLayer_Hardware_Server::isPingable

    • isWindowsServer

      @ApiMethod(instanceRequired=true) Boolean isWindowsServer()
      Determine if the server runs any version of the Microsoft Windows operating systems. Return ''true'' if it does and ''false if otherwise.
      See Also:
      SoftLayer_Hardware_Server::isWindowsServer

    • 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

    • massSparePool

      @ApiMethod List<Request> massSparePool​(List<String> hardwareIds, String action, Boolean newOrder)
      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.
      See Also:
      SoftLayer_Hardware_Server::massSparePool

    • pingForServer

      @ApiMethod(value="ping", instanceRequired=true) String pingForServer()
      Issues a ping command to the server and returns the ping response.
      See Also:
      SoftLayer_Hardware_Server::ping

    • populateServerRam

      @ApiMethod(instanceRequired=true) Void populateServerRam​(String ramSerialString)
      See Also:
      SoftLayer_Hardware_Server::populateServerRam

    • 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

    • powerOffForServer

      @ApiMethod(value="powerOff", instanceRequired=true) Boolean powerOffForServer()
      This method will power off the server via the server's remote management card.
      See Also:
      SoftLayer_Hardware_Server::powerOff

    • 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

    • setOperatingSystemPassword

      @ApiMethod(instanceRequired=true) Boolean setOperatingSystemPassword​(String newPassword)
      Changes the password that we have stored in our database for a servers' Operating System
      See Also:
      SoftLayer_Hardware_Server::setOperatingSystemPassword

    • 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

    • setUserMetadata

      @ApiMethod(instanceRequired=true) List<Attribute> setUserMetadata​(List<String> metadata)
      Sets the data that will be written to the configuration drive.
      See Also:
      SoftLayer_Hardware_Server::setUserMetadata

    • 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

    • sparePool

      @ApiMethod(instanceRequired=true) Boolean sparePool​(String action, Boolean newOrder)
      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.
      See Also:
      SoftLayer_Hardware_Server::sparePool

    • testRaidAlertService

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

    • toggleManagementInterface

      @ApiMethod(instanceRequired=true) Boolean toggleManagementInterface​(Boolean enabled)
      Attempt to toggle the IPMI interface. If there is an active transaction on the server, it will throw an exception. This method creates a transaction to toggle the interface. It is not instant.
      See Also:
      SoftLayer_Hardware_Server::toggleManagementInterface

    • updateIpmiPassword

      @ApiMethod(instanceRequired=true) Boolean updateIpmiPassword​(String password)
      This method will update the root IPMI password on this SoftLayer_Hardware.
      Specified by:
      updateIpmiPassword in interface Hardware.Service
      See Also:
      SoftLayer_Hardware_Server::updateIpmiPassword

    • validatePartitionsForOperatingSystem

      @ApiMethod Boolean validatePartitionsForOperatingSystem​(Description operatingSystem, List<Partition> partitions)
      Validates a collection of partitions for an operating system
      See Also:
      SoftLayer_Hardware_Server::validatePartitionsForOperatingSystem

    • getActiveNetworkFirewallBillingItem

      @ApiMethod(instanceRequired=true) Item getActiveNetworkFirewallBillingItem()
      The billing item for a server's attached network firewall.
      See Also:
      SoftLayer_Hardware_Server::getActiveNetworkFirewallBillingItem

    • getActiveTickets

      @ApiMethod(instanceRequired=true) List<Ticket> getActiveTickets()
      See Also:
      SoftLayer_Hardware_Server::getActiveTickets

    • getActiveTransaction

      @ApiMethod(instanceRequired=true) Transaction getActiveTransaction()
      Transaction currently running for server.
      See Also:
      SoftLayer_Hardware_Server::getActiveTransaction

    • getActiveTransactions

      @ApiMethod(instanceRequired=true) List<Transaction> getActiveTransactions()
      Any active transaction(s) that are currently running for the server (example: os reload).
      See Also:
      SoftLayer_Hardware_Server::getActiveTransactions

    • getAvailableMonitoring

      @ApiMethod(instanceRequired=true) List<Stratum> getAvailableMonitoring()
      An object that stores the maximum level for the monitoring query types and response types.
      See Also:
      SoftLayer_Hardware_Server::getAvailableMonitoring

    • getAverageDailyBandwidthUsage

      @ApiMethod(instanceRequired=true) BigDecimal getAverageDailyBandwidthUsage()
      The average daily total bandwidth usage for the current billing cycle.
      See Also:
      SoftLayer_Hardware_Server::getAverageDailyBandwidthUsage

    • getAverageDailyPrivateBandwidthUsage

      @ApiMethod(instanceRequired=true) BigDecimal getAverageDailyPrivateBandwidthUsage()
      The average daily private bandwidth usage for the current billing cycle.
      See Also:
      SoftLayer_Hardware_Server::getAverageDailyPrivateBandwidthUsage

    • getBillingCycleBandwidthUsage

      @ApiMethod(instanceRequired=true) List<Usage> getBillingCycleBandwidthUsage()
      The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to.
      See Also:
      SoftLayer_Hardware_Server::getBillingCycleBandwidthUsage

    • getBillingCyclePrivateBandwidthUsage

      @ApiMethod(instanceRequired=true) Usage getBillingCyclePrivateBandwidthUsage()
      The raw private bandwidth usage data for the current billing cycle.
      See Also:
      SoftLayer_Hardware_Server::getBillingCyclePrivateBandwidthUsage

    • getBillingCyclePublicBandwidthUsage

      @ApiMethod(instanceRequired=true) Usage getBillingCyclePublicBandwidthUsage()
      The raw public bandwidth usage data for the current billing cycle.
      See Also:
      SoftLayer_Hardware_Server::getBillingCyclePublicBandwidthUsage

    • getBiosPasswordNullFlag

      @ApiMethod(instanceRequired=true) Boolean getBiosPasswordNullFlag()
      Determine if BIOS password should be left as null.
      See Also:
      SoftLayer_Hardware_Server::getBiosPasswordNullFlag

    • getCaptureEnabledFlag

      @ApiMethod(instanceRequired=true) CaptureEnabled getCaptureEnabledFlag()
      Determine if the server is able to be image captured. If unable to image capture a reason will be provided.
      See Also:
      SoftLayer_Hardware_Server::getCaptureEnabledFlag

    • getContainsSolidStateDrivesFlag

      @ApiMethod(instanceRequired=true) Boolean getContainsSolidStateDrivesFlag()
      See Also:
      SoftLayer_Hardware_Server::getContainsSolidStateDrivesFlag

    • getControlPanel

      @ApiMethod(instanceRequired=true) ControlPanel getControlPanel()
      A server's control panel.
      See Also:
      SoftLayer_Hardware_Server::getControlPanel

    • getCost

      @ApiMethod(instanceRequired=true) BigDecimal getCost()
      The total cost of a server, measured in US Dollars ($USD).
      See Also:
      SoftLayer_Hardware_Server::getCost

    • getCurrentBandwidthSummary

      @ApiMethod(instanceRequired=true) Summary getCurrentBandwidthSummary()
      An object that provides commonly used bandwidth summary components for the current billing cycle.
      See Also:
      SoftLayer_Hardware_Server::getCurrentBandwidthSummary

    • getCustomerInstalledOperatingSystemFlag

      @ApiMethod(instanceRequired=true) Boolean getCustomerInstalledOperatingSystemFlag()
      Indicates if a server has a Customer Installed OS
      See Also:
      SoftLayer_Hardware_Server::getCustomerInstalledOperatingSystemFlag

    • getCustomerOwnedFlag

      @ApiMethod(instanceRequired=true) Boolean getCustomerOwnedFlag()
      Indicates if a server is a customer owned device.
      See Also:
      SoftLayer_Hardware_Server::getCustomerOwnedFlag

    • getHasSingleRootVirtualizationBillingItemFlag

      @ApiMethod(instanceRequired=true) Boolean getHasSingleRootVirtualizationBillingItemFlag()
      Determine if hardware has Single Root IO VIrtualization (SR-IOV) billing item.
      See Also:
      SoftLayer_Hardware_Server::getHasSingleRootVirtualizationBillingItemFlag

    • getInboundPrivateBandwidthUsage

      @ApiMethod(instanceRequired=true) BigDecimal getInboundPrivateBandwidthUsage()
      The total private inbound bandwidth for this hardware for the current billing cycle.
      See Also:
      SoftLayer_Hardware_Server::getInboundPrivateBandwidthUsage

    • getIsCloudReadyNodeCertified

      @ApiMethod(instanceRequired=true) Boolean getIsCloudReadyNodeCertified()
      Determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute.
      See Also:
      SoftLayer_Hardware_Server::getIsCloudReadyNodeCertified

    • getIsIpmiDisabled

      @ApiMethod(instanceRequired=true) Boolean getIsIpmiDisabled()
      Determine if remote management has been disabled due to port speed.
      See Also:
      SoftLayer_Hardware_Server::getIsIpmiDisabled

    • getIsVirtualPrivateCloudNode

      @ApiMethod(instanceRequired=true) Boolean getIsVirtualPrivateCloudNode()
      Determine if hardware object is a Virtual Private Cloud node.
      See Also:
      SoftLayer_Hardware_Server::getIsVirtualPrivateCloudNode

    • getLastOperatingSystemReload

      @ApiMethod(instanceRequired=true) Transaction getLastOperatingSystemReload()
      The last transaction that a server's operating system was loaded.
      See Also:
      SoftLayer_Hardware_Server::getLastOperatingSystemReload

    • getLogicalVolumeStorageGroups

      @ApiMethod(instanceRequired=true) List<Group> getLogicalVolumeStorageGroups()
      Returns a list of logical volumes on the physical machine.
      See Also:
      SoftLayer_Hardware_Server::getLogicalVolumeStorageGroups

    • getMetricTrackingObjectId

      @ApiMethod(instanceRequired=true) Long getMetricTrackingObjectId()
      The metric tracking object id for this server.
      See Also:
      SoftLayer_Hardware_Server::getMetricTrackingObjectId

    • getMonitoringUserNotification

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

    • getOpenCancellationTicket

      @ApiMethod(instanceRequired=true) Ticket getOpenCancellationTicket()
      An open ticket requesting cancellation of this server, if one exists.
      See Also:
      SoftLayer_Hardware_Server::getOpenCancellationTicket

    • getOutboundPrivateBandwidthUsage

      @ApiMethod(instanceRequired=true) BigDecimal getOutboundPrivateBandwidthUsage()
      The total private outbound bandwidth for this hardware for the current billing cycle.
      See Also:
      SoftLayer_Hardware_Server::getOutboundPrivateBandwidthUsage

    • getOverBandwidthAllocationFlag

      @ApiMethod(instanceRequired=true) Long getOverBandwidthAllocationFlag()
      Whether the bandwidth usage for this hardware for the current billing cycle exceeds the allocation.
      See Also:
      SoftLayer_Hardware_Server::getOverBandwidthAllocationFlag

    • getPrivateIpAddress

      @ApiMethod(instanceRequired=true) String getPrivateIpAddress()
      A server's primary private IP address.
      See Also:
      SoftLayer_Hardware_Server::getPrivateIpAddress

    • getProjectedOverBandwidthAllocationFlag

      @ApiMethod(instanceRequired=true) Long getProjectedOverBandwidthAllocationFlag()
      Whether the bandwidth usage for this hardware for the current billing cycle is projected to exceed the allocation.
      See Also:
      SoftLayer_Hardware_Server::getProjectedOverBandwidthAllocationFlag

    • getProjectedPublicBandwidthUsage

      @ApiMethod(instanceRequired=true) BigDecimal getProjectedPublicBandwidthUsage()
      The projected public outbound bandwidth for this hardware for the current billing cycle.
      See Also:
      SoftLayer_Hardware_Server::getProjectedPublicBandwidthUsage

    • getReadyNodeFlag

      @ApiMethod(instanceRequired=true) Boolean getReadyNodeFlag()
      Determine if hardware object is vSan Ready Node.
      See Also:
      SoftLayer_Hardware_Server::getReadyNodeFlag

    • getRecentRemoteManagementCommands

      @ApiMethod(instanceRequired=true) List<Request> getRecentRemoteManagementCommands()
      The last five commands issued to the server's remote management card.
      See Also:
      SoftLayer_Hardware_Server::getRecentRemoteManagementCommands

    • getRegionalInternetRegistry

      @ApiMethod(instanceRequired=true) Registry getRegionalInternetRegistry()
      See Also:
      SoftLayer_Hardware_Server::getRegionalInternetRegistry

    • getRemoteManagement

      @ApiMethod(instanceRequired=true) RemoteManagement getRemoteManagement()
      A server's remote management card.
      See Also:
      SoftLayer_Hardware_Server::getRemoteManagement

    • getRemoteManagementUsers

      @ApiMethod(instanceRequired=true) List<User> getRemoteManagementUsers()
      User(s) who have access to issue commands and/or interact with the server's remote management card.
      See Also:
      SoftLayer_Hardware_Server::getRemoteManagementUsers

    • getSoftwareGuardExtensionEnabled

      @ApiMethod(instanceRequired=true) Boolean getSoftwareGuardExtensionEnabled()
      Determine if hardware object has Software Guard Extension (SGX) enabled.
      See Also:
      SoftLayer_Hardware_Server::getSoftwareGuardExtensionEnabled

    • getStatisticsRemoteManagement

      @ApiMethod(instanceRequired=true) RemoteManagement getStatisticsRemoteManagement()
      A server's remote management card used for statistics.
      See Also:
      SoftLayer_Hardware_Server::getStatisticsRemoteManagement

    • getUefiBootFlag

      @ApiMethod(instanceRequired=true) Boolean getUefiBootFlag()
      Whether to use UEFI boot instead of BIOS.
      See Also:
      SoftLayer_Hardware_Server::getUefiBootFlag

    • getUsers

      @ApiMethod(instanceRequired=true) List<Customer> getUsers()
      A list of users that have access to this computing instance.
      See Also:
      SoftLayer_Hardware_Server::getUsers

    • getVirtualGuests

      @ApiMethod(instanceRequired=true) List<Guest> getVirtualGuests()
      A hardware server's virtual servers.
      See Also:
      SoftLayer_Hardware_Server::getVirtualGuests