Use this object to define the parameters controlling registration relay behavior.

Command Syntax


% set addressContext <name> zone <name> sipTrunkGroup <name> signaling registration 
	alwaysRandomExtExpires <disabled | enabled>
	alwaysRandomIntExpires <disabled | enabled>
	bulkRegisterFormat <disabled | enabled | followIngress>
	expires <15-65535>
	extRefreshFactorMax <0-1000>
	extRefreshFactorMin <0-1000>
	includeXOriginalAddr <disabled | enabled>
	insideExpiresMinimum <0-100000>
	intRefreshFactorMax <0-1000>
	intRefreshFactorMin <0-1000>
	preserveRcbOnRefreshRegErrResponse <disabled | enabled>
	requireRegistration <none | required | required-nonpriority | required-group | required-group-nonpriority | supported | supported-group>
	useRUriForRegisterRouting <disabled | enabled>

Command Parameters


Registration Parameters

ParameterLength/RangeDescription
alwaysRandomExtExpiresN/A

Use this flag to control how the random value is used for external expires timer.

  • disabled (default) – The external expires timeout is randomized for the initial REGISTER.

  • enabled – The external expires timeout is randomized for the initial and refresh REGISTER.
alwaysRandomIntExpires N/A

Use this flag to control how the random value is used for external expires timer.

  • disabled (default) – The internal expires timeout is randomized for the initial REGISTER.
  • enabled – The internal expires timeout is randomized for the initial and refresh REGISTER. 
bulkRegisterFormatN/A

Use this flag to determine how the registration requests are formatted with respect to RFC 6140. 

  • disabled (default) – REGISTER message is not formatted as per RFC 6140. 
  • enabled – REGISTER message is formatted as per RFC 6140. 
  • followIngress – No changes are made to the Egress Register with respect to RFC 6140.
expires 15-65535The time (in seconds) a SIP endpoint's registration session lasts before requiring re-registration. This value does not apply if the endpoint is NAT'd. (default = 3600)
extRefreshFactorMax0-1000Defines the maximum factor for random number calculation for external refresh timeout. (default = 0). 
extRefreshFactorMin0-1000

Defines the minimum factor for random number calculation for external refresh timeout. (default = 0).

includeXOriginalAddrN/A

Enable this flag to insert the X Original Addr header into REGISTER message. 

  • disabled (default) 
  • enabled
 insideExpiresMinimum0-100000

Controls the initial expire value (in seconds) in a REGISTER relayed to a registrar. (default = 3600).

NOTE: Since the SBC expects an expires value greater than 540 seconds (9 minutes) from the registrar, do not set “insideExpiresMinimum” value less than 540 seconds. Ideally, set this value much higher (3600 seconds is recommended) to avoid overloading registrar with register refreshes.

NOTE: When configuring surrogate registration, be sure to set the expires value of ingress trunk group toward IAD to the maximum default value of “3600”.

intRefreshFactorMax0-1000

Defines the maximum factor for random number calculation for internal refresh timeout. (default = 0).

intRefreshFactorMin0-1000

Defines the minimum factor for random number calculation for internal refresh timeout. (default = 0).

 

preserveRcbOnRefreshRegErrResponse

 

N/A

Enable this parameter to allow the SBC to preserve the RCB on receiving error response (4xx/5xx/6xx, except 401, 407, 408, and 7xx) for the REFRESH REGISTER requests.

If disabled, the SBC deletes the RCB.

  • disabled (default)
  • enabled

NOTE:

  • If the error response is any of 401, 407, 408, and 7xx, the SBC exhibits the default characteristics even if the parameter is enabled.
  • When this parameter is disabled (as the default behavior), and the SBC gets an error response for the REFRESH REGISTER, it changes the RCB state from REFRESHING to TERMINATED and starts a 64 second timer.
    • If the SBC receives a Re-REGISTER request (REFRESH or UPDATE) within the next 64 seconds, it does not relay the request to the Registrar.
    • Instead, it locally responds to the UE with the previously preserved error message (because the RCB state is TERMINATED). However, if the SBC receives an Un-REGISTER request from the UE within 64 seconds, it deletes the information about the earlier registration failures and allows the next REGISTER attempt to go through. 
  • When this parameter is enabled and the SBC receives an error response for REFRESH REGISTER attempts, it sets the RCB state to COMPLETED instead of TERMINATED. On receiving subsequent REFRESH REGISTER requests, instead of locally relaying the previously stored error message to the UE, the SBC relays the REFRESH REGISTER request to the Registrar. In general, whenever the RCB is COMPLETED, the SBC relays the REFRESH REGISTER requests to the Registrar.

requireRegistrationN/A

Use this parameter to specify the type of endpoint registration validation required. 

  • none (default) – No registration validation is required. 
  • required – Use this option to prevent unregistered IADs from making or receiving any calls. 
  • required-nonpriority – Prevent unregistered IADs from making or receiving non-priority calls. Since priority calls are exempt, unregistered endpoints are still allowed to make priority calls. 
  • required-group – If this option is selected for an ingress IP trunk group in relation to a received call (e.g. call from IP-PBX towards AS) so that if the source IP address and port of the INVITE/OOD request do not match the source IP address and port of an existing registration in the zone, they are rejected.

    However, if the AOR does not match, but if the source IP Address and the port match to the existing registration in the zone, messages are accepted.
  • If this option is selected for an egress IP trunk group in relation to a received call (e.g. call from AS towards IP-PBX), the user part check between registered AoR and Request-URI of the INVITE does not occur, and the call is accepted.
  • required-group-nonpriority – Prevent unregistered IADs from making or receiving non-priority calls. All emergency calls are allowed even if the source IP/port fails to fetch RCB.
  • supported – Accept registrations from unregistered endpoints when the associated trunk group is used for endpoints optionally requiring registration. If an endpoint is registered, then the registration data is used to send calls to that endpoint instead of PSX route. 
  • supported-group – Accept registrations from unregistered users and from users whose user names do not match with the stored URI in Registration Control Block. If an endpoint is registered, then the registration data is used to send calls to that endpoint instead of PSX route.

NOTE: Set requireRegistration to ‘supported-group’ for the IP Peer on which surrogate registration functionality is being enabled.

NOTE: In loopback scenarios for SIP-H323 calls, requireRegistration must be set to “none”.

useRUriForRegisterRoutingN/A

Use this flag to specify how to handle URI for a REGISTER request.

  • disabled (default) – Send the TO AOR as CALLED URI instead of Request-URI which results in default routing mechanism.
  • enabled – Send the Request-URI as Called-URI, resulting in Request-URI based routing.

NOTE: This flag is not supported on ERE and is only intended for use with an external PSX.