+

Search Tips   |   Advanced Search

Operating Systems: AIX, HP-UX, Linux, Solaris, Windows, z/OS

 

SIP rules for ODR routing policy administrative tasks


You can use administrative tasks to configure Session Initiation Protocol (SIP) rules for the on demand router (ODR) routing policy.

Command name: Description: Parameters and return values: Examples:
addRoutingRule Use this command to add a routing policy rule. Required parameters:

-protocol
Name of the protocol to associate with these rules.
-priority
Positive integer value representing the priority of the rule. Zero is the highest priority.
-expression
Specifies the rule expression. The expression must be enclosed in double quotes.
-actionType
Specifies the type of action to associate with the rule.
Optional parameters:

-odrname
Name of the ODR to apply the routing policy work class. Required only if modifying an ODR.
-nodename
Name of the node on which the ODR resides. Required only if modifying an ODR.
-clustername
Name of the cluster to which to apply the rules. Required only if modifying an on demand router cluster.
-multiclusterAction
Specifies the method to route requests if multiple routing location clusters are matched. Required only if actionType is equal to permit.
-routingLocations
Specifies a list of locations to route requests. Required only if actionType is equal to permit.
-errorcode
Integer error code to reject request. Required only if actionType is equal to reject.

Batch mode example usage:

  • Use Jacl: 
    $AdminTask addRoutingRule {-odrname odr -nodename node1 -protocol SIP -priority 0 -expression "request.method = 'getOperation'" -actionType permit -multiclusterAction Failover -routingLocations cluster=*/*}

  • Use Jython: 
    AdminTask.addRoutingRule('[-odrname odr] [-nodename node1] [-protocol SIP] [-priority 0] [-expression "request.method = 'getOperation'"] [-actionType permit] [-multiclusterAction Failover] [-routingLocations cluster=*/*]')

Interactive mode example usage:

  • Use Jacl: 
    $AdminTask addRoutingRule {-interactive}

  • Use Jython: 
    AdminTask.addRoutingRule ('[-interactive]')
changeRoutingDefaultRulesAction Use this command to change the routing policy default action for a rule. Required parameters:

-protocol
Name of the protocol to associate with these rules.
Optional parameters:

-odrname
Name of the ODR to apply the routing policy work class. Required only if modifying an ODR.
-nodename
Name of the node on which the ODR resides. Required only if modifying an ODR.
-clustername
Name of the cluster to which to apply the rules. Required only if modifying an on demand router cluster.
-multiclusterAction
Specifies the method to route requests if multiple routing location clusters are matched. Required only if actionType is equal to permit.
-routingLocations
Specifies a list of locations to route requests. Required only if actionType is equal to permit.
-errorcode
Integer error code to reject request. Required only if actionType is equal to reject.

Batch mode example usage:

  • Use Jacl: 
    $AdminTask changeRoutingDefaultRulesAction {-odrname odr -nodename node1 -protocol SIP -multiclusterAction Failover -routingLocations cluster=*/*}

  • Use Jython: 
    AdminTask.changeRoutingDefaultRulesAction('[-odrname odr] [-nodename node1] [-protocol SIP] [-multiclusterAction Failover] [-routingLocations cluster=*/*]')

Interactive mode example usage:

  • Use Jacl: 
    $AdminTask changeRoutingDefaultRulesAction {-interactive}

  • Use Jython: 
    AdminTask.changeRoutingDefaultRulesAction ('[-interactive]')
changeRoutingRuleAction Use this command to change a routing policy action for a rule. Required parameters:

-protocol
Name of the protocol to associate with these rules.
-priority
Positive integer value representing the priority of the rule. Zero is the highest priority.
Optional parameters:

-odrname
Name of the ODR to apply the routing policy work class. Required only if modifying an ODR.
-nodename
Name of the node on which the ODR resides. Required only if modifying an ODR.
-clustername
Name of the cluster to which to apply the rules. Required only if modifying an on demand router cluster.
-multiclusterAction
Specifies the method to route requests if multiple routing location clusters are matched. Required only if actionType is equal to permit.
-routingLocations
Specifies a list of locations to route requests. Required only if actionType is equal to permit.
-errorcode
Integer error code to reject request. Required only if actionType is equal to reject.

Batch mode example usage:

  • Use Jacl: 
    $AdminTask changeRoutingRuleAction {-odrname odr -nodename node1 -protocol SIP -priority 0 -multiclusterAction Failover -routingLocations cluster=*/*}

  • Use Jython: 
    AdminTask.changeRoutingRuleAction('[-odrname odr] [-nodename node1] [-protocol SIP] [-priority 0] [-multiclusterAction Failover] [-routingLocations cluster=*/*]')

Interactive mode example usage:

  • Use Jacl: 
    $AdminTask changeRoutingRuleAction {-interactive}

  • Use Jython: 
    AdminTask.changeRoutingRuleAction ('[-interactive]')
changeRoutingRuleExpression Use this command to change a routing policy rule expression. Required parameters:

-protocol
Name of the protocol to associate with these rules.
-priority
Positive integer value representing the priority of the rule. Zero is the highest priority.
-expression
Specifies the rule expression. The expression must be enclosed in double quotes.
Optional parameters:

-odrname
Name of the ODR to apply the routing policy work class. Required only if modifying an ODR.
-nodename
Name of the node on which the ODR resides. Required only if modifying an ODR.
-clustername
Name of the cluster to which to apply the rules. Required only if modifying an on demand router cluster.

Batch mode example usage:

  • Use Jacl: 
    $AdminTask changeRoutingRuleExpression {-odrname odr -nodename node1 -protocol SIP -priority 0 -expression request.method = 'getOperation0'}

  • Use Jython: 
    AdminTask.changeRoutingRuleExpression('[-odrname odr] [-nodename node1] [-protocol SIP] [-priority 0] [-expression "request.method = 'getOperation'"]')

Interactive mode example usage:

  • Use Jacl: 
    $AdminTask changeRoutingRuleExpression {-interactive}

  • Use Jython: 
    AdminTask.changeRoutingRuleExpression ('[-interactive]')
changeRoutingRulePriority Use this command to change a routing policy rule priority. Required parameters:

-protocol
Name of the protocol to associate with these rules.
-priority
Positive integer value representing the priority of the rule. Zero is the highest priority.
-expression
Specifies the rule expression. The expression must be enclosed in double quotes.
Optional parameters:

-odrname
Name of the ODR to apply the routing policy work class. Required only if modifying an ODR.
-nodename
Name of the node on which the ODR resides. Required only if modifying an ODR.
-clustername
Name of the cluster to which to apply the rules. Required only if modifying an on demand router cluster.

Batch mode example usage:

  • Use Jacl: 
    $AdminTask changeRoutingRulePriority {-odrname odr -nodename node1 -protocol SIP -priority 0 -expression "request.method = 'getOperation0'"}

  • Use Jython: 
    AdminTask.changeRoutingRulePriority('[-odrname odr] [-nodename node1] [-protocol SIP] [-priority 0] [-expression "request.method = 'getOperation'"]')

Interactive mode example usage:

  • Use Jacl: 
    $AdminTask changeRoutingRulePriority {-interactive}

  • Use Jython: 
    AdminTask.changeRoutingRulePriority ('[-interactive]')
createRoutingRules Use this command to create a routing policy rule list. Required parameters:

-protocol
Name of the protocol to associate with these rules.
Optional parameters:

-odrname
Name of the ODR to apply the routing policy work class. Required only if modifying an ODR.
-nodename
Name of the node on which the ODR resides. Required only if modifying an ODR.
-clustername
Name of the cluster to which to apply the rules. Required only if modifying an on demand router cluster.

Batch mode example usage:

  • Use Jacl: 
    $AdminTask createRoutingRules {-odrname odr -nodename node1 -protocol SIP}

  • Use Jython: 
    AdminTask.createRoutingRules('[-odrname odr] [-nodename node1] [-protocol SIP]')

Interactive mode example usage:

  • Use Jacl: 
    $AdminTask createRoutingRules {-interactive}

  • Use Jython: 
    AdminTask.createRoutingRules ('[-interactive]')
listRoutingRules Use this command to list routing policy rules. Required parameters:

-protocol
Name of the protocol to associate with these rules.
Optional parameters:

-odrname
Name of the ODR to apply the routing policy work class. Required only if modifying an ODR.
-nodename
Name of the node on which the ODR resides. Required only if modifying an ODR.
-clustername
Name of the cluster to which to apply the rules. Required only if modifying an on demand router cluster.

Batch mode example usage:

  • Use Jacl: 
    $AdminTask listRoutingRules {-odrname odr -nodename node1 -protocol SIP}

  • Use Jython: 
    AdminTask.listRoutingRules('[-odrname odr] [-nodename node1] [-protocol SIP]')

Interactive mode example usage:

  • Use Jacl: 
    $AdminTask listRoutingRules {-interactive}

  • Use Jython: 
    AdminTask.listRoutingRules ('[-interactive]')
removeRoutingRule   Required parameters

-protocol
Name of the protocol to associate with these rules.
-expression
Specifies the rule expression. The expression must be enclosed in double quotes.
Optional parameters:

-odrname
Name of the ODR to apply the routing policy work class. Required only if modifying an ODR.
-nodename
Name of the node on which the ODR resides. Required only if modifying an ODR.
-clustername
Name of the cluster to which to apply the rules. Required only if modifying an on demand router cluster.

Batch mode example usage:

  • Use Jacl: 
    $AdminTask removeRoutingRule {-odrname odr -nodename node1 -protocol SIP -expression "request.method = 'getOperation'"}

  • Use Jython: 
    AdminTask.removeRoutingRule('[-odrname odr] [-nodename node1] [-protocol SIP] [-expression "request.method = 'getOperation'"]')

Interactive mode example usage:

  • Use Jacl: 
    $AdminTask removeRoutingRule {-interactive}

  • Use Jython: 
    AdminTask.removeRoutingRule ('[-interactive]')


 

Related concepts


Overview of request flow prioritization

 

Related tasks


Configure ODRs

Related information


SIP rules for ODR service policy administrative tasks