SoftLayer Hardware Server

From SoftLayer Development Network Wiki

Jump to: navigation, search

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

Contents

Overview

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.

Endpoints

SOAP WSDL http://api.service.softlayer.com/soap/v3/SoftLayer_Hardware_Server?wsdl
XML-RPC http://api.service.softlayer.com/xmlrpc/v3/SoftLayer_Hardware_Server

User Access

Users wishing to access the SoftLayer_Hardware_Server service must have the View Hardware permission assigned to their account.

Methods

activatePrivatePort

Activates the private port

  • returns
boolean
  • parameters
None


activatePublicPort

Activates the public port

  • returns
boolean
  • parameters
None


bootToRescueLayer

Initiates the RescueLayer Kernel to bring a server online to troubleshoot system problems.

  • returns
boolean
  • parameters
None


editObject

Edit a server's properties

  • returns
boolean
  • parameters
SoftLayer_Hardware templateObject


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


getActiveTransaction

Retrieve a transaction that is still be performed on a server.

  • returns
SoftLayer_Provisioning_Version1_Transaction
  • parameters
None


getActiveTransactions

Retrieve any active transaction(s) that are currently running for the server (example: os reload).

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


getAvailableMonitoring

Retrieve an object that stores the maximum level for the monitoring query types and response types.

  • returns
SoftLayer_Network_Monitor_Version1_Query_Host_StratumArray
  • parameters
None


getAverageDailyBandwidthUsage

Retrieve the average daily usage of all the inbound and outbound network traffic for the last 30 days.

  • returns
decimal
  • parameters
None


getBackendBandwidthUse

Retrieves private bandwidth usage records.

  • returns
SoftLayer_Network_Bandwidth_Version1_Usage_DetailArray
  • parameters
dateTime startDate
dateTime endDate


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 alloted detail record. Allotment details link bandwidth allocation with allotments.

  • returns
SoftLayer_Network_Bandwidth_Version1_Allotment_Detail
  • parameters
None


getBandwidthByHour

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

  • returns
SoftLayer_Container_Network_Bandwidth_Version1_UsageArray
  • parameters
string mode
dateTime day


getBandwidthImage

Retrieve a bandwidth image and textual description of that image for this server.

  • returns
SoftLayer_Container_Bandwidth_GraphOutputs
  • parameters
string networkType
string snapshotRange
boolean draw
dateTime dateSpecified


getBenchmarkCertifications

Retrieve a hardware's benchmark certifications.

  • returns
SoftLayer_Hardware_Benchmark_CertificationArray
  • parameters
None


getBillingItem

Retrieve the billing item for a server.

  • returns
SoftLayer_Billing_Item
  • parameters
None


getBusinessContinuanceInsuranceFlag

Retrieve tODO.

  • 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


getControlPanel

Retrieve a server's control panel.

  • returns
SoftLayer_Software_Component
  • parameters
None


getCost

Retrieve the total cost of a server, measured in US Dollars ($USD).

  • returns
float
  • parameters
None


getCurrentBenchmarkCertificationResultFile

Get the file for the current benchmark certification result, if it exists.

  • returns
binary data
  • 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


getFrontendBandwidthUse

Retrieves public bandwidth usage records.

  • returns
SoftLayer_Network_Bandwidth_Version1_Usage_DetailArray
  • parameters
dateTime startDate
dateTime endDate


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_Network_Component_Uplink_HardwareArray
  • parameters
None


getHardDrives

Retrieve the hard drives contained within a piece of hardware.

  • returns
SoftLayer_Hardware_ComponentArray
  • parameters
None


getHardwareByIpAddress

Retrieve a SoftLayer_Hardware_Server object by IP address.

  • returns
SoftLayer_Hardware
  • parameters
string ipAddress


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


getInboundBandwidthUsage

Retrieve the sum of all the inbound network traffic data for the last 30 days.

  • returns
decimal
  • parameters
None


getLastOperatingSystemReload

Retrieve the last transaction that a server's operating system was loaded.

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


getManagementNetworkComponent

Retrieve a server's management network component.

  • returns
SoftLayer_Network_Component
  • parameters
None


getMemory

Retrieve a hardware's memory.

  • returns
SoftLayer_Hardware_ComponentArray
  • parameters
None


getMonitoringServiceComponent

Retrieve a hardware's network monitoring services.

  • returns
SoftLayer_Network_Monitor_Version1_Query_Host_Stratum
  • parameters
None


getMonitoringUserNotification

Retrieve 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

  • returns
SoftLayer_User_Customer_Notification_HardwareArray
  • parameters
None


getMotherboard

Retrieve a server's motherboard.

  • returns
SoftLayer_Hardware_Component
  • parameters
None


getNetworkComponentFirewallProtectableIpAddresses

Get the IP addresses associated with this server that are protectable by a network component firewall.

  • returns
SoftLayer_Network_Subnet_IpAddressArray
  • 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 tODO:.

  • 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_Server record.

  • returns
SoftLayer_Hardware
  • parameters
None


getOperatingSystem

Retrieve a hardware's operating system.

  • returns
SoftLayer_Software_Component
  • parameters
None


getOutboundBandwidthUsage

Retrieve the sum of all the outbound network traffic for the last 30 days.

  • returns
decimal
  • parameters
None


getPrimaryBackendIpAddress

Retrieve the hardware's primary private IP address.

  • returns
string
  • parameters
None


getPrimaryBackendNetworkComponent

Retrieve the hardware's primary public network component.

  • returns
SoftLayer_Network_Component
  • parameters
None


getPrimaryIpAddress

Retrieve a server's primary public IP address.

  • returns
string
  • parameters
None


getPrimaryNetworkComponent

Retrieve the hardware's primary public network component.

  • returns
SoftLayer_Network_Component
  • parameters
None


getPrivateBandwidthDataSummary

Retrieve a server's private bandwidth usage summary

  • returns
SoftLayer_Container_Network_Bandwidth_Data_Summary
  • parameters
None


getPrivateBandwidthGraphImage

Retrieve a graph of a server's private network usage.

  • returns
binary data
  • parameters
string startTime
string endTime


getPrivateIpAddress

Retrieve a server's primary private IP address.

  • returns
string
  • parameters
None


getPrivateNetworkComponent

Retrieve a server's private network component.

  • returns
SoftLayer_Network_Component
  • parameters
None


getPrivateNetworkOnlyFlag

Retrieve whether the server only has access to the private network.

  • returns
boolean
  • parameters
None


getPrivateVlan

Retrieve the backend VLAN for the primary IP address of the server.

  • returns
SoftLayer_Network_Vlan
  • parameters
None


getPrivateVlanByIpAddress

Retrieve a backend network VLAN by searching for an IP address.

  • returns
SoftLayer_Network_Vlan
  • parameters
string ipAddress


getProcessors

Retrieve a hardware's processors.

  • returns
SoftLayer_Hardware_ComponentArray
  • parameters
None


getProvisionDate

Retrieve the date a server was ordered.

  • returns
dateTime
  • parameters
None


getPublicBandwidthDataSummary

Retrieve a server's public bandwidth usage summary

  • returns
SoftLayer_Container_Network_Bandwidth_Data_Summary
  • parameters
None


getPublicBandwidthGraphImage

Retrieve a graph of a server's public network usage.

  • returns
binary data
  • parameters
dateTime startTime
dateTime endTime


getPublicBandwidthTotal

Retrieve total number of public bytes used by a server over time period specified.

  • returns
unsigned long
  • parameters
integer startTime
integer endTime


getPublicNetworkComponent

Retrieve a server's public network component.

  • returns
SoftLayer_Network_Component
  • parameters
None


getPublicVlan

Retrieve the frontend VLAN for the primary IP address of the server

  • returns
SoftLayer_Network_Vlan
  • parameters
None


getPublicVlanByHostname

Retrieve the frontend VLAN by a server's hostname.

  • returns
SoftLayer_Network_Vlan
  • parameters
string hostname


getRaidControllers

Retrieve the RAID controllers contained within a piece of hardware.

  • returns
SoftLayer_Hardware_ComponentArray
  • parameters
None


getRecentRemoteManagementCommands

Retrieve the last five commands issued to the server's remote management card.

  • returns
SoftLayer_Hardware_Component_RemoteManagement_Command_RequestArray
  • parameters
None


getRemoteManagement

Retrieve a server's remote management card.

  • returns
SoftLayer_Hardware_Component
  • parameters
None


getRemoteManagementComponent

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

  • returns
SoftLayer_Network_Component
  • parameters
None


getRemoteManagementUsers

Retrieve user(s) who have access to issue commands and/or interact with the server's remote management card.

  • returns
SoftLayer_Hardware_Component_RemoteManagement_UserArray
  • parameters
None


getReverseDomainRecords

Retrieve the reverse domain records associated with a server.

  • returns
SoftLayer_Dns_DomainArray
  • 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 its 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


getServerDetails

Retrieve a server's hardware components, software, and network components.

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


getUsers

Retrieve a list of users that have access to this server.

  • returns
SoftLayer_User_CustomerArray
  • parameters
None


getVirtualRackName

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

  • returns
string
  • parameters
None


getWindowsUpdateAvailableUpdates

Retrieve a list of Windows updates available to a server.

  • returns
SoftLayer_Container_Utility_Microsoft_Windows_UpdateServices_UpdateItemArray
  • parameters
None


getWindowsUpdateInstalledUpdates

Retrieve a list of Windows updates installed on a server.

  • returns
SoftLayer_Container_Utility_Microsoft_Windows_UpdateServices_UpdateItemArray
  • parameters
None


getWindowsUpdateStatus

Retrieve a server's Windows update synchronization status

  • returns
SoftLayer_Container_Utility_Microsoft_Windows_UpdateServices_Status
  • parameters
None


isBackendPingable

Verifies if a server's backend ip address is pingable.

  • returns
boolean
  • parameters
None


isPingable

Verifies if server is pingable.

  • returns
boolean
  • parameters
None


isWindowsServer

Determine if a server runs the Microsoft Windows operating system.

  • returns
boolean
  • parameters
None


new_getBandwidthImage

Retrieve a bandwidth image and textual description of that image for this server.

  • returns
SoftLayer_Container_Bandwidth_GraphOutputs
  • parameters
string networkType
string snapshotRange
boolean draw
dateTime dateSpecified


new_getPrivateBandwidthGraphImage

Retrieve a graph of a server's private network usage.

  • returns
binary data
  • parameters
string startTime
string endTime


new_getPublicBandwidthGraphImage

Retrieve a graph of a server's public network usage.

  • returns
binary data
  • parameters
dateTime startTime
dateTime endTime


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


reloadCurrentOperatingSystemConfiguration

Reloads current operating system configuration.

  • returns
string
  • parameters
string token


reloadOperatingSystem

Reloads operating system configuration.

  • returns
string
  • parameters
string token
SoftLayer_Container_Hardware_Server_Configuration config


runPassmarkCertificationBenchmark

Runs a hardware stress test on the server to obtain a Passmark Certification.

  • returns
boolean
  • parameters
None


setOperatingSystemPassword

Changes the password for a servers Operating System

  • returns
boolean
  • parameters
string newPassword


setPrivateNetworkInterfaceSpeed

Updates the private network interface (eth0) speed.

  • returns
boolean
  • parameters
integer newSpeed


setPublicNetworkInterfaceSpeed

Updates the public network interface (eth1) speed.

  • returns
boolean
  • parameters
integer newSpeed


shutdownPrivatePort

Shuts down the public port

  • returns
boolean
  • parameters
None


shutdownPublicPort

Shuts down the public port

  • returns
boolean
  • parameters
None


validatePartitionsForOperatingSystem

Validates a collection of partitions for an operating system

  • returns
boolean
  • parameters
SoftLayer_Software_Description operationSystem
SoftLayer_Hardware_Component_PartitionArray partitions

See Also

Retrieved from "http://sldn.softlayer.com/wiki/index.php/SoftLayer_Hardware_Server"
Personal tools