SoftLayer Hardware Router
From SoftLayer Development Network Wiki
Overview
The SoftLayer_Hardware_Router data type contains general information relating to a single SoftLayer router.
| 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
antivirusSpywareSoftwareComponent
A antivirus / spyware software component object.
antivirusSpywareSoftwareComponent can be queried by object mask.
antivirusSpywareSoftwareComponent must be a unique value.
attributes
TODO: describe this
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 alloted 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
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.
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.
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.
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
memory
A hardware's memory.
memory can be queried by object mask.
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.
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.
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.
primaryBackendNetworkComponent
The hardware's primary public network component.
primaryBackendNetworkComponent can be queried by object mask.
primaryBackendNetworkComponent must be a unique value.
primaryNetworkComponent
The hardware's primary public network component.
primaryNetworkComponent can be queried by object mask.
primaryNetworkComponent must be a unique value.
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.
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.
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
attributeCount
A count of tODO: describe this
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
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
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
