SoftLayer Network Firewall Update Request Rule (type)

From SoftLayer Development Network Wiki

Jump to: navigation, search

This page refers to the SoftLayer_Network_Firewall_Update_Request_Rule data type. For information on the SoftLayer_Network_Firewall_Update_Request_Rule service please see SoftLayer_Network_Firewall_Update_Request_Rule.

Contents

Overview

The SoftLayer_Network_Firewall_Update_Request_Rule type contains information relating to a SoftLayer network firewall update request rule. This rule is a member of a SoftLayer Network Firewall Update Request. Use the SoftLayer Network Component Firewall service to view current rules. Use the SoftLayer Network Firewall Template service to pull SoftLayer recommended rule set templates.

User Access

Users wishing to access the SoftLayer_Network_Firewall_Update_Request_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 update request rule is to take [permit or deny].
action is required for object creation.

  • Type: string
  • Length: 10 characters
  • Permission: Hardware Firewall



destinationIpAddress

The destination IP address considered for determining rule application.
destinationIpAddress is required for object creation.

  • 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



firewallUpdateRequestId

The unique identifier of the firewall update request that a firewall update request rule is associated with.
firewallUpdateRequestId is required for object creation.

  • Type: integer
  • Length: 10 digits
  • Permission: Hardware Firewall



id

A Firewall update request rule's internal identifier.

  • Type: integer
  • Permission: Hardware Firewall



notes

The notes field for the firewall update request rule.

  • Type: string
  • Length: 200 characters
  • Permission: Hardware Firewall



orderValue

The numeric value describing the order in which the rule should be applied.
orderValue is required for object creation.

  • Type: integer
  • Length: 3 digits
  • Permission: Hardware Firewall



protocol

The protocol considered for determining rule application.
protocol is required for object creation.

  • Type: string
  • Length: 20 characters
  • Permission: Hardware Firewall



sourceIpAddress

The source IP address considered for determining rule application.
sourceIpAddress is required for object creation.

  • Type: string
  • Length: 20 characters
  • Permission: Hardware Firewall



sourceIpSubnetMask

The source IP subnet mask considered for determining rule application.
sourceIpSubnetMask is required for object creation.

  • Type: string
  • Length: 20 characters
  • Permission: Hardware Firewall


Relational Properties

firewallUpdateRequest

The update request that this rule belongs to.
firewallUpdateRequest can be queried by object mask.
firewallUpdateRequest must be a unique value.

External Links

Personal tools