All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

Firewall
```
@ApiService("SoftLayer_Network_Vlan_Firewall")
public static interface Firewall.Service
extends Service
```
The SoftLayer_Network_Vlan_Firewall service accesses general information relating to a single SoftLayer VLAN firewall. This is the object which ties the running rules to a specific downstream server. The current running rule set can be pulled from this service. 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.

See Also:

SoftLayer_Network_Vlan_Firewall

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Void`	`approveBypassRequest()`	Approve a request from technical support to bypass the firewall.
`Firewall.ServiceAsync`	`asAsync()`	Get an async version of this service
`Long`	`getAccountId()`
`BigDecimal`	`getBandwidthAllocation()`	A firewall's allotted bandwidth (measured in GB).
`List<Usage>`	`getBillingCycleBandwidthUsage()`	The raw bandwidth usage data for the current billing cycle.
`Usage`	`getBillingCyclePrivateBandwidthUsage()`	The raw private bandwidth usage data for the current billing cycle.
`Usage`	`getBillingCyclePublicBandwidthUsage()`	The raw public bandwidth usage data for the current billing cycle.
`Item`	`getBillingItem()`	The billing item for a Hardware Firewall (Dedicated).
`String`	`getBypassRequestStatus()`	Administrative bypass request status.
`Location`	`getDatacenter()`	The datacenter that the firewall resides in.
`String`	`getFirewallFirmwareVersion()`	Retrieve the firewall device firmware version from database.
`String`	`getFirewallType()`	The firewall device type.
`String`	`getFullyQualifiedDomainName()`	A name reflecting the hostname and domain of the firewall.
`Password`	`getManagementCredentials()`	The credentials to log in to a firewall device.
`Object`	`getMetricTrackingObject()`	A firewall's metric tracking object.
`Long`	`getMetricTrackingObjectId()`	The metric tracking object ID for this firewall.
`List<Request>`	`getNetworkFirewallUpdateRequests()`	The update requests made for this firewall.
`Gateway`	`getNetworkGateway()`	The gateway associated with this firewall, if any.
`Vlan`	`getNetworkVlan()`	The VLAN object that a firewall is associated with and protecting.
`List<Vlan>`	`getNetworkVlans()`	The VLAN objects that a firewall is associated with and protecting.
`Firewall`	`getObject()`	getObject returns a SoftLayer_Network_Vlan_Firewall object.
`List<Rule>`	`getRules()`	The currently running rule set of this network component firewall.
`List<Reference>`	`getTagReferences()`
`Request`	`getUpgradeRequest()`	A firewall's associated upgrade request object, if any.
`Boolean`	`hasActiveTransactions()`	Check for active transactions for the Firewall.
`Boolean`	`isAccountAllowed()`	Checks if the account is allowed to use some features of FSA1G and Hardware firewall (Dedicated)
`Boolean`	`isHighAvailabilityUpgradeAvailable()`	Whether this firewall qualifies for High Availability upgrade.
`Void`	`rejectBypassRequest()`	Reject a request from technical support to bypass the firewall.
`Transaction`	`restoreDefaults()`	This will completely reset the firewall to factory settings.
`void`	`setMask(Firewall.Mask mask)`
`Boolean`	`setTags(String tags)`	This method will associate a comma separated list of tags with this object.
`Transaction`	`updateRouteBypass(Boolean bypass)`	Enable or disable route bypass for this context.
`Firewall.Mask`	`withMask()`	Use the existing mask on this service or create it if not present
`Firewall.Mask`	`withNewMask()`	Overwrite the existing mask on this service with a new one and return it

Methods inherited from interface com.softlayer.api.Maskable
clearMask, setMask, setMask

Methods inherited from interface com.softlayer.api.ResultLimitable
getLastResponseTotalItemCount, getResultLimit, setResultLimit

- Method Detail
  - asAsync
```
Firewall.ServiceAsync asAsync()
```
    Description copied from interface: Service
    
    Get an async version of this service
    
    Specified by:
    
    asAsync in interface Service
  - withNewMask
```
Firewall.Mask withNewMask()
```
    Description copied from interface: Maskable
    
    Overwrite the existing mask on this service with a new one and return it
    
    Specified by:
    
    withNewMask in interface Maskable
  - withMask
```
Firewall.Mask withMask()
```
    Description copied from interface: Maskable
    
    Use the existing mask on this service or create it if not present
    
    Specified by:
    
    withMask in interface Maskable
  - setMask
```
void setMask(Firewall.Mask mask)
```
  - approveBypassRequest
```
@ApiMethod(instanceRequired=true)
Void approveBypassRequest()
```
    Approve a request from technical support to bypass the firewall. Once approved, support will be able to route and unroute the VLAN on the firewall.
    
    See Also:
    
    SoftLayer_Network_Vlan_Firewall::approveBypassRequest
  - getFirewallFirmwareVersion
```
@ApiMethod(instanceRequired=true)
String getFirewallFirmwareVersion()
```
    Retrieve the firewall device firmware version from database.
    
    See Also:
    
    SoftLayer_Network_Vlan_Firewall::getFirewallFirmwareVersion
  - getObject
```
@ApiMethod(instanceRequired=true)
Firewall getObject()
```
    getObject returns a SoftLayer_Network_Vlan_Firewall object. You can only get objects for vlans attached to your account that have a network firewall enabled.
    
    See Also:
    
    SoftLayer_Network_Vlan_Firewall::getObject
  - hasActiveTransactions
```
@ApiMethod(instanceRequired=true)
Boolean hasActiveTransactions()
```
    Check for active transactions for the Firewall.
    
    See Also:
    
    SoftLayer_Network_Vlan_Firewall::hasActiveTransactions
  - isAccountAllowed
```
@ApiMethod(instanceRequired=true)
Boolean isAccountAllowed()
```
    Checks if the account is allowed to use some features of FSA1G and Hardware firewall (Dedicated)
    
    See Also:
    
    SoftLayer_Network_Vlan_Firewall::isAccountAllowed
  - isHighAvailabilityUpgradeAvailable
```
@ApiMethod(instanceRequired=true)
Boolean isHighAvailabilityUpgradeAvailable()
```
    Whether this firewall qualifies for High Availability upgrade.
    
    See Also:
    
    SoftLayer_Network_Vlan_Firewall::isHighAvailabilityUpgradeAvailable
  - rejectBypassRequest
```
@ApiMethod(instanceRequired=true)
Void rejectBypassRequest()
```
    Reject a request from technical support to bypass the firewall. Once rejected, IBM support will not be able to route and unroute the VLAN on the firewall.
    
    See Also:
    
    SoftLayer_Network_Vlan_Firewall::rejectBypassRequest
  - restoreDefaults
```
@ApiMethod(instanceRequired=true)
Transaction restoreDefaults()
```
    This will completely reset the firewall to factory settings. If the firewall is not a FSA 10G appliance an error will occur. Note, this process is performed asynchronously. During the process all traffic will not be routed through the firewall.
    
    See Also:
    
    SoftLayer_Network_Vlan_Firewall::restoreDefaults
  - setTags
```
@ApiMethod(instanceRequired=true)
Boolean setTags(String tags)
```
    This method will associate a comma separated list of tags with this object.
    
    See Also:
    
    SoftLayer_Network_Vlan_Firewall::setTags
  - updateRouteBypass
```
@ApiMethod(instanceRequired=true)
Transaction updateRouteBypass(Boolean bypass)
```
    Enable or disable route bypass for this context. If enabled, this will bypass the firewall entirely and all traffic will be routed directly to the host(s) behind it. If disabled, traffic will flow through the firewall normally. This feature is only available for Hardware Firewall (Dedicated) and dedicated appliances.
    
    See Also:
    
    SoftLayer_Network_Vlan_Firewall::updateRouteBypass
  - getAccountId
```
@ApiMethod(instanceRequired=true)
Long getAccountId()
```
    See Also:
    
    SoftLayer_Network_Vlan_Firewall::getAccountId
  - getBandwidthAllocation
```
@ApiMethod(instanceRequired=true)
BigDecimal getBandwidthAllocation()
```
    A firewall's allotted bandwidth (measured in GB).
    
    See Also:
    
    SoftLayer_Network_Vlan_Firewall::getBandwidthAllocation
  - getBillingCycleBandwidthUsage
```
@ApiMethod(instanceRequired=true)
List<Usage> getBillingCycleBandwidthUsage()
```
    The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this firewall is attached to.
    
    See Also:
    
    SoftLayer_Network_Vlan_Firewall::getBillingCycleBandwidthUsage
  - getBillingCyclePrivateBandwidthUsage
```
@ApiMethod(instanceRequired=true)
Usage getBillingCyclePrivateBandwidthUsage()
```
    The raw private bandwidth usage data for the current billing cycle.
    
    See Also:
    
    SoftLayer_Network_Vlan_Firewall::getBillingCyclePrivateBandwidthUsage
  - getBillingCyclePublicBandwidthUsage
```
@ApiMethod(instanceRequired=true)
Usage getBillingCyclePublicBandwidthUsage()
```
    The raw public bandwidth usage data for the current billing cycle.
    
    See Also:
    
    SoftLayer_Network_Vlan_Firewall::getBillingCyclePublicBandwidthUsage
  - getBillingItem
```
@ApiMethod(instanceRequired=true)
Item getBillingItem()
```
    The billing item for a Hardware Firewall (Dedicated).
    
    See Also:
    
    SoftLayer_Network_Vlan_Firewall::getBillingItem
  - getBypassRequestStatus
```
@ApiMethod(instanceRequired=true)
String getBypassRequestStatus()
```
    Administrative bypass request status.
    
    See Also:
    
    SoftLayer_Network_Vlan_Firewall::getBypassRequestStatus
  - getDatacenter
```
@ApiMethod(instanceRequired=true)
Location getDatacenter()
```
    The datacenter that the firewall resides in.
    
    See Also:
    
    SoftLayer_Network_Vlan_Firewall::getDatacenter
  - getFirewallType
```
@ApiMethod(instanceRequired=true)
String getFirewallType()
```
    The firewall device type.
    
    See Also:
    
    SoftLayer_Network_Vlan_Firewall::getFirewallType
  - getFullyQualifiedDomainName
```
@ApiMethod(instanceRequired=true)
String getFullyQualifiedDomainName()
```
    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.
    
    See Also:
    
    SoftLayer_Network_Vlan_Firewall::getFullyQualifiedDomainName
  - getManagementCredentials
```
@ApiMethod(instanceRequired=true)
Password getManagementCredentials()
```
    The credentials to log in to a firewall device. This is only present for dedicated appliances.
    
    See Also:
    
    SoftLayer_Network_Vlan_Firewall::getManagementCredentials
  - getMetricTrackingObject
```
@ApiMethod(instanceRequired=true)
Object getMetricTrackingObject()
```
    A firewall's metric tracking object.
    
    See Also:
    
    SoftLayer_Network_Vlan_Firewall::getMetricTrackingObject
  - getMetricTrackingObjectId
```
@ApiMethod(instanceRequired=true)
Long getMetricTrackingObjectId()
```
    The metric tracking object ID for this firewall.
    
    See Also:
    
    SoftLayer_Network_Vlan_Firewall::getMetricTrackingObjectId
  - getNetworkFirewallUpdateRequests
```
@ApiMethod(instanceRequired=true)
List<Request> getNetworkFirewallUpdateRequests()
```
    The update requests made for this firewall.
    
    See Also:
    
    SoftLayer_Network_Vlan_Firewall::getNetworkFirewallUpdateRequests
  - getNetworkGateway
```
@ApiMethod(instanceRequired=true)
Gateway getNetworkGateway()
```
    The gateway associated with this firewall, if any.
    
    See Also:
    
    SoftLayer_Network_Vlan_Firewall::getNetworkGateway
  - getNetworkVlan
```
@ApiMethod(instanceRequired=true)
Vlan getNetworkVlan()
```
    The VLAN object that a firewall is associated with and protecting.
    
    See Also:
    
    SoftLayer_Network_Vlan_Firewall::getNetworkVlan
  - getNetworkVlans
```
@ApiMethod(instanceRequired=true)
List<Vlan> getNetworkVlans()
```
    The VLAN objects that a firewall is associated with and protecting.
    
    See Also:
    
    SoftLayer_Network_Vlan_Firewall::getNetworkVlans
  - getRules
```
@ApiMethod(instanceRequired=true)
List<Rule> getRules()
```
    The currently running rule set of this network component firewall.
    
    See Also:
    
    SoftLayer_Network_Vlan_Firewall::getRules
  - getTagReferences
```
@ApiMethod(instanceRequired=true)
List<Reference> getTagReferences()
```
    See Also:
    
    SoftLayer_Network_Vlan_Firewall::getTagReferences
  - getUpgradeRequest
```
@ApiMethod(instanceRequired=true)
Request getUpgradeRequest()
```
    A firewall's associated upgrade request object, if any.
    
    See Also:
    
    SoftLayer_Network_Vlan_Firewall::getUpgradeRequest

Interface Firewall.Service

Method Summary

Methods inherited from interface com.softlayer.api.Maskable

Methods inherited from interface com.softlayer.api.ResultLimitable

Method Detail

asAsync

withNewMask

withMask

setMask

approveBypassRequest

getFirewallFirmwareVersion

getObject

hasActiveTransactions

isAccountAllowed

isHighAvailabilityUpgradeAvailable

rejectBypassRequest

restoreDefaults

setTags

updateRouteBypass

getAccountId

getBandwidthAllocation

getBillingCycleBandwidthUsage

getBillingCyclePrivateBandwidthUsage

getBillingCyclePublicBandwidthUsage

getBillingItem

getBypassRequestStatus

getDatacenter

getFirewallType

getFullyQualifiedDomainName

getManagementCredentials

getMetricTrackingObject

getMetricTrackingObjectId

getNetworkFirewallUpdateRequests

getNetworkGateway

getNetworkVlan

getNetworkVlans

getRules

getTagReferences

getUpgradeRequest