Configuring Route Groups

Viewing a List of Route Groups and Corresponding Elements

SUMMARY STEPS

  1. Choose Configure > Route Groups.
  2. There can be multiple elements in a route group. To see the elements associated with this route group, click click here.
  3. To delete a route group, do the following:
  4. To revert any changes you have made back to the state they were in at the time of the last commit, do the following:

DETAILED STEPS


Step 1

Choose Configure > Route Groups.

The system displays the Route Groups page, which contains the fields described in Route Group Fields.

Step 2

There can be multiple elements in a route group. To see the elements associated with this route group, click click here.

The system displays the Route Group ‘<name of route group>’ page, containing the fields described in Element Fields.

Step 3

To delete a route group, do the following:

  1. Check the check box next to the name of the route group to delete.

  2. Click Remove.

  3. In the Cisco Unified SIP Proxy header, click Commit Candidate Configuration to commit this change.

Step 4

To revert any changes you have made back to the state they were in at the time of the last commit, do the following:

  1. Check the check box next to the name of the route group that has the changes to revert back to.

  2. Click Revert.

  3. In the Cisco Unified SIP Proxy header, click Commit Candidate Configuration to commit this change.


About Route Groups

A route group allows you to designate the order in which gateways and trunks are selected. It allows you to prioritize a list of gateways and ports for outgoing trunk selection.

For example, if you use two long-distance carriers, you could add a route group so that long-distance calls to the less expensive carrier are given priority. Calls only route to the more expensive carrier if the first trunk is unavailable.

You can add, update, or delete route groups from the Route Group page. You can also add, update, or delete elements.

Route Group Fields

The table lists the fields on the Route Groups page.

Table 1. Route Group Parameters

Parameter

Description

State

Can be one of the following:

  • New—New record. Will be added to the active configuration when it is committed.

  • Modified—Modified record. Will become the active configuration when it is committed.

  • Deleted—Deleted record. Will be removed from the active configuration when it is committed.

  • Active—Active record and active configuration.

Name

Name of this route group.

Elements

Elements that belong to this route group.

Time Of Day Routing

Specifies if this route group allows for time policy-based routing.

Can be either true or false. The default value is false.

Weight Based Routing

Specifies if this route group allows for weight-based routing.

Can be either true or false. The default value is false.

Element Fields

The table lists the fields on the Route Group ‘<name of route group>’ page when the Elements tab is highlighted.

Table 2. Route Group Element Parameters

Parameter

Description

State

Can be one of the following:

  • New—New record. Will be added to the active configuration when it is committed.

  • Modified—Modified record. Will become the active configuration when it is committed.

  • Deleted—Deleted record. Will be removed from the active configuration when it is committed.

  • Active—Active record and active configuration.

Target Destination

Host/Server Group

Specifies the interface host name or IP address of the route group element.

Note 

If you select Server Group, you must not enter the port and transport type details.

Port

Specifies the port used by the route group element. Valid values are from 1024 to 65535. The default is 5060.

Transport

Specifies the transport type of the route group element.

Can be one of the following:

  • none (default)

  • UDP

  • TCP

  • TLS

Next Hop

SIP URI

The URI of the next hop.

Options

Network

The name of the network to which this route group is associated.

Q-Value

(Optional) Specifies a real number that indicates the priority of the route group element with respect to others in the route group.

The Q-value provides the priority of each member (element) which varies from 0.0 to 1.0, where 1.0 is the highest priority.

Weight

(Optional) Specifies the percentage assigned to the IP element in the route group if implementing weight-based routing.

The valid range is from 0 to 100. The default weight is 0.

Time Policy

Specifies the time policy if time-based routing is being used.

Failover Response Codes

The response code(s) that indicates the next-hop server is unable to process the request. The valid values are numbers between 400 and 599.

To add multiple failover response codes, separate the individual codes by a comma and indicate ranges with a dash. Commas and dashes must be followed by a space.

Adding a Route Group

SUMMARY STEPS

  1. Choose Configure > Route Groups.
  2. Click Add.
  3. Enter a name for this route group. If you will enable time-of-day routing or weight-based routing, check those check boxes.
  4. Click Add.
  5. In the Cisco Unified SIP Proxy header, click Commit Candidate Configuration to commit this change.

DETAILED STEPS


Step 1

Choose Configure > Route Groups.

The system displays the Route Groups page.

Step 2

Click Add.

The system displays the Route Group (New) page.

Step 3

Enter a name for this route group. If you will enable time-of-day routing or weight-based routing, check those check boxes.

Step 4

Click Add.

The system displays the Route Groups page, with the new route group listed in the table.

Step 5

In the Cisco Unified SIP Proxy header, click Commit Candidate Configuration to commit this change.


Viewing and Deleting Route Group Elements

SUMMARY STEPS

  1. Choose Configure > Route Groups.
  2. On the line of the route group that has the element to delete, under the title Elements, click click here.
  3. To delete a route group element, do the following:
  4. To revert any changes you have made back to the state they were in at the time of the last commit, do the following:

DETAILED STEPS


Step 1

Choose Configure > Route Groups.

The system displays the Route Groups page.

Step 2

On the line of the route group that has the element to delete, under the title Elements, click click here.

The system displays the Route Group ‘<name of route group>’ page with the Elements tab highlighted.

Step 3

To delete a route group element, do the following:

  1. Check the check box next to the name of the element.

  2. Click Remove.

  3. In the Cisco Unified SIP Proxy header, click Commit Candidate Configuration to commit this change.

Step 4

To revert any changes you have made back to the state they were in at the time of the last commit, do the following:

  1. Check the check box next to the name of the route group element that has the changes to revert back to.

  2. Click Revert.

  3. In the Cisco Unified SIP Proxy header, click Commit Candidate Configuration to commit this change.


Adding and Editing Route Group Elements

SUMMARY STEPS

  1. Choose Configure > Route Groups.
  2. Under Elements, click click here on the line for the route group for which you want to add an element.
  3. To add an element, do the following:
  4. To edit an element, do the following:
  5. In the Cisco Unified SIP Proxy header, click Commit Candidate Configuration to commit this change.

DETAILED STEPS


Step 1

Choose Configure > Route Groups.

The system displays the Route Groups page.

Step 2

Under Elements, click click here on the line for the route group for which you want to add an element.

The system displays the Route Group ‘<name of route group>’ page with the Elements tab highlighted.

Step 3

To add an element, do the following:

  1. Click Add. The system displays the Route Group ‘<name of route group>’ Element (New) page.

  2. Choose whether this element will use a target destination or next hop.

  3. Enter information about the element as described in Element Fields.

  4. Click Add.

Step 4

To edit an element, do the following:

  1. Click the underlined Host/Server Group of the element. The system displays the Route Group ‘<name of route group>’ Element page.

  2. Make changes to the information about the element as described in Element Fields.

  3. Click Update.

Step 5

In the Cisco Unified SIP Proxy header, click Commit Candidate Configuration to commit this change.


Editing a Route Group

SUMMARY STEPS

  1. Choose Configure > Route Groups.
  2. Click the underlined name of the route group to edit.
  3. You can change if this route group will enable time-of-day routing or weight-based routing.
  4. Click Update.
  5. To edit the elements of the route group, follow the procedure Adding and Editing Route Group Elements.
  6. In the Cisco Unified SIP Proxy header, click Commit Candidate Configuration to commit this change.

DETAILED STEPS


Step 1

Choose Configure > Route Groups.

The system displays the Route Groups page.

Step 2

Click the underlined name of the route group to edit.

The system displays the Route Group ‘<name of route group>’ page with the Group Settings tab highlighted.

Step 3

You can change if this route group will enable time-of-day routing or weight-based routing.

Step 4

Click Update.

Step 5

To edit the elements of the route group, follow the procedure Adding and Editing Route Group Elements.

Step 6

In the Cisco Unified SIP Proxy header, click Commit Candidate Configuration to commit this change.