Load and Enable an SPL Plug-in

Some SPL plug-ins require manual loading onto the ESBC.

The process to load and enable an SPL includes the following steps.

  1. Upload the SPL to the ESBC. See "Upload an SPL Plug-in."
  2. Add the SPL to the ESBC configuration. See "Add an SPL Plug-in to your Configuration."
  3. In a High Availability (HA) deployment, synchronize the SPL files across the HA pair. See "Synchronize an SPL Plug-in File Across an HA Pair."

Upload an SPL Plug-in

The ESBC comes preloaded with many SPLs. Use show spl to see the preloaded SPLs.

To upload a non-preloaded SPL to the ESBC, SFTP the plugin file to the ESBC's /code/spl directory.

Add an SPL Plug-in to the Configuration

You must add an SBC Programming Language (SPL) plug-in file to the spl-config element before the system can execute the plug-in. The system ignores any SPL plug-in that exists in the /code/spl directory that is not included in the spl-config element.

Before You Begin
  • Confirm that you have Superuser permissions

In the following procedure, you add the name of one or more SPL plug-ins to the spl-config configuration element. Note that the system executes SPL plug-ins in the order in which they were configured.

Procedure
  1. Access the spl-config configuration element.
    ORACLE# configure terminal
    ORACLE(configure)# system
    ORACLE(system)# spl-config
    ORACLE(spl-config)# 
  2. Type plugins , and press Enter. The system prompt changes to let you know that you can begin configuring individual parameters.
    ORACLE(spl-config)# plugins
    ORACLE(spl-plugins)#
  3. Type name, a space, and the name of the SPL file.
    ORACLE(spl-plugins)#name UniversalCallId.1.spl
  4. Type done to save your work.
  5. Save and activate the configuration.
Next Steps
  • If your deployment supports a High Availability (HA) pair configuration, see "Synchronize SPL Files Across HA Pairs."

Synchronize SPL Plug-in Files Across an HA Pair

In a High Availability (HA) configuration, both the active and the standby systems require the same version of the SBC Programming Language (SPL) plug-in script.

SPL files do not automatically synchronize when saving and activating your configuration. To configure the standby system, use the synchronize spl command from the active node in the HA pair.

ORACLE# synchronize spl

If you have any SPL files in the /code/spl directory on the active system, these files will sync and overwrite any existing SPL files in the /code/spl directory on the standby system.

To copy individual files, add the specific filename as an argument to the synchronize spl command. For example:

ORACLE#synchronize spl /code/spl/MediaPlayback.1.0.spl
ORACLE#synchronize spl /code/spl/LyncEmergencyCall.1.0.spl
ORACLE#synchronize spl /code/spl/SipHeaderExtensionMetadata.1.2.spl
ORACLE#synchronize spl /code/spl/UniversalCallId.1.spl
ORACLE#synchronize spl /code/spl/ComfortNoiseGeneration.1.1.spl