Hardware
SoftLayer_Hardware_Server

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.

Methods

Activates the private port
Activates the public port
Allow access to a SoftLayer_Network_Storage volume from this device.
Allow access to multiple SoftLayer_Network_Storage volumes from this device.
Initiates the Rescue Kernel to bring a server online to troubleshoot system problems.
Captures a Flex Image of the hard disk on the physical machine.
Returns monitoring alarm detailed history
Runs firmware updates on the servers components.
Create a new server
Delete a server
Delete software component passwords.
Edit a server's properties
Edit the properties of software component passwords.
Download and run remote script from uri on the hardware. Requires https for script to be executed after download.
Find hardware by its primary public or private IP (ipv4) address.
Obtain an order container for a given template object
Retrieve the account associated with a piece of hardware.
Retrieve a piece of hardware's active physical components.
Retrieve the billing item for a server's attached network firewall.
Retrieve transaction currently running for server.
Retrieve the SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists.
Retrieve the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.
Retrieve the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.
Retrieve information regarding an antivirus/spyware software component object.
Return a list of SoftLayer_Network_Storage volumes authorized to this device.
Retrieve information regarding a piece of hardware's specific attributes.
Return a list of SoftLayer_Network_Storage volumes that can be authorized to this device.
Retrieve the average daily total bandwidth usage for the current billing cycle.
Retrieve the average daily private bandwidth usage for the current billing cycle.
Retrieve the average daily public bandwidth usage for the current billing cycle.
Retrieves public bandwidth usage records.
Retrieve the amount of incoming private network bandwidth used by a server over a period of time.
Retrieve a piece of hardware's back-end or private network components.
Retrieve the amount of outgoing private network bandwidth used by a server over a period of time.
Retrieve a hardware's backend or private router.
Retrieve a hardware's allotted bandwidth (measured in GB).
Retrieve a hardware's allotted detail record. Allotment details link bandwidth allocation with allotments.
Retrieve bandwidth data from a tracking object.
Retrieve a bandwidth image and textual description of that image for this server.
Retrieve information regarding a piece of hardware's benchmark certifications.
Retrieve the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to.
Retrieve the raw private bandwidth usage data for the current billing cycle.
Retrieve the raw public bandwidth usage data for the current billing cycle.
Retrieve the billing item for a server.
Retrieve a flag indicating that a billing item exists.
Retrieve determines whether the hardware is ineligible for cancellation because it is disconnected.
Retrieve status indicating whether or not a piece of hardware has business continuance insurance.
Retrieve child hardware.
Retrieve a piece of hardware's components.
Retrieve a continuous data protection/server backup software component object.
Retrieve a server's control panel.
Retrieve the total cost of a server, measured in US Dollars ($USD).
Determine options available when creating a server
Retrieve an object that provides commonly used bandwidth summary components for the current billing cycle.
Get the file for the current benchmark certification result, if it exists.
Retrieve the current billable public outbound bandwidth for this hardware for the current billing cycle.
Get the detail billing data for this instance's current billing period. This excludes bandwidth usage.
Get the total billing price for this instance's hourly usage up to this point. This includes total includes all bandwidth charges.
Retrieve bandwidth graph by date.
Retrieve indicates if a server has a Customer Installed OS
Retrieve indicates if a server is a customer owned device.
calculate the average daily network traffic used by a server in gigabytes.
Retrieve information regarding the datacenter in which a piece of hardware resides.
Retrieve the name of the datacenter in which a piece of hardware resides.
Retrieve number of day(s) a server have been in spare pool.
Retrieve all hardware that has uplink network connections to a piece of hardware.
Retrieve all hardware that has uplink network connections to a piece of hardware.
Retrieve information regarding all servers attached to a piece of network hardware.
Retrieve information regarding all virtual guests attached to a piece of network hardware.
Retrieve all network hardware downstream from the selected piece of hardware.
Retrieve all network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware.
Retrieve information regarding all servers attached downstream to a piece of network hardware.
Retrieve information regarding all virtual guests attached to a piece of network hardware.
Retrieve the drive controllers contained within a piece of hardware.
Retrieve information regarding a piece of hardware's associated EVault network storage service account.
Get the subnets associated with this server that are protectable by a network component firewall.
Retrieve information regarding a piece of hardware's firewall services.
Retrieve defines the fixed components in a fixed configuration bare metal server.
Retrieves public bandwidth usage records.
Retrieve the amount of incoming public network bandwidth used by a server over a period of time.
Retrieve a piece of hardware's front-end or public network components.
Retrieve the amount of outgoing public network bandwidth used by a server over a period of time.
Retrieve a hardware's frontend or public router.
Retrieve a hardware's universally unique identifier.
Retrieve the hard drives contained within a piece of hardware.
Retrieve a SoftLayer_Hardware_Server object by IP address.
Retrieve the chassis that a piece of hardware is housed in.
Retrieve a hardware's function.
Retrieve a hardware's function.
Retrieve a hardware's status.
Retrieve determine in hardware object has TPM enabled.
Retrieve information regarding a host IPS software component object.
Retrieves bandwidth hourly over a 24-hour period for the specified hardware.
Retrieve a server's hourly billing status.
Retrieve the sum of all the inbound network traffic data for the last 30 days.
Retrieve the total private inbound bandwidth for this hardware for the current billing cycle.
Retrieve the total public inbound bandwidth for this hardware for the current billing cycle.
Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description
Retrieve the last transaction that a server's operating system was loaded.
Retrieve information regarding the last transaction a server performed.
Retrieve a piece of hardware's latest network monitoring incident.
Retrieve where a piece of hardware is located within SoftLayer's location hierarchy.
Retrieve information regarding a lockbox account associated with a server.
Retrieve a flag indicating that the hardware is a managed resource.
Retrieve a server's management network component.
Retrieve information regarding a piece of hardware's memory.
Retrieve the amount of memory a piece of hardware has, measured in gigabytes.
Retrieve a piece of hardware's metric tracking object.
Retrieve the metric tracking object id for this server.
Retrieve information regarding the monitoring agents associated with a piece of hardware.
Retrieve information regarding the hardware's monitoring robot.
Retrieve information regarding a piece of hardware's network monitoring services.
Retrieve the monitoring service flag eligibility status for a piece of hardware.
Retrieve the service flag status for a piece of hardware.
Retrieve a server's motherboard.
Retrieve information regarding a piece of hardware's network cards.
Get the IP addresses associated with this server that are protectable by a network component firewall.
Retrieve returns a hardware's network components.
Retrieve the gateway member if this device is part of a network gateway.
Retrieve whether or not this device is part of a network gateway.
Retrieve a piece of hardware's network management IP address.
Retrieve all servers with failed monitoring that are attached downstream to a piece of hardware.
Retrieve virtual guests that are attached downstream to a hardware that have failed monitoring
Retrieve the value of a hardware's network status attribute.
Retrieve the hardware's related network status attribute.
Retrieve information regarding a piece of hardware's associated network storage service account.
Retrieve the network virtual LANs (VLANs) associated with a piece of hardware's network components.
Retrieve a hardware's allotted bandwidth for the next billing cycle (measured in GB).
Retrieve a SoftLayer_Hardware_Server record.
Retrieve an open ticket requesting cancellation of this server, if one exists.
Retrieve information regarding a piece of hardware's operating system.
Retrieve a hardware's operating system software description.
Retrieve the sum of all the outbound network traffic data for the last 30 days.
Retrieve the total private outbound bandwidth for this hardware for the current billing cycle.
Retrieve the total public outbound bandwidth for this hardware for the current billing cycle.
Retrieve whether the bandwidth usage for this hardware for the current billing cycle exceeds the allocation.
Retrieve parent Hardware.
Retrieve information regarding the Point of Presence (PoP) location in which a piece of hardware resides.
Retrieve the power components for a hardware object.
Retrieve a server's power supply.
Retrieve the hardware's primary private IP address.
Retrieve information regarding the hardware's primary back-end network component.
Retrieve the hardware's primary public IP address.
Retrieve information regarding the hardware's primary public network component.
Retrieve a graph of a server's private network usage.
Retrieve a server's private bandwidth usage summary
Retrieve a graph of a server's private network usage.
Retrieve a server's primary private IP address.
Retrieve a server's private network component.
Retrieve whether the hardware only has access to the private network.
Retrieve the backend VLAN for the primary IP address of the server.
Retrieve a backend network VLAN by searching for an IP address.
Retrieve the total number of processor cores, summed from all processors that are attached to a piece of hardware
Retrieve the total number of physical processor cores, summed from all processors that are attached to a piece of hardware
Retrieve information regarding a piece of hardware's processors.
Retrieve whether the bandwidth usage for this hardware for the current billing cycle is projected to exceed the allocation.
Retrieve the projected public outbound bandwidth for this hardware for the current billing cycle.
Retrieve a graph of a server's public network usage.
Retrieve a server's public bandwidth usage summary
Retrieve a graph of a server's public network usage.
Retrieve total number of public bytes used by a server over time period specified.
Retrieve a server's public network component.
Retrieve the frontend VLAN for the primary IP address of the server
Retrieve the frontend VLAN by a server's hostname.
Retrieve the RAID controllers contained within a piece of hardware.
Retrieve recent events that impact this hardware.
Retrieve a server's remote management card.
Retrieve a hardware's associated remote management component. This is normally IPMI.
Retrieve the resource groups in which this hardware is a member.
Retrieve the reverse domain records associated with a server.
Retrieve a hardware's routers.
Retrieve collection of scale assets this hardware corresponds to.
Retrieve information regarding a piece of hardware's vulnerability scan requests.
Retrieve server's temperature and fan speed graphs as well the sensor raw data.
Retrieve a server's hardware components, software, and network components.
Retrieves server's power state
Retrieve information regarding the server room in which the hardware is located.
Retrieve information regarding the piece of hardware's service provider.
Retrieve information regarding a piece of hardware's installed software.
Retrieve sSH keys to be installed on the server during provisioning or an OS reload.
Retrieve a server's remote management card used for statistics.
Retrieve a list of upgradable items available to a piece of hardware.
Retrieve an account's associated upgrade request object, if any.
Retrieve the network device connected to a piece of hardware.
Retrieve information regarding the network component that is one level higher than a piece of hardware on the network infrastructure.
Retrieve a string containing custom user data for a hardware order.
Retrieve a list of users that have access to this computing instance.
Retrieve information regarding the virtual chassis for a piece of hardware.
Retrieve information regarding the virtual chassis siblings for a piece of hardware.
Retrieve a hardware server's virtual servers.
Retrieve a piece of hardware's virtual host record.
Retrieve a piece of hardware's virtualization platform software.
Retrieve information regarding a piece of hardware's virtual software licenses.
Retrieve information regarding the bandwidth allotment to which a piece of hardware belongs.
Retrieve the name of the bandwidth allotment belonging to a piece of hardware.
Retrieve the name of the bandwidth allotment belonging to a piece of hardware.
Retrieve a server's Windows update synchronization status
attempt to import the host record for the virtualization platform running on a server
Initiate an Idera bare metal restore for the server tied to an Idera Server Backup
Initiate an R1Soft bare metal restore for the server tied to an R1Soft CDP Server
Verifies if a server's backend ip address is pingable.
Verifies if server is pingable.
Determine if a server runs the Microsoft Windows operating system.
Issues ping command.
Issues power cycle to server.
Power off server.
Power on server.
Reboot the server via the default method.
Reboot the server via "hard" reboot.
Reboot the server via gracefully (soft reboot).
Reloads current operating system configuration.
Remove access to a SoftLayer_Network_Storage volume from this device.
Remove access to multiple SoftLayer_Network_Storage volumes from this device.
Runs a hardware stress test on the server to obtain a Passmark Certification.
Changes the password stored in our system for a servers' Operating System
Updates the private network interface (eth0) speed.
Updates the public network interface (eth1) speed.
Sets the server's user metadata value.
Shuts down the public port
Shuts down the public port
Allows servers to be added to or removed from the spare pool.
Update the root IPMI user password
Validates a collection of partitions for an operating system