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:
Use this object to configure an IP Peer for a particular zone.
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.
% set addressContext <name> zone <name> ipPeer <peer name> authentication intChallengeResponse <disabled | enabled> incInternalCredentials <disabled | enabled> defaultForIp <false | true> ipAddress <IP address> ipPort <0-65535> mode <inService | outOfService> pathCheck (See Patch Check section below for details) policy description <description> ipSignalingProfile <profile name> packetServiceProfile <profile name> sip fqdn <fqdn> fqdnPort <0-65535> sip cacProfile <profile name> sipResponseCodeStats <enabled|disabled> surrogateRegistration (See Surrogate Registration section below for details)
Zone IP Peer Parameters
Parameter | Length/Range | Description |
---|---|---|
<peer name> | 1-23 characters | The name of the IP Peer. |
| N/A | Use this object to support local authentication autonomously on a per-IP trunk group basis in situations where an IP-PBX does not perform a registration and the service provider does not require/want registrations (see IP Trunk Group Authentication additional feature functionality).
NOTE: If intChallengeResponse is disabled, incInternalCredentials is not used. NOTE: If IPTG authentication is configured for both ingress IPTG and IP Peer, the IP Peer configuration takes precedence. If you wish to use the flags configured on IPTG, the IP Peer must not be present in the configurations. Otherwise, the IP Peer flags default to 'disabled' state and take precedence over IPTG flags. |
defaultForIp | N/A | Set flag to “true” to use this peer for the ipAddress and ephemeral port on ingress.
|
ipAddress | IPv4/IPv6 format | The IPv4 or IPv6 address of the Peer. |
ipPort | 0-65535 | The TCP/UDP port for this peer. (default = 0) |
mode | N/A | Specifies the status of the IP peer.
|
pathCheck | N/A | Use this parameter to define Options ping settings. (See Path Check Parameters table below for details) |
policy | N/A | Use this parameter to specify policy parameters and profiles associated with this IP peer.
|
sip | N/A | Use this parameter to specify the SIP endpoint CAC profile for the IP peer using .
|
sipResponseCodeStats | N/A | Option to enable or disable collection of SIP response code statistics for an IP peer. Possible values:
|
| N/A | Use this parameter to configure the SBC to act as a surrogate registration entity between a non-registering IP PBX or SIP UA and REGISTRAR (which mandates registration) for this IP Peer. Do not use FQDN format when configuring a Surrogate Peer. When configuring surrogate registration, be sure to set the expires value of ingress trunk group toward IAD to the maximum default value of “3600”. (See Surrogate Registration Parameters table below for details.) |
% set addressContext <name> zone <name> ipPeer <peer name> pathCheck hostName <peer FQDN> hostPort <0-65535> profile <Path Check Profile name> state <disabled | enabled> statusUpdateSupport <disabled | enabled>
Path Check Parameters
Parameter | Length/Range | Description |
---|---|---|
hostName | 1-63 characters | <FQDN of the peer> – This is resolved using DNS, and the resulting servers are pinged using SIP OPTIONS requests. |
hostPort | 0-65535 |
|
profile | 0-23 characters |
|
state | N/A | Use this flag to enable/disable active pinging.
|
statusUpdateSupport | N/A | Enable this flag to provide OPTIONS-based status update support.
NOTE: If NOTE: Status updates only apply when new calls are sent to a peer. They do not impact messages belonging to existing calls or new calls received from the peer. |
Status updates are sent/received under the following conditions:
Status Update Conditions
Status Update is sent by: | When: |
---|---|
Peer | Peer restarts |
Peer | Peer is manually blocked |
Peer | Peer's congestion state changes (this update is ignored by SBC) |
SBC | Peer has restarted indicating it is ready to receive calls |
SBC | Peer is manually blocked in SBC |
% set addressContext <name> zone <name> ipPeer <peer name> surrogateRegistration authUserName <user name [string up to 127 characters]> hostPart <1-63 characters> regAuthPassword <DES3 encrypted string> retryTimer <50-10000000 milliseconds> sendCredentials <challengeForAnyMessage | challengeForAnyMessageAndInDialogRequests | challengeForRegister> state <disabled | enabled> suppressRegRetryAfterAuthFail <disabled | enabled> surrRegProfile <profile name> useNextSurrRegForCall <disabled | enabled> useUserNameAsPAI <disabled | enabled> userPart <user part for surrogate registration>
Surrogate Registration Parameters
Parameter | Length/Range | Description |
---|---|---|
authUserName | 1-127 characters | <name> – Authorization User Name for surrogate registration. |
hostPart | 1-63 characters | <host name> – This assigned name is used as a hostname of RURI, FROM, TO headers of all outgoing calls. |
regAuthPassword | 1-32 characters |
Note: While exporting the configuration, the plain text authentication password for NOTE: If regAuthPassword contains ASCII characters, enclose the entire password string with " " (double quotes).
NOTE: "Field Service" and "Guest" users do not have access to |
retryTimer | 50-10000000 | <#> – The time, in milliseconds, after which the REGISTRATION is retried after a failure. When a Registration or Refresh-Registration for a peer fails (except 403 message – see Surrogate Registration Criteria below), the retry timer is initiated. Upon expiry, a new Registration for the peer is attempted. (Default = 900000 ms, which equates to 15 minutes). |
sendCredentials | N/A | Use this parameter to control how credentials are sent on receiving a challenge from AS for methods REGISTER, INVITE,PRACK, REINVITE, UPDATE and BYE.
|
state | N/A | Use this flag to disable/enable surrogate registration on IP peer.
|
suppressRegRetryAfterAuthFail | Use this flag to control the sending of 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.
| |
surrRegProfile | 1-23 characters | <profile name> – Surrogate registration profile name. To establish a Surrogate Registration Profile, refer to Surrogate Registration Profile - CLI page. |
useNextSurrRegForCall | N/A | Enable this flag to use the next available pilot number to resend the INVITE.
NOTE: If using this flag, be sure to configure Crankback profile for 4xx (403) response (refer to Crankback Profile - CLI page for details). |
useUserNameAsPAI | N/A | Enable this flag to use the configured
NOTE: Because this flag sends PAI in outgoing INVITE, the |
userPart | 1-127 characters |
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 |
When configuring surrogate registration, be sure to set the expires value of ingress trunk group toward IAD to the maximum default value of “3600”.
To allow originating calls from non-pilot numbers behind an IP-PBX, set "validateAor" flag to "disabled". If enabled, only calls from the AOR configured as surrogate registration username are allowed (refer to SIP Trunk Group - Signaling - CLI).
The following examples demonstrate how to configure, enable and disable surrogate registration.
Be sure to issue the ‘commit’ command after configuring surrogate peer and before enabling surrogate registration. Otherwise, an error will occur.
Configure Peer for surrogate registration:
set addressContext PKT0_ADDR_CONTEXT_1 zone PKT0_TG1 ipPeer SURR_PEER1 ipAddress 10.32.241.2 ipPort 12020 surrogateRegistration userPart SURR_REG_PEER1 retryTimer 5 regAuthPassword 123456789012345678901234567890 commit
Enable surrogate registration:
set addressContext PKT0_ADDR_CONTEXT_1 zone PKT0_TG1 ipPeer SURR_PEER1 surrogateRegistration state enabled commit
Disable surrogate registration:
set addressContext PKT0_ADDR_CONTEXT_1 zone PKT0_TG1 ipPeer SURR_PEER1 surrogateRegistration state disabled commit