DO NOT SHARE THESE DOCS WITH CUSTOMERS!

This is an LA release that will only be provided to a select number of PLM-sanctioned customers (PDFs only). Contact PLM for details.

In this section:

Related articles:

 

Use this window to create and configure a static IP Peer in a zone.

Note:

If an IP Peer is configured to use an FQDN port (other than port 5061), the SBC increments the configured port number by 1 and uses it as the new port number for SIP over TLS signaling.

If the IP Peer is configured to use port 5061 and the transport is TLS, no changes are made to the configuration. 

To View IP Peers

On the SBC main screen, go to Configuration > System Provisioning > Category: Trunk Provisioning > IP Peer or
Configuration > System Provisioning > Category: SIP Carrier Peering > IP Peer or
Configuration > System Provisioning > Category: Call Routing > IP Peer or
Configuration > System Provisioning > Category: CAC Provisioning > IP Peer or
All > Address Context > Zone > IP Peer 

The IP Peer window is displayed. The IP Peer list can be filtered by Address Context and/or Zone using the drop-down lists.

System Provisioning - IP Peer

 

To Create an IP Peer

To create a new IP Peer, click New IP Peer. The Create New IP Peer window opens.

IP Peer Create Window

 

 

Use the following table to configure the IP Peer and then click Save.

IP Peer Parameters

 


Parameter


Description

Name

The name of the IP Peer.

IP Address

Specifies the IPv4 or IPv6 address of the peer.

IP Port

The IP port for this peer.

Default for IP

Set to 'true' if this peer should be used for the IP Address and ephemeral port on ingress, or 'false' if this peer will not be used for the IP Address and ephemeral port on ingress.

SIP Response Code Stats

Specifies whether SIP response code statistics are collected for the IP Peer.The options are:

  • Disabled (default)
  • Enabled
Warning:
Enabling the collection of statistics on trunk groups or IP peers may have significant impact on network performance of an SBC system under heavy load. 
Mode

Specifies the status of the IP peer. The options are:

  • Out of Service
  • In Service (default)
Action

Specifies the method to use to exit calls if the mode of the IP peer is set to Out of Service. Options are:

  • Dry up - allows the amount of time specified by Dry Up Timeout for calls to end before calls are cleared.
  • Force - calls are cleared immediately.
Dry Up TimeoutSpecifies an interval, in minutes, that calls are allowed to continue when the IP peer is taken out of service. The default is 5 minutes. The range allowed is 1 to 1440 minutes.
Block Direction

Specifies a direction in which calls are blocked for this IP peer. The options are:

  • None (default)
  • Bothways
  • Incoming
  • Outgoing
SIP
CAC ProfileSpecifies the SIP endpoint CAC profile for the IP peer.
Policy
DescriptionSpecifies the description of this IP Peer.

Packet Service
Profile

Specifies the name of the Packet Service Profile used for this IP Peer.

IP Signaling
Profile

Specifies the name of the IP Signaling Profile used for this IP Peer.
Policy - SIP
FQDNSpecifies the FQDN value to use for sending egress calls/requests to the IP peer.

FQDN Port

Specifies the FQDN port number for sending egress calls/requests to the IP Peer.
Path Check
ProfileSpecifies the path check profile name used for OPTIONS ping.
Host NameSpecifies the FQDN value of the peer. It will be resolved using DNS and the resulting servers will be pinged using SIP OPTIONS requests. The value ranges up to 63 characters.
Host PortSpecifies the TCP/UDP port number of the peer. The peer's servers will be pinged using SIP OPTIONS requests at this port. The value ranges from 0 to 65535 and the default value is 0.
State

Specifies if the active pinging is enabled or not. The options are:

  • Enabled
  • Disabled (default)

Status Update
Support

Specifies if the status update support should be enabled for this peer or not. The options are:

  • Enabled
  • Disabled (default)
Surrogate Registration

User Part

Specifies the user part for this Surrogate Registration.
Auth User NameSpecifies the authorization User Name for surrogate registration. The value ranges up to 127 characters.

Retry Timer

Specifies the time, in milliseconds, after which the REGISTRATION is retried after a failure. The Value range from 50 - 10000000 milliseconds. The default value is 900000 milliseconds (15 minutes).

Reg Auth Password

Specifies the DES3 (triple Digital Encryption Standard) encrypted string authentication password for surrogate registration. All ASCII characters from 33 to 126 (except 34 - double quotes) are allowed. SBC users "Admin" and "Operator" have full access to surrogate registration passwords.

Note:

If Reg Auth Password contains ASCII characters, enclose the entire password string with " " (double quotes).

Example using double quotes
"1234567890123456789012340\!$$@#$!@#!@#!@#"
Note:

"Field Service" and "Guest" users do not have access to Reg Auth Password field.

State

Specifies if the Surrogate Registration should be enabled or not. The options are:

  • Enabled
  • Disabled (default)
Send Credentials 

Defines how the Credentials are sent. Options are:

  • Challenge For Any Message – The SBC sends credentials for REGISTER, INVITE, PRACK, UPDATE, REINVITE and BYE when these messages are challenged.
  • Challenge For Any Message And InDialog Requests – The SBC sends credentials for REGISTER, INVITE, PRACK, UPDATE, REINVITE and BYE when these messages are challenged. The SBC also sends credentials by default as per last challenge in the in-dialog requests such as PRACK, UPDATE, REINVITE and BYE when any one of these methods is challenged earlier in the call.
  • Challenge For Register (default) – The SBC sends credentials only for REGISTER when challenged. Challenges for any other messages are returned to the IP-PBX.
Note:

Refresh REGISTER and De-REGISTER are always sent without credentials. If such a REGISTER is challenged, then SBC responds with a new REGISTER with credentials.

Note:

The SBC mirrors the credentials to the standby of an HA System. If the sendCredentials is set to 'challengeForAnyMessageAndInDialogRequests', upon a switchover the SBC can send in-dialog requests such as REINVITE/UPDATE/BYE with credentials.

Suppress Reg Retry After Auth Fail

Use this flag to control sending registration retries when a REGISTER with credentials is challenged (with stale ≠ true and realm is identical to previous realm received).
When stale = true or realm is not identical to previous realm received, the SBC immediately sends REGISTER.

  • Disabled (default) – Send REGISTER when a 401 or 407 in response to REGISTER with credentials is received.
  • Enabled – Do not attempt to send REGISTER after receiving a 401 or 407 response.
Surr Reg Profile Specifies the name of the Surrogate Registration Profile.
User Next Reg Call For Call

When this option is enabled, it tries to use the next available pilot number to resend the INVITE.

Note:

Crankback profile should be configured for 4xx (403) response.

Use User Name As PAI

When this option is enabled, the configured User Name in Surrogate Registration should be used as the User Name in the outgoing INVITE.

Note:

This flag indicates sending PAI in outgoing Invite. The flag, Include Privacy must be disabled.

Host PartWhen this flag is configured with a name, the assigned name is used as a hostname of R-URI, From, and To headers of all outgoing calls.
Authentication
Int Challenge Response

Enable this flag on the ingress IP Peer to allow the SBC to reply to local authentication challenges autonomously. If this flag is disabled, the SBC will not reply to authentication challenges locally even if credentials are configured on the egress IPTG.

  • Disabled (default)
  • Enabled
Inc Internal Credentials

Enable this flag on the ingress IP Peer to allow egress IPTG authentication to be internally created using the authorization information in mid-dialogue without being challenged.

  • Disabled (default)
  • Enabled
Note:

If Int Challenge Response is disabled, Inc Internal Credentials are not used.

 To Edit an IP Peer

  1. To edit any of the IP Peers in the list, click the radio button next to the specific IP Peer name. The Edit Selected IP Peer window opens.
  2. Make the required changes and click Save.

To Copy an IP Peer

  1. To copy an IP Peer, click the radio button next to the specific IP Peer.
  2. Click Copy IP Peer. The Copy Selected IP Peer window opens.
  3. Make any required changes and click Save.

To Delete an IP Peer

  1. To delete an IP Peer, click the radio button next to the specific IP Peer.
  2. Click the delete icon (X) at the end of the row. 
  3. Confirm the deletion when prompted.