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.
HardwareSoftLayer_Hardware_Server
Overview
Methods
| activatePrivatePort |
Activates the private port |
| activatePublicPort |
Activates the public port |
| bootToRescueLayer |
Initiates the RescueLayer Kernel to bring a server online to troubleshoot system problems. |
| captureImage | |
| closeAlarm |
Returns monitoring alarm detailed history |
| createFirmwareUpdateTransaction |
Runs firmware updates on the servers components. |
| deleteSoftwareComponentPasswords |
Delete software component passwords. |
| editObject |
Edit a server's properties |
| editSoftwareComponentPasswords |
Edit the properties of software component passwords. |
| findByIpAddress |
Find hardware by its primary public or private IP (ipv4) address. |
| getAccount |
Retrieve the account associated with a piece of hardware. |
| getActiveComponents |
Retrieve a piece of hardware's active physical components. |
| getActiveNetworkFirewallBillingItem |
Retrieve the billing item for a server's attached network firewall. |
| getActiveNetworkMonitorIncident |
Retrieve a piece of hardware's active network monitoring incidents. |
| getActiveTickets |
Retrieve Array |
| getActiveTransaction |
Retrieve transaction currently running for server. |
| getActiveTransactions |
Retrieve any active transaction(s) that are currently running for the server (example: os reload). |
| getAlarmHistory |
Returns monitoring alarm detailed history |
| getAllPowerComponents |
Retrieve Array |
| getAntivirusSpywareSoftwareComponent |
Retrieve information regarding an antivirus/spyware software component object. |
| getAttributes |
Retrieve information regarding a piece of hardware's specific attributes. |
| getAvailableMonitoring |
Retrieve an object that stores the maximum level for the monitoring query types and response types. |
| getAverageDailyBandwidthUsage |
Retrieve the average daily total bandwidth usage for the current billing cycle. |
| getAverageDailyPrivateBandwidthUsage |
Retrieve the average daily private bandwidth usage for the current billing cycle. |
| getAverageDailyPublicBandwidthUsage |
Retrieve the average daily public bandwidth usage for the current billing cycle. |
| getBackendBandwidthUsage |
Retrieves public bandwidth usage records. |
| getBackendBandwidthUse |
Retrieves private bandwidth usage records. |
| getBackendIncomingBandwidth |
Retrieve the amount of incoming private network bandwidth used by a server over a period of time. |
| getBackendNetworkComponents |
Retrieve a piece of hardware's back-end or private network components. |
| getBackendOutgoingBandwidth |
Retrieve the amount of outgoing private network bandwidth used by a server over a period of time. |
| getBackendRouters |
Retrieve a hardware's backend or private router. |
| getBandwidthAllocation |
Retrieve a hardware's allotted bandwidth (measured in GB). |
| getBandwidthAllotmentDetail |
Retrieve a hardware's allotted detail record. Allotment details link bandwidth allocation with allotments. |
| getBandwidthForDateRange |
Retrieve bandwidth data from a tracking object. |
| getBandwidthImage |
Retrieve a bandwidth image and textual description of that image for this server. |
| getBenchmarkCertifications |
Retrieve information regarding a piece of hardware's benchmark certifications. |
| getBillingCycleBandwidthUsage |
Retrieve the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. |
| getBillingCyclePrivateBandwidthUsage |
Retrieve the raw private bandwidth usage data for the current billing cycle. |
| getBillingCyclePublicBandwidthUsage |
Retrieve the raw public bandwidth usage data for the current billing cycle. |
| getBillingItem |
Retrieve the billing item for a server. |
| getBillingItemFlag |
Retrieve a flag indicating that a billing item exists. |
| getBusinessContinuanceInsuranceFlag |
Retrieve status indicating whether or not a piece of hardware has business continuance insurance. |
| getComponents |
Retrieve a piece of hardware's components. |
| getContinuousDataProtectionSoftwareComponent |
Retrieve a continuous data protection/server backup software component object. |
| getControlPanel |
Retrieve a server's control panel. |
| getCost |
Retrieve a Billing Item's total, including any child billing items and associated billing items if they exist.' |
| getCurrentBenchmarkCertificationResultFile |
Get the file for the current benchmark certification result, if it exists. |
| getCurrentBillableBandwidthUsage |
Retrieve the current billable public outbound bandwidth for this hardware for the current billing cycle. |
| getCurrentBillingDetail |
Get the detail billing data for this instance's current billing period. This excludes bandwidth usage. |
| getCurrentBillingTotal |
Get the total billing price for this instance's hourly usage up to this point. This includes total includes all bandwidth charges. |
| getCustomBandwidthDataByDate |
Retrieve bandwidth graph by date. |
| getCustomerOwnedFlag |
Retrieve indicates if a server is a customer owned device. |
| getDailyAverage |
calculate the average daily network traffic used by a server in gigabytes. |
| getDatacenter |
Retrieve information regarding the datacenter in which a piece of hardware resides. |
| getDatacenterName |
Retrieve the name of the datacenter in which a piece of hardware resides. |
| getDownlinkHardware |
Retrieve all hardware that has uplink network connections to a piece of hardware. |
| getDownlinkNetworkHardware |
Retrieve all hardware that has uplink network connections to a piece of hardware. |
| getDownlinkServers |
Retrieve information regarding all servers attached to a piece of network hardware. |
| getDownlinkVirtualGuests |
Retrieve information regarding all virtual guests attached to a piece of network hardware. |
| getDownstreamHardwareBindings |
Retrieve all hardware downstream from a network device. |
| getDownstreamNetworkHardware |
Retrieve all network hardware downstream from the selected piece of hardware. |
| getDownstreamNetworkHardwareWithIncidents |
Retrieve all network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. |
| getDownstreamServers |
Retrieve information regarding all servers attached downstream to a piece of network hardware. |
| getDownstreamVirtualGuests |
Retrieve information regarding all virtual guests attached to a piece of network hardware. |
| getDriveControllers |
Retrieve the drive controllers contained within a piece of hardware. |
| getEvaultNetworkStorage |
Retrieve information regarding a piece of hardware's associated EVault network storage service account. |
| getFirewallServiceComponent |
Retrieve information regarding a piece of hardware's firewall services. |
| getFrontendBandwidthUsage |
Retrieves public bandwidth usage records. |
| getFrontendBandwidthUse |
Retrieves public bandwidth usage records. |
| getFrontendIncomingBandwidth |
Retrieve the amount of incoming public network bandwidth used by a server over a period of time. |
| getFrontendNetworkComponents |
Retrieve a piece of hardware's front-end or public network components. |
| getFrontendOutgoingBandwidth |
Retrieve the amount of outgoing public network bandwidth used by a server over a period of time. |
| getFrontendRouters |
Retrieve a hardware's frontend or public router. |
| getGlobalIdentifier |
Retrieve a hardware's universally unique identifier. |
| getHardDrives |
Retrieve the hard drives contained within a piece of hardware. |
| getHardwareByIpAddress |
Retrieve a SoftLayer_Hardware_Server object by IP address. |
| getHardwareChassis |
Retrieve the chassis that a piece of hardware is housed in. |
| getHardwareFunction |
Retrieve a hardware's function. |
| getHardwareFunctionDescription |
Retrieve a hardware's function. |
| getHardwareStatus |
Retrieve a hardware's status. |
| getHostIpsSoftwareComponent |
Retrieve information regarding a host IPS software component object. |
| getHourlyBandwidth |
Retrieves bandwidth hourly over a 24-hour period for the specified hardware. |
| getHourlyBillingFlag |
Retrieve a server's hourly billing status. |
| getInboundBandwidthUsage |
Retrieve the sum of all the inbound network traffic data for the last 30 days. |
| getInboundPrivateBandwidthUsage |
Retrieve the total private inbound bandwidth for this hardware for the current billing cycle. |
| getInboundPublicBandwidthUsage |
Retrieve the total public inbound bandwidth for this hardware for the current billing cycle. |
| getInternalTagReferences |
Retrieve Array |
| getItemPricesFromSoftwareDescriptions |
Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description |
| getLastOperatingSystemReload |
Retrieve the last transaction that a server's operating system was loaded. |
| getLastTransaction |
Retrieve information regarding the last transaction a server performed. |
| getLatestNetworkMonitorIncident |
Retrieve a piece of hardware's latest network monitoring incident. |
| getLocation |
Retrieve where a piece of hardware is located within SoftLayer's location hierarchy. |
| getLocationPathString |
Retrieve Array |
| getLockboxNetworkStorage |
Retrieve information regarding a lockbox account associated with a server. |
| getManagedResourceFlag |
Retrieve a flag indicating that the hardware is a managed resource. |
| getManagementNetworkComponent |
Retrieve a server's management network component. |
| getMemory |
Retrieve information regarding a piece of hardware's memory. |
| getMemoryCapacity |
Retrieve the amount of memory a piece of hardware has, measured in gigabytes. |
| getMetricTrackingObject |
Retrieve a piece of hardware's metric tracking object. |
| getMetricTrackingObjectId |
Retrieve the metric tracking object id for this server. |
| getMonitoringActiveAlarms |
Returns open monitoring alarms for a given time period |
| getMonitoringAgents |
Retrieve information regarding the monitoring agents associated with a piece of hardware. |
| getMonitoringClosedAlarms |
Returns closed monitoring alarms for a given time period |
| getMonitoringRobot |
Retrieve information regarding the hardware's monitoring robot. |
| getMonitoringServiceComponent |
Retrieve information regarding a piece of hardware's network monitoring services. |
| getMonitoringServiceEligibilityFlag |
Retrieve the monitoring service flag eligibility status for a piece of hardware. |
| getMonitoringServiceFlag |
Retrieve the service flag status for a piece of hardware. |
| 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 |
| getMotherboard |
Retrieve a server's motherboard. |
| getNetworkCards |
Retrieve information regarding a piece of hardware's network cards. |
| getNetworkComponentFirewallProtectableIpAddresses |
Get the IP addresses associated with this server that are protectable by a network component firewall. |
| getNetworkComponents |
Retrieve returns a hardware's network components. |
| getNetworkManagementIpAddress |
Retrieve a piece of hardware's network management IP address. |
| getNetworkMonitorAttachedDownHardware |
Retrieve all servers with failed monitoring that are attached downstream to a piece of hardware. |
| getNetworkMonitorAttachedDownVirtualGuests |
Retrieve virtual guests that are attached downstream to a hardware that have failed monitoring |
| getNetworkMonitorIncidents |
Retrieve the status of all of a piece of hardware's network monitoring incidents. |
| getNetworkMonitors |
Retrieve information regarding a piece of hardware's network monitors. |
| getNetworkStatus |
Retrieve the value of a hardware's network status attribute. |
| getNetworkStatusAttribute |
Retrieve the hardware's related network status attribute. |
| getNetworkStorage |
Retrieve information regarding a piece of hardware's associated network storage service account. |
| getNetworkVlans |
Retrieve the network virtual LANs (VLANs) associated with a piece of hardware's network components. |
| getNextBillingCycleBandwidthAllocation |
Retrieve a hardware's allotted bandwidth for the next billing cycle (measured in GB). |
| getObject |
Retrieve a SoftLayer_Hardware_Server record. |
| getOpenCancellationTicket |
Retrieve an open ticket requesting cancellation of this server, if one exists. |
| getOperatingSystem |
Retrieve information regarding a piece of hardware's operating system. |
| getOutboundBandwidthUsage |
Retrieve the sum of all the outbound network traffic data for the last 30 days. |
| getOutboundPrivateBandwidthUsage |
Retrieve the total private outbound bandwidth for this hardware for the current billing cycle. |
| getOutboundPublicBandwidthUsage |
Retrieve the total public outbound bandwidth for this hardware for the current billing cycle. |
| getOverBandwidthAllocationFlag |
Retrieve whether the bandwidth usage for this hardware for the current billing cycle exceeds the alloaction. |
| getPMInfo |
Retrieve a server's hardware state via its internal sensors. |
| getPointOfPresenceLocation |
Retrieve information regarding the Point of Presence (PoP) location in which a piece of hardware resides. |
| getPowerComponents |
Retrieve the power components for a hardware object. |
| getPowerSupply |
Retrieve a server's power supply. |
| getPrimaryBackendIpAddress |
Retrieve the hardware's primary private IP address. |
| getPrimaryBackendNetworkComponent |
Retrieve information regarding the hardware's primary back-end network component. |
| getPrimaryIpAddress |
Retrieve a server's primary public IP address. |
| getPrimaryNetworkComponent |
Retrieve information regarding the hardware's primary public network component. |
| getPrivateBandwidthData |
Retrieve a graph of a server's private network usage. |
| getPrivateBandwidthDataSummary |
Retrieve a server's private bandwidth usage summary |
| getPrivateBandwidthGraphImage |
EXPERIMENTAL Retrieve a graph of a server's private network usage. |
| getPrivateIpAddress |
Retrieve a server's primary private IP address. |
| getPrivateNetworkComponent |
Retrieve a server's private network component. |
| getPrivateNetworkOnlyFlag |
Retrieve whether the server only has access to the private network. |
| getPrivateVlan |
Retrieve the backend VLAN for the primary IP address of the server. |
| getPrivateVlanByIpAddress |
Retrieve a backend network VLAN by searching for an IP address. |
| getProcessorCoreAmount |
Retrieve the total number of processor cores, summed from all processors that are attached to a piece of hardware |
| getProcessors |
Retrieve information regarding a piece of hardware's processors. |
| getProjectedOverBandwidthAllocationFlag |
Retrieve whether the bandwidth usage for this hardware for the current billing cycle is projected to exceed the allocation. |
| getProjectedPublicBandwidthUsage |
Retrieve the projected public outbound bandwidth for this hardware for the current billing cycle. |
| getProvisionDate |
Retrieve the date a server was provisioned or last underwent a chassis transfer. |
| getPublicBandwidthData |
Retrieve a graph of a server's public network usage. |
| getPublicBandwidthDataSummary |
Retrieve a server's public bandwidth usage summary |
| getPublicBandwidthGraphImage |
EXPERIMENTAL Retrieve a graph of a server's public network usage. |
| getPublicBandwidthTotal |
Retrieve total number of public bytes used by a server over time period specified. |
| getPublicNetworkComponent |
Retrieve a server's public network component. |
| getPublicVlan |
Retrieve the frontend VLAN for the primary IP address of the server |
| getPublicVlanByHostname |
Retrieve the frontend VLAN by a server's hostname. |
| getRack |
Retrieve Array |
| getRaidControllers |
Retrieve the RAID controllers contained within a piece of hardware. |
| getRecentRemoteManagementCommands |
Retrieve the last five commands issued to the server's remote management card. |
| getRemoteManagement |
Retrieve a server's remote management card. |
| getRemoteManagementAccounts |
Retrieve user credentials to issue commands and/or interact with the server's remote management card. |
| getRemoteManagementComponent |
Retrieve a hardware's associated remote management component. This is normally IPMI. |
| getRemoteManagementUsers |
Retrieve user(s) who have access to issue commands and/or interact with the server's remote management card. |
| getRemoteMonitoringActiveAlarms |
Returns open monitoring alarms for a given time period |
| getRemoteMonitoringClosedAlarms |
Returns closed monitoring alarms for a given time period |
| getReverseDomainRecords |
Retrieve the reverse domain records associated with a server. |
| getRouters |
Retrieve a hardware's routers. |
| getSecurityScanRequests |
Retrieve information regarding a piece of hardware's vulnerability scan requests. |
| getSensorData |
Retrieve a server's hardware state via its internal sensors. |
| getSensorDataWithGraphs |
Retrieve server's temperature and fan speed graphs as well the sensor raw data. |
| getServerDetails |
Retrieve a server's hardware components, software, and network components. |
| getServerFanSpeedGraphs |
Retrieve server's fan speed graphs. |
| getServerPowerState |
Retrieves server's power state |
| getServerRoom |
Retrieve information regarding the server room in which the hardware is located. |
| getServerTemperatureGraphs |
Retrieve server's temperature graphs |
| getServiceProvider |
Retrieve information regarding the piece of hardware's service provider. |
| getSoftwareComponents |
Retrieve information regarding a piece of hardware's installed software. |
| getStatisticsRemoteManagement |
Retrieve a server's remote management card used for statistics. |
| getStorageNetworkComponents |
Retrieve Array |
| getTagReferences |
Retrieve Array |
| getUpgradeItemPrices |
Retrieve a list of upgradable items available to a piece of hardware. |
| getUpgradeRequest |
Retrieve an account's associated upgrade request object, if any. |
| getUplinkHardware |
Retrieve the network device connected to a piece of hardware. |
| getUplinkNetworkComponents |
Retrieve information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. |
| getUsers |
Retrieve a list of users that have access to this server. |
| getVirtualChassis |
Retrieve information regarding the virtual chassis for a piece of hardware. |
| getVirtualChassisSiblings |
Retrieve information regarding the virtual chassis siblings for a piece of hardware. |
| getVirtualGuests |
Retrieve a hardware server's cloud computing instances. |
| getVirtualHost |
Retrieve a piece of hardware's virtual host record. |
| getVirtualLicenses |
Retrieve information regarding a piece of hardware's virtual software licenses. |
| getVirtualRack |
Retrieve information regarding the bandwidth allotment to which a piece of hardware belongs. |
| getVirtualRackId |
Retrieve the name of the bandwidth allotment belonging to a piece of hardware. |
| getVirtualRackName |
Retrieve the name of the bandwidth allotment belonging to a piece of hardware. |
| getVirtualizationPlatform |
Retrieve a piece of hardware's virtualization platform software. |
| getWindowsUpdateAvailableUpdates |
Retrieve a list of Windows updates available to a server. |
| getWindowsUpdateInstalledUpdates |
Retrieve a list of Windows updates installed on a server. |
| getWindowsUpdateStatus |
Retrieve a server's Windows update synchronization status |
| importVirtualHost |
attempt to import the host record for the virtualization platform running on a server |
| initiateR1SoftBareMetalRestore |
Initiate an R1Soft bare metal restore for the server tied to an R1Soft CDP Server |
| isBackendPingable |
Verifies if a server's backend ip address is pingable. |
| isPingable |
Verifies if server is pingable. |
| isWindowsServer |
Determine if a server runs the Microsoft Windows operating system. |
| ping |
Issues ping command. |
| powerCycle |
Issues power cycle to server. |
| powerOff |
Power off server. |
| powerOn |
Power on server. |
| rebootDefault |
Reboot the server via the default method. |
| rebootHard |
Reboot the server via "hard" reboot. |
| rebootSoft |
Reboot the server via gracefully (soft reboot). |
| reloadCurrentOperatingSystemConfiguration |
Reloads current operating system configuration. |
| reloadOperatingSystem |
Reloads operating system configuration. |
| runPassmarkCertificationBenchmark |
Runs a hardware stress test on the server to obtain a Passmark Certification. |
| setPrivateNetworkInterfaceSpeed |
Updates the private network interface (eth0) speed. |
| setPublicNetworkInterfaceSpeed |
Updates the public network interface (eth1) speed. |
| setTags | |
| shutdownPrivatePort |
Shuts down the public port |
| shutdownPublicPort |
Shuts down the public port |
| sparePool |
Allows servers to be added to or removed from the spare pool. |
| validatePartitionsForOperatingSystem |
Validates a collection of partitions for an operating system |
| getResourceGroupMemberReferences |
Retrieve Array |
| getResourceGroups |
Retrieve the resource groups in which this hardware is a member. |
| getUserData |
Retrieve a string containing custom user data for a hardware order. |
| setUserMetadata |
Sets the server's user metadata value. |
| getContainsSolidStateDrivesFlag |
Retrieve Array |
| getInternalNotes |
Retrieve Array |
| getInternalNotesHistory |
Retrieve Array |
| getNotesHistory |
Retrieve Array |
| getFirewallProtectableSubnets |
Get the subnets associated with this server that are protectable by a network component firewall. |
| isolateServerForDestructiveAction | |
| getTopLevelLocation |
Retrieve Array |
| getResourceGroupRoles |
Retrieve Array |
| initiateIderaBareMetalRestore |
Initiate an Idera bare metal restore for the server tied to an Idera Server Backup |
| getProcessorPhysicalCoreAmount |
Retrieve the total number of physical processor cores, summed from all processors that are attached to a piece of hardware |