Hardware
SoftLayer_Hardware_Router_Backend

Overview

The SoftLayer_Hardware_Router_Backend data type contains general information relating to a single SoftLayer router item for hardware.

Local Properties

accountId

A hardware's associated 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 & Count Properties

Relational Properties can be queried by object mask
account

The account associated with a piece of hardware.

activeComponentCount

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

Type:

unsignedLong

activeComponents

A piece of hardware's active physical components.

activeNetworkMonitorIncident

A piece of hardware's active network monitoring incidents.

activeNetworkMonitorIncidentCount

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

Type:

unsignedLong

allowedHost

The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists.

allowedNetworkStorage

The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.

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

allowedNetworkStorageReplicas

The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.

allPowerComponentCount

A count of

Type:

unsignedLong

allPowerComponents
antivirusSpywareSoftwareComponent

Information regarding an antivirus/spyware software component object.

attributeCount

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

Type:

unsignedLong

attributes

Information regarding a piece of hardware's specific attributes.

averageDailyPublicBandwidthUsage

The average daily public bandwidth usage for the current billing cycle.

Type:

float

backendNetworkComponentCount

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

Type:

unsignedLong

backendNetworkComponents

A piece of hardware's back-end or private network components.

backendRouterCount

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

Type:

unsignedLong

backendRouters

A hardware's backend or private router.

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.

benchmarkCertificationCount

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

Type:

unsignedLong

benchmarkCertifications

Information regarding a piece of hardware's benchmark certifications.

billingItem

Information regarding the billing item for a server.

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

boundSubnetCount

A count of associated subnets for a router object.

Type:

unsignedLong

boundSubnets

Associated subnets for a router object.

businessContinuanceInsuranceFlag

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

Type:

boolean

childrenHardware

Child hardware.

childrenHardwareCount

A count of child hardware.

Type:

unsignedLong

componentCount

A count of a piece of hardware's components.

Type:

unsignedLong

components

A piece of hardware's components.

continuousDataProtectionSoftwareComponent

A continuous data protection/server backup software component object.

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.

datacenterName

The name of the datacenter in which a piece of hardware resides.

Type:

string

downlinkHardware

All hardware that has uplink network connections to a piece of hardware.

downlinkHardwareCount

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

Type:

unsignedLong

downlinkNetworkHardware

All hardware that has uplink network connections to a piece of hardware.

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

downlinkServers

Information regarding all servers attached to a piece of network hardware.

downlinkVirtualGuestCount

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

Type:

unsignedLong

downlinkVirtualGuests

Information regarding all virtual guests attached to a piece of network hardware.

downstreamHardwareBindingCount

A count of all hardware downstream from a network device.

Type:

unsignedLong

downstreamHardwareBindings

All hardware downstream from a network device.

downstreamNetworkHardware

All network hardware downstream from the selected piece of hardware.

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

downstreamNetworkHardwareWithIncidents

All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware.

downstreamServerCount

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

Type:

unsignedLong

downstreamServers

Information regarding all servers attached downstream to a piece of network hardware.

downstreamVirtualGuestCount

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

Type:

unsignedLong

downstreamVirtualGuests

Information regarding all virtual guests attached to a piece of network hardware.

driveControllerCount

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

Type:

unsignedLong

driveControllers

The drive controllers contained within a piece of hardware.

evaultNetworkStorage

Information regarding a piece of hardware's associated EVault network storage service account.

evaultNetworkStorageCount

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

Type:

unsignedLong

firewallServiceComponent

Information regarding a piece of hardware's firewall services.

fixedConfigurationPreset

Defines the fixed components in a fixed configuration bare metal server.

frontendNetworkComponentCount

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

Type:

unsignedLong

frontendNetworkComponents

A piece of hardware's front-end or public network components.

frontendRouterCount

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

Type:

unsignedLong

frontendRouters

A hardware's frontend or public router.

globalIdentifier

A hardware's universally unique identifier.

Type:

string

hardDriveCount

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

Type:

unsignedLong

hardDrives

The hard drives contained within a piece of hardware.

hardwareChassis

The chassis that a piece of hardware is housed in.

hardwareFunction

A hardware's function.

hardwareFunctionDescription

A hardware's function.

Type:

string

hardwareStatus

A hardware's status.

hasTrustedPlatformModuleBillingItemFlag

Determine in hardware object has TPM enabled.

Type:

boolean

hostIpsSoftwareComponent

Information regarding a host IPS software component object.

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.

latestNetworkMonitorIncident

A piece of hardware's latest network monitoring incident.

localDiskStorageCapabilityFlag

A flag indicating that a VLAN on the router can be assigned to a host that has local disk functionality.

Type:

boolean

location

Where a piece of hardware is located within SoftLayer's location hierarchy.

locationPathString
Type:

string

lockboxNetworkStorage

Information regarding a lockbox account associated with a server.

managedResourceFlag

A flag indicating that the hardware is a managed resource.

Type:

boolean

memory

Information regarding a piece of hardware's memory.

memoryCapacity

The amount of memory a piece of hardware has, measured in gigabytes.

Type:

unsigned integer

memoryCount

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

Type:

unsignedLong

metricTrackingObject

A piece of hardware's metric tracking object.

monitoringAgentCount

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

Type:

unsignedLong

monitoringAgents

Information regarding the monitoring agents associated with a piece of hardware.

monitoringRobot

Information regarding the hardware's monitoring robot.

monitoringServiceComponent

Information regarding a piece of hardware's network monitoring services.

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.

networkCardCount

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

Type:

unsignedLong

networkCards

Information regarding a piece of hardware's network cards.

networkComponentCount

A count of returns a hardware's network components.

Type:

unsignedLong

networkComponents

Returns a hardware's network components.

networkGatewayMember

The gateway member if this device is part of a network gateway.

networkGatewayMemberFlag

Whether or not this device is part of a network gateway.

Type:

boolean

networkMonitorAttachedDownHardware

All servers with failed monitoring that are attached downstream to a piece of hardware.

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

networkMonitorAttachedDownVirtualGuests

Virtual guests that are attached downstream to a hardware that have failed monitoring

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

networkMonitorIncidents

The status of all of a piece of hardware's network monitoring incidents.

networkMonitors

Information regarding a piece of hardware's network monitors.

networkStatus

The value of a hardware's network status attribute.

Type:

string

networkStatusAttribute

The hardware's related network status attribute.

networkStorage

Information regarding a piece of hardware's associated network storage service account.

networkStorageCount

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

Type:

unsignedLong

nextBillingCycleBandwidthAllocation

A hardware's allotted bandwidth for the next billing cycle (measured in GB).

Type:

decimal

notesHistory
notesHistoryCount

A count of

Type:

unsignedLong

operatingSystem

Information regarding a piece of hardware's operating system.

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.

pointOfPresenceLocation

Information regarding the Point of Presence (PoP) location in which a piece of hardware resides.

powerComponentCount

A count of the power components for a hardware object.

Type:

unsignedLong

powerComponents

The power components for a hardware object.

powerSupply

Information regarding a piece of hardware's power supply.

powerSupplyCount

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

Type:

unsignedLong

primaryBackendNetworkComponent

Information regarding the hardware's primary back-end network component.

primaryNetworkComponent

Information regarding the hardware's primary public network component.

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

processorCount

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

Type:

unsignedLong

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.

rack
raidControllerCount

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

Type:

unsignedLong

raidControllers

The RAID controllers contained within a piece of hardware.

recentEventCount

A count of recent events that impact this hardware.

Type:

unsignedLong

recentEvents

Recent events that impact this hardware.

remoteManagementAccountCount

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

Type:

unsignedLong

remoteManagementAccounts

User credentials to issue commands and/or interact with the server's remote management card.

remoteManagementComponent

A hardware's associated remote management component. This is normally IPMI.

resourceConfigurationCount

A count of

Type:

unsignedLong

resourceConfigurations
resourceGroupCount

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

Type:

unsignedLong

resourceGroupMemberReferenceCount

A count of

Type:

unsignedLong

resourceGroupMemberReferences
resourceGroupRoleCount

A count of

Type:

unsignedLong

resourceGroupRoles
resourceGroups

The resource groups in which this hardware is a member.

routerCount

A count of a hardware's routers.

Type:

unsignedLong

routers

A hardware's routers.

sanStorageCapabilityFlag

A flag indicating that a VLAN on the router can be assigned to a host that has SAN disk functionality.

Type:

boolean

scaleAssetCount

A count of collection of scale assets this hardware corresponds to.

Type:

unsignedLong

scaleAssets

Collection of scale assets this hardware corresponds to.

securityScanRequestCount

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

Type:

unsignedLong

securityScanRequests

Information regarding a piece of hardware's vulnerability scan requests.

serverRoom

Information regarding the server room in which the hardware is located.

serviceProvider

Information regarding the piece of hardware's service provider.

softwareComponentCount

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

Type:

unsignedLong

softwareComponents

Information regarding a piece of hardware's installed software.

sparePoolBillingItem

Information regarding the billing item for a spare pool server.

sshKeyCount

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

Type:

unsignedLong

sshKeys

SSH keys to be installed on the server during provisioning or an OS reload.

storageNetworkComponentCount

A count of

Type:

unsignedLong

storageNetworkComponents
tagReferenceCount

A count of

Type:

unsignedLong

tagReferences
topLevelLocation
upgradeRequest

An account's associated upgrade request object, if any.

uplinkHardware

The network device connected to a piece of hardware.

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

uplinkNetworkComponents

Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure.

userData

A string containing custom user data for a hardware order.

userDataCount

A count of a string containing custom user data for a hardware order.

Type:

unsignedLong

virtualChassis

Information regarding the virtual chassis for a piece of hardware.

virtualChassisSiblingCount

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

Type:

unsignedLong

virtualChassisSiblings

Information regarding the virtual chassis siblings for a piece of hardware.

virtualHost

A piece of hardware's virtual host record.

virtualizationPlatform

A piece of hardware's virtualization platform software.

virtualLicenseCount

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

Type:

unsignedLong

virtualLicenses

Information regarding a piece of hardware's virtual software licenses.

virtualRack

Information regarding the bandwidth allotment to which a piece of hardware belongs.

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