SoftLayer Hardware Server (type)

From SoftLayer Development Network Wiki

This page refers to the SoftLayer_Hardware_Server data type. For information on the SoftLayer_Hardware_Server service please see SoftLayer_Hardware_Server.

Contents 1 Overview 2 User Access 3 Local Properties 3.1 accountId 3.2 domain 3.3 hardwareStatusId 3.4 hostname 3.5 id 3.6 notes 4 Relational Properties 4.1 account 4.2 activeTransaction 4.3 activeTransactions 4.4 antivirusSpywareSoftwareComponent 4.5 attributes 4.6 availableMonitoring 4.7 averageDailyBandwidthUsage 4.8 backendNetworkComponents 4.9 backendRouters 4.10 bandwidthAllocation 4.11 bandwidthAllotmentDetail 4.12 benchmarkCertifications 4.13 billingItem 4.14 businessContinuanceInsuranceFlag 4.15 components 4.16 controlPanel 4.17 cost 4.18 datacenter 4.19 driveControllers 4.20 evaultNetworkStorage 4.21 firewallServiceComponent 4.22 frontendNetworkComponents 4.23 frontendRouters 4.24 hardDrives 4.25 hardwareChassis 4.26 hardwareFunction 4.27 hardwareStatus 4.28 hostIpsSoftwareComponent 4.29 inboundBandwidthUsage 4.30 lastOperatingSystemReload 4.31 lastTransaction 4.32 location 4.33 memory 4.34 monitoringServiceComponent 4.35 monitoringUserNotification 4.36 motherboard 4.37 networkComponents 4.38 networkManagementIpAddress 4.39 networkMonitors 4.40 networkStorage 4.41 networkVlans 4.42 nextBillingCycleBandwidthAllocation 4.43 operatingSystem 4.44 outboundBandwidthUsage 4.45 primaryBackendIpAddress 4.46 primaryBackendNetworkComponent 4.47 primaryIpAddress 4.48 primaryNetworkComponent 4.49 privateIpAddress 4.50 privateNetworkOnlyFlag 4.51 processors 4.52 provisionDate 4.53 raidControllers 4.54 recentRemoteManagementCommands 4.55 remoteManagement 4.56 remoteManagementComponent 4.57 remoteManagementUsers 4.58 securityScanRequests 4.59 serverRoom 4.60 softwareComponents 4.61 uplinkNetworkComponents 4.62 users 4.63 virtualRackName 5 Count Properties 5.1 activeTransactionCount 5.2 attributeCount 5.3 availableMonitoringCount 5.4 backendNetworkComponentCount 5.5 backendRouterCount 5.6 benchmarkCertificationCount 5.7 componentCount 5.8 driveControllerCount 5.9 evaultNetworkStorageCount 5.10 frontendNetworkComponentCount 5.11 frontendRouterCount 5.12 hardDriveCount 5.13 memoryCount 5.14 monitoringUserNotificationCount 5.15 networkComponentCount 5.16 networkMonitorCount 5.17 networkStorageCount 5.18 networkVlanCount 5.19 processorCount 5.20 raidControllerCount 5.21 recentRemoteManagementCommandCount 5.22 remoteManagementUserCount 5.23 securityScanRequestCount 5.24 softwareComponentCount 5.25 uplinkNetworkComponentCount 5.26 userCount 6 Associated Methods

Overview

The SoftLayer_Hardware_Server data type contains general information relating to a single SoftLayer server.

User Access

Users wishing to access the SoftLayer_Hardware_Server type must have the View Hardware permission assigned to their account.

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

---

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

---

activeTransaction

A transaction that is still be performed on a server.
activeTransaction can be queried by object mask.
activeTransaction must be a unique value.

• Type: SoftLayer_Provisioning_Version1_Transaction

---

activeTransactions

Any active transaction(s) that are currently running for the server (example: os reload).
activeTransactions can be queried by object mask.

• Type: SoftLayer_Provisioning_Version1_TransactionArray

---

antivirusSpywareSoftwareComponent

A antivirus / spyware software component object.
antivirusSpywareSoftwareComponent can be queried by object mask.
antivirusSpywareSoftwareComponent must be a unique value.

• Type: SoftLayer_Software_Component

---

attributes

TODO: describe this
attributes can be queried by object mask.

• Type: SoftLayer_Hardware_AttributeArray

---

availableMonitoring

An object that stores the maximum level for the monitoring query types and response types.
availableMonitoring can be queried by object mask.

• Type: SoftLayer_Network_Monitor_Version1_Query_Host_StratumArray

---

averageDailyBandwidthUsage

The average daily usage of all the inbound and outbound network traffic for the last 30 days.
averageDailyBandwidthUsage can be queried by object mask.
averageDailyBandwidthUsage must be a unique value.

• Type: decimal

---

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.

• Type: SoftLayer_Network_ComponentArray

---

backendRouters

A hardware's backend or private router.
backendRouters can be queried by object mask.

• Type: SoftLayer_Network_Component_Uplink_HardwareArray

---

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 alloted detail record. Allotment details link bandwidth allocation with allotments.
bandwidthAllotmentDetail can be queried by object mask.
bandwidthAllotmentDetail must be a unique value.

• Type: SoftLayer_Network_Bandwidth_Version1_Allotment_Detail

---

benchmarkCertifications

A hardware's benchmark certifications.
benchmarkCertifications can be queried by object mask.

• Type: SoftLayer_Hardware_Benchmark_CertificationArray

---

billingItem

The billing item for a server.
billingItem can be queried by object mask.
billingItem must be a unique value.

• Type: SoftLayer_Billing_Item

---

businessContinuanceInsuranceFlag

TODO.
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.

• Type: SoftLayer_Hardware_ComponentArray

---

controlPanel

A server's control panel.
controlPanel can be queried by object mask.
controlPanel must be a unique value.

• Type: SoftLayer_Software_Component

---

cost

The total cost of a server, measured in US Dollars ($USD).
cost can be queried by object mask.
cost must be a unique value.

• Type: float

---

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.

• Type: SoftLayer_Hardware_ComponentArray

---

evaultNetworkStorage

A piece of hardware's associated EVault network storage service account.
evaultNetworkStorage can be queried by object mask.

• Type: SoftLayer_Network_StorageArray

---

firewallServiceComponent

A hardware's hardware firewall services.
firewallServiceComponent can be queried by object mask.
firewallServiceComponent must be a unique value.

• Type: SoftLayer_Network_Component_Firewall

---

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.

• Type: SoftLayer_Network_ComponentArray

---

frontendRouters

A hardware's frontend or public router.
frontendRouters can be queried by object mask.

• Type: SoftLayer_Network_Component_Uplink_HardwareArray

---

hardDrives

The hard drives contained within a piece of hardware.
hardDrives can be queried by object mask.

• Type: SoftLayer_Hardware_ComponentArray

---

hardwareChassis

The chassis that a piece of hardware is housed in.
hardwareChassis can be queried by object mask.
hardwareChassis must be a unique value.

• Type: SoftLayer_Hardware_Chassis

---

hardwareFunction

A hardware's function.
hardwareFunction can be queried by object mask.
hardwareFunction must be a unique value.

• Type: SoftLayer_Hardware_Function

---

hardwareStatus

A hardware's status.
hardwareStatus can be queried by object mask.
hardwareStatus must be a unique value.

• Type: SoftLayer_Hardware_Status

---

hostIpsSoftwareComponent

A host IPS software component object.
hostIpsSoftwareComponent can be queried by object mask.
hostIpsSoftwareComponent must be a unique value.

• Type: SoftLayer_Software_Component

---

inboundBandwidthUsage

The sum of all the inbound network traffic data for the last 30 days.
inboundBandwidthUsage can be queried by object mask.
inboundBandwidthUsage must be a unique value.

• Type: decimal

---

lastOperatingSystemReload

The last transaction that a server's operating system was loaded.
lastOperatingSystemReload can be queried by object mask.
lastOperatingSystemReload must be a unique value.

• Type: SoftLayer_Provisioning_Version1_Transaction

---

lastTransaction

The last transaction a server had performed.
lastTransaction can be queried by object mask.
lastTransaction must be a unique value.

• Type: SoftLayer_Provisioning_Version1_Transaction

---

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

---

memory

A hardware's memory.
memory can be queried by object mask.

• Type: SoftLayer_Hardware_ComponentArray

---

monitoringServiceComponent

A hardware's network monitoring services.
monitoringServiceComponent can be queried by object mask.
monitoringServiceComponent must be a unique value.

• Type: SoftLayer_Network_Monitor_Version1_Query_Host_Stratum

---

monitoringUserNotification

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
monitoringUserNotification can be queried by object mask.

• Type: SoftLayer_User_Customer_Notification_HardwareArray

---

motherboard

A server's motherboard.
motherboard can be queried by object mask.
motherboard must be a unique value.

• Type: SoftLayer_Hardware_Component

---

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.

• Type: SoftLayer_Network_ComponentArray

---

networkManagementIpAddress

TODO:.
networkManagementIpAddress must be a unique value.

• Type: string

---

networkMonitors

A hardware's network monitors.
networkMonitors can be queried by object mask.

• Type: SoftLayer_Network_Monitor_Version1_Query_HostArray

---

networkStorage

A piece of hardware's associated network storage service account.
networkStorage can be queried by object mask.

• Type: SoftLayer_Network_StorageArray

---

networkVlans

The network Vlan's that a hardware's network components are associated with.
networkVlans can be queried by object mask.

• Type: SoftLayer_Network_VlanArray

---

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.

• Type: SoftLayer_Software_Component

---

outboundBandwidthUsage

The sum of all the outbound network traffic for the last 30 days.
outboundBandwidthUsage can be queried by object mask.
outboundBandwidthUsage must be a unique value.

• Type: decimal

---

primaryBackendIpAddress

The hardware's primary private IP address.
primaryBackendIpAddress must be a unique value.

• Type: string

---

primaryBackendNetworkComponent

The hardware's primary public network component.
primaryBackendNetworkComponent can be queried by object mask.
primaryBackendNetworkComponent must be a unique value.

• Type: SoftLayer_Network_Component

---

primaryIpAddress

A server'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.

• Type: SoftLayer_Network_Component

---

privateIpAddress

A server's primary private IP address.
privateIpAddress must be a unique value.

• Type: string

---

privateNetworkOnlyFlag

Whether the server only has access to the private network.
privateNetworkOnlyFlag can be queried by object mask.
privateNetworkOnlyFlag must be a unique value.

• Type: boolean

---

processors

A hardware's processors.
processors can be queried by object mask.

• Type: SoftLayer_Hardware_ComponentArray

---

provisionDate

The date a server was ordered.
provisionDate can be queried by object mask.
provisionDate must be a unique value.

• Type: dateTime

---

raidControllers

The RAID controllers contained within a piece of hardware.
raidControllers can be queried by object mask.

• Type: SoftLayer_Hardware_ComponentArray

---

recentRemoteManagementCommands

The last five commands issued to the server's remote management card.
recentRemoteManagementCommands can be queried by object mask.

• Type: SoftLayer_Hardware_Component_RemoteManagement_Command_RequestArray

---

remoteManagement

A server's remote management card.
remoteManagement can be queried by object mask.
remoteManagement must be a unique value.

• Type: SoftLayer_Hardware_Component

---

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.

• Type: SoftLayer_Network_Component

---

remoteManagementUsers

User(s) who have access to issue commands and/or interact with the server's remote management card.
remoteManagementUsers can be queried by object mask.

• Type: SoftLayer_Hardware_Component_RemoteManagement_UserArray

---

securityScanRequests

A hardware's vulnerability scan requests.
securityScanRequests can be queried by object mask.

• Type: SoftLayer_Network_Security_Scanner_RequestArray

---

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.

• Type: SoftLayer_Software_ComponentArray

---

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.

• Type: SoftLayer_Network_ComponentArray

---

users

A list of users that have access to this server.
users can be queried by object mask.

• Type: SoftLayer_User_CustomerArray

---

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

Count Properties

activeTransactionCount

A count of any active transaction(s) that are currently running for the server (example: os reload).
activeTransactionCount must be a unique value.

• Type: unsigned long

---

attributeCount

A count of tODO: describe this
attributeCount must be a unique value.

• Type: unsigned long

---

availableMonitoringCount

A count of an object that stores the maximum level for the monitoring query types and response types.
availableMonitoringCount 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

---

monitoringUserNotificationCount

A count of 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
monitoringUserNotificationCount 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

---

recentRemoteManagementCommandCount

A count of the last five commands issued to the server's remote management card.
recentRemoteManagementCommandCount must be a unique value.

• Type: unsigned long

---

remoteManagementUserCount

A count of user(s) who have access to issue commands and/or interact with the server's remote management card.
remoteManagementUserCount 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

---

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

---

userCount

A count of a list of users that have access to this server.
userCount must be a unique value.

• Type: unsigned long

Associated Methods

• SoftLayer_Account::getHardware
• SoftLayer_Hardware::findByIpAddress
• SoftLayer_Hardware::getObject
• SoftLayer_Hardware_Server::getHardwareByIpAddress
• SoftLayer_Hardware_Server::getObject