SoftLayer Hardware

From SoftLayer Development Network Wiki

Jump to: navigation, search

This page refers to the SoftLayer_Hardware service. For information on the SoftLayer_Hardware data type please see SoftLayer_Hardware (type).

Contents

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 tODO: describe this

  • returns
SoftLayer_Hardware_AttributeArray
  • parameters
None



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



getBandwidthByHour

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

  • returns
SoftLayer_Container_Network_Bandwidth_Version1_UsageArray
  • parameters
string mode
timestamp day



getBenchmarkCertifications

Retrieve a hardware's benchmark certifications.

  • returns
SoftLayer_Hardware_Benchmark_CertificationArray
  • parameters
None



getBusinessContinuanceInsuranceFlag

Retrieve tODO.

  • returns
SoftLayer_Billing_Item
  • parameters
None



getComponents

Retrieve a hardware's components. Hardware components include hard drives, processors, drive controllers, etc.

  • returns
SoftLayer_Hardware_ComponentArray
  • parameters
None



getDailyAverage

calculate the average daily network traffic used by a server in gigabytes.

  • returns
float
  • parameters
timestamp startDate
timestamp endDate



getDatacenter

Retrieve the datacenter that a piece of hardware resides in.

  • returns
SoftLayer_Location
  • parameters
None



getEvaultNetworkStorage

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

  • returns
SoftLayer_Network_StorageArray
  • parameters
None



getFrontendIncomingBandwidth

calculate the incoming network traffic used by a server in gigabytes.

  • returns
int
  • parameters
timestamp startDate
timestamp 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

calculate the outgoing network traffic used by a server in gigabytes.

  • returns
int
  • parameters
timestamp startDate
timestamp endDate



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



getLocation

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

  • returns
SoftLayer_Location
  • 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



getNetworkMonitors

Retrieve a hardware's network monitors.

  • returns
SoftLayer_Network_Monitor_Version1_Query_HostArray
  • 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



getPrimaryNetworkComponent

Retrieve the hardware's primary public network component.

  • returns
SoftLayer_Network_Component
  • 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



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



isPingable

Verifies if server is pingable.

  • returns
bool
  • parameters
None



ping

Issues ping command.

  • returns
string
  • parameters
None



powerCycle

Issues power cycle to server.

  • returns
bool
  • parameters
None



powerOff

Power off server.

  • returns
bool
  • parameters
None



powerOn

Power on server.

  • returns
bool
  • parameters
None



rebootDefault

Reboot the server via the default method.

  • returns
bool
  • parameters
None



rebootHard

Reboot the server via "hard" reboot.

  • returns
bool
  • parameters
None



rebootSoft

Reboot the server via gracefully (soft reboot).

  • returns
bool
  • parameters
None
Personal tools