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

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

Interactive mode example usage

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

Interactive mode example usage

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

Interactive mode example usage

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

Interactive mode example usage

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

Interactive mode example usage

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

Interactive mode example usage

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

Interactive mode example usage

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

Interactive mode example usage

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

Interactive mode example usage

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

Interactive mode example usage

Reference topic    

Terms and conditions for information centers | Feedback

Last updated: March 19, 2013 10:03 PM CST
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=phil&product=was-nd-mp&topic=rwve_adtaskruleset
File name: rwve_adtaskruleset.html