AdminTasks for web server routing rules

The AdminTasks command group

Configure Web server routing rules with the following options for the WebServerRoutingRuleCommands command:

addWebServerRoutingRule

Add a rule with the following options:

*nodeName

The name of the node hosting the web server or custom HTTP server that the routing rule applies to.

*serverName

The name of the web server or custom HTTP server that the routing rule applies to.

*order

A positive integer value representing the order of the rule.

*expression

A string value containing the match expression for the rule.

*actionType

A string value containing the action to be executed when the rule expression is matched.

• permit: Permit routing to servers not in a maintenance mode.
• permitMM: Permit routing to servers even if in maintenance mode.
• redirect: Redirect the request to the URL specified by the redirectURL option.
• reject: Reject routing with return code specified by the errorcode option.

routingLocations

This parameter is required if the actionType of the rule is permit or permitMM and is a string value containing a list of targets to which the request can be sent. See the following supported formats:

cluster=cellName/clusterName

server=cellName/nodeName/serverName

Multiple targets can be specified separated by an & (ampersand) to indicate a load balancing group and a | (vertical bar) to indicate fail-over groups.

errorCode

This parameter is required if the actionType of the rule is reject and is an integer value containing the return code to be used when rejecting the request.

redirectURL

This parameter is required if the actionType of the rule is redirect and is a string value containing the URL that the request will be redirected to.

changeWebServerRoutingRuleAction

Change the action associated with an existing routing rule with the following options:

*nodeName

The name of the node hosting the web server or custom HTTP server that the routing rule applies to.

*serverName

The name of the web server or custom HTTP server that the routing rule applies to.

*order

A positive integer value representing the order of the rule.

*actionType

A string value containing the action to be executed when the rule expression is matched.

• permit: Permit routing to servers not in a maintenance mode.
• permitMM: Permit routing to servers even if in maintenance mode.
• redirect: Redirect the request to the URL specified by the redirectURL option.
• reject: Reject routing with return code specified by the errorcode option.

routingLocations

This parameter is required if the actionType of the rule is permit or permitMM and is a string value containing a list of targets to which the request can be sent. See the following supported formats:

cluster=cellName/clusterName

server=cellName/nodeName/serverName

Multiple targets can be specified separated by an & (ampersand) to indicate a load balancing group and a | (vertical bar) to indicate fail-over groups.

errorCode

This parameter is required if the actionType of the rule is reject and is an integer value containing the return code to be used when rejecting the request.

redirectURL

This parameter is required if the actionType of the rule is redirect and is a string value containing the URL that the request will be redirected to.

changeWebServerRoutingRuleExpression

Change the expression that is associated with an existing routing rule by using the following options:

*nodeName

The name of the node hosting the web server or custom HTTP server that the routing rule applies to.

*serverName

The name of the web server or custom HTTP server that the routing rule applies to.

*order

A positive integer value representing the order of the rule.

*expression

A string value containing the match expression for the rule.

changeWebServerRoutingRuleOrder

Change the order that is associated with an existing routing rule by using the following options:

*nodeName

The name of the node hosting the web server or custom HTTP server that the routing rule applies to.

*serverName

The name of the web server or custom HTTP server that the routing rule applies to.

*order

A positive integer value representing the order of the rule.

*newOrder

A positive integer value representing the new order of an existing routing rule.

listWebServerRoutingRules

List routing rules and properties that are associated with routing rules by using the following options:

*nodeName

The name of the node hosting the web server or custom HTTP server that the routing rule applies to.

*serverName

The name of the web server or custom HTTP server that the routing rule applies to.

removeWebServerRoutingRule

Remove an existing routing rule by using the following options:

*nodeName

The name of the node hosting the web server or custom HTTP server that the routing rule applies to.

*serverName

The name of the web server or custom HTTP server that the routing rule applies to.

*order

A positive integer value representing the order of the rule.

setWebServerRoutingRulesProperty

Set properties that are associated with routing rules by using the following options:

*nodeName

The name of the node hosting the web server or custom HTTP server that the routing rule applies to.

*serverName

The name of the web server or custom HTTP server that the routing rule applies to.

*propertyName

The name of the property to set. Currently the only valid property name is 'overrideAffinity'.

*propertyValue

The value of the property to set. Currently the only valid property values are 'true' and 'false'