Network
SoftLayer_Network_Vlan_Firewall

Overview

The SoftLayer_Network_Vlan_Firewall data type contains general information relating to a single SoftLayer VLAN firewall. This is the object which ties the running rules to a specific downstream server. Use the SoftLayer Network Firewall Template service to pull SoftLayer recommended rule set templates. Use the SoftLayer Network Firewall Update Request service to submit a firewall update request.

Local Properties

administrativeBypassFlag

A flag to indicate if the firewall is in administrative bypass mode. In other words, no rules are being applied to the traffic coming through.

Type:

string

customerManagedFlag

Whether or not this firewall can be directly logged in to.

Type:

boolean

id

A firewall's unique identifier.

Type:

integer

primaryIpAddress

A firewall's primary IP address. This field will be the IP shown when doing network traces and reverse DNS and is a read-only property.

Type:

string

Relational & Count Properties

Relational Properties can be queried by object mask
accountId
Type:

integer

bandwidthAllocation

A firewall's allotted bandwidth (measured in GB).

Type:

decimal

billingCycleBandwidthUsage

The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this firewall is attached to.

billingCycleBandwidthUsageCount

A count of the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this firewall is attached to.

Type:

unsignedLong

billingCyclePrivateBandwidthUsage

The raw private bandwidth usage data for the current billing cycle.

billingCyclePublicBandwidthUsage

The raw public bandwidth usage data for the current billing cycle.

billingItem

The billing item for a Hardware Firewall (Dedicated).

bypassRequestStatus

Administrative bypass request status.

Type:

string

currentBandwidthSummary

An object that provides commonly used bandwidth summary components for the current billing cycle.

datacenter

The datacenter that the firewall resides in.

firewallType

The firewall device type.

Type:

string

fullyQualifiedDomainName

A name reflecting the hostname and domain of the firewall. This is created from the combined values of the firewall's logical name and vlan number automatically, and thus can not be edited directly.

Type:

string

managementCredentials

The credentials to log in to a firewall device. This is only present for dedicated appliances.

metricTrackingObjectId

The metric tracking object ID for this firewall.

Type:

integer

networkFirewallUpdateRequestCount

A count of the update requests made for this firewall.

Type:

unsignedLong

networkFirewallUpdateRequests

The update requests made for this firewall.

networkGateway

The gateway associated with this firewall, if any.

networkVlan

The VLAN object that a firewall is associated with and protecting.

networkVlanCount

A count of the VLAN objects that a firewall is associated with and protecting.

Type:

unsignedLong

networkVlans

The VLAN objects that a firewall is associated with and protecting.

overBandwidthAllocationFlag

Whether the bandwidth usage for this firewall for the current billing cycle exceeds the allocation.

Type:

integer

projectedOverBandwidthAllocationFlag

Whether the bandwidth usage for this firewall for the current billing cycle is projected to exceed the allocation.

Type:

integer

projectedPublicBandwidthUsage

The projected public outbound bandwidth for this firewall for the current billing cycle.

Type:

float

ruleCount

A count of the currently running rule set of this network component firewall.

Type:

unsignedLong

rules

The currently running rule set of this network component firewall.

tagReferenceCount

A count of

Type:

unsignedLong

tagReferences