Software Licensing

You enable features and functionality primarily through the Setup Entitlements task, where you self-provision features and certain session capacities. The Oracle® Enterprise Session Border Controller is seeded with a default feature set when you first follow the Setup Product task, and is based on software version, the platform on which the software runs, and the product type that you choose.

Note:

Refer to the Self-Provisioned Entitlements and License Keys section in the Release Notes for a list of the methods used to enable features in this release.

Initial Setup

Prior to system configuration, you must set up the product, self-provision entitlements, and optionally install license keys to activate features as required. If you log onto an unconfigured Oracle® Enterprise Session Border Controller, the system displays a warning message that a valid product type is required.

Entitlement Provisioning

License provisioning for components of the Oracle® Enterprise Session Border Controller is offered in a Basic bundle and an Advanced Bundle.

The following lists the licenses offered in a Basic Bundle:

Application Communication Protocol (ACP )
AMR-25 (NB) royalty
AMR-WB-25 royalty
Enhanced Variable Rate Codec (EVRC) royalty
Enhanced Variable Rate Codec - B(EVRC-B) royalty
G.729 royalty
H.323
High Availability (HA)
Intrusion Detection System (IDS) advanced
Intrusion Detection System (IDS) reporting
National Security Emergency Preparedess NSEP/RPH (GETS)
SIP Session Recording (SIPREC)
Session Initiation Protocol (SIP)
Software Secure Real-time Transport Protocol (SRTP)
Software Transport Layer Security (TLS)

The following lists the licenses offered in an Advanced Bundle:

Accounting
ENUM Lookup
IWF
Load Balancing
QoS
Routing

The following components of the Base license require a key for activation.

AMR-25 royalty
AMR-WB-25 royalty
EVRC royalty
EVRCB royalty
G.729 royalty
Software SRTP
Software TLS

System Setup

Before you begin configuring the Oracle® Enterprise Session Border Controller, you will set the product type with the setup product command, and the features with the setup entitlements command.

Note:

Not all of the features are available on all platforms.

Setup Product

Type setup product at the ACLI. If this is the first time running the command on this hardware, the product will show as Uninitialized.
Type 1 <Enter> to modify the uninitialized product.
Type the number followed by <Enter> for the product type you wish to initialize.
Type s <Enter> to commit your choice as the product type of this platform.
Reboot your Oracle® Enterprise Session Border Controller.

ORACLE# setup product

--------------------------------------------------------------
WARNING:
Alteration of product alone or in conjunction with entitlement
changes will not be complete until system reboot

Last Modified 2014-09-24 14:38:59
--------------------------------------------------------------
 1 : Product       : Enterprise Session Border Controller

Enter 1 to modify, d' to display, 's' to save, 'q' to exit. [s]: 1

  Product
    1 - Enterprise Session Border Controller
  Enter choice     : 1

Enter 1 to modify, d' to display, 's' to save, 'q' to exit. [s]: s
save SUCCESS
ORACLE#

Note:

When configuring an HA pair, you must provision the same product type and features on each system.

Setup Entitlements

Type setup entitlements at the ACLI. Currently provisioned features are printed on the screen.
Type the number of the feature you wish to setup followed by pressing the <Enter> Key. Some features are set as enabled/disabled (provisionable features), and some features are provisioned with a maximum capacity value (provisionable capacity features). The command will let you provision these values as appropriate.
Type enabled or disabled to set a provisionable feature, or type an integer value for a provisionable capacity feature. Both input types are followed by pressing the <Enter> key.
Repeat steps 2 and 3 to setup additional entitlements.
Type d followed by the <Enter> key to review the full range of your choices. Note that disabled entitlements display their state as blank.
Type s followed by the <Enter> key to commit your choice as an entitlement for your system. After saving the value succeeds you will be returned to the ACLI.
Reboot your Oracle® Enterprise Session Border Controller.

ORACLE# setup entitlements

----------------------------------------------------------------
Entitlements for Enterprise Session Border Controller
Last Modified: 2020-01-01 14:40:03
----------------------------------------------------------------
 1 : Session Capacity             : 360
 2 :   Advanced                   : enabled

Enter 1 - 2 to modify, d' to display, 's' to save, 'q' to exit. [s]: s
SAVE SUCCEEDED

Editing and Viewing Features

If you are not changing the product type, and you are changing only the features, you can edit the existing feature with the setup entitlements command. Executing this command will display existing features before giving you the option to modify their settings.

The show entitlements command displays the currently provisioned features and controlled features. You may also use the setup entitlements command and type d to display the current features. Upon first executing the setup entitlements command, all features (excluding controlled features) are displayed on the screen.

License Keys and Self-Provisioned Entitlements Compatibility

The Oracle® Enterprise Session Border Controller continues to support any license keys originally purchased and installed pre-self-provisioned-entitlements for enabling system features.

The licensing and entitlements processes work with each other, as follows.

You must use self-provisioning to enable features and session capacity on all platforms.
Oracle only provides license keys to enable specific features and capacities not available for self-provisioning, such as codecs and regulatory features .
Upon migrating to self-provisioned entitlements, the system seeds the current range of your installed license keys to the self-provisioned entitlements. The system's functionality remains identical.
When you upgrade to self-provisioned entitlements and then downgrade the software to an older version that requires license keys, any pre-existing license keys will still function.
When you upgrade to self-provisioned entitlements and then change the functionality (such as, adding more SIP sessions or removing a feature set), the new functionality will not be present upon downgrade to an older version that requires license keys.

System Setup with Existing License Keys

When changing the Oracle® Enterprise Session Border Controller licensing technique from the legacy license key method to the self-provisioned method, be aware of the following:

After running setup product and setup entitlements, the system will be seeded with the existing license keys' functionalities.
When the system is seeded with its previous functionality to the provisioned entitlements system, functionality may be changed with the setup entitlements command.
You may notice that there are fewer entitlements than there were with license keys. This is normal.
After setting up self-provisioned features, the show features command will still function to display the previously installed license keys.

Adding and Deleting License Keys

Certain features may only be enabled with license keys, like royalty-based codecs. The following guidelines apply to these license keys:

Each license key is bound to a specific Oracle® Enterprise Session Border Controller by serial number.
Oracle does not allow transferring a license key from one Oracle® Enterprise Session Border Controller to another.
Multiple license keys can be active on the same Oracle® Enterprise Session Border Controller simultaneously.
If a feature is covered by more than one license key, the latest expiration date applies.
You can activate and deactivate license keys in real time.

You can request license keys via the License Codes website at http://www.oracle.com/us/support/licensecodes/acme-packet/index.html

License Key Expiration

When a license expires, you are no longer able to use the features associated with it. The Oracle® Enterprise Session Border Controller automatically disables all associated functionality.

To avoid a license unexpectedly expiring and therefore potentially disrupting service, you should track expiration dates and renew licenses well in advance of expiration.

Expired licenses appear in the show features command until you delete them, although you cannot use those features. Deleting an expired license requires that you take the same steps as you do for deleting a valid one.

Add a License Key

Once you have obtained a license key, you can add it to your Oracle® Enterprise Session Border Controller and activate it.

Access the license configuration element.

ORACLE# configure terminal
ORACLE(configure)# system
ORACLE(system)# license
ORACLE(license)#

Using the add command and the license key you received from Oracle, add the license to your Oracle® Enterprise Session Border Controller.
```
ORACLE(license)# add sl25o39pvtqhas4v2r2jc1oaen9e01o21b1dmh3
```
Note:
Do note type done after you add the license. If you do, the system will return an error.

You can check that the license has been added by using the ACLI show command within the license configuration.

ORACLE(license)#  show
License #1: 16000 sessions, SIP, LI,
            Transcode Codec AMR (25 AMR transcoding sessions),
            Transcode Codec EVRC (25 EVRC transcoding sessions),
            Transcode Codec Opus (25 OPUS transcoding sessions),
            Transcode Codec SILK (25 SILK transcoding sessions)
            expires at 06:28:15 Feb 07 2106
            installed at 17:03:53 May 04 2017
ORACLE(license)#

Note:

Do not type done before exiting the license configuration element.

Type exit until you return to the top-level superuser prompt.

ORACLE(license)# exit
ORACLE(system)# exit
ORACLE(configure)# exit
ORACLE#

Perform a save- and activate- on the configuration.

ORACLE#  save-config
checking configuration
--------------------------------------------------------------------------------
Results of config verification:
   0 configuration error
--------------------------------------------------------------------------------
Save-Config received, processing.
waiting for request to finish
Request to 'SAVE-CONFIG' has Finished,
Save complete
Currently active and saved configurations do not match!
To sync & activate, run 'activate-config' or 'reboot activate'.
ORACLE# activate-config
Activate-Config received, processing.
waiting for request to finish
Setting phy on Slot=0, Port=0, MAC=00:08:25:22:81:B0, VMAC=00:08:25:22:81:B0
Setting phy on Slot=0, Port=1, MAC=00:08:25:22:81:B1, VMAC=00:08:25:22:81:B1
Request to 'ACTIVATE-CONFIG' has Finished,
Activate Complete

Delete a License Key

You can delete a license from your Oracle® Enterprise Session Border Controller, including licenses that have not expired. If you want to delete a license that has not expired, you need to confirm the deletion.

To delete a license from the Oracle® Enterprise Session Border Controller:

Access the license configuration element.

ORACLE# configure terminal
ORACLE(configure)# system
ORACLE(system)# license
ORACLE(license)#

Type no and press Enter. A list of possible licenses to delete appears.

ORACLE(license)# no
feature:
1: 16000 sessions, SIP, Transcode Codec AMR (25 AMR transcoding sessions),
   Transcode Codec EVRC (25 EVRC transcoding sessions),
   Transcode Codec Opus (25 OPUS transcoding sessions),
   Transcode Codec SILK (25 SILK transcoding sessions)
   expires at 06:28:15 Feb 07 2106

selection:
ORACLE(license)#

Type the number corresponding to the license you want to delete and press Enter.
```
selection:1
```
If the license has not expired, you will be asked to confirm the deletion.
```
Delete unexpired license [y/n]?: y
ORACLE(license)#
```
Note:
Do not type done before leaving the license configuration element.

Type exit until you return to the top-level superuser prompt.

ORACLE(license)# exit
ORACLE(system)# exit
ORACLE(configure)# exit
ORACLE#

Perform a save- and activate- on the configuration.

ORACLE#  save-config
checking configuration
--------------------------------------------------------------------------------
Results of config verification:
   0 configuration error
--------------------------------------------------------------------------------
Save-Config received, processing.
waiting for request to finish
Request to 'SAVE-CONFIG' has Finished,
Save complete
Currently active and saved configurations do not match!
To sync & activate, run 'activate-config' or 'reboot activate'.
ORACLE# activate-config
Activate-Config received, processing.
waiting for request to finish
Setting phy on Slot=0, Port=0, MAC=00:08:25:22:81:B0, VMAC=00:08:25:22:81:B0
Setting phy on Slot=0, Port=1, MAC=00:08:25:22:81:B1, VMAC=00:08:25:22:81:B1
Request to 'ACTIVATE-CONFIG' has Finished,
Activate Complete

View Installed Features, Entitlements, and Licenses

Use the show entitlements command to display all self-provisioned entitlements and features enabled with license keys.

ORACLE# show entitlements
Provisioned Entitlements:
-------------------------
Session Border Controller Base    : enabled
Session Capacity                  : 16000
  Accounting                      : enabled
  IPv4 - IPv6 Interworking        :
  IWF (SIP-H323)                  :
  Load Balancing                  : enabled
  Policy Server                   : enabled
  Quality of Service              : enabled
  Routing                         : enabled
  SIPREC Session Recording        :
Admin Security                    :
IMS-AKA Endpoints                 : 0
IPSec Trunking Sessions           : 0
MSRP B2BUA Sessions               : 0
SRTP Sessions                     : 0
TSCF Tunnels                      : 0

Keyed (Licensed) Entitlements
-----------------------------
LI
Transcode Codec AMR (25 AMR transcoding sessions)
Transcode Codec EVRC (25 EVRC transcoding sessions)
Transcode Codec Opus (25 OPUS transcoding sessions)
Transcode Codec SILK (25 SILK transcoding sessions)

Use the show features to display currently active features on the system. This command shows the union of features enabled with license keys and with the self-provisioning method.

ORACLE# show features
 Total session capacity: 16000
Enabled features:
        16000 sessions, SIP, H323, QOS, ACP, Routing, Load Balancing,
        Accounting, High Availability, LI, External BW Mgmt,
        External CLF Mgmt, External Policy Services, ENUM, NSEP RPH,
        Transcode Codec AMR (25 AMR transcoding sessions),
        Transcode Codec EVRC (25 EVRC transcoding sessions), IDS,
        IDS Advanced,
        Transcode Codec Opus (25 OPUS transcoding sessions),
        Transcode Codec SILK (25 SILK transcoding sessions)

Use the licenses' show command to see all features enabled by license keys.

ORACLE(license)# show
License #1: 16000 sessions, SIP, LI,
            Transcode Codec AMR (25 AMR transcoding sessions),
            Transcode Codec EVRC (25 EVRC transcoding sessions),
            Transcode Codec Opus (25 OPUS transcoding sessions),
            Transcode Codec SILK (25 SILK transcoding sessions)
            expires at 06:28:15 Feb 07 2020
            installed at 17:08:15 May 08 2030

Note:

Examples in this section are provided for illustration and may not reflect all available features on your system.

Setup Features on an HA Pair

An HA pair requires that you set up identical features on both systems during the same service window. Peers with mismatched features may exhibit unexpected behavior. You should carefully confirm system synchronization at every step.

This procedure uses the designations system-1 as the original active and system-2 as the original standby.

Confirm that system-1 and system-2 are healthy and synchronized. First check system health with the show health command on both systems to confirm they are in identical states and healthy.

Verify that both systems are in identical health with all processes synchronized with the show health command.

Note:

The following examples may not accurately portray your Oracle Communications product and version combination.

ORACLE-1# show health

               Media Synchronized            true
               SIP Synchronized              true
               REC Synchronized              disabled
               MGCP Synchronized             disabled
               H248 Synchronized             disabled
               XSERV Synchronized            disabled
               Config Synchronized           true
               Collect Synchronized          disabled
               RADIUS CDR  Synchronized      true
               Rotated CDRs Synchronized     true
               IPSEC Synchronized            true
               Iked Synchronized             disabled
               TSCF Synchronized             disabled
               Active Peer Address           

Redundancy Protocol Process (v3):
               State                                                   Active
               Health                                                100
               Lowest Local Address                     169.254.1.2:9090
               1 peer(s) on 2 socket(s):
               system-2: v3, Standby, health=100, max silence=1050
                      last received from 169.254.1.1 on wancom1:0


ORACLE-2# show health
               Media Synchronized            true
               SIP Synchronized              true
               REC Synchronized              disabled
               MGCP Synchronized             disabled
               H248 Synchronized             disabled
               XSERV Synchronized            disabled
               Config Synchronized           true
               Collect Synchronized          disabled
               RADIUS CDR  Synchronized      true
               Rotated CDRs Synchronized     true
               IPSEC Synchronized            true
               Iked Synchronized             disabled
               TSCF Synchronized             disabled
               Active Peer Address           169.254.2.2

Redundancy Protocol Process (v3):
               State                                                   Standby
               Health                                                100
               Lowest Local Address                     169.254.1.1:9090
               1 peer(s) on 2 socket(s):
               system-1: v3, Active, health=100, max silence=1050
                      last received from 169.254.2.2 on wancom2:0

Next, confirm that both the saved and running configurations across both systems are at the same version number. The following example verifies that system-1 and system-2 all share version 5 of their current and running configurations. If the configurations are out of sync, use the save-config and activate-config commands to fix this.

Verify that the current configurations are in sync on both system-1 and system-2 with the display-current-cfg-version command.

ORACLE-1# display-current-cfg-version
Current configuration version is 5

ORACLE-2# display-current-cfg-version
Current configuration version is 5

Verify that the running configurations are in sync on both system-1 and system-2 with the display-running-cfg-version command.

ORACLE-1# display-running-cfg-version
Running configuration version is 5

ORACLE-2# display-running-cfg-version
Running configuration version is 5

Self-provision features on system-1 with the setup entitlements command. This procedure is explained in the Setup Entitlements task, but DO NOT reboot the system at this point.

Save and activate the configuration on system-1.

ORACLE-1# save-config
checking configuration
Save-Config received, processing.
waiting for request to finish
Request to 'SAVE-CONFIG' has Finished,
Save complete
Currently active and saved configurations do not match!
To sync & activate, run 'activate-config' or 'reboot activate'.
ORACLE-1# activate-config
Activate-Config received, processing.
waiting for request to finish
Request to 'ACTIVATE-CONFIG' has Finished,
Activate Complete

Install License-key enabled features on system-1 with the licenses configuration element. This procedure is explained in the Add a license task, but DO NOT reboot the system at this point. Perform a save- and activate- as performed in the previous step.
Repeat steps 2 through 4 on system-2.
At the end of this step, identical features are installed, synchronized, and verified both system-1 and system-2.
Confirm once again that system-1 and system-2 are synchronized exactly as you did in step 1.
Reboot the standby system-2.
```
ORACLE-2# reboot
```
Wait for system-2 to startup and synchronize, then confirm that system-1 and system-2 are fully synchronized as explained in step 1.
Trigger a switchover from system-1 so that the standby system transitions to active, and vice-versa.
```
ORACLE-1# notify berpd force
```
Wait while system-2 transitions to the active state, then confirm that system-1 and system-2 are fully synchronized as explained in step 1.
Reboot the newly-standby system-1.
```
ORACLE-1# reboot
```
Wait for system-1 to complete rebooting, then confirm that system-1 and system-2 are fully synchronized as explained in step 1.
At this point both systems should be healthy, synchronized, and contain identical feature configurations.
If desired, trigger a switchover between the two systems in the HA node so the originally active system (system-1) assumes the active role again.