The SBC Core is enhanced to support SIP Registrar functionality for SIP end points. This feature allows the Ribbon SBC to act as an Access SBC with Registrar functionality in a single deployment.

The Ribbon SBC acting as a SIP REGISTRAR provides the following functions:

  • Allows users to configure a subscriber profile. The profile is stored in the internal database.
  • Handles the REGISTER request locally. The SBC establishes endpoint binding and removes the bindings on receiving a SIP DEREGISTER message or timeouts as defined in RFC 3261.
  • Challenges the REGISTER and INVITE request received from a subscribed user.
  • Proxies the incoming calls based on stored bindings:
     – The incoming INVITE from the user to the Access SBC is routed to the SIP LOCAL REGISTRAR hosted in the same instance based on the Trunk Group (TG) control flag.
     – The Registrar routes the incoming calls back to the Access SBC hosted on the same instance, which is again routed to the called endpoint.

The following types of users can manage the SIP Registrar functionalities.

  • Administrator
  • Operator
  • Field Service

Use the SIP Registrar screen to import and export subscriber data in the form of an XML document to the TemplateConfigServlet, which in turn invokes confd commands for importing and exporting the data. As the import and export operations are time consuming, they are asynchronously executed in separate light weight processes.

Once the user uploads the subscriber data as an XML file, the EMA performs data validation and verification using the Inputs Sanitization technique to validate the uploaded data against the validation logic embedded in ValidationHandler.java in order to ensure that the client sent valid inputs.

On the SBC main screen, go to Administration > System Administration > SIP Registrar.

You can perform the following operations on the "SIP Registrar" screen:

OperationParametersDescription
Check Status N/ACheck the details/status of an import/export operation, if any.
ListN/AList exported subscribers files in the JSON Format.
Import SubscribersFile Name, File ContentsImport the subscriber data.
Export SubscribersN/AExport the subscriber data.
DownloadFile NameDownload the subscriber data in the form of an attachment using the file name as an input parameter (identifier).
DeleteFile NameDelete Subscriber data using the file name as an identifier.

When updating (adding/modifying/deleting) Subscriber profiles from the EMA, Ribbon recommends doing so only during a maintenance window. Also, before performing a bulk import of profiles, set the debug level to Major or Critical using the CLI.

Example:
set oam eventLog typeAdmin debug filterLevel major

Check Status

After you log into the EMA, the SBC makes an API call to verify if any Subscriber operation is in progress. If an operation is in progress, you are blocked from performing any other operations, and must log out of the EMA until the operation completes.

Import Subscribers

  1. Click Import Subscribers. A new section under the data table is displayed for operators to upload the XML file.
  2. Select the Subscribers XML file to upload to the SBC and then click Upload to import the file.

Once the Import operation starts, you are blocked from doing any other operations. Log out of the EMA until the operation completes.

Export Subscribers

Use the Export Subscribers option to export and list the files of the subscribers in a data table. 

  1. On the SIP registrar screen, click Export Subscribers. A confirmation message "Do you really want to start Export?" appears.
  2. Click Start Export to start the export operation. A subscriber operation message appears: "Export of subscribers is in progress. You are not allowed to perform any other operation. Please logout and check back later."


  3. Click Logout and log back in later.

Note

If the number of Exported files is 20, operators are prompted to delete the file from the table to proceed with the Export operation.

Import/Export Status Monitor

This section of the screen indicates if the Import/Export operation was successful.

Download File

Use this option to download the Subscriber XML file. In the SIP Registrar screen, select the Subscribers XML file from the list and then click Download to download the file to disk.

Delete File

Use this option to delete the subscriber XML file. In the SIP Registrar screen, select the Subscribers XML file from the list and then click Delete to delete the file. A confirmation message "Are you sure you want to delete the file appears". Click Yes to confirm.

Add Multiple Subscriber Profiles for Bulk Entries

Add multiple subscriber entries using the following sample XML file data. You must add the multiple entries within the tags <sipLocalRegistrar> </sipLocalRegistrar>.

Sample XML file Data
<config xmlns="http://tail-f.com/ns/config/1.0">
<global xmlns="http://sonusnet.com/ns/mibs/SONUS-GLOBAL-OBJECTS/1.0">
<signaling>
<sipLocalRegistrar>
	<sipRegSubscriberProfile>
		<sipRegAor>53055@10.xx.xx.xx</sipRegAor>
		<sipRegAuthUserName>testUser1</sipRegAuthUserName>
		<sipRegAuthRealm>rbbn.com</sipRegAuthRealm>
		<sipRegAuthPassword>testPassword1</sipRegAuthPassword>
		<sipRegSendChallenge>challengeForNone</sipRegSendChallenge>
	</sipRegSubscriberProfile>
	<sipRegSubscriberProfile>
	 	<sipRegAor>53069@10.xx.xx.xx</sipRegAor>
		<sipRegAuthUserName>testUser2</sipRegAuthUserName>
		<sipRegAuthRealm>rbbn.com</sipRegAuthRealm>
		<sipRegAuthPassword>testPassword2</sipRegAuthPassword>
		<sipRegSendChallenge>challengeForNone</sipRegSendChallenge>
	</sipRegSubscriberProfile>
</sipLocalRegistrar>
</signaling>
</global>
</config>


IMPORTANT

When performing bulk provisioning, Ribbon recommends using the SBC EMA or RESTCONF API, instead of the CLI.