SoftLayer_Hardware_Firewall

Local

accountId

A hardware’s associated SoftLayer_Account id.
Type: int

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: int

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: int

hostname

A hardware’s hostname
Type: string

id

A hardware’s internal identification number
Type: int

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

None
Type: dateTime

serialNumber

A hardware’s serial number that is supplied by SoftLayer.
Type: string

serviceProviderId

None
Type: int

serviceProviderResourceId

A hardware’s internal identification number at its service provider
Type: int

Relational

account

The account associated with a piece of hardware.
Type: SoftLayer_Account

activeComponents

A piece of hardware’s active physical components.
Type: SoftLayer_Hardware_Component[]

activeNetworkMonitorIncident

A piece of hardware’s active network monitoring incidents.
Type: SoftLayer_Network_Monitor_Version1_Incident[]

allPowerComponents

None
Type: SoftLayer_Hardware_Power_Component[]

allowedHost

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

allowedNetworkStorage

The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.
Type: SoftLayer_Network_Storage[]

allowedNetworkStorageReplicas

The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.
Type: SoftLayer_Network_Storage[]

antivirusSpywareSoftwareComponent

Information regarding an antivirus/spyware software component object.
Type: SoftLayer_Software_Component

attributes

Information regarding a piece of hardware’s specific attributes.
Type: SoftLayer_Hardware_Attribute[]

averageDailyPublicBandwidthUsage

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

backendNetworkComponents

A piece of hardware’s back-end or private network components.
Type: SoftLayer_Network_Component[]

backendRouters

A hardware’s backend or private router.
Type: SoftLayer_Hardware[]

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.
Type: SoftLayer_Network_Bandwidth_Version1_Allotment_Detail

benchmarkCertifications

Information regarding a piece of hardware’s benchmark certifications.
Type: SoftLayer_Hardware_Benchmark_Certification[]

billingItem

Information regarding the billing item for a server.
Type: SoftLayer_Billing_Item_Hardware

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

businessContinuanceInsuranceFlag

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

childrenHardware

Child hardware.
Type: SoftLayer_Hardware[]

components

A piece of hardware’s components.
Type: SoftLayer_Hardware_Component[]

continuousDataProtectionSoftwareComponent

A continuous data protection/server backup software component object.
Type: SoftLayer_Software_Component

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.
Type: SoftLayer_Location

datacenterName

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

daysInSparePool

Number of day(s) a server have been in spare pool.
Type: int

downlinkHardware

All hardware that has uplink network connections to a piece of hardware.
Type: SoftLayer_Hardware[]

downlinkNetworkHardware

All hardware that has uplink network connections to a piece of hardware.
Type: SoftLayer_Hardware[]

downlinkServers

Information regarding all servers attached to a piece of network hardware.
Type: SoftLayer_Hardware[]

downlinkVirtualGuests

Information regarding all virtual guests attached to a piece of network hardware.
Type: SoftLayer_Virtual_Guest[]

downstreamHardwareBindings

All hardware downstream from a network device.
Type: SoftLayer_Network_Component_Uplink_Hardware[]

downstreamNetworkHardware

All network hardware downstream from the selected piece of hardware.
Type: SoftLayer_Hardware[]

downstreamNetworkHardwareWithIncidents

All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. [DEPRECATED]
Type: SoftLayer_Hardware[]

Deprecated

downstreamServers

Information regarding all servers attached downstream to a piece of network hardware.
Type: SoftLayer_Hardware[]

downstreamVirtualGuests

Information regarding all virtual guests attached to a piece of network hardware.
Type: SoftLayer_Virtual_Guest[]

driveControllers

The drive controllers contained within a piece of hardware.
Type: SoftLayer_Hardware_Component[]

evaultNetworkStorage

Information regarding a piece of hardware’s associated EVault network storage service account.
Type: SoftLayer_Network_Storage[]

firewallServiceComponent

Information regarding a piece of hardware’s firewall services.
Type: SoftLayer_Network_Component_Firewall

fixedConfigurationPreset

Defines the fixed components in a fixed configuration bare metal server.
Type: SoftLayer_Product_Package_Preset

frontendNetworkComponents

A piece of hardware’s front-end or public network components.
Type: SoftLayer_Network_Component[]

frontendRouters

A hardware’s frontend or public router.
Type: SoftLayer_Hardware[]

futureBillingItem

Information regarding the future billing item for a server.
Type: SoftLayer_Billing_Item_Hardware

globalIdentifier

A hardware’s universally unique identifier.
Type: string

hardDrives

The hard drives contained within a piece of hardware.
Type: SoftLayer_Hardware_Component[]

hardwareChassis

The chassis that a piece of hardware is housed in.
Type: SoftLayer_Hardware_Chassis

hardwareFunction

A hardware’s function.
Type: SoftLayer_Hardware_Function

hardwareFunctionDescription

A hardware’s function.
Type: string

hardwareState

A hardware’s power/transaction state.
Type: SoftLayer_Hardware_State

hardwareStatus

A hardware’s status.
Type: SoftLayer_Hardware_Status

hasTrustedPlatformModuleBillingItemFlag

Determine in hardware object has TPM enabled.
Type: boolean

hostIpsSoftwareComponent

Information regarding a host IPS software component object.
Type: SoftLayer_Software_Component

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

isBillingTermChangeAvailableFlag

Whether or not this hardware object is eligible to change to term billing.
Type: boolean

isCloudReadyNodeCertified

Determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute.
Type: boolean

lastTransaction

Information regarding the last transaction a server performed.
Type: SoftLayer_Provisioning_Version1_Transaction

latestNetworkMonitorIncident

A piece of hardware’s latest network monitoring incident.
Type: SoftLayer_Network_Monitor_Version1_Incident

location

Where a piece of hardware is located within SoftLayer’s location hierarchy.
Type: SoftLayer_Location

locationPathString

None
Type: string

lockboxNetworkStorage

Information regarding a lockbox account associated with a server.
Type: SoftLayer_Network_Storage

managedResourceFlag

A flag indicating that the hardware is a managed resource.
Type: boolean

memory

Information regarding a piece of hardware’s memory.
Type: SoftLayer_Hardware_Component[]

memoryCapacity

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

metricTrackingObject

A piece of hardware’s metric tracking object.
Type: SoftLayer_Metric_Tracking_Object

modules

None
Type: SoftLayer_Hardware_Component[]

monitoringRobot

None
Type: SoftLayer_Monitoring_Robot

monitoringServiceComponent

Information regarding a piece of hardware’s network monitoring services.
Type: SoftLayer_Network_Monitor_Version1_Query_Host_Stratum

monitoringServiceEligibilityFlag

None
Type: boolean

motherboard

Information regarding a piece of hardware’s motherboard.
Type: SoftLayer_Hardware_Component

networkCards

Information regarding a piece of hardware’s network cards.
Type: SoftLayer_Hardware_Component[]

networkComponents

Returns a hardware’s network components.
Type: SoftLayer_Network_Component[]

networkGatewayMember

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

networkGatewayMemberFlag

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

networkManagementIpAddress

A piece of hardware’s network management IP address.
Type: string

networkMonitorAttachedDownHardware

All servers with failed monitoring that are attached downstream to a piece of hardware.
Type: SoftLayer_Hardware[]

networkMonitorAttachedDownVirtualGuests

Virtual guests that are attached downstream to a hardware that have failed monitoring
Type: SoftLayer_Virtual_Guest[]

networkMonitorIncidents

The status of all of a piece of hardware’s network monitoring incidents.
Type: SoftLayer_Network_Monitor_Version1_Incident[]

networkMonitors

Information regarding a piece of hardware’s network monitors.
Type: SoftLayer_Network_Monitor_Version1_Query_Host[]

networkStatus

The value of a hardware’s network status attribute. [DEPRECATED]
Type: string

Deprecated

networkStatusAttribute

The hardware’s related network status attribute. [DEPRECATED]
Type: SoftLayer_Hardware_Attribute

Deprecated

networkStorage

Information regarding a piece of hardware’s associated network storage service account.
Type: SoftLayer_Network_Storage[]

networkVlans

The network virtual LANs (VLANs) associated with a piece of hardware’s network components.
Type: SoftLayer_Network_Vlan[]

nextBillingCycleBandwidthAllocation

A hardware’s allotted bandwidth for the next billing cycle (measured in GB).
Type: decimal

notesHistory

None
Type: SoftLayer_Hardware_Note[]

nvRamCapacity

The amount of non-volatile memory a piece of hardware has, measured in gigabytes.
Type: unsignedInt

nvRamComponentModels

None
Type: SoftLayer_Hardware_Component_Model[]

operatingSystem

Information regarding a piece of hardware’s operating system.
Type: SoftLayer_Software_Component_OperatingSystem

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

parentBay

Blade Bay
Type: SoftLayer_Hardware_Blade

parentHardware

Parent Hardware.
Type: SoftLayer_Hardware

pointOfPresenceLocation

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

powerComponents

The power components for a hardware object.
Type: SoftLayer_Hardware_Power_Component[]

powerSupply

Information regarding a piece of hardware’s power supply.
Type: SoftLayer_Hardware_Component[]

primaryBackendIpAddress

The hardware’s primary private IP address.
Type: string

primaryBackendNetworkComponent

Information regarding the hardware’s primary back-end network component.
Type: SoftLayer_Network_Component

primaryIpAddress

The firewall’s primary public IP address.
Type: string

primaryNetworkComponent

Information regarding the hardware’s primary public network component.
Type: SoftLayer_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: unsignedInt

processorPhysicalCoreAmount

The total number of physical processor cores, summed from all processors that are attached to a piece of hardware
Type: unsignedInt

processors

Information regarding a piece of hardware’s processors.
Type: SoftLayer_Hardware_Component[]

rack

None
Type: SoftLayer_Location

raidControllers

The RAID controllers contained within a piece of hardware.
Type: SoftLayer_Hardware_Component[]

recentEvents

Recent events that impact this hardware.
Type: SoftLayer_Notification_Occurrence_Event[]

remoteManagementAccounts

User credentials to issue commands and/or interact with the server’s remote management card.
Type: SoftLayer_Hardware_Component_RemoteManagement_User[]

remoteManagementComponent

A hardware’s associated remote management component. This is normally IPMI.
Type: SoftLayer_Network_Component

resourceGroups

The resource groups in which this hardware is a member.
Type: SoftLayer_Resource_Group[]

routers

A hardware’s routers.
Type: SoftLayer_Hardware[]

securityScanRequests

Information regarding a piece of hardware’s vulnerability scan requests.
Type: SoftLayer_Network_Security_Scanner_Request[]

serverRoom

Information regarding the server room in which the hardware is located.
Type: SoftLayer_Location

serviceProvider

Information regarding the piece of hardware’s service provider.
Type: SoftLayer_Service_Provider

softwareComponents

Information regarding a piece of hardware’s installed software.
Type: SoftLayer_Software_Component[]

sparePoolBillingItem

Information regarding the billing item for a spare pool server.
Type: SoftLayer_Billing_Item_Hardware

sshKeys

SSH keys to be installed on the server during provisioning or an OS reload.
Type: SoftLayer_Security_Ssh_Key[]

storageGroups

None
Type: SoftLayer_Configuration_Storage_Group[]

storageNetworkComponents

A piece of hardware’s private storage network components. [Deprecated]
Type: SoftLayer_Network_Component[]

Deprecated

tagReferences

None
Type: SoftLayer_Tag_Reference[]

topLevelLocation

None
Type: SoftLayer_Location

upgradeRequest

An account’s associated upgrade request object, if any.
Type: SoftLayer_Product_Upgrade_Request

upgradeableActiveComponents

A piece of hardware’s active upgradeable physical components.
Type: SoftLayer_Hardware_Component[]

uplinkHardware

The network device connected to a piece of hardware.
Type: SoftLayer_Hardware

uplinkNetworkComponents

Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure.
Type: SoftLayer_Network_Component[]

userData

An array containing a single string of custom user data for a hardware order. Max size is 16 kb.
Type: SoftLayer_Hardware_Attribute[]

users

A list of users that have access to this hardware firewall.
Type: SoftLayer_User_Customer[]

virtualChassis

Information regarding the virtual chassis for a piece of hardware.
Type: SoftLayer_Hardware_Group

virtualChassisSiblings

Information regarding the virtual chassis siblings for a piece of hardware.
Type: SoftLayer_Hardware[]

virtualHost

A piece of hardware’s virtual host record.
Type: SoftLayer_Virtual_Host

virtualLicenses

Information regarding a piece of hardware’s virtual software licenses.
Type: SoftLayer_Software_VirtualLicense[]

virtualRack

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

virtualRackId

The name of the bandwidth allotment belonging to a piece of hardware.
Type: int

virtualRackName

The name of the bandwidth allotment belonging to a piece of hardware.
Type: string

virtualizationPlatform

A piece of hardware’s virtualization platform software.
Type: SoftLayer_Software_Component

Datatypes

SoftLayer_Hardware_Firewall

Description

Local

Relational