SoftLayer Hardware (type)
From SoftLayer Development Network Wiki
This page refers to the SoftLayer_Hardware data type. For information on the SoftLayer_Hardware service please see SoftLayer_Hardware.
Overview
The SoftLayer_Hardware data type contains general information relating to a single SoftLayer hardware.
| Warning! Even though our API is object based, XML-RPC can only return data as array values. The SOAP implementation treats data as object properties. |
Local Properties
accountId
A hardware's associated account id.
- Type: integer
- Length: 10 digits
- Permission: edit company
bareMetalInstanceFlag
When true this flag specifies that a hardware is Bare Metal computing Instance. Bare Metal computing instances are Cloud Computing Instances that have an entire server dedicated to them.
- Type: integer
- Length: 4 digits
domain
A piece of hardware's local network domain name.
- Type: string
- Length: 100 characters
hardwareStatusId
A number reflecting the state of a hardware
- Type: integer
- Length: 10 digits
hostname
A hardware's hostname
- Type: string
- Length: 100 characters
id
A hardware's internal identification number
- Type: integer
notes
A small note about a piece of hardware to use at your discretion.
- Type: string
- Length: 1000 characters
Relational Properties
account
The account that a hardware belongs to.
account can be queried by object mask.
account must be a unique value.
- Type: SoftLayer_Account
antivirusSpywareSoftwareComponent
A antivirus / spyware software component object.
antivirusSpywareSoftwareComponent can be queried by object mask.
antivirusSpywareSoftwareComponent must be a unique value.
attributes
A hardware's specific attributes.
attributes can be queried by object mask.
backendNetworkComponents
A hardware's backend or private network components. Network components are hardware components such as IPMI cards or Ethernet cards.
backendNetworkComponents can be queried by object mask.
backendRouters
A hardware's backend or private router.
backendRouters can be queried by object mask.
bandwidthAllocation
A hardware's allotted bandwidth (measured in GB).
bandwidthAllocation can be queried by object mask.
bandwidthAllocation must be a unique value.
- Type: decimal
bandwidthAllotmentDetail
A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments.
bandwidthAllotmentDetail can be queried by object mask.
bandwidthAllotmentDetail must be a unique value.
benchmarkCertifications
A hardware's benchmark certifications.
benchmarkCertifications can be queried by object mask.
businessContinuanceInsuranceFlag
A flag indicating if a hardware has business continuance insurance. Business continuance insurance protects the owner from bandwidth overage charges in the event that the hardware is compromised from an unauthorized user.
businessContinuanceInsuranceFlag can be queried by object mask.
businessContinuanceInsuranceFlag must be a unique value.
- Type: boolean
components
A hardware's components. Hardware components include hard drives, processors, drive controllers, etc.
components can be queried by object mask.
datacenter
The datacenter that a piece of hardware resides in.
datacenter can be queried by object mask.
datacenter must be a unique value.
- Type: SoftLayer_Location
driveControllers
The drive controllers contained within a piece of hardware.
driveControllers can be queried by object mask.
evaultNetworkStorage
A piece of hardware's associated EVault network storage service account.
evaultNetworkStorage can be queried by object mask.
firewallServiceComponent
A hardware's hardware firewall services.
firewallServiceComponent can be queried by object mask.
firewallServiceComponent must be a unique value.
frontendNetworkComponents
A hardware's frontend or public network components. Network components are hardware components such as IPMI cards or Ethernet cards.
frontendNetworkComponents can be queried by object mask.
frontendRouters
A hardware's frontend or public router.
frontendRouters can be queried by object mask.
- Type: SoftLayer_HardwareArray
hardDrives
The hard drives contained within a piece of hardware.
hardDrives can be queried by object mask.
hardwareChassis
The chassis that a piece of hardware is housed in.
hardwareChassis can be queried by object mask.
hardwareChassis must be a unique value.
hardwareFunction
A hardware's function.
hardwareFunction can be queried by object mask.
hardwareFunction must be a unique value.
hardwareStatus
A hardware's status.
hardwareStatus can be queried by object mask.
hardwareStatus must be a unique value.
hostIpsSoftwareComponent
A host IPS software component object.
hostIpsSoftwareComponent can be queried by object mask.
hostIpsSoftwareComponent must be a unique value.
hourlyBillingFlag
Whether or not a server is billed hourly instead of monthly. This flag is only applicable to Bare Metal Instances.
hourlyBillingFlag can be queried by object mask.
hourlyBillingFlag must be a unique value.
- Type: boolean
lastTransaction
The last transaction a server had performed.
lastTransaction can be queried by object mask.
lastTransaction must be a unique value.
location
Where a piece of hardware is located within SoftLayer's location hierarchy.
location can be queried by object mask.
location must be a unique value.
- Type: SoftLayer_Location
lockboxNetworkStorage
A lockbox account associated with a server.
lockboxNetworkStorage can be queried by object mask.
lockboxNetworkStorage must be a unique value.
memory
A hardware's memory.
memory can be queried by object mask.
memoryCapacity
The amount of memory a piece of hardware has, measured in gigabytes.
memoryCapacity can be queried by object mask.
memoryCapacity must be a unique value.
- Type: unsigned integer
metricTrackingObject
A hardware's metric tracking object. This object records all periodic polled data available to this hardware.
metricTrackingObject can be queried by object mask.
metricTrackingObject must be a unique value.
monitoringServiceComponent
A hardware's network monitoring services.
monitoringServiceComponent can be queried by object mask.
monitoringServiceComponent must be a unique value.
motherboard
A hardware's motherboard.
motherboard can be queried by object mask.
motherboard must be a unique value.
networkComponents
A hardware's network components. Network components are hardware components such as IPMI cards or Ethernet cards.
networkComponents can be queried by object mask.
networkManagementIpAddress
A hardware's network management IP address.
networkManagementIpAddress must be a unique value.
- Type: string
networkMonitors
A hardware's network monitors.
networkMonitors can be queried by object mask.
networkStorage
A piece of hardware's associated network storage service account.
networkStorage can be queried by object mask.
networkVlans
The network Vlan's that a hardware's network components are associated with.
networkVlans can be queried by object mask.
nextBillingCycleBandwidthAllocation
A hardware's allotted bandwidth for the next billing cycle (measured in GB).
nextBillingCycleBandwidthAllocation can be queried by object mask.
nextBillingCycleBandwidthAllocation must be a unique value.
- Type: decimal
operatingSystem
A hardware's operating system.
operatingSystem can be queried by object mask.
operatingSystem must be a unique value.
primaryBackendIpAddress
The hardware's primary private IP address.
primaryBackendIpAddress must be a unique value.
- Type: string
primaryBackendNetworkComponent
The hardware's primary backend network component.
primaryBackendNetworkComponent can be queried by object mask.
primaryBackendNetworkComponent must be a unique value.
primaryIpAddress
The hardware's primary public IP address.
primaryIpAddress must be a unique value.
- Type: string
primaryNetworkComponent
The hardware's primary public network component.
primaryNetworkComponent can be queried by object mask.
primaryNetworkComponent must be a unique value.
processorCoreAmount
The total number of processor cores, summed from all processors that are attached to a piece of hardware
processorCoreAmount can be queried by object mask.
processorCoreAmount must be a unique value.
- Type: unsigned integer
processors
A hardware's processors.
processors can be queried by object mask.
raidControllers
The RAID controllers contained within a piece of hardware.
raidControllers can be queried by object mask.
remoteManagementComponent
A hardware's associated remote management component. This is normally IPMI.
remoteManagementComponent can be queried by object mask.
remoteManagementComponent must be a unique value.
securityScanRequests
A hardware's vulnerability scan requests.
securityScanRequests can be queried by object mask.
serverRoom
The server room that a hardware is located at. There may be more than one server room for every data center.
serverRoom can be queried by object mask.
serverRoom must be a unique value.
- Type: SoftLayer_Location
softwareComponents
A hardware's installed software.
softwareComponents can be queried by object mask.
storageNetworkComponents
A hardware's private storage network components. Network components are hardware components such as IPMI cards or Ethernet cards.
storageNetworkComponents can be queried by object mask.
upgradeRequest
An account's associated upgrade request object if any.
upgradeRequest can be queried by object mask.
upgradeRequest must be a unique value.
uplinkNetworkComponents
The network component that is one level higher to a hardware on the network infrastructure. likely a switch or a router.
uplinkNetworkComponents can be queried by object mask.
virtualHost
A hardware's virtual host record.
virtualHost can be queried by object mask.
virtualHost must be a unique value.
- Type: SoftLayer_Virtual_Host
virtualRack
The name of the bandwidth allotment that a hardware belongs too.
virtualRack can be queried by object mask.
virtualRack must be a unique value.
virtualRackId
The name of the bandwidth allotment that a hardware belongs too.
virtualRackId can be queried by object mask.
virtualRackId must be a unique value.
- Type: integer
virtualRackName
The name of the bandwidth allotment that a hardware belongs too.
virtualRackName can be queried by object mask.
virtualRackName must be a unique value.
- Type: string
virtualizationPlatform
A hardware's virtualization platform software.
virtualizationPlatform can be queried by object mask.
virtualizationPlatform must be a unique value.
Count Properties
attributeCount
A count of a hardware's specific attributes.
attributeCount must be a unique value.
- Type: unsigned long
backendNetworkComponentCount
A count of a hardware's backend or private network components. Network components are hardware components such as IPMI cards or Ethernet cards.
backendNetworkComponentCount must be a unique value.
- Type: unsigned long
backendRouterCount
A count of a hardware's backend or private router.
backendRouterCount must be a unique value.
- Type: unsigned long
benchmarkCertificationCount
A count of a hardware's benchmark certifications.
benchmarkCertificationCount must be a unique value.
- Type: unsigned long
componentCount
A count of a hardware's components. Hardware components include hard drives, processors, drive controllers, etc.
componentCount must be a unique value.
- Type: unsigned long
driveControllerCount
A count of the drive controllers contained within a piece of hardware.
driveControllerCount must be a unique value.
- Type: unsigned long
evaultNetworkStorageCount
A count of a piece of hardware's associated EVault network storage service account.
evaultNetworkStorageCount must be a unique value.
- Type: unsigned long
frontendNetworkComponentCount
A count of a hardware's frontend or public network components. Network components are hardware components such as IPMI cards or Ethernet cards.
frontendNetworkComponentCount must be a unique value.
- Type: unsigned long
frontendRouterCount
A count of a hardware's frontend or public router.
frontendRouterCount must be a unique value.
- Type: unsigned long
hardDriveCount
A count of the hard drives contained within a piece of hardware.
hardDriveCount must be a unique value.
- Type: unsigned long
memoryCount
A count of a hardware's memory.
memoryCount must be a unique value.
- Type: unsigned long
networkComponentCount
A count of a hardware's network components. Network components are hardware components such as IPMI cards or Ethernet cards.
networkComponentCount must be a unique value.
- Type: unsigned long
networkMonitorCount
A count of a hardware's network monitors.
networkMonitorCount must be a unique value.
- Type: unsigned long
networkStorageCount
A count of a piece of hardware's associated network storage service account.
networkStorageCount must be a unique value.
- Type: unsigned long
networkVlanCount
A count of the network Vlan's that a hardware's network components are associated with.
networkVlanCount must be a unique value.
- Type: unsigned long
processorCount
A count of a hardware's processors.
processorCount must be a unique value.
- Type: unsigned long
raidControllerCount
A count of the RAID controllers contained within a piece of hardware.
raidControllerCount must be a unique value.
- Type: unsigned long
securityScanRequestCount
A count of a hardware's vulnerability scan requests.
securityScanRequestCount must be a unique value.
- Type: unsigned long
softwareComponentCount
A count of a hardware's installed software.
softwareComponentCount must be a unique value.
- Type: unsigned long
storageNetworkComponentCount
A count of a hardware's private storage network components. Network components are hardware components such as IPMI cards or Ethernet cards.
storageNetworkComponentCount must be a unique value.
- Type: unsigned long
uplinkNetworkComponentCount
A count of the network component that is one level higher to a hardware on the network infrastructure. likely a switch or a router.
uplinkNetworkComponentCount must be a unique value.
- Type: unsigned long
Associated Methods
- SoftLayer_Hardware::findByIpAddress
- SoftLayer_Account::getAccount
- SoftLayer_Hardware_Attribute::getAttributes
- SoftLayer_Network_Component::getBackendNetworkComponents
- SoftLayer_Billing_Item::getBciServiceComponent
- SoftLayer_Hardware_Benchmark_Certification::getBenchmarkCertifications
- SoftLayer_Hardware_Component::getComponents
- SoftLayer_Location::getDatacenter
- SoftLayer_Network_Storage::getEvaultNetworkStorage
- SoftLayer_Network_Component_Firewall::getFirewallServiceComponent
- SoftLayer_Network_Component::getFrontEndNetworkComponents
- SoftLayer_Hardware_Component::getHardDrives
- SoftLayer_Hardware_Chassis::getHardwareChassis
- SoftLayer_Hardware_Function::getHardwareFunction
- SoftLayer_Hardware_Status::getHardwareStatus
- SoftLayer_Location::getLocation
- SoftLayer_Network_Monitor_Version1_Query_Host_Stratum::getMonitoringServiceComponent
- SoftLayer_Network_Component::getNetworkComponents
- SoftLayer_Network_Monitor_Version1_Query_Host::getNetworkMonitors
- SoftLayer_Network_Vlan::getNetworkVlans
- SoftLayer_Hardware::getObject
- SoftLayer_Software_Component::getOperatingSystem
- SoftLayer_Hardware_Component::getProcessors
- SoftLayer_Hardware_Component::getRaidControllers
- SoftLayer_Location::getServerRoom
- SoftLayer_Software_Component::getSoftwareComponents
- SoftLayer_Network_Component::getUplinkNetworkComponents
- bool::reboot
- SoftLayer_Network_Security_Scanner_Request::getSecurityScanRequests
