SoftLayer Network Firewall Template Rule
From SoftLayer Development Network Wiki
Contents |
Overview
The SoftLayer_Network_Component_Firewall_Rule type contains general information relating to a single SoftLayer firewall template rule. Use the SoftLayer Network Component Firewall service to view current rules. Use the SoftLayer Network Firewall Update Request service to submit a firewall update request.
User Access
Users wishing to access the SoftLayer_Network_Firewall_Template_Rule type must have the Hardware Firewall permission assigned to their account.
| 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
action
The action that this template rule is to take [permit or deny].
- Type: string
- Length: 10 characters
- Permission: Hardware Firewall
destinationIpAddress
The destination IP address considered for determining rule application.
- Type: string
- Length: 20 characters
- Permission: Hardware Firewall
destinationIpSubnetMask
The destination IP subnet mask considered for determining rule application.
- Type: string
- Length: 20 characters
- Permission: Hardware Firewall
destinationPortRangeEnd
The ending (upper end of range) destination port considered for determining rule application.
- Type: integer
- Length: 10 digits
- Permission: Hardware Firewall
destinationPortRangeStart
The starting (lower end of range) destination port considered for determining rule application.
- Type: integer
- Length: 10 digits
- Permission: Hardware Firewall
firewallTemplateId
The unique identifier of the firewall template that a firewall template rule is associated with.
- Type: integer
- Length: 10 digits
- Permission: Hardware Firewall
id
A Firewall template rule's internal identifier.
- Type: integer
- Permission: Hardware Firewall
notes
The notes field for the firewall template rule.
- Type: string
- Length: 200 characters
- Permission: Hardware Firewall
orderValue
The numeric value describing the order in which the rule set should be applied.
- Type: integer
- Length: 3 digits
- Permission: Hardware Firewall
protocol
The protocol considered for determining rule application.
- Type: string
- Length: 20 characters
- Permission: Hardware Firewall
sourceIpAddress
The source IP address considered for determining rule application.
- Type: string
- Length: 20 characters
- Permission: Hardware Firewall
sourceIpSubnetMask
The source IP subnet mask considered for determining rule application.
- Type: string
- Length: 20 characters
- Permission: Hardware Firewall
Relational Properties
firewallTemplate
The firewall template that this rule is attached to.
firewallTemplate can be queried by object mask.
firewallTemplate must be a unique value.
