SoftLayer_Hardware_Server


SoftLayer_Hardware_Server

Description

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

activatePrivatePort

Activate a server’s private network interface.

activatePublicPort

Activate a server’s public network interface.

allowAccessToNetworkStorage

Allow access to a SoftLayer_Network_Storage volume from this device.

allowAccessToNetworkStorageList

Allow access to multiple SoftLayer_Network_Storage volumes from this device.

bootToRescueLayer

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

captureImage

Captures an Image of the hard disk on the physical machine.

createFirmwareReflashTransaction

Runs firmware reflash on the servers components.

createFirmwareUpdateTransaction

Runs firmware updates on the servers components.

createHyperThreadingUpdateTransaction

Runs BIOS update on the server to change the hyper-threading configuration.

createObject

Create a new server

deleteObject

Delete a server

deleteSoftwareComponentPasswords

Delete software component passwords.

deleteTag

Delete a tag

editObject

Edit a server’s properties

editSoftwareComponentPasswords

Edit the properties of software component passwords.

executeRemoteScript

Download and run remote script from uri on the hardware. Requires https for script to be executed after download.

findByIpAddress

Find hardware by its primary public or private IP (ipv4) address.

generateOrderTemplate

Obtain an order container for a given template object

getAccount

The account associated with a piece of hardware.

getActiveComponents

A piece of hardware’s active physical components.

getActiveNetworkFirewallBillingItem

The billing item for a server’s attached network firewall.

getActiveNetworkMonitorIncident

A piece of hardware’s active network monitoring incidents.

getActiveTransaction

Transaction currently running for server.

getActiveTransactions

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

getAllowedHost

The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists.

getAllowedNetworkStorage

The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.

getAllowedNetworkStorageReplicas

The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.

getAntivirusSpywareSoftwareComponent

Information regarding an antivirus/spyware software component object.

getAttachedNetworkStorages

Return a list of SoftLayer_Network_Storage volumes authorized to this device.

getAttributes

Information regarding a piece of hardware’s specific attributes.

getAvailableBillingTermChangePrices

Retrieves a list of available term prices available to this of hardware.

getAvailableMonitoring

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

getAvailableNetworkStorages

Return a list of SoftLayer_Network_Storage volumes that can be authorized to this device.

getAverageDailyBandwidthUsage

The average daily total bandwidth usage for the current billing cycle.

getAverageDailyPrivateBandwidthUsage

The average daily private bandwidth usage for the current billing cycle.

getAverageDailyPublicBandwidthUsage

The average daily public bandwidth usage for the current billing cycle.

getBackendBandwidthUsage

Retrieves public bandwidth usage records.

getBackendIncomingBandwidth

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

getBackendNetworkComponents

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

A hardware’s backend or private router.

getBandwidthAllocation

A hardware’s allotted bandwidth (measured in GB).

getBandwidthAllotmentDetail

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

Information regarding a piece of hardware’s benchmark certifications.

getBillingCycleBandwidthUsage

The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to.

getBillingCyclePrivateBandwidthUsage

The raw private bandwidth usage data for the current billing cycle.

getBillingCyclePublicBandwidthUsage

The raw public bandwidth usage data for the current billing cycle.

getBillingItem

Information regarding the billing item for a server.

getBillingItemFlag

A flag indicating that a billing item exists.

getBiosPasswordNullFlag

Determine if BIOS password should be left as null.

getBlockCancelBecauseDisconnectedFlag

Determines whether the hardware is ineligible for cancellation because it is disconnected.

getBootModeOptions

Retrieve the valid boot modes for this server.

getBusinessContinuanceInsuranceFlag

Status indicating whether or not a piece of hardware has business continuance insurance.

getCaptureEnabledFlag

Determine if the server is able to be image captured. If unable to image capture a reason will be provided.

getChildrenHardware

Child hardware.

getComponents

A piece of hardware’s components.

getContinuousDataProtectionSoftwareComponent

A continuous data protection/server backup software component object.

getControlPanel

A server’s control panel.

getCost

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

getCreateObjectOptions

Determine options available when creating a server

getCurrentBandwidthSummary

An object that provides commonly used bandwidth summary components for the current billing cycle.

getCurrentBenchmarkCertificationResultFile

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

getCurrentBillableBandwidthUsage

The current billable public outbound bandwidth for this hardware for the current billing cycle.

getCurrentBillingTotal

Get the billing total for this instance’s usage up to this point. This total includes all bandwidth charges.

getCustomBandwidthDataByDate

Retrieve bandwidth graph by date.

getCustomerInstalledOperatingSystemFlag

Indicates if a server has a Customer Installed OS

getCustomerOwnedFlag

Indicates if a server is a customer owned device.

getDailyAverage

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

getDatacenter

Information regarding the datacenter in which a piece of hardware resides.

getDatacenterName

The name of the datacenter in which a piece of hardware resides.

getDaysInSparePool

Number of day(s) a server have been in spare pool.

getDownlinkHardware

All hardware that has uplink network connections to a piece of hardware.

getDownlinkNetworkHardware

All hardware that has uplink network connections to a piece of hardware.

getDownlinkServers

Information regarding all servers attached to a piece of network hardware.

getDownlinkVirtualGuests

Information regarding all virtual guests attached to a piece of network hardware.

getDownstreamHardwareBindings

All hardware downstream from a network device.

getDownstreamNetworkHardware

All network hardware downstream from the selected piece of hardware.

getDownstreamNetworkHardwareWithIncidents

All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. [DEPRECATED]

getDownstreamServers

Information regarding all servers attached downstream to a piece of network hardware.

getDownstreamVirtualGuests

Information regarding all virtual guests attached to a piece of network hardware.

getDriveControllers

The drive controllers contained within a piece of hardware.

getEvaultNetworkStorage

Information regarding a piece of hardware’s associated EVault network storage service account.

getFirewallProtectableSubnets

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

getFirewallServiceComponent

Information regarding a piece of hardware’s firewall services.

getFixedConfigurationPreset

Defines the fixed components in a fixed configuration bare metal server.

getFrontendBandwidthUsage

Retrieves public bandwidth usage records.

getFrontendIncomingBandwidth

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

getFrontendNetworkComponents

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

A hardware’s frontend or public router.

getFutureBillingItem

Information regarding the future billing item for a server.

getGlobalIdentifier

A hardware’s universally unique identifier.

getHardDrives

The hard drives contained within a piece of hardware.

getHardwareByIpAddress

Retrieve a SoftLayer_Hardware_Server object by IP address.

getHardwareChassis

The chassis that a piece of hardware is housed in.

getHardwareFunction

A hardware’s function.

getHardwareFunctionDescription

A hardware’s function.

getHardwareState

A hardware’s power/transaction state.

getHardwareStatus

A hardware’s status.

getHasSingleRootVirtualizationBillingItemFlag

Determine if hardware has Single Root IO VIrtualization (SR-IOV) billing item.

getHasTrustedPlatformModuleBillingItemFlag

Determine in hardware object has TPM enabled.

getHostIpsSoftwareComponent

Information regarding a host IPS software component object.

getHourlyBandwidth

Retrieves bandwidth hourly over a 24-hour period for the specified hardware.

getHourlyBillingFlag

A server’s hourly billing status.

getInboundBandwidthUsage

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

getInboundPrivateBandwidthUsage

The total private inbound bandwidth for this hardware for the current billing cycle.

getInboundPublicBandwidthUsage

The total public inbound bandwidth for this hardware for the current billing cycle.

getIsBillingTermChangeAvailableFlag

Whether or not this hardware object is eligible to change to term billing.

getIsCloudReadyNodeCertified

Determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute.

getIsIpmiDisabled

Determine if remote management has been disabled due to port speed.

getIsVirtualPrivateCloudNode

Determine if hardware object is a Virtual Private Cloud node.

getItemPricesFromSoftwareDescriptions

Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description

getLastOperatingSystemReload

The last transaction that a server’s operating system was loaded.

getLastTransaction

Information regarding the last transaction a server performed.

getLatestNetworkMonitorIncident

A piece of hardware’s latest network monitoring incident.

getLocation

Where a piece of hardware is located within SoftLayer’s location hierarchy.

getLockboxNetworkStorage

Information regarding a lockbox account associated with a server.

getLogicalVolumeStorageGroups

Returns a list of logical volumes on the physical machine.

getManagedResourceFlag

A flag indicating that the hardware is a managed resource.

getManagementNetworkComponent

Retrieve a server’s management network component.

getMemory

Information regarding a piece of hardware’s memory.

getMemoryCapacity

The amount of memory a piece of hardware has, measured in gigabytes.

getMetricTrackingObject

A piece of hardware’s metric tracking object.

getMetricTrackingObjectId

The metric tracking object id for this server.

getMonitoringServiceComponent

Information regarding a piece of hardware’s network monitoring services.

getMonitoringUserNotification

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

Information regarding a piece of hardware’s motherboard.

getNetworkCards

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

Returns a hardware’s network components.

getNetworkGatewayMember

The gateway member if this device is part of a network gateway.

getNetworkGatewayMemberFlag

Whether or not this device is part of a network gateway.

getNetworkManagementIpAddress

A piece of hardware’s network management IP address.

getNetworkMonitorAttachedDownHardware

All servers with failed monitoring that are attached downstream to a piece of hardware.

getNetworkMonitorAttachedDownVirtualGuests

Virtual guests that are attached downstream to a hardware that have failed monitoring

getNetworkMonitorIncidents

The status of all of a piece of hardware’s network monitoring incidents.

getNetworkMonitors

Information regarding a piece of hardware’s network monitors.

getNetworkStatus

The value of a hardware’s network status attribute. [DEPRECATED]

getNetworkStatusAttribute

The hardware’s related network status attribute. [DEPRECATED]

getNetworkStorage

Information regarding a piece of hardware’s associated network storage service account.

getNetworkVlans

The network virtual LANs (VLANs) associated with a piece of hardware’s network components.

getNextBillingCycleBandwidthAllocation

A hardware’s allotted bandwidth for the next billing cycle (measured in GB).

getNvRamCapacity

The amount of non-volatile memory a piece of hardware has, measured in gigabytes.

getObject

Retrieve a SoftLayer_Hardware_Server record.

getOpenCancellationTicket

An open ticket requesting cancellation of this server, if one exists.

getOperatingSystem

Information regarding a piece of hardware’s operating system.

getOperatingSystemReferenceCode

A hardware’s operating system software description.

getOutboundBandwidthUsage

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

getOutboundPrivateBandwidthUsage

The total private outbound bandwidth for this hardware for the current billing cycle.

getOutboundPublicBandwidthUsage

The total public outbound bandwidth for this hardware for the current billing cycle.

getOverBandwidthAllocationFlag

Whether the bandwidth usage for this hardware for the current billing cycle exceeds the allocation.

getPMInfo

Retrieve a server’s hardware state via its internal sensors.

getParentBay

Blade Bay

getParentHardware

Parent Hardware.

getPointOfPresenceLocation

Information regarding the Point of Presence (PoP) location in which a piece of hardware resides.

getPowerComponents

The power components for a hardware object.

getPowerSupply

Information regarding a piece of hardware’s power supply.

getPrimaryBackendIpAddress

The hardware’s primary private IP address.

getPrimaryBackendNetworkComponent

Information regarding the hardware’s primary back-end network component.

getPrimaryIpAddress

The hardware’s primary public IP address.

getPrimaryNetworkComponent

Information regarding the hardware’s primary public network component.

getPrivateBackendNetworkComponents

A collection of backendNetwork components

getPrivateBandwidthData

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

getPrivateBandwidthDataSummary

Retrieve a server’s private bandwidth usage summary

getPrivateBandwidthGraphImage

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

getPrivateIpAddress

A server’s primary private IP address.

getPrivateNetworkComponent

Retrieve a server’s private network component.

getPrivateNetworkOnlyFlag

Whether the hardware 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

The total number of processor cores, summed from all processors that are attached to a piece of hardware

getProcessorPhysicalCoreAmount

The total number of physical processor cores, summed from all processors that are attached to a piece of hardware

getProcessors

Information regarding a piece of hardware’s processors.

getProjectedOverBandwidthAllocationFlag

Whether the bandwidth usage for this hardware for the current billing cycle is projected to exceed the allocation.

getProjectedPublicBandwidthUsage

The projected public outbound bandwidth for this hardware for the current billing cycle.

getPublicBandwidthData

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

getPublicBandwidthDataSummary

Retrieve a server’s public bandwidth usage summary

getPublicBandwidthGraphImage

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.

getRaidControllers

The RAID controllers contained within a piece of hardware.

getReadyNodeFlag

Determine if hardware object is vSan Ready Node.

getRecentEvents

Recent events that impact this hardware.

getRecentRemoteManagementCommands

The last five commands issued to the server’s remote management card.

getRemoteManagement

A server’s remote management card.

getRemoteManagementAccounts

User credentials to issue commands and/or interact with the server’s remote management card.

getRemoteManagementComponent

A hardware’s associated remote management component. This is normally IPMI.

getRemoteManagementUsers

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

getResourceGroups

The resource groups in which this hardware is a member.

getReverseDomainRecords

Retrieve the reverse domain records associated with a server.

getRouters

A hardware’s routers.

getScaleAssets

[DEPRECATED] Collection of scale assets this hardware corresponds to.

getSecurityScanRequests

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

Information regarding the server room in which the hardware is located.

getServerTemperatureGraphs

Retrieve server’s temperature graphs

getServiceProvider

Information regarding the piece of hardware’s service provider.

getSoftwareComponents

Information regarding a piece of hardware’s installed software.

getSoftwareGuardExtensionEnabled

Determine if hardware object has Software Guard Extension (SGX) enabled.

getSparePoolBillingItem

Information regarding the billing item for a spare pool server.

getSshKeys

SSH keys to be installed on the server during provisioning or an OS reload.

getStatisticsRemoteManagement

A server’s remote management card used for statistics.

getStorageNetworkComponents

A piece of hardware’s private storage network components. [Deprecated]

getTransactionHistory

Get transaction history for a piece of hardware.

getUefiBootFlag

Whether to use UEFI boot instead of BIOS.

getUpgradeItemPrices

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

getUpgradeRequest

An account’s associated upgrade request object, if any.

getUpgradeableActiveComponents

A piece of hardware’s active upgradeable physical components.

getUplinkHardware

The network device connected to a piece of hardware.

getUplinkNetworkComponents

Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure.

getUserData

An array containing a single string of custom user data for a hardware order. Max size is 16 kb.

getUsers

A list of users that have access to this computing instance.

getValidBlockDeviceTemplateGroups

Return a list of valid block device template groups based on this host

getVirtualChassis

Information regarding the virtual chassis for a piece of hardware.

getVirtualChassisSiblings

Information regarding the virtual chassis siblings for a piece of hardware.

getVirtualGuests

[DEPRECATED] A hardware server’s virtual servers.

getVirtualHost

A piece of hardware’s virtual host record.

getVirtualLicenses

Information regarding a piece of hardware’s virtual software licenses.

getVirtualRack

Information regarding the bandwidth allotment to which a piece of hardware belongs.

getVirtualRackId

The name of the bandwidth allotment belonging to a piece of hardware.

getVirtualRackName

The name of the bandwidth allotment belonging to a piece of hardware.

getVirtualizationPlatform

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

initiateIderaBareMetalRestore

Initiate an Idera bare metal restore for the server tied to an Idera Server Backup

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.

massFirmwareReflash

Runs firmware reflashes on the servers components.

massFirmwareUpdate

Runs firmware updates on the servers components.

massHyperThreadingUpdate

Runs firmware reflashes on the servers components.

massReloadOperatingSystem

Reloads operating system configuration on a set of hardware Ids.

massSparePool

Allows multiple servers to be added to or removed from the spare pool.

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.

removeAccessToNetworkStorage

Remove access to a SoftLayer_Network_Storage volume from this device.

removeAccessToNetworkStorageList

Remove access to multiple SoftLayer_Network_Storage volumes from this device.

removeTags

Remove a tag reference

runPassmarkCertificationBenchmark

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

setOperatingSystemPassword

Changes the password stored in our system for a servers’ Operating System

setPrivateNetworkInterfaceSpeed

Set the speed and redundancy configuration of a server’s private network interface.

setPublicNetworkInterfaceSpeed

Set the speed and redundancy configuration of a server’s public network interface.

setUserMetadata

Sets the server’s user metadata value.

shutdownPrivatePort

Disconnect a server’s private network interface.

shutdownPublicPort

Disconnect a server’s public network interface.

sparePool

Allows servers to be added to or removed from the spare pool.

testRaidAlertService

Tests the RAID Alert service.

toggleManagementInterface

Toggle the IPMI interface on and off.

updateIpmiPassword

Update the root IPMI user password

validatePartitionsForOperatingSystem

Validates a collection of partitions for an operating system