SoftLayer_Hardware


SoftLayer_Hardware

Description

The SoftLayer_Hardware data type contains general information relating to a single SoftLayer hardware.

associatedMethods

Local

accountId
A hardware's associated [[SoftLayer_Account|account]] id.
Type:

integer

bareMetalInstanceFlag
When true, this flag specifies that a hardware is Bare Metal Server. Bare Metal Servers are physical bare metal servers that are billed with the same options as Virtual Servers, with monthly and hourly rates. Bare Metal instances are ordered based on processor core count and ram amount.
Type:

integer

domain
A piece of hardware's local network domain name.
Type:

string

fullyQualifiedDomainName
A name reflecting the hostname and domain of the hardware. This is created from the combined values of the hardware's hostname and domain name automatically, and thus should not be edited directly.
Type:

string

hardwareStatusId
A number reflecting the state of a hardware
Type:

integer

hostname
A hardware's hostname
Type:

string

id
A hardware's internal identification number
Type:

integer

manufacturerSerialNumber
A hardware's serial number that is supplied by the manufacturer.
Type:

string

notes
A small note about a piece of hardware to use at your discretion.
Type:

string

postInstallScriptUri
URI of the script to be downloaded and executed after installation is complete.
Type:

string

provisionDate
Type:

dateTime

serialNumber
A hardware's serial number that is supplied by SoftLayer.
Type:

string

serviceProviderId
Type:

integer

serviceProviderResourceId
A hardware's internal identification number at its service provider
Type:

integer

Relational

account
The account associated with a piece of hardware.
Type:
activeComponents
A piece of hardware's active physical components.
Type:
activeNetworkMonitorIncident
A piece of hardware's active network monitoring incidents.
Type:
allowedHost
The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists.
Type:
allowedNetworkStorage
The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.
Type:
allowedNetworkStorageReplicas
The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.
Type:
antivirusSpywareSoftwareComponent
Information regarding an antivirus/spyware software component object.
Type:
attributes
Information regarding a piece of hardware's specific attributes.
Type:
averageDailyPublicBandwidthUsage
The average daily public bandwidth usage for the current billing cycle.
Type:

float

backendNetworkComponents
A piece of hardware's back-end or private network components.
Type:
backendRouters
A hardware's backend or private router.
Type:
bandwidthAllocation
A hardware's allotted bandwidth (measured in GB).
Type:

decimal

bandwidthAllotmentDetail
A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments.
Type:
benchmarkCertifications
Information regarding a piece of hardware's benchmark certifications.
Type:
billingItem
Information regarding the billing item for a server.
Type:
billingItemFlag
A flag indicating that a billing item exists.
Type:

boolean

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

boolean

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

boolean

components
A piece of hardware's components.
Type:
continuousDataProtectionSoftwareComponent
A continuous data protection/server backup software component object.
Type:
currentBillableBandwidthUsage
The current billable public outbound bandwidth for this hardware for the current billing cycle.
Type:

decimal

datacenter
Information regarding the datacenter in which a piece of hardware resides.
Type:
datacenterName
The name of the datacenter in which a piece of hardware resides.
Type:

string

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

integer

downlinkHardware
All hardware that has uplink network connections to a piece of hardware.
Type:
downlinkNetworkHardware
All hardware that has uplink network connections to a piece of hardware.
Type:
downlinkServers
Information regarding all servers attached to a piece of network hardware.
Type:
downlinkVirtualGuests
Information regarding all virtual guests attached to a piece of network hardware.
Type:
downstreamHardwareBindings
All hardware downstream from a network device.
Type:
downstreamNetworkHardware
All network hardware downstream from the selected piece of hardware.
Type:
downstreamNetworkHardwareWithIncidents
All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware.
Type:
downstreamServers
Information regarding all servers attached downstream to a piece of network hardware.
Type:
downstreamVirtualGuests
Information regarding all virtual guests attached to a piece of network hardware.
Type:
driveControllers
The drive controllers contained within a piece of hardware.
Type:
evaultNetworkStorage
Information regarding a piece of hardware's associated EVault network storage service account.
Type:
firewallServiceComponent
Information regarding a piece of hardware's firewall services.
Type:
fixedConfigurationPreset
Defines the fixed components in a fixed configuration bare metal server.
Type:
frontendNetworkComponents
A piece of hardware's front-end or public network components.
Type:
frontendRouters
A hardware's frontend or public router.
Type:
globalIdentifier
A hardware's universally unique identifier.
Type:

string

hardDrives
The hard drives contained within a piece of hardware.
Type:
hardwareChassis
The chassis that a piece of hardware is housed in.
Type:
hardwareFunction
A hardware's function.
Type:
hardwareFunctionDescription
A hardware's function.
Type:

string

hardwareStatus
A hardware's status.
Type:
hasTrustedPlatformModuleBillingItemFlag
Determine in hardware object has TPM enabled.
Type:

boolean

hostIpsSoftwareComponent
Information regarding a host IPS software component object.
Type:
hourlyBillingFlag
A server's hourly billing status.
Type:

boolean

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

decimal

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

decimal

lastTransaction
Information regarding the last transaction a server performed.
Type:
latestNetworkMonitorIncident
A piece of hardware's latest network monitoring incident.
Type:
location
Where a piece of hardware is located within SoftLayer's location hierarchy.
Type:
locationPathString
Type:

string

lockboxNetworkStorage
Information regarding a lockbox account associated with a server.
Type:
managedResourceFlag
A flag indicating that the hardware is a managed resource.
Type:

boolean

memory
Information regarding a piece of hardware's memory.
Type:
memoryCapacity
The amount of memory a piece of hardware has, measured in gigabytes.
Type:

unsigned integer

metricTrackingObject
A piece of hardware's metric tracking object.
Type:
monitoringAgents
Information regarding the monitoring agents associated with a piece of hardware.
Type:
monitoringRobot
Information regarding the hardware's monitoring robot.
Type:
monitoringServiceComponent
Information regarding a piece of hardware's network monitoring services.
Type:
monitoringServiceEligibilityFlag
The monitoring service flag eligibility status for a piece of hardware.
Type:

boolean

monitoringServiceFlag
The service flag status for a piece of hardware.
Type:

boolean

motherboard
Information regarding a piece of hardware's motherboard.
Type:
networkCards
Information regarding a piece of hardware's network cards.
Type:
networkComponents
Returns a hardware's network components.
Type:
networkGatewayMember
The gateway member if this device is part of a network gateway.
Type:
networkGatewayMemberFlag
Whether or not this device is part of a network gateway.
Type:

boolean

networkManagementIpAddress
A piece of hardware's network management IP address.
Type:

string

networkMonitorAttachedDownHardware
All servers with failed monitoring that are attached downstream to a piece of hardware.
Type:
networkMonitorAttachedDownVirtualGuests
Virtual guests that are attached downstream to a hardware that have failed monitoring
Type:
networkMonitorIncidents
The status of all of a piece of hardware's network monitoring incidents.
Type:
networkMonitors
Information regarding a piece of hardware's network monitors.
Type:
networkStatus
The value of a hardware's network status attribute.
Type:

string

networkStatusAttribute
The hardware's related network status attribute.
Type:
networkStorage
Information regarding a piece of hardware's associated network storage service account.
Type:
networkVlans
The network virtual LANs (VLANs) associated with a piece of hardware's network components.
Type:
nextBillingCycleBandwidthAllocation
A hardware's allotted bandwidth for the next billing cycle (measured in GB).
Type:

decimal

operatingSystem
Information regarding a piece of hardware's operating system.
Type:
operatingSystemReferenceCode
A hardware's operating system software description.
Type:

string

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

decimal

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

decimal

parentHardware
Parent Hardware.
Type:
pointOfPresenceLocation
Information regarding the Point of Presence (PoP) location in which a piece of hardware resides.
Type:
powerComponents
The power components for a hardware object.
Type:
powerSupply
Information regarding a piece of hardware's power supply.
Type:
primaryBackendIpAddress
The hardware's primary private IP address.
Type:

string

primaryBackendNetworkComponent
Information regarding the hardware's primary back-end network component.
Type:
primaryIpAddress
The hardware's primary public IP address.
Type:

string

primaryNetworkComponent
Information regarding the hardware's primary public network component.
Type:
privateNetworkOnlyFlag
Whether the hardware only has access to the private network.
Type:

boolean

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

unsigned integer

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

unsigned integer

processors
Information regarding a piece of hardware's processors.
Type:
raidControllers
The RAID controllers contained within a piece of hardware.
Type:
recentEvents
Recent events that impact this hardware.
Type:
remoteManagementAccounts
User credentials to issue commands and/or interact with the server's remote management card.
Type:
remoteManagementComponent
A hardware's associated remote management component. This is normally IPMI.
Type:
resourceGroups
The resource groups in which this hardware is a member.
Type:
routers
A hardware's routers.
Type:
scaleAssets
Collection of scale assets this hardware corresponds to.
Type:
securityScanRequests
Information regarding a piece of hardware's vulnerability scan requests.
Type:
serverRoom
Information regarding the server room in which the hardware is located.
Type:
serviceProvider
Information regarding the piece of hardware's service provider.
Type:
softwareComponents
Information regarding a piece of hardware's installed software.
Type:
sparePoolBillingItem
Information regarding the billing item for a spare pool server.
Type:
sshKeys
SSH keys to be installed on the server during provisioning or an OS reload.
Type:
upgradeRequest
An account's associated upgrade request object, if any.
Type:
uplinkHardware
The network device connected to a piece of hardware.
Type:
uplinkNetworkComponents
Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure.
Type:
userData
An array containing a single string of custom user data for a hardware order. Max size is 16 kb.
Type:
virtualChassis
Information regarding the virtual chassis for a piece of hardware.
Type:
virtualChassisSiblings
Information regarding the virtual chassis siblings for a piece of hardware.
Type:
virtualHost
A piece of hardware's virtual host record.
Type:
virtualLicenses
Information regarding a piece of hardware's virtual software licenses.
Type:
virtualRack
Information regarding the bandwidth allotment to which a piece of hardware belongs.
Type:
virtualRackId
The name of the bandwidth allotment belonging to a piece of hardware.
Type:

integer

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

string

virtualizationPlatform
A piece of hardware's virtualization platform software.
Type:

Count

activeComponentCount
A count of a piece of hardware's active physical components.
Type:

unsignedLong

activeNetworkMonitorIncidentCount
A count of a piece of hardware's active network monitoring incidents.
Type:

unsignedLong

allPowerComponentCount
A count of
Type:

unsignedLong

allowedNetworkStorageCount
A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.
Type:

unsignedLong

allowedNetworkStorageReplicaCount
A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.
Type:

unsignedLong

attributeCount
A count of information regarding a piece of hardware's specific attributes.
Type:

unsignedLong

backendNetworkComponentCount
A count of a piece of hardware's back-end or private network components.
Type:

unsignedLong

backendRouterCount
A count of a hardware's backend or private router.
Type:

unsignedLong

benchmarkCertificationCount
A count of information regarding a piece of hardware's benchmark certifications.
Type:

unsignedLong

childrenHardwareCount
A count of child hardware.
Type:

unsignedLong

componentCount
A count of a piece of hardware's components.
Type:

unsignedLong

downlinkHardwareCount
A count of all hardware that has uplink network connections to a piece of hardware.
Type:

unsignedLong

downlinkNetworkHardwareCount
A count of all hardware that has uplink network connections to a piece of hardware.
Type:

unsignedLong

downlinkServerCount
A count of information regarding all servers attached to a piece of network hardware.
Type:

unsignedLong

downlinkVirtualGuestCount
A count of information regarding all virtual guests attached to a piece of network hardware.
Type:

unsignedLong

downstreamHardwareBindingCount
A count of all hardware downstream from a network device.
Type:

unsignedLong

downstreamNetworkHardwareCount
A count of all network hardware downstream from the selected piece of hardware.
Type:

unsignedLong

downstreamNetworkHardwareWithIncidentCount
A count of all network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware.
Type:

unsignedLong

downstreamServerCount
A count of information regarding all servers attached downstream to a piece of network hardware.
Type:

unsignedLong

downstreamVirtualGuestCount
A count of information regarding all virtual guests attached to a piece of network hardware.
Type:

unsignedLong

driveControllerCount
A count of the drive controllers contained within a piece of hardware.
Type:

unsignedLong

evaultNetworkStorageCount
A count of information regarding a piece of hardware's associated EVault network storage service account.
Type:

unsignedLong

frontendNetworkComponentCount
A count of a piece of hardware's front-end or public network components.
Type:

unsignedLong

frontendRouterCount
A count of a hardware's frontend or public router.
Type:

unsignedLong

hardDriveCount
A count of the hard drives contained within a piece of hardware.
Type:

unsignedLong

memoryCount
A count of information regarding a piece of hardware's memory.
Type:

unsignedLong

monitoringAgentCount
A count of information regarding the monitoring agents associated with a piece of hardware.
Type:

unsignedLong

networkCardCount
A count of information regarding a piece of hardware's network cards.
Type:

unsignedLong

networkComponentCount
A count of returns a hardware's network components.
Type:

unsignedLong

networkMonitorAttachedDownHardwareCount
A count of all servers with failed monitoring that are attached downstream to a piece of hardware.
Type:

unsignedLong

networkMonitorAttachedDownVirtualGuestCount
A count of virtual guests that are attached downstream to a hardware that have failed monitoring
Type:

unsignedLong

networkMonitorCount
A count of information regarding a piece of hardware's network monitors.
Type:

unsignedLong

networkMonitorIncidentCount
A count of the status of all of a piece of hardware's network monitoring incidents.
Type:

unsignedLong

networkStorageCount
A count of information regarding a piece of hardware's associated network storage service account.
Type:

unsignedLong

networkVlanCount
A count of the network virtual LANs (VLANs) associated with a piece of hardware's network components.
Type:

unsignedLong

notesHistoryCount
A count of
Type:

unsignedLong

powerComponentCount
A count of the power components for a hardware object.
Type:

unsignedLong

powerSupplyCount
A count of information regarding a piece of hardware's power supply.
Type:

unsignedLong

processorCount
A count of information regarding a piece of hardware's processors.
Type:

unsignedLong

raidControllerCount
A count of the RAID controllers contained within a piece of hardware.
Type:

unsignedLong

recentEventCount
A count of recent events that impact this hardware.
Type:

unsignedLong

remoteManagementAccountCount
A count of user credentials to issue commands and/or interact with the server's remote management card.
Type:

unsignedLong

resourceConfigurationCount
A count of
Type:

unsignedLong

resourceGroupCount
A count of the resource groups in which this hardware is a member.
Type:

unsignedLong

resourceGroupMemberReferenceCount
A count of
Type:

unsignedLong

resourceGroupRoleCount
A count of
Type:

unsignedLong

routerCount
A count of a hardware's routers.
Type:

unsignedLong

scaleAssetCount
A count of collection of scale assets this hardware corresponds to.
Type:

unsignedLong

securityScanRequestCount
A count of information regarding a piece of hardware's vulnerability scan requests.
Type:

unsignedLong

softwareComponentCount
A count of information regarding a piece of hardware's installed software.
Type:

unsignedLong

sshKeyCount
A count of sSH keys to be installed on the server during provisioning or an OS reload.
Type:

unsignedLong

storageNetworkComponentCount
A count of
Type:

unsignedLong

tagReferenceCount
A count of
Type:

unsignedLong

uplinkNetworkComponentCount
A count of information regarding the network component that is one level higher than a piece of hardware on the network infrastructure.
Type:

unsignedLong

userDataCount
A count of an array containing a single string of custom user data for a hardware order. Max size is 16 kb.
Type:

unsignedLong

virtualChassisSiblingCount
A count of information regarding the virtual chassis siblings for a piece of hardware.
Type:

unsignedLong

virtualLicenseCount
A count of information regarding a piece of hardware's virtual software licenses.
Type:

unsignedLong