IP Groups Table Parameter Syntax

This section describes the syntax for representing parameters in the IP Groups table.

Syntax: 

param.ipg.src|dst|<ID>|<Name>.host|id|is-alive|name|tags|type| user|user-defined

Where:

■ ID: Specifies the IP Group by table row index.
■ Name: Specifies the IP Group by name.
■ ipg.src|dst: These are determined according to the context in which they are used:
● Message Manipulations table:
◆ Pre-Classification: The param.ipg.src|dst parameters are not relevant. For rules of a Manipulation Set that are assigned in the SIP Interfaces table ('Pre-classification Manipulation Set ID' parameter), use param.ipg.<Name>|<ID>.
◆ Inbound Manipulation Set: You can use param.ipg.src|dst and param.ipg.<Name>|<ID> because these rules are run after both Classification and Routing stages complete. For a SIP message (request or response) that is received by the device from one UA and then sent to another UA, param.ipg.src is the IP Group to which the message is sent; param.ipg.dst is the IP Group from where the message was received.
◆ Outbound Manipulation Set: You can use param.ipg.src|dst and ipg.<Name>|<ID> because these rules are run after both Classification and Routing stages complete. For a SIP message (request or response) that is received by the device from one UA and then sent to another UA, param.ipg.src is the IP Group from where the message was received; param.ipg.dst is the IP Group to where the message is sent.
● Call Setup Rules: The param.ipg.dst parameter is accessible only when the Call Setup Rule is invoked from the IP-to-IP Routing table. The param.ipg.src parameter may be used when the Call Setup Rule is run after the Classification stage (i.e., when the Call Setup Rule is run from the IP Groups table or the IP-to-IP Routing table). This parameter can't be used when Call Setup Rules are run from the SIP Interfaces table.
● Message Conditions: The param.ipg.src|dst parameters are not relevant. Use only param.ipg.<Name >|<ID> because message conditions are run before the Classification or Routing stages complete.

When using the param.ipg.<Name>, the IP Group name is case-sensitive and cannot contain spaces or dots (.).

The specific parameters -- fourth-level in the syntax above -- (host|id|is-alive|name|tags|type|user|user-defined) are described in the following table:

IP Group Parameter Syntax

IP Group Parameter

Description

'SIP Group Name'

host

Specifies the IP Group's host name.

'Index '

id

Specifies the table row index (ID) of the given IP Group. For example, the following checks if the index of the source IP Group is 5: 

param.ipg.src.id=='5'

'Keep-Alive'

is-alive

Specifies the IP Group's connectivity status, using the keywords 'true' or 'false' (online or offline, respectively). For example, the following specifies a condition checking if IP Group at index 5 is online: 

param.ipg.5.is-alive=='true'

Note:

■ User-type IP Groups are always online.
■ A Gateway-type IP Group is online when it is registered with the device.
■ A Server-type IP Group is online when its' associated Proxy Set has at least one valid IP address and either has keep-alive disabled or has keep-alive enabled and keep-alive transactions with the proxy server(s) are successful

'Name'

name

Specifies the name of the given IP Group. For example, the following condition checks if the name of the source IP Group is "ITSP-Site1": 

param.ipg.src.name=='ITSP-Site1'

'Tags'

tags.<Tag Name>

Specifies the value of an IP Group's tag. By not specifying a tag name, you can refer to all the tags and their values associated with the IP Group. For example, the following specifies the value of tag, "city" for source IP Groups:

param.ipg.src.tags.city

'Type'

type

Specifies the IP Group's type (server, user, and gateway). For example, the following condition checks if the source IP Group is of type server:

param.ipg.src.type=='server'

'Contact User'

user

Specifies the IP Group's user part of the From, To, and Contact headers of SIP REGISTER messages, and the user part of the Contact header of INVITE messages (in other words, it specifies the value of the 'Contact User' parameter for the IP Group). For example, the following condition checks if the source IP Group has Contact "jdoe":

param.ipg.src.user=='jdoe'

'Message Manipulation User-Defined String 1 / 2'

user-defined.0|1

Specifies the IP Group's user-defined string for manipulation rules in the IP Group table, where:

■ 0 uses the string configured for the 'Message Manipulation User-Defined String 1' parameter in the IP Group table
■ 1 uses the string configured for the 'Message Manipulation User-Defined String 2'  parameter in the IP Group table

For example, the following specifies the 'Message Manipulation User-Defined String 2' parameter of the source IP Group:

param.ipg.src.user-defined.1