@@ -10,10 +10,10 @@ module SoftLayer
1010 # SoftLayer environment that exists in a 1 to 1 relationship
1111 # with a particular server (either Bare Metal or Virtual).
1212 #
13- # This is also called a "Shared Firewall" in some documentation
13+ # This is also called a "Shared Firewall" in some documentation.
1414 #
1515 # Instances of this class rougly correspond to instances of the
16- # SoftLayer_Network_Component_Firewall service entity
16+ # SoftLayer_Network_Component_Firewall service entity.
1717 #
1818 class ServerFirewall < SoftLayer ::ModelBase
1919 include ::SoftLayer ::DynamicAttribute
@@ -28,9 +28,9 @@ class ServerFirewall < SoftLayer::ModelBase
2828
2929 ##
3030 # :attr_reader:
31- # The firewall rules assigned to this firewall. These rules will
31+ # The firewall rules assigned to this firewall. These rules will
3232 # be read from the network API every time you ask for the value
33- # of this property. To change the rules on the server use the
33+ # of this property. To change the rules on the server use the
3434 # asymmetric method change_rules!
3535 sl_dynamic_attr :rules do |firewall_rules |
3636 firewall_rules . should_update? do
@@ -90,7 +90,7 @@ def initialize(client, network_hash)
9090 # Cancel the firewall
9191 #
9292 # This method cancels the firewall and releases its
93- # resources. The cancellation is processed immediately!
93+ # resources. The cancellation is processed immediately!
9494 # Call this method with careful deliberation!
9595 #
9696 # Notes is a string that describes the reason for the
@@ -121,13 +121,18 @@ def cancel!(notes = nil)
121121 # hashes should be entries from the array returned by
122122 # SoftLayer::ServerFirewall.default_rules_mask_keys
123123 #
124+ # *NOTE!* When changing the rules on the firewall, you must
125+ # pass in a complete set of rules each time. The rules you
126+ # submit will replace the entire ruleset on the destination
127+ # firewall.
128+ #
124129 # *NOTE!* The rules themselves have an "orderValue" property.
125130 # It is this property, and *not* the order that the rules are
126131 # found in the rules_data array, which will determine in which
127132 # order the firewall applies it's rules to incomming traffic.
128133 #
129134 # *NOTE!* Changes to the rules are not applied immediately
130- # on the server side. Instead, they are enqueued by the
135+ # on the server side. Instead, they are enqueued by the
131136 # firewall update service and updated periodically. A typical
132137 # update will take about one minute to apply, but times may vary
133138 # depending on the system load and other circumstances.
@@ -150,7 +155,7 @@ def change_rules!(rules_data)
150155 # used with careful deliberation.
151156 #
152157 # Note that this routine queues a rule change and rule changes may take
153- # time to process. The change will probably not take effect immediately
158+ # time to process. The change will probably not take effect immediately.
154159 #
155160 # The two symbols accepted as arguments by this routine are:
156161 # :apply_firewall_rules - The rules of the firewall are applied to traffic. This is the default operating mode of the firewall
0 commit comments