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).

Contents 1 Overview 2 Endpoints 3 Methods 3.1 findByIpAddress 3.2 getAccount 3.3 getAntivirusSpywareSoftwareComponent 3.4 getAttributes 3.5 getBackendIncomingBandwidth 3.6 getBackendNetworkComponents 3.7 getBackendOutgoingBandwidth 3.8 getBackendRouters 3.9 getBandwidthAllocation 3.10 getBandwidthAllotmentDetail 3.11 getBenchmarkCertifications 3.12 getBusinessContinuanceInsuranceFlag 3.13 getComponents 3.14 getCurrentBillingDetail 3.15 getCurrentBillingTotal 3.16 getDailyAverage 3.17 getDatacenter 3.18 getDriveControllers 3.19 getEvaultNetworkStorage 3.20 getFirewallServiceComponent 3.21 getFrontendIncomingBandwidth 3.22 getFrontendNetworkComponents 3.23 getFrontendOutgoingBandwidth 3.24 getFrontendRouters 3.25 getHardDrives 3.26 getHardwareChassis 3.27 getHardwareFunction 3.28 getHardwareStatus 3.29 getHostIpsSoftwareComponent 3.30 getHourlyBandwidth 3.31 getHourlyBillingFlag 3.32 getLastTransaction 3.33 getLocation 3.34 getLockboxNetworkStorage 3.35 getMemory 3.36 getMemoryCapacity 3.37 getMetricTrackingObject 3.38 getMonitoringServiceComponent 3.39 getMotherboard 3.40 getNetworkComponents 3.41 getNetworkManagementIpAddress 3.42 getNetworkMonitors 3.43 getNetworkStorage 3.44 getNetworkVlans 3.45 getNextBillingCycleBandwidthAllocation 3.46 getObject 3.47 getOperatingSystem 3.48 getPrimaryBackendIpAddress 3.49 getPrimaryBackendNetworkComponent 3.50 getPrimaryIpAddress 3.51 getPrimaryNetworkComponent 3.52 getProcessorCoreAmount 3.53 getProcessors 3.54 getRaidControllers 3.55 getRemoteManagementComponent 3.56 getSecurityScanRequests 3.57 getSensorData 3.58 getSensorDataWithGraphs 3.59 getServerFanSpeedGraphs 3.60 getServerPowerState 3.61 getServerRoom 3.62 getServerTemperatureGraphs 3.63 getSoftwareComponents 3.64 getStorageNetworkComponents 3.65 getUpgradeItemPrices 3.66 getUpgradeRequest 3.67 getUplinkNetworkComponents 3.68 getVirtualHost 3.69 getVirtualRack 3.70 getVirtualRackId 3.71 getVirtualRackName 3.72 getVirtualizationPlatform 3.73 importVirtualHost 3.74 isPingable 3.75 ping 3.76 powerCycle 3.77 powerOff 3.78 powerOn 3.79 rebootDefault 3.80 rebootHard 3.81 rebootSoft

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

SoftLayer_Hardware

• parameters

string ipAddress

---

getAccount

Retrieve the account that a hardware belongs to.

• returns

SoftLayer_Account

• parameters

None

---

getAntivirusSpywareSoftwareComponent

Retrieve a antivirus / spyware software component object.

• returns

SoftLayer_Software_Component

• parameters

None

---

getAttributes

Retrieve a hardware's specific attributes.

• returns

SoftLayer_Hardware_AttributeArray

• parameters

None

---

getBackendIncomingBandwidth

Retrieve the amount of incoming private network bandwidth used by a server over a period of time.

• returns

float

• parameters

dateTime startDate

dateTime endDate

---

getBackendNetworkComponents

Retrieve a hardware's backend or private network components. Network components are hardware components such as IPMI cards or Ethernet cards.

• returns

SoftLayer_Network_ComponentArray

• parameters

None

---

getBackendOutgoingBandwidth

Retrieve the amount of outgoing private network bandwidth used by a server over a period of time.

• returns

float

• parameters

dateTime startDate

dateTime endDate

---

getBackendRouters

Retrieve a hardware's backend or private router.

• returns

SoftLayer_Network_Component_Uplink_HardwareArray

• 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

SoftLayer_Network_Bandwidth_Version1_Allotment_Detail

• parameters

None

---

getBenchmarkCertifications

Retrieve a hardware's benchmark certifications.

• returns

SoftLayer_Hardware_Benchmark_CertificationArray

• 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

SoftLayer_Hardware_ComponentArray

• parameters

None

---

getCurrentBillingDetail

Get the detail billing data for this instance's current billing period. This excludes bandwidth usage.

• returns

SoftLayer_Billing_ItemArray

• 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

dateTime startDate

dateTime endDate

---

getDatacenter

Retrieve the datacenter that a piece of hardware resides in.

• returns

SoftLayer_Location

• parameters

None

---

getDriveControllers

Retrieve the drive controllers contained within a piece of hardware.

• returns

SoftLayer_Hardware_ComponentArray

• parameters

None

---

getEvaultNetworkStorage

Retrieve a piece of hardware's associated EVault network storage service account.

• returns

SoftLayer_Network_StorageArray

• parameters

None

---

getFirewallServiceComponent

Retrieve a hardware's hardware firewall services.

• returns

SoftLayer_Network_Component_Firewall

• parameters

None

---

getFrontendIncomingBandwidth

Retrieve the amount of incoming public network bandwidth used by a server over a period of time.

• returns

float

• parameters

dateTime startDate

dateTime endDate

---

getFrontendNetworkComponents

Retrieve a hardware's frontend or public network components. Network components are hardware components such as IPMI cards or Ethernet cards.

• returns

SoftLayer_Network_ComponentArray

• parameters

None

---

getFrontendOutgoingBandwidth

Retrieve the amount of outgoing public network bandwidth used by a server over a period of time.

• returns

float

• parameters

dateTime startDate

dateTime endDate

---

getFrontendRouters

Retrieve a hardware's frontend or public router.

• returns

SoftLayer_HardwareArray

• parameters

None

---

getHardDrives

Retrieve the hard drives contained within a piece of hardware.

• returns

SoftLayer_Hardware_ComponentArray

• parameters

None

---

getHardwareChassis

Retrieve the chassis that a piece of hardware is housed in.

• returns

SoftLayer_Hardware_Chassis

• parameters

None

---

getHardwareFunction

Retrieve a hardware's function.

• returns

SoftLayer_Hardware_Function

• parameters

None

---

getHardwareStatus

Retrieve a hardware's status.

• returns

SoftLayer_Hardware_Status

• parameters

None

---

getHostIpsSoftwareComponent

Retrieve a host IPS software component object.

• returns

SoftLayer_Software_Component

• parameters

None

---

getHourlyBandwidth

Retrieves bandwidth by hour over 24hours for a particular hardware id.

• returns

SoftLayer_Metric_Tracking_Object_DataArray

• 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

SoftLayer_Provisioning_Version1_Transaction

• parameters

None

---

getLocation

Retrieve where a piece of hardware is located within SoftLayer's location hierarchy.

• returns

SoftLayer_Location

• parameters

None

---

getLockboxNetworkStorage

Retrieve a lockbox account associated with a server.

• returns

SoftLayer_Network_Storage

• parameters

None

---

getMemory

Retrieve a hardware's memory.

• returns

SoftLayer_Hardware_ComponentArray

• 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

SoftLayer_Metric_Tracking_Object

• parameters

None

---

getMonitoringServiceComponent

Retrieve a hardware's network monitoring services.

• returns

SoftLayer_Network_Monitor_Version1_Query_Host_Stratum

• parameters

None

---

getMotherboard

Retrieve a hardware's motherboard.

• returns

SoftLayer_Hardware_Component

• parameters

None

---

getNetworkComponents

Retrieve a hardware's network components. Network components are hardware components such as IPMI cards or Ethernet cards.

• returns

SoftLayer_Network_ComponentArray

• parameters

None

---

getNetworkManagementIpAddress

Retrieve a hardware's network management IP address.

• returns

string

• parameters

None

---

getNetworkMonitors

Retrieve a hardware's network monitors.

• returns

SoftLayer_Network_Monitor_Version1_Query_HostArray

• parameters

None

---

getNetworkStorage

Retrieve a piece of hardware's associated network storage service account.

• returns

SoftLayer_Network_StorageArray

• parameters

None

---

getNetworkVlans

Retrieve the network Vlan's that a hardware's network components are associated with.

• returns

SoftLayer_Network_VlanArray

• 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

SoftLayer_Hardware

• parameters

None

---

getOperatingSystem

Retrieve a hardware's operating system.

• returns

SoftLayer_Software_Component

• 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

SoftLayer_Network_Component

• 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

SoftLayer_Network_Component

• 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

SoftLayer_Hardware_ComponentArray

• parameters

None

---

getRaidControllers

Retrieve the RAID controllers contained within a piece of hardware.

• returns

SoftLayer_Hardware_ComponentArray

• parameters

None

---

getRemoteManagementComponent

Retrieve a hardware's associated remote management component. This is normally IPMI.

• returns

SoftLayer_Network_Component

• parameters

None

---

getSecurityScanRequests

Retrieve a hardware's vulnerability scan requests.

• returns

SoftLayer_Network_Security_Scanner_RequestArray

• parameters

None

---

getSensorData

Retrieve a server's hardware state via it's internal sensors.

• returns

SoftLayer_Container_RemoteManagement_SensorReadingArray

• parameters

None

---

getSensorDataWithGraphs

Retrieve server's temperature and fan speed graphs as well the sensor raw data.

• returns

SoftLayer_Container_RemoteManagement_SensorReadingsWithGraphs

• parameters

None

---

getServerFanSpeedGraphs

Retrieve server's fan speed graphs.

• returns

SoftLayer_Container_RemoteManagement_Graphs_SensorSpeedArray

• 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

SoftLayer_Location

• parameters

None

---

getServerTemperatureGraphs

Retrieve server's temperature graphs

• returns

SoftLayer_Container_RemoteManagement_Graphs_SensorTemperatureArray

• parameters

None

---

getSoftwareComponents

Retrieve a hardware's installed software.

• returns

SoftLayer_Software_ComponentArray

• parameters

None

---

getStorageNetworkComponents

Retrieve a hardware's private storage network components. Network components are hardware components such as IPMI cards or Ethernet cards.

• returns

SoftLayer_Network_ComponentArray

• parameters

None

---

getUpgradeItemPrices

Retrieve a list of upgradable items available to a piece of hardware.

• returns

SoftLayer_Product_Item_PriceArray

• parameters

None

---

getUpgradeRequest

Retrieve an account's associated upgrade request object if any.

• returns

SoftLayer_Product_Upgrade_Request

• 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

SoftLayer_Network_ComponentArray

• parameters

None

---

getVirtualHost

Retrieve a hardware's virtual host record.

• returns

SoftLayer_Virtual_Host

• parameters

None

---

getVirtualRack

Retrieve the name of the bandwidth allotment that a hardware belongs too.

• returns

SoftLayer_Network_Bandwidth_Version1_Allotment

• 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

SoftLayer_Software_Component

• parameters

None

---

importVirtualHost

attempt to import the host record for the virtualization platform running on a server

• returns

SoftLayer_Virtual_Host

• 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