SoftLayer Hardware
From SoftLayer Development Network Wiki
This page refers to the SoftLayer_Hardware service. For information on the SoftLayer_Hardware data type please see SoftLayer_Hardware (type).
Overview
Every SoftLayer hardware is defined in the SoftLayer_Hardware service. SoftLayer hardware has network components, software, monitoring services such as network monitoring, and hardware components such as hard drives. The SoftLayer_Hardware service is a convenient way to obtain general information about your SoftLayer hardware. Use the data returned by these methods with other API services to get more detailed information about your services and to make changes to your servers and services.
Endpoints
| SOAP WSDL | http://api.service.softlayer.com/soap/v3/SoftLayer_Hardware?wsdl |
| XML-RPC | http://api.service.softlayer.com/xmlrpc/v3/SoftLayer_Hardware |
Methods
findByIpAddress
Find hardware by its primary public or private IP (ipv4) address.
- returns
- parameters
- string ipAddress
getAccount
Retrieve the account that a hardware belongs to.
- returns
- parameters
- None
getAntivirusSpywareSoftwareComponent
Retrieve a antivirus / spyware software component object.
- returns
- parameters
- None
getAttributes
Retrieve a hardware's specific attributes.
- returns
- parameters
- None
getBackendIncomingBandwidth
Retrieve the amount of incoming private network bandwidth used by a server over a period of time.
- returns
- float
- parameters
getBackendNetworkComponents
Retrieve a hardware's backend or private network components. Network components are hardware components such as IPMI cards or Ethernet cards.
- returns
- parameters
- None
getBackendOutgoingBandwidth
Retrieve the amount of outgoing private network bandwidth used by a server over a period of time.
- returns
- float
- parameters
getBackendRouters
Retrieve a hardware's backend or private router.
- returns
- parameters
- None
getBandwidthAllocation
Retrieve a hardware's allotted bandwidth (measured in GB).
- returns
- decimal
- parameters
- None
getBandwidthAllotmentDetail
Retrieve a hardware's allotted detail record. Allotment details link bandwidth allocation with allotments.
- returns
- parameters
- None
getBenchmarkCertifications
Retrieve a hardware's benchmark certifications.
- returns
- parameters
- None
getBusinessContinuanceInsuranceFlag
Retrieve a flag indicating if a hardware has business continuance insurance. Business continuance insurance protects the owner from bandwidth overage charges in the event that the hardware is compromised from an unauthorized user.
- returns
- boolean
- parameters
- None
getComponents
Retrieve a hardware's components. Hardware components include hard drives, processors, drive controllers, etc.
- returns
- parameters
- None
getCurrentBillingDetail
Get the detail billing data for this instance's current billing period. This excludes bandwidth usage.
- returns
- parameters
- None
getCurrentBillingTotal
Get the total billing price for this instance's hourly usage up to this point. This includes total includes all bandwidth charges.
- returns
- decimal
- parameters
- None
getDailyAverage
calculate the average daily network traffic used by a server in gigabytes.
- returns
- float
- parameters
getDatacenter
Retrieve the datacenter that a piece of hardware resides in.
- returns
- parameters
- None
getDriveControllers
Retrieve the drive controllers contained within a piece of hardware.
- returns
- parameters
- None
getEvaultNetworkStorage
Retrieve a piece of hardware's associated EVault network storage service account.
- returns
- parameters
- None
getFirewallServiceComponent
Retrieve a hardware's hardware firewall services.
- returns
- parameters
- None
getFrontendIncomingBandwidth
Retrieve the amount of incoming public network bandwidth used by a server over a period of time.
- returns
- float
- parameters
getFrontendNetworkComponents
Retrieve a hardware's frontend or public network components. Network components are hardware components such as IPMI cards or Ethernet cards.
- returns
- parameters
- None
getFrontendOutgoingBandwidth
Retrieve the amount of outgoing public network bandwidth used by a server over a period of time.
- returns
- float
- parameters
getFrontendRouters
Retrieve a hardware's frontend or public router.
- returns
- parameters
- None
getHardDrives
Retrieve the hard drives contained within a piece of hardware.
- returns
- parameters
- None
getHardwareChassis
Retrieve the chassis that a piece of hardware is housed in.
- returns
- parameters
- None
getHardwareFunction
Retrieve a hardware's function.
- returns
- parameters
- None
getHardwareStatus
Retrieve a hardware's status.
- returns
- parameters
- None
getHostIpsSoftwareComponent
Retrieve a host IPS software component object.
- returns
- parameters
- None
getHourlyBandwidth
Retrieves bandwidth by hour over 24hours for a particular hardware id.
- returns
- parameters
- string mode
- dateTime day
getHourlyBillingFlag
Retrieve whether or not a server is billed hourly instead of monthly. This flag is only applicable to Bare Metal Instances.
- returns
- boolean
- parameters
- None
getLastTransaction
Retrieve the last transaction a server had performed.
- returns
- parameters
- None
getLocation
Retrieve where a piece of hardware is located within SoftLayer's location hierarchy.
- returns
- parameters
- None
getLockboxNetworkStorage
Retrieve a lockbox account associated with a server.
- returns
- parameters
- None
getMemory
Retrieve a hardware's memory.
- returns
- parameters
- None
getMemoryCapacity
Retrieve the amount of memory a piece of hardware has, measured in gigabytes.
- returns
- unsigned integer
- parameters
- None
getMetricTrackingObject
Retrieve a hardware's metric tracking object. This object records all periodic polled data available to this hardware.
- returns
- parameters
- None
getMonitoringServiceComponent
Retrieve a hardware's network monitoring services.
- returns
- parameters
- None
getMotherboard
Retrieve a hardware's motherboard.
- returns
- parameters
- None
getNetworkComponents
Retrieve a hardware's network components. Network components are hardware components such as IPMI cards or Ethernet cards.
- returns
- parameters
- None
getNetworkManagementIpAddress
Retrieve a hardware's network management IP address.
- returns
- string
- parameters
- None
getNetworkMonitors
Retrieve a hardware's network monitors.
- returns
- parameters
- None
getNetworkStorage
Retrieve a piece of hardware's associated network storage service account.
- returns
- parameters
- None
getNetworkVlans
Retrieve the network Vlan's that a hardware's network components are associated with.
- returns
- parameters
- None
getNextBillingCycleBandwidthAllocation
Retrieve a hardware's allotted bandwidth for the next billing cycle (measured in GB).
- returns
- decimal
- parameters
- None
getObject
Retrieve a SoftLayer_Hardware record.
- returns
- parameters
- None
getOperatingSystem
Retrieve a hardware's operating system.
- returns
- parameters
- None
getPrimaryBackendIpAddress
Retrieve the hardware's primary private IP address.
- returns
- string
- parameters
- None
getPrimaryBackendNetworkComponent
Retrieve the hardware's primary backend network component.
- returns
- parameters
- None
getPrimaryIpAddress
Retrieve the hardware's primary public IP address.
- returns
- string
- parameters
- None
getPrimaryNetworkComponent
Retrieve the hardware's primary public network component.
- returns
- parameters
- None
getProcessorCoreAmount
Retrieve the total number of processor cores, summed from all processors that are attached to a piece of hardware
- returns
- unsigned integer
- parameters
- None
getProcessors
Retrieve a hardware's processors.
- returns
- parameters
- None
getRaidControllers
Retrieve the RAID controllers contained within a piece of hardware.
- returns
- parameters
- None
getRemoteManagementComponent
Retrieve a hardware's associated remote management component. This is normally IPMI.
- returns
- parameters
- None
getSecurityScanRequests
Retrieve a hardware's vulnerability scan requests.
- returns
- parameters
- None
getSensorData
Retrieve a server's hardware state via it's internal sensors.
- returns
- parameters
- None
getSensorDataWithGraphs
Retrieve server's temperature and fan speed graphs as well the sensor raw data.
- returns
- parameters
- None
getServerFanSpeedGraphs
Retrieve server's fan speed graphs.
- returns
- parameters
- None
getServerPowerState
Retrieves server's power state
- returns
- string
- parameters
- None
getServerRoom
Retrieve the server room that a hardware is located at. There may be more than one server room for every data center.
- returns
- parameters
- None
getServerTemperatureGraphs
Retrieve server's temperature graphs
- returns
- parameters
- None
getSoftwareComponents
Retrieve a hardware's installed software.
- returns
- parameters
- None
getStorageNetworkComponents
Retrieve a hardware's private storage network components. Network components are hardware components such as IPMI cards or Ethernet cards.
- returns
- parameters
- None
getUpgradeItemPrices
Retrieve a list of upgradable items available to a piece of hardware.
- returns
- parameters
- None
getUpgradeRequest
Retrieve an account's associated upgrade request object if any.
- returns
- parameters
- None
getUplinkNetworkComponents
Retrieve the network component that is one level higher to a hardware on the network infrastructure. likely a switch or a router.
- returns
- parameters
- None
getVirtualHost
Retrieve a hardware's virtual host record.
- returns
- parameters
- None
getVirtualRack
Retrieve the name of the bandwidth allotment that a hardware belongs too.
- returns
- parameters
- None
getVirtualRackId
Retrieve the name of the bandwidth allotment that a hardware belongs too.
- returns
- integer
- parameters
- None
getVirtualRackName
Retrieve the name of the bandwidth allotment that a hardware belongs too.
- returns
- string
- parameters
- None
getVirtualizationPlatform
Retrieve a hardware's virtualization platform software.
- returns
- parameters
- None
importVirtualHost
attempt to import the host record for the virtualization platform running on a server
- returns
- parameters
- None
isPingable
Verifies if server is pingable.
- returns
- boolean
- parameters
- None
ping
Issues ping command.
- returns
- string
- parameters
- None
powerCycle
Issues power cycle to server.
- returns
- boolean
- parameters
- None
powerOff
Power off server.
- returns
- boolean
- parameters
- None
powerOn
Power on server.
- returns
- boolean
- parameters
- None
rebootDefault
Reboot the server via the default method.
- returns
- boolean
- parameters
- None
rebootHard
Reboot the server via "hard" reboot.
- returns
- boolean
- parameters
- None
rebootSoft
Reboot the server via gracefully (soft reboot).
- returns
- boolean
- parameters
- None

