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 | <password> – 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: While exporting the configuration, the plain text authentication password for regAuthPassword is replaced with “SonusDefaultValue” in the config dump. When you import the same config dump (xml), configure the entity with the appropriate value. Otherwise, it will still have the value “SonusDefaultValue”. NOTE: If regAuthPassword contains ASCII characters, enclose the entire password string with " " (double quotes). % set addressContext default zone ZONE1 ipPeer basu surrogateRegistration userPart 452613 regAuthPassword "1234567890123456789012340\!$$@#$!@#!@#!@#"
NOTE: "Field Service" and "Guest" users do not have access to regAuthPassword field. |
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, REINVITEre-INVITE, UPDATE, and BYE. challengeForAnyMessage – The SBC sends credentials for REGISTER, INVITE, PRACK, UPDATE, REINVITE re-INVITE and BYE when these messages are challenged.challengeForAnyMessageAndInDialogRequests – The SBC sends credentials for REGISTER, INVITE, PRACK, UPDATE, REINVITE re-INVITE, 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 re-INVITEm, and BYE when any one of these methods is challenged earlier in the call.challengeForRegister (default) – The SBC sends credentials only for REGISTER when challenged. Challenges for any other messages are returned to the IP-PBX.
|
state | N/A | Use this flag to disable/enable surrogate registration on IP peer. disabled (default)enabled
|
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. 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.
|
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. disabled (default)
enabled
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 userName in surrogateRegistraion as userName in the outgoing INVITE. disabled (default)enabled
NOTE: Because this flag sends PAI in outgoing INVITE, the includePrivacy flag must be disabled (refer to Egress IP Attributes - SIP - CLI page to disable flag). |
userPart | 1-127 characters | <userpart identity> – User part name for the IP-PBX/SIP UA for which surrogate registration is being enabled. This is a mandatory parameter. Any character in ABNF format is allowed except a semi-colon ( ; ).
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 REINVITEre-INVITE/UPDATE/BYE with credentials. |