Ruleset administrative tasks

You can use the ruleset commands to add, remove, or modify rules and actions of the ruleset.xml file without using the administrative console.

Use the following commands to create ruleset lists, and add or remove rules and actions from the ruleset:

createRuleset
listRuleset
addRuleToRuleset
removeRuleFromRuleset
changeRulePriority
changeRuleExpression
addActionToRule
removeActionFromRule
addDefaultAction
removeDefaultAction

createRuleset

The createRuleset command creates a ruleset list.

Required parameters

-rulesetName: Specifies the name of the ruleset. (String, required)
-rulesetType: Specifies the protocol type to associate with the ruleset. The only valid types are HTTP and SOAP. (String, required)
-defaultContinue: Specifies the setting for the default continue flag value. Specify True or False. (Boolean, required)

Optional parameters

-odrname: Specifies the name of the on demand router (ODR) to which the ruleset applies. The -odrname parameter is required only if you modify an ODR. (String, optional)
-nodename: Specifies the name of the node on which the ODR resides. The -nodename parameter is required only if you modify an ODR. (String, optional)
-clustername: Specifies the name of the cluster to which the ruleset applies. The -clusterName parameter is required only if you modify an ODR cluster. (String, optional)

Batch mode example usage

Using Jacl:

$AdminTask createRuleset {-odrname odr -nodename node1 -rulesetName myRuleset -rulesetType 
HTTP -defaultContinue True}

Using Jython string:

AdminTask.createRuleset ('-odrname odr -nodename node1 -rulesetName myRuleset -rulesetType 
HTTP -defaultContinue True')

Interactive mode example usage

Using Jacl:
```
$AdminTask createRuleset {-interactive}
```

Using Jython string:

AdminTask.createRuleset ('[-interactive]')

listRuleset

The listRuleset command lists ruleset rules and actions.

Required parameters

-rulesetName: Specifies the name of the ruleset. (String, required)

Optional parameters

-odrname: Specifies the name of the on demand router (ODR) to which the ruleset applies. The -odrname parameter is required only if you modify an ODR. (String, optional)
-nodename: Specifies the name of the node on which the ODR resides. The -nodename parameter is required only if you modify an ODR. (String, optional)
-clustername: Specifies the name of the cluster to which the ruleset applies. The -clusterName parameter is required only if you modify an ODR cluster. (String, optional)

Batch mode example usage

Using Jacl:

$AdminTask listRuleset {-odrname odr -nodename node1 -rulesetName myRuleset}

Using Jython string:

AdminTask.listRuleset ('-odrname odr -nodename node1 -rulesetName myRuleset')

Interactive mode example usage

Using Jacl:
```
$AdminTask listRuleset {-interactive}
```

Using Jython string:

AdminTask.listRuleset ('[-interactive]')

addRuleToRuleset

The addRuleToRuleset command adds a rule to the ruleset.

Required parameters

-rulesetName: Specifies the name of the ruleset. (String, required)
-ruleName: Specifies the name of the rule. The -ruleName parameter must be unique within the ruleset. (String, required)
-rulePriority: Specifies a positive integer value representing the priority of the rule. Zero is the highest priority. (String, required)
-expression: Specifies the rule expression. You must enclose the value in double quotes. (String, required)

Optional parameters

-odrname: Specifies the name of the on demand router (ODR) to which the ruleset applies. The -odrname parameter is required only if you modify an ODR. (String, optional)
-nodename: Specifies the name of the node on which the ODR resides. The -nodename parameter is required only if you modify an ODR. (String, optional)
-clustername: Specifies the name of the cluster to which the ruleset applies. The -clusterName parameter is required only if you modify an ODR cluster. (String, optional)

Batch mode example usage

Using Jacl:

$AdminTask addRuleToRuleset {-odrname odr -nodename node1 -rulesetName myRuleset -ruleName myRule
 -rulePriority 0 -expression "vhost = vhostA"}

Using Jython string:

AdminTask.addRuleToRuleset('-odrname odr -nodename node1 -rulesetName myRuleset -ruleName myRule
 -rulePriority 0 -expression "vhost = \'vhostA\'"')

Interactive mode example usage

Using Jacl:

$AdminTask addRuleToRuleset {-interactive}

Using Jython string:

AdminTask.addRuleToRuleset ('[-interactive]')

removeRuleFromRuleset

The removeRuleFromRuleset command removes a rule from the ruleset.

Required parameters

-rulesetName: Specifies the name of the ruleset. (String, required)
-ruleName: Specifies the name of the rule to remove. (String, required)

Optional parameters

-odrname: Specifies the name of the on demand router (ODR) to which the ruleset applies. The -odrname parameter is required only if you modify an ODR. (String, optional)
-nodename: Specifies the name of the node on which the ODR resides. The -nodename parameter is required only if you modify an ODR. (String, optional)
-clustername: Specifies the name of the cluster to which the ruleset applies. The -clusterName parameter is required only if you modify an ODR cluster. (String, optional)

Batch mode example usage

Using Jacl:

$AdminTask removeRuleFromRuleset {-odrname odr -nodename node1 -rulesetName myRuleset -ruleName myRule}

Using Jython string:

AdminTask.removeRuleFromRuleset('-odrname odr -nodename node1 -rulesetName myRuleset -ruleName myRule')

Interactive mode example usage

Using Jacl:

$AdminTask removeRulefromRuleset {-interactive}

Using Jython string:

AdminTask.removeRulefromRuleset ('[-interactive]')

changeRulePriority

The changeRulePriority command modifies the priority of a rule.

Required parameters

-rulesetName: Specifies the name of the ruleset. (String, required)
-ruleName: Specifies the name of the rule to modify. (String, required)
-rulePriority: Specifies a positive integer value representing the priority of the rule. Zero is the highest priority. (String, required)

Optional parameters

-odrname: Specifies the name of the on demand router (ODR) to which the ruleset applies. The -odrname parameter is required only if you modify an ODR. (String, optional)
-nodename: Specifies the name of the node on which the ODR resides. The -nodename parameter is required only if you modify an ODR. (String, optional)
-clustername: Specifies the name of the cluster to which the ruleset applies. The -clusterName parameter is required only if you modify an ODR cluster. (String, optional)

Batch mode example usage

Using Jacl:

$AdminTask changeRulePriority {-odrname odr -nodename node1 -rulesetName myRuleset -ruleName myRule -rulePriority 1}

Using Jython string:

AdminTask.changeRulePriority('-odrname odr-nodename node1 -rulesetName myRuleset -ruleName myRule -rulePriority 1')

Interactive mode example usage

Using Jacl:

$AdminTask changeRulePriority {-interactive}

Using Jython string:

AdminTask.changeRulePriority ('[-interactive]')

changeRuleExpression

The changeRuleExpression command modifies a rule expression.

Required parameters

-rulesetName: Specifies the name of the ruleset. (String, required)
-ruleName: Specifies the name of the rule to modify. (String, required)
-expression: Specifies the new rule expression. (String, required)

Optional parameters

-odrname: Specifies the name of the on demand router (ODR) to which the ruleset applies. The -odrname parameter is required only if you modify an ODR. (String, optional)
-nodename: Specifies the name of the node on which the ODR resides. The -nodename parameter is required only if you modify an ODR. (String, optional)
-clustername: Specifies the name of the cluster to which the ruleset applies. The -clusterName parameter is required only if you modify an ODR cluster. (String, optional)

Batch mode example usage

Using Jacl:

$AdminTask changeRuleExpression {-odrname odr -nodename node1 -rulesetName myRuleset -ruleName myRule 
-expression "vhost = vhostB"}

Using Jython string:

AdminTask.changeRuleExpression('-odrname odr -nodename node1 -rulesetName myRuleset -ruleName myRule 
-expression "vhost = \'vhostB\'"')

Interactive mode example usage

Using Jacl:

$AdminTask changeRuleExpression {-interactive}

Using Jython string:

AdminTask.changeRuleExpression ('[-interactive]')

addActionToRule

The addActionToRule command adds an action to a rule.

Required parameters

-rulesetName: Specifies the name of the ruleset. (String, required)
-ruleName: Specifies the name of the rule. The -ruleName parameter must be unique within the ruleset. (String, required)
-actionName: Specifies the name of the action. The -actionName parameter must be unique within the ruleset. (String, required)
-actionType: Specifies the type of action to associate with the rule. (String, required)
-actionValue: Specifies the action value, such as the format of the log file, to use. (String, required)
-actionContinue: Specifies the setting for the action continue flag value. Specify True or False. (Boolean, required)

Optional parameters

-odrname: Specifies the name of the on demand router (ODR) to which the ruleset applies. The -odrname parameter is required only if you modify an ODR. (String, optional)
-nodename: Specifies the name of the node on which the ODR resides. The -nodename parameter is required only if you modify an ODR. (String, optional)
-clustername: Specifies the name of the cluster to which the ruleset applies. The -clusterName parameter is required only if you modify an ODR cluster. (String, optional)

Batch mode example usage

Using Jacl:

$AdminTask addActionToRule {-odrname odr -nodename node1 -rulesetName myRuleset -ruleName myRule 
-actionName myAction -actionType log -actionValue "MyCustom.log %r %T %z %Z" -actionContinue true}

Using Jython string:

AdminTask.addActionToRule('-odrname odr -nodename node1 -rulesetName myRuleset -ruleName myRule 
-actionName myAction -actionType log -actionValue "MyCustom.log %r %T %z %Z" -actionContinue true')

Interactive mode example usage

Using Jacl:

$AdminTask addActionToRule {-interactive}

Using Jython string:

AdminTask.addActionToRule ('[-interactive]')

removeActionFromRule

The removeActionFromRule command removes an action from a rule.

Required parameters

-rulesetName: Specifies the name of the ruleset. (String, required)
-ruleName: Specifies the name of the rule that contains the action. (String, required)
-actionName: Specifies the name of the action to remove. (String, required)

Optional parameters

-odrname: Specifies the name of the on demand router (ODR) to which the ruleset applies. The -odrname parameter is required only if you modify an ODR. (String, optional)
-nodename: Specifies the name of the node on which the ODR resides. The -nodename parameter is required only if you modify an ODR. (String, optional)
-clustername: Specifies the name of the cluster to which the ruleset applies. The -clusterName parameter is required only if you modify an ODR cluster. (String, optional)

Batch mode example usage

Using Jacl:

$AdminTask removeActionFromRule {-odrname odr -nodename node1 -rulesetName myRuleset -ruleName
 myRule -actionName myAction}

Using Jython string:

AdminTask.removeActionFromRule('-odrname odr -nodename node1 -rulesetName myRuleset -ruleName
 myRule -actionName myAction')

Interactive mode example usage

Using Jacl:

$AdminTask removeActionFromRule {-interactive}

Using Jython string:

AdminTask.removeActionFromRule ('[-interactive]')

addDefaultAction

The addDefaultAction command adds a default action to a ruleset.

Required parameters

-rulesetName: Specifies the name of the ruleset. (String, required)
-actionName: Specifies the name of the action. The -actionName parameter must be unique within the ruleset. (String, required)
-actionType: Specifies the type of action to associate with the rule. (String, required)
-actionValue: Specifies the action value, such as the format of the log file, to use. (String, required)
-actionContinue: Specifies the setting for the action continue flag value. Specify True or False. (Boolean, required)

Optional parameters

-odrname: Specifies the name of the on demand router (ODR) to which the ruleset applies. The -odrname parameter is required only if you modify an ODR. (String, optional)
-nodename: Specifies the name of the node on which the ODR resides. The -nodename parameter is required only if you modify an ODR. (String, optional)
-clustername: Specifies the name of the cluster to which the ruleset applies. The -clusterName parameter is required only if you modify an ODR cluster. (String, optional)

Batch mode example usage

Using Jacl:

$AdminTask addDefaultAction {-odrname odr -nodename node1 -rulesetName myRuleset -actionName defAction 
-actionType log -actionValue "default.log %a %d %D" -actionContinue True}

Using Jython string:

AdminTask.addDefaultAction('-odrname odr -nodename node1 -rulesetName myRuleset -actionName defAction 
-actionType log -actionValue "default.log %a %d %D" -actionContinue True')

Interactive mode example usage

Using Jacl:

$AdminTask addDefaultAction {-interactive}

Using Jython string:

AdminTask.addDefaultAction ('[-interactive]')

removeDefaultAction

The removeDefaultAction command removes a default action from a ruleset.

Required parameters

-rulesetName: Specifies the name of the ruleset. (String, required)
-actionName: Specifies the name of the action to remove. (String, required)

Optional parameters

-odrname: Specifies the name of the on demand router (ODR) to which the ruleset applies. The -odrname parameter is required only if you modify an ODR. (String, optional)
-nodename: Specifies the name of the node on which the ODR resides. The -nodename parameter is required only if you modify an ODR. (String, optional)
-clustername: Specifies the name of the cluster to which the ruleset applies. The -clusterName parameter is required only if you modify an ODR cluster. (String, optional)

Batch mode example usage

Using Jacl:

$AdminTask removeDefaultAction {-odrname odr -nodename node1 -rulesetName myRuleset -actionName defAction}

Using Jython string:

AdminTask.removeDefaultAction('-odrname odr -nodename node1 -rulesetName myRuleset -actionName defAction')

Interactive mode example usage

Using Jacl:

$AdminTask removeDefaultAction {-interactive}

Using Jython string:

AdminTask.removeDefaultAction ('[-interactive]')