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.

Contents 1 Overview 2 Local Properties 2.1 accountId 2.2 domain 2.3 hardwareStatusId 2.4 hostname 2.5 id 2.6 notes 3 Relational Properties 3.1 account 3.2 antivirusSpywareSoftwareComponent 3.3 attributes 3.4 backendNetworkComponents 3.5 backendPod 3.6 bandwidthAllocation 3.7 bandwidthAllotmentDetail 3.8 benchmarkCertifications 3.9 businessContinuanceInsuranceFlag 3.10 components 3.11 datacenter 3.12 evaultNetworkStorage 3.13 firewallServiceComponent 3.14 frontendNetworkComponents 3.15 frontendPod 3.16 hardDrives 3.17 hardwareChassis 3.18 hardwareFunction 3.19 hardwareStatus 3.20 hostIpsSoftwareComponent 3.21 location 3.22 monitoringServiceComponent 3.23 motherboard 3.24 networkComponents 3.25 networkManagementIpAddress 3.26 networkMonitors 3.27 nextBillingCycleBandwidthAllocation 3.28 operatingSystem 3.29 primaryBackendIpAddress 3.30 primaryIpAddress 3.31 primaryNetworkComponent 3.32 processors 3.33 raidControllers 3.34 remoteManagementComponent 3.35 securityScanRequests 3.36 serverRoom 3.37 softwareComponents 3.38 uplinkNetworkComponents 3.39 virtualRackName 4 Count Properties 4.1 networkComponentCount 4.2 frontendNetworkComponentCount 4.3 backendNetworkComponentCount 4.4 componentCount 4.5 hardDriveCount 4.6 processorCount 4.7 raidControllerCount 4.8 softwareComponentCount 4.9 attributeCount 4.10 uplinkNetworkComponentCount 4.11 evaultNetworkStorageCount 4.12 benchmarkCertificationCount 4.13 networkMonitorCount 4.14 securityScanRequestCount 5 Associated Methods

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: int
• length: 10 digits
• permission: Edit Company Profile

---

domain

A piece of hardware's local network domain name.
Domain must match the regular expression "/^(?:(?!\d+\.)[a-zA-Z0-9_\-]{1,100})\.[a-zA-Z]{2,}$/". Domain must be between 1 and 100 characters, may not be all digits, and must contain only alphanumeric characters, underscores, and dashes. Must be followed by at least a 2 character alphabetic TLD.

• type: string
• length: 100 characters

---

hardwareStatusId

A number reflecting the state of a hardware

• type: int
• length: 10 digits

---

hostname

A hardware's hostname
Hostname must match the regular expression "/^(?:(?!\d+\.)[a-zA-Z0-9_\-]{1,100})$/". Host must be between 1 and 100 characters, may not be all digits, and must contain only alphanumeric characters, underscores, and dashes

• type: string
• length: 100 characters

---

id

A hardware's internal identification number

• type: int

---

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.
SoftLayer_Hardware can have only one account.
account is queried by object mask.

• type: SoftLayer_Account

---

antivirusSpywareSoftwareComponent

A antivirus / spyware software component object.
SoftLayer_Hardware can have only one antivirusSpywareSoftwareComponent.
antivirusSpywareSoftwareComponent is queried by object mask.

• type: SoftLayer_Software_Component

---

attributes

TODO: describe this
attributes is queried by object mask.

• type: SoftLayer_Hardware_AttributeArray

---

backendNetworkComponents

A hardware's backend or private network components. Network components are hardware components such as IPMI cards or Ethernet cards.
backendNetworkComponents is queried by object mask.

• type: SoftLayer_Network_ComponentArray

---

backendPod

A hardware's backend pod number.
SoftLayer_Hardware can have only one backendPod.
backendPod is queried by object mask.

• type: int

---

bandwidthAllocation

A hardware's allotted bandwidth (measured in GB).
SoftLayer_Hardware can have only one bandwidthAllocation.
bandwidthAllocation is queried by object mask.

• type: decimal

---

bandwidthAllotmentDetail

A hardware's alloted detail record. Allotment details link bandwidth allocation with allotments.
SoftLayer_Hardware can have only one bandwidthAllotmentDetail.
bandwidthAllotmentDetail is queried by object mask.

• type: [[]]

---

benchmarkCertifications

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

• type: SoftLayer_Hardware_Benchmark_CertificationArray

---

businessContinuanceInsuranceFlag

TODO.
SoftLayer_Hardware can have only one businessContinuanceInsuranceFlag.
businessContinuanceInsuranceFlag is queried by object mask.

• type: SoftLayer_Billing_Item

---

components

A hardware's components. Hardware components include hard drives, processors, drive controllers, etc.
components is queried by object mask.

• type: SoftLayer_Hardware_ComponentArray

---

datacenter

The datacenter that a piece of hardware resides in.
SoftLayer_Hardware can have only one datacenter.
datacenter is queried by object mask.

• type: SoftLayer_Location

---

evaultNetworkStorage

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

• type: SoftLayer_Network_StorageArray

---

firewallServiceComponent

A hardware's hardware firewall services.
SoftLayer_Hardware can have only one firewallServiceComponent.
firewallServiceComponent is queried by object mask.

• type: [[]]

---

frontendNetworkComponents

A hardware's frontend or public network components. Network components are hardware components such as IPMI cards or Ethernet cards.
frontendNetworkComponents is queried by object mask.

• type: SoftLayer_Network_ComponentArray

---

frontendPod

A hardware's frontend pod number.
SoftLayer_Hardware can have only one frontendPod.
frontendPod is queried by object mask.

• type: int

---

hardDrives

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

• type: SoftLayer_Hardware_ComponentArray

---

hardwareChassis

The chassis that a piece of hardware is housed in.
SoftLayer_Hardware can have only one hardwareChassis.
hardwareChassis is queried by object mask.

• type: SoftLayer_Hardware_Chassis

---

hardwareFunction

A hardware's function.
SoftLayer_Hardware can have only one hardwareFunction.
hardwareFunction is queried by object mask.

• type: SoftLayer_Hardware_Function

---

hardwareStatus

A hardware's status.
SoftLayer_Hardware can have only one hardwareStatus.
hardwareStatus is queried by object mask.

• type: SoftLayer_Hardware_Status

---

hostIpsSoftwareComponent

A host IPS software component object.
SoftLayer_Hardware can have only one hostIpsSoftwareComponent.
hostIpsSoftwareComponent is queried by object mask.

• type: SoftLayer_Software_Component

---

location

Where a piece of hardware is located within SoftLayer's location hierarchy.
SoftLayer_Hardware can have only one location.
location is queried by object mask.

• type: SoftLayer_Location

---

monitoringServiceComponent

A hardware's network monitoring services.
SoftLayer_Hardware can have only one monitoringServiceComponent.
monitoringServiceComponent is queried by object mask.

• type: SoftLayer_Network_Monitor_Version1_Query_Host_Stratum

---

motherboard

A hardware's motherboard.
SoftLayer_Hardware can have only one motherboard.
motherboard is queried by object mask.

• type: SoftLayer_Hardware_Component

---

networkComponents

A hardware's network components. Network components are hardware components such as IPMI cards or Ethernet cards.
networkComponents is queried by object mask.

• type: SoftLayer_Network_ComponentArray

---

networkManagementIpAddress

TODO:.
SoftLayer_Hardware can have only one networkManagementIpAddress.

• type: string

---

networkMonitors

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

• type: SoftLayer_Network_Monitor_Version1_Query_HostArray

---

nextBillingCycleBandwidthAllocation

A hardware's allotted bandwidth for the next billing cycle (measured in GB).
SoftLayer_Hardware can have only one nextBillingCycleBandwidthAllocation.
nextBillingCycleBandwidthAllocation is queried by object mask.

• type: decimal

---

operatingSystem

A hardware's operating system.
SoftLayer_Hardware can have only one operatingSystem.
operatingSystem is queried by object mask.

• type: SoftLayer_Software_Component

---

primaryBackendIpAddress

The hardware's primary private IP address.
SoftLayer_Hardware can have only one primaryBackendIpAddress.

• type: string

---

primaryIpAddress

The hardware's primary public IP address.
SoftLayer_Hardware can have only one primaryIpAddress.

• type: string

---

primaryNetworkComponent

The hardware's primary public network component.
SoftLayer_Hardware can have only one primaryNetworkComponent.
primaryNetworkComponent is queried by object mask.

• type: SoftLayer_Network_Component

---

processors

A hardware's processors.
processors is queried by object mask.

• type: SoftLayer_Hardware_ComponentArray

---

raidControllers

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

• type: SoftLayer_Hardware_ComponentArray

---

remoteManagementComponent

A hardware's associated remote management component. This is normally IPMI.
SoftLayer_Hardware can have only one remoteManagementComponent.
remoteManagementComponent is queried by object mask.

• type: SoftLayer_Network_Component

---

securityScanRequests

A hardware's vulnerability scan requests.
securityScanRequests is 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.
SoftLayer_Hardware can have only one serverRoom.
serverRoom is queried by object mask.

• type: SoftLayer_Location

---

softwareComponents

A hardware's installed software.
softwareComponents is 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 is queried by object mask.

• type: SoftLayer_Network_ComponentArray

---

virtualRackName

The name of the bandwidth allotment that a hardware belongs too.
SoftLayer_Hardware can have only one virtualRackName.
virtualRackName is queried by object mask.

• type: string

Count Properties

networkComponentCount

A count of a hardware's network components. Network components are hardware components such as IPMI cards or Ethernet cards.
networkComponentCount is queried by object mask.

• type: int

---

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 is queried by object mask.

• type: int

---

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 is queried by object mask.

• type: int

---

componentCount

A count of a hardware's components. Hardware components include hard drives, processors, drive controllers, etc.
componentCount is queried by object mask.

• type: int

---

hardDriveCount

A count of the hard drives contained within a piece of hardware.
hardDriveCount is queried by object mask.

• type: int

---

processorCount

A count of a hardware's processors.
processorCount is queried by object mask.

• type: int

---

raidControllerCount

A count of the RAID controllers contained within a piece of hardware.
raidControllerCount is queried by object mask.

• type: int

---

softwareComponentCount

A count of a hardware's installed software.
softwareComponentCount is queried by object mask.

• type: int

---

attributeCount

A count of tODO: describe this
attributeCount is queried by object mask.

• type: int

---

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 is queried by object mask.

• type: int

---

evaultNetworkStorageCount

A count of a piece of hardware's associated EVault network storage service account.
evaultNetworkStorageCount is queried by object mask.

• type: int

---

benchmarkCertificationCount

A count of a hardware's benchmark certifications.
benchmarkCertificationCount is queried by object mask.

• type: int

---

networkMonitorCount

A count of a hardware's network monitors.
networkMonitorCount is queried by object mask.

• type: int

---

securityScanRequestCount

A count of a hardware's vulnerability scan requests.
securityScanRequestCount is queried by object mask.

• type: int

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