Configuring Server Groups

Viewing a List of Server Groups

Server groups define the elements with which the Cisco Unified SIP Proxy system interacts for each network.

SUMMARY STEPS

  1. Choose Configure > Server Groups > Groups.
  2. To delete a server group, do the following:
  3. 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 > Server Groups > Groups.

The system displays the Server Groups page with the Groups tab highlighted, containing the fields described in Server Groups (Group Tab) Fields.

Step 2

To delete a server group, do the following:

  1. Check the check box next to the server group to delete.

  2. Click Remove.

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

Step 3

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 server group that has the changes to which you want to revert.

  2. Click Revert.

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

Server Groups (Group Tab) Fields

Table 1. Server Groups (Groups Tab) Fields

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 server group.

Note 

The system inserts the server group name into the SIP URI of the outgoing request. Some devices, such as Cisco Unified Communications Manager, validate the URI of requests before processing, so you may need to configure the end device with a Fully Qualified Domain Name (FQDN) to allow for this functionality.

Load Balancing Scheme

Configures the load-balancing algorithm for all SIP server groups.

Can be one of the following:

  • global (default)

  • call-id—Specifies that a hash algorithm with call-id is performed to select an element.

  • request-uri—Specifies that a hash algorithm with a request URI is performed to select an element.

  • to-uri—Specifies that a hash algorithm with a To header URI is performed to select an element.

  • weight—Specifies that the element is selected proportional to its weight relative to the weights of other elements of the same q-value. This value is only applicable if implementing weight-based routing.

  • highest-q—Specifies that the first element in the list of available elements with the same highest q-value is selected.

Network

Name of the network associated with this server group.

Elements

Elements associated with this server group.

Pinging Allowed

Whether pinging is allowed. Can be either true or false.

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 500 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 Server Group

Before you begin

You must create and configure at least one network before you can add a server group. See Configuring Networks.

SUMMARY STEPS

  1. Choose Configure > Server Groups > Groups.
  2. Click Add.
  3. Enter information. See Server Groups (Group Tab) Fields.
  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 > Server Groups > Groups.

The system displays the Server Groups page with the Groups tab highlighted.

Step 2

Click Add.

The system displays the Server Group (New) page.

Step 3

Enter information. See Server Groups (Group Tab) Fields.

Step 4

Click Add.

Step 5

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

Editing a Server Group

SUMMARY STEPS

  1. Choose Configure > Server Groups > Groups.
  2. Click the underlined name of the server group to edit.
  3. Edit the information. See Server Groups (Group Tab) Fields.
  4. Click Update.
  5. In the Cisco Unified SIP Proxy header, click Commit Candidate Configuration to commit this change.

DETAILED STEPS

Step 1

Choose Configure > Server Groups > Groups.

The system displays the Server Groups page with the Groups tab highlighted.

Step 2

Click the underlined name of the server group to edit.

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

Step 3

Edit the information. See Server Groups (Group Tab) Fields.

Step 4

Click Update.

Step 5

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

Viewing and Editing the General Settings for All Server Groups

Follow this procedure to view and edit the general settings that affect all server groups.

SUMMARY STEPS

  1. Choose Configure > Server Groups > General Settings.
  2. To edit the settings, change the values.
  3. Click Update.
  4. In the Cisco Unified SIP Proxy header, click Commit Candidate Configuration to commit this change.

DETAILED STEPS

Step 1

Choose Configure > Server Groups > General Settings.

The system displays the Server Groups page with the General Settings tab highlighted, containing the fields described in Server Groups (General Settings Tab) Fields.

Step 2

To edit the settings, change the values.

Step 3

Click Update.

Step 4

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

Server Groups (General Settings Tab) Fields

Table 2. Server Groups (General Settings Tab) Fields

Parameter

Description

Server Group Element Retries

UDP

Maximum number of consecutive failed attempts to send a request to a server group element via the specified protocol before the element is considered down. A failed attempt can occur because of a timeout, ICMP error, or receipt of a failure response. The valid range is from 0 to 65535.

TCP

TLS

Global Load Balancing Scheme

Load Balancing Scheme

Configures the load-balancing algorithm for all SIP server groups.

Can be one of the following:

  • call-id (default)—Specifies that a hash algorithm with call-id is performed to select an element.

  • request-uri—Specifies that a hash algorithm with a request URI is performed to select an element.

  • to-uri—Specifies that a hash algorithm with a To header URI is performed to select an element.

  • weight—Specifies that the element is selected proportional to its weight relative to the weights of other elements of the same q-value. This value is only applicable if implementing weight-based routing.

  • highest-q—Specifies that the first element in the list of available elements with the same highest q-value is selected.

Global Ping

Pinging Allowed

Whether pinging is allowed. Can be either enable or disable.

Ping 503

Verifies the 503 response code

Checks whether the SIP application service in the remote server element is up or down by monitoring the response. It treats the element as down for the 503 response to the PING request.

Default Failed Element Retry After Duration (in milliseconds)

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 500 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.

Viewing and Deleting Server Group Elements

There can be multiple elements in each server group.

SUMMARY STEPS

  1. Choose Configure > Server Groups > Groups.
  2. To see the elements associated with this server group, click click here under the Elements header.
  3. To delete a server 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 > Server Groups > Groups.

The system displays the Server Groups page with the Groups tab highlighted.

Step 2

To see the elements associated with this server group, click click here under the Elements header.

The system displays the Server Group ‘<name of server group>’ page with the Elements tab highlighted. The page contains the fields described in Server Group (Elements Tab) Fields.

Step 3

To delete a server 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 server group element that has the changes to which you want to revert.

  2. Click Revert.

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

Server Group (Elements Tab) Fields

Table 3. Server Group (Elements Tab) Fields

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.

IP Address

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

Port

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

Transport

Specifies the transport type of the server group element. Can be one of the following:

  • UDP (default)

  • TCP

  • TLS

Nested Server Group

Whether or not this server group can contain another server group.

Q-Value

Specifies a real number that indicates the priority of the server group element with respect to others in the server 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

Specifies the percentage assigned to the IP element in the server group if implementing weight-based routing.

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

Adding and Editing a Server Group Element

SUMMARY STEPS

  1. Choose Configure > Server Groups > Groups.
  2. Click click here under the Elements header that corresponds with the server group to 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 > Server Groups > Groups.

The system displays the Server Groups page with the Groups tab highlighted.

Step 2

Click click here under the Elements header that corresponds with the server group to which you want to add an element.

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

Step 3

To add an element, do the following:

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

  2. Choose whether this element will be for an endpoint or server group.

  3. Enter information about the element as described in Server Group (Elements Tab) Fields.

  4. Click Add.

Step 4

To edit an element, do the following:

  1. Click the underlined IP address for the element to edit. The system displays the Server Group ‘<name of server group>’ Element page.

  2. Make changes to the values.

  3. Click Update.

Step 5

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

Viewing a List of SIP Ping Network Connections

Before you begin

You must have already created at least one network. See Configuring Networks.

SUMMARY STEPS

  1. Choose Configure > Server Groups > SIP Ping.
  2. To delete a SIP ping network connection, do the following:

DETAILED STEPS

Step 1

Choose Configure > Server Groups > SIP Ping.

The system displays the SIP Ping page with the SIP Ping tab highlighted, containing the fields described in SIP Ping Fields.

Step 2

To delete a SIP ping network connection, do the following:

  1. Check the check box next to the SIP ping network connection to delete.

  2. Click Remove.

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

SIP Ping Fields

Table 4. SIP Ping Fields

Parameter

Description

Network

Name of this SIP ping network connection.

IP Address

Specifies the interface host name or IP address that listens for responses to the SIP pings.

Note 

When you specify a hostname, the server performs a DNS lookup to confirm that the host can be resolved. It then uses the IP address when the configuration is saved. If the system cannot resolve the hostname, it displays an “IP Address validation failed” error.

Port

The UDP port that listens for responses to the SIP pings. The valid range is from 1024 to 65535. The default value is 4000.

Note 

Be sure this port number is different from the port number specified for the server’s SIP listen point.

SIP Method

The request method for the SIP pings. Can be one of the following:

  • OPTIONS (default)

  • PING

  • INFO

Ping Type

The ping type for the SIP ping. Can be one of the following:

  • Proactive—Specifies that pinging is performed to both up and down elements, and both are pinged at the same interval.

  • Reactive—Specifies that pinging is performed to only down elements. This is the default value.

  • Adaptive—Specifies that pinging is performed to both up and down elements, and both are pinged at different intervals.

Up Interval

(Optional; only available if you choose Adaptive or Proactive for Ping Type) Specifies the consecutive ping interval for up elements. The default value is 5000 milliseconds.

Down Interval

(Optional; only available if you choose Adaptive or Reactive for Ping Type) Specifies the consecutive ping interval in milliseconds. For Adaptive pinging, this value configures the down element ping interval. The default value is 5000 milliseconds.

Ping Timeout

Specifies the maximum number of milliseconds between a ping and a response before the ping is considered unsuccessful. The minimum allowed value is 0. The default value is 500.

Adding a SIP Ping Configuration


Restriction

  • You can only define one SIP ping configuration for each network. To create multiple SIP ping configurations, you must create and configure multiple networks.

  • You can only add a SIP ping for server group elements with a transport type of UDP.

Before you begin

You must create and configure at least one network before you can add a SIP ping configuration. See Configuring Networks.

SUMMARY STEPS

  1. Choose Configure > Server Groups > SIP Ping.
  2. Click Add.
  3. Enter information. See SIP Ping Fields.
  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 > Server Groups > SIP Ping.

The system displays the SIP Ping page with the SIP Ping tab highlighted.

Step 2

Click Add.

The system displays the SIP Ping Configuration (New) page.

Step 3

Enter information. See SIP Ping Fields.

Step 4

Click Add.

Step 5

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

Editing a SIP Ping Configuration

SUMMARY STEPS

  1. Choose Configure > Server Groups > SIP Ping.
  2. Check the check box next to the SIP ping network configuration to edit.
  3. Click Edit.
  4. Edit information. See SIP Ping Fields.
  5. Click Update.
  6. In the Cisco Unified SIP Proxy header, click Commit Candidate Configuration to commit this change.

DETAILED STEPS

Step 1

Choose Configure > Server Groups > SIP Ping.

The system displays the SIP Ping page with the SIP Ping tab highlighted.

Step 2

Check the check box next to the SIP ping network configuration to edit.

Step 3

Click Edit.

The system displays the SIP Ping Configuration ‘<name of network>’ page.

Step 4

Edit information. See SIP Ping Fields.

Step 5

Click Update.

Step 6

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

Viewing a List of Call Admission Control Endpoints

The system automatically adds call admission control endpoints when you add a server group and elements and then commit the configuration.

Procedure

Choose Configure > Server Groups > Call Admission Control.

The system displays the Server Groups page with the Call Admission Control tab highlighted.

For each call admission control endpoint, the system lists the IP address, port, transport, network and call admission control limit.

Changing the Limit of a Call Admission Control Endpoint

Procedure

Step 1

Choose Configure > Server Groups > Call Admission Control.

The system displays the Server Groups page with the Call Admission Control tab highlighted.

Step 2

Click the underlined limit to change.

The system displays the CAC Endpoint page.

Step 3

Check the unlimited check box to make the limit unlimited, or enter a value in the field.

Step 4

Click Update.