Surrogate Registration Profile - CLI

In this section:

Overview

The

Unable to show "metadata-from": No such page "_space_variables"

supports configuring surrogate registration information for a single IP Peer. Up to 256 Surrogate Registration entries are supported for each IP Peer.

The

Unable to show "metadata-from": No such page "_space_variables"

also supports configuring multiple Address of Records (AORs) for the same IP-PBX using the surrogate registration profile (surrogateRegistrationProfile). Surrogate registration specific statistics are generated separately per surrogate AOR, as applicable, even if the statistics are associated with the same IP Peer.

When configuring surrogate registration, only one of the following mutually exclusive parameters should be enabled at the IP Peer surrogateRegistration level depending upon the number of AORs per IP Peer desired.

Only one AOR per IP Peer for surrogate registration—Configure only userPart at the surrogate registration level. With this method, you cannot associate a surrRegprofile with this peer.
Multiple AORs for IP Peer for surrogate registration—Associate more than one AOR to the same peer by configuring and attaching a surrRegprofile to the IP peer. When using this profile, you cannot configure userPart at the surrogate registration level.

Surrogate Registration Profile Limitations

Configuration limitations:
- Up to 200 subscribers for each AoR
- Up to 256 surrogate registration profiles system-wide
- Up to 10,000 AoRs for surrogate registration system-wide
Subscriber numbers must be unique across the system.
Configure subscriber numbers using the same format as the numbers expected from the received call.
The SBC supports a registration rate of 100 registrations/second.

Note

If the same AorUsername is configured on two different peers, AorUserName start and end range values for either peer should not fall within start and end range values of the other peer.

Note

Do not attach a surrogate registration profile to more than one peer.

A surrogate registration profile is added, modified and deleted as explained below. For additional feature details, refer to Surrogate Registration Support.

Adding New Profile

Configure a new surrogate registration profile.
Enter various AOR username and corresponding details in this profile.
Attach this profile to given IP Peer (refer Zone - IP Peer - CLI page).
Optionally configure pacing time at IP Peer (refer Signaling - Global - CLI page).
Enable surrogate registration feature at IP Peer.

The SBC starts sending register messages using a randomized timer (unless surrogateRegisterPacingTime is configured).

Modifying Existing Profile

Set AOR state to 'disabled'.
Modify the configuration value of AOR.
Set the AOR state to 'enabled'.

The modified configuration takes effect from the next register onwards for the given AOR.

Deleting Existing Profile

Disable the surrogateRegistration state from IP Peer (see Zone - IP Peer - CLI page).
Detach the profile from ipPeer.
Remove the profile.

As soon as the administrator detaches the profile from ipPeer, all AORs in the profile are queued for De-registration. If profile is re-attached, a fresh registration request is queued. Note that the register will happen after all of the de-register requests resulting from detachment of the profile are executed.

Command Syntax

The CLI syntax to configure the Surrogate Registration Profile is shown below:

% set profiles services surrogateRegistrationProfile <profile name> aorUserName <user name> 
	aorAuthPassword <6-32 characters>
	aorAuthUserName <1-127 characters>
	aorSendCredentials <challengeForAnyMessage | challengeForAnyMessageAndInDialogRequests | challengeForRegister>
	aorState <disabled | enabled>
	userEndRange <1-32>
	userStartRange <1-32>

Command Parameters

SIP Resource Priority Header Profile Parameters

Parameter	Length/Range	Description
surrogateRegistrationProfile	1-23 characters	`<profile name>` – Surrogate registration profile name.
`aorUserName`	1-127 characters	`<AOR user name>` – Surrogate AOR user name.
`aorAuthPassword`	6 to 32 characters	`<password>` – The authorization Password for surrogate registration.
`aorAuthUserName`	1-127 characters	`<auth user name>` – The authorization User Name for surrogate registration.
`aorSendCredentials`	N/A	Use this parameter to define how the credentials are sent. The options are: `challengeForAnyMessage` – The SBC sends credentials for REGISTER, INVITE, PRACK, UPDATE, REINVITE and BYE when these messages are challenged. `challengeForAnyMessageAndInDialogRequests` – 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. `challengeForRegister` (default) – The SBC sends credentials only for REGISTER when challenged. Challenges for any other messages are returned to the IP-PBX.
`aorState`	N/A	Enable or disable the specified Surrogate Registration profile. `disabled` (default) `enabled`
`userEndRange`	1-32	`<end number>` – Use this attribute to specify the Ending number in the range of user numbers in this surrogate registration profile.
`userStartRange`	1-32	`<starting number>` – Use this attribute to specify the Starting number in the range of user numbers in this surrogate registration profile.

Space shortcuts

Page tree