Contents

Rule Status - Field Help

If applicable, edit any of the following configuration settings on the Rule Status panel and click Update Configuration.

Begin range

The lower value in the range used to determine whether or not the rule is true. The kind of value and its default depends on the type of rule:

  • ip - the address of the client as either a symbolic name or in dotted-decimal format. The default value is 0.0.0.0.
  • time - an integer. The default value is 0, representing midnight.
  • connections - an integer. The default value is 0.
  • active - an integer. The default value is 0.
  • true - the rule is always true.

End range

The higher value in the range used to determine whether or not the rule is true. The kind of value and its default depends on the type of rule:

  • ip - the address of the client as either a symbolic name or in dotted-decimal format. The default value is 255.255.255.255.
  • time - an integer. The default value is 24, representing midnight.
  • connections - an integer. The default value is 2 to the 32nd power minus 1.
  • active - an integer. The default value is 2 to the 32nd power minus 1.
  • port - an integer. The default value is 65535.

Priority

An integer representing the order in which the rules will be reviewed. If you do not specify the priority of the first rule you add, the Dispatcher will set it by default to 1. Subsequent rules will be added by default with the priority of current highest priority value + 10.

Sticky time

The sticky time for this port. Sticky time is used to create an affinity relationship between a client and a specific server. After the sticky time has been exceeded, the client may be sent to a server different from the previous. The default value is 0, meaning that the port is not sticky. Sticky time can also be set at the executor and cluster levels.

By setting the affinity field to "cookie" and setting the sticky time of the port to a positive number, you can provide a new way to make clients "sticky" to a particular server. Once a port has been enabled for cookie affinity, new client requests will be load-balanced using standard CBR algorithms, and succeeding requests from the same clinet will be sent to the initially chosen server.

Affinity type

The affinity type associated with a rule. Options are client IP or cookie; the default is client IP. Cookie affinity is used to ensure that a client continues to be load balanced to the same server for some period of time. The cookie contains the cluster:port:rule that was used to make the decision, the server that was load balanced to, and a timeout timestamp for when the affinity is no longer valid.



The following current statistics are also displayed on the Rule Status panel:

Name

The name you chose for the rule. This name can contain any alphanumeric character, underscore, hyphen, or period. It may be from 1 to 20 characters and cannot contain any blanks.

Rule type

The type of the rule. Possible types are:

  • ip - based on the client IP address.
  • time - based on the time of day.
  • connections - based on the number of connections per second for the port.
  • active - based on the number of active connections total for the port.
  • port - based on the client port.
  • content - based on the client uniform resource locator (URL) request.

Times fired

The number of times this rule has fired either since it was added or since the last time the executor was restarted.



List of Servers

Shows the addresses of servers currently associated with the rule.