You can use administrative tasks to configure Session Initiation Protocol (SIP) or HTTP
rules for an on demand router (ODR) service policy.
Command list
You can specify
SIP or HTTP protocols in the commands.
The following examples use SIP as the protocol:
addServiceRule
The
addServiceRule command adds a service policy rule.
Required parameters
- -protocol
- Specifies the name of the protocol to associate with a rule. (String,
required)
- -priority
- Specifies a positive integer value representing the priority of
a rule. Zero is the highest priority. (String, required)
- -expression
- Specifies the rule expression. The expression must be enclosed
in double quotes. (String, required)
- -transactionClass
- Specifies the transaction class to associate with a rule. (String,
required)
Optional parameters
- -odrname
- Specifies the name of the ODR to which the service policy work
class applies. The -odrname parameter is required
only if you modify an ODR.
- -nodename
- Specifies the name of the node on which the ODR resides. The -nodename parameter
is required only if you modify an ODR.
- -clustername
- Specifies the name of the cluster to which the rule applies. The -clustername parameter
is required only if you modify an ODR cluster.
Batch mode example
usage
- Using Jacl:
$AdminTask addServiceRule {-odrname odr -nodename node1 -protocol SIP -priority 0 -expression "request.method = 'getOperation'" -transactionClass Default_TC}
- Using Jython string:
AdminTask.addServiceRule('-odrname odr -nodename node1 -protocol SIP -priority 0 -expression "request.method = \'getOperation\'" -transactionClass Default_TC')
Interactive mode example usage
- Using Jacl:
$AdminTask addServiceRule {-interactive}
- Using Jython string:
AdminTask.addServiceRule ('[-interactive]')
removeServiceRule
The
removeServiceRule command removes a service policy rule.
Required parameters
- -protocol
- Specifies the name of the protocol to associate with a rule. (String,
required)
- -expression
- Specifies the rule expression. The expression must be enclosed
in double quotes. (String, required)
Optional parameters
- -odrname
- Specifies the name of the ODR to which the service policy work
class applies. The -odrname parameter is required
only if you modify an ODR.
- -nodename
- Specifies the name of the node on which the ODR resides. The -nodename parameter
is required only if you modify an ODR.
- -clustername
- Specifies the name of the cluster to which the rule applies. The -clustername parameter
is required only if you modify an ODR cluster.
Batch mode example
usage
- Using Jacl:
$AdminTask removeServiceRule {-odrname odr -nodename node1 -protocol SIP -expression "request.method = 'getOperation'"}
- Using Jython string:
AdminTask.removeServiceRule('-odrname odr -nodename node1 -protocol SIP -expression "request.method = \'getOperation\'"')
Interactive mode example usage
- Using Jacl:
$AdminTask removeServiceRule {-interactive}
- Using Jython string:
AdminTask.removeServiceRule ('[-interactive]')
createServiceRules
The
createServiceRules command creates a rule list for the service policy.
Required parameters
- -protocol
- Specifies the name of the protocol to associate with a rule. (String,
required)
Optional parameters
- -odrname
- Specifies the name of the ODR to which the service policy work
class applies. The -odrname parameter is required
only if you modify an ODR.
- -nodename
- Specifies the name of the node on which the ODR resides. The -nodename parameter
is required only if you modify an ODR.
- -clustername
- Specifies the name of the cluster to which the rule applies. The -clustername parameter
is required only if you modify an ODR cluster.
Batch mode example
usage
- Using Jacl:
$AdminTask createServiceRules {-odrname odr -nodename node1 -protocol SIP}
- Using Jython string:
AdminTask.createServiceRules('-odrname odr -nodename node1 -protocol SIP')
Interactive mode example usage
- Using Jacl:
$AdminTask createServiceRules {-interactive}
- Using Jython string:
AdminTask.createServiceRules ('[-interactive]')
listServiceRules
The
listServiceRules lists service policy rules.
Required parameters
- -protocol
- Specifies the name of the protocol to associate with a rule. (String,
required)
Optional parameters
- -odrname
- Specifies the name of the ODR to which the service policy work
class applies. The -odrname parameter is required
only if you modify an ODR.
- -nodename
- Specifies the name of the node on which the ODR resides. The -nodename parameter
is required only if you modify an ODR.
- -clustername
- Specifies the name of the cluster to which the rule applies. The -clustername parameter
is required only if you modify an ODR cluster.
Batch mode example
usage
- Using Jacl:
$AdminTask listServiceRules {-odrname odr -nodename node1 -protocol SIP}
- Using Jython string:
AdminTask.listServiceRules('-odrname odr -nodename node1 -protocol SIP')
Interactive mode example usage
- Using Jacl:
$AdminTask listServiceRules {-interactive}
- Using Jython string:
AdminTask.listServiceRules ('[-interactive]')
changeServiceRuleAction
The
changeServiceRuleAction command changes the service policy action
for a rule.
Restriction: The use of the changeServiceRuleAction
command with HTTP is not supported.
Required
parameters
- -protocol
- Specifies the name of the protocol to associate with a rule. (String,
required)
- -priority
- Specifies a positive integer value representing the priority of
a rule. Zero is the highest priority. (String, required)
- -transactionClass
- Specifies the transaction class to associate with a rule. (String,
required)
Optional parameters
- -odrname
- Specifies the name of the ODR to which the service policy work
class applies. The -odrname parameter is required
only if you modify an ODR.
- -nodename
- Specifies the name of the node on which the ODR resides. The -nodename parameter
is required only if you modify an ODR.
- -clustername
- Specifies the name of the cluster to which the rule applies. The -clustername parameter
is required only if you modify an ODR cluster.
Batch mode example
usage
- Using Jacl:
$AdminTask changeServiceRuleAction {-odrname odr -nodename node1 -protocol SIP -priority 0 -transactionClass Default_TC}
- Using Jython string:
AdminTask.changeServiceRuleAction('-odrname odr -nodename node1 -protocol SIP -priority 0 -transactionClass Default_TC')
Interactive mode example usage
- Using Jacl:
$AdminTask changeServiceRuleAction {-interactive}
- Using Jython string:
AdminTask.changeServiceRuleAction ('[-interactive]')
changeServiceDefaultRulesAction
The
changeServiceDefaultRulesAction command changes the default action
of a service policy rule.
Restriction: The use of the
changeServiceDefaultRulesAction command with HTTP is not supported.
Required parameters
- -protocol
- Specifies the name of the protocol to associate with a rule. (String,
required)
- -transactionClass
- Specifies the transaction class to associate with a rule. (String,
required)
Optional parameters
- -odrname
- Specifies the name of the ODR to which the service policy work
class applies. The -odrname parameter is required
only if you modify an ODR.
- -nodename
- Specifies the name of the node on which the ODR resides. The -nodename parameter
is required only if you modify an ODR.
- -clustername
- Specifies the name of the cluster to which the rule applies. The -clustername parameter
is required only if you modify an ODR cluster.
Batch mode example
usage
- Using Jacl:
$AdminTask changeServiceDefaultRulesAction {-odrname odr -nodename node1 -protocol SIP -transactionClass Default_TC}
- Using Jython string:
AdminTask.changeServiceDefaultRulesAction('-odrname odr -nodename node1 -protocol SIP -transactionClass Default_TC')
Interactive mode example usage
- Using Jacl:
$AdminTask changeServiceDefaultRulesAction {-interactive}
- Using Jython string:
AdminTask.changeServiceDefaultRulesAction ('[-interactive]')
changeServiceRuleExpression
The
changeServiceRuleExpression command changes a rule expression of a
service policy.
Required parameters
- -protocol
- Specifies the name of the protocol to associate with a rule. (String,
required)
- -priority
- Specifies a positive integer value representing the priority of
a rule. Zero is the highest priority. (String, required)
- -expression
- Specifies the rule expression. The expression must be enclosed
in double quotes. (String, required)
- -transactionClass
- Specifies the transaction class to associate with a rule. (String,
required)
Optional parameters
- -odrname
- Specifies the name of the ODR to which the service policy work
class applies. The -odrname parameter is required
only if you modify an ODR.
- -nodename
- Specifies the name of the node on which the ODR resides. The -nodename parameter
is required only if you modify an ODR.
- -clustername
- Specifies the name of the cluster to which the rule applies. The -clustername parameter
is required only if you modify an ODR cluster.
Batch mode example
usage
- Using Jacl:
$AdminTask changeServiceRuleExpression {-odrname odr -nodename node1 -protocol SIP -priority 0 -expression "request.method = 'getOperation0'"}
- Using Jython string:
AdminTask.changeServiceRuleExpression('-odrname odr -nodename node1 -protocol SIP -priority 0 -expression "request.method = \'getOperation\'"')
Interactive mode example usage
- Using Jacl:
$AdminTask changeServiceRuleExpression {-interactive}
- Using Jython string:
AdminTask.changeServiceRuleExpression ('[-interactive]')
changeServiceRulePriority
The
changeServiceRulePriority command changes the priority of a service
policy rule.
Required parameters
- -protocol
- Specifies the name of the protocol to associate with a rule. (String,
required)
- -priority
- Specifies a positive integer value representing the priority of
a rule. Zero is the highest priority. (String, required)
- -expression
- Specifies the rule expression. The expression must be enclosed
in double quotes. (String, required)
Optional parameters
- -odrname
- Specifies the name of the ODR to which the service policy work
class applies. The -odrname parameter is required
only if you modify an ODR.
- -nodename
- Specifies the name of the node on which the ODR resides. The -nodename parameter
is required only if you modify an ODR.
- -clustername
- Specifies the name of the cluster to which the rule applies. The -clustername parameter
is required only if you modify an ODR cluster.
Batch mode example
usage
- Using Jacl:
$AdminTask changeServiceRulePriority {-odrname odr -nodename node1 -protocol SIP -priority 0 -expression "request.method = 'getOperation0'"}
- Using Jython string:
AdminTask.changeServiceRulePriority('-odrname odr -nodename node1 -protocol SIP -priority 0 -expression "request.method = \'getOperation\'"')
Interactive mode example usage
- Using Jacl:
$AdminTask changeServiceRulePriority {-interactive}
- Using Jython string:
AdminTask.changeServiceRulePriority ('[-interactive]')