ACLI Configuration and Examples

Use the following procedure to configure the Local Media Playback options on the Oracle® Enterprise Session Border Controller.

1. Set up the playback configuration and associated entries sub-elements.
2. Set up the realm, session-agents, or sip-interfaces for which you want to enable local playback.

Set up the Playback Configuration

The playback configuration defines the media files that you want to play, listed by codec. Each codec encoding that you want to support requires its own file, defined by the playback entry sub-element.

Procedure

1. In Superuser mode, type configure terminal, and press Enter.

   ACMEPACKET# configure terminal

2. Type media-manager, and press Enter.

   ACMEPACKET(configure)# media
   ACMEPACKET(media-manager)#

3. Type playback-config , and press Enter.

   ACMEPACKET(media-manager)# playback-config
   ACMEPACKET(playback-config)#

4. name—Enter the name of this playback configuration. This parameter has no default, and is required. You use this name when you configure the spl-options parameter; it specifies the media the Oracle® Enterprise Session Border Controller (E-SBC) plays.
5. entries—Configure the entries for this playback configuration. These entries refer to files in the /code/media directory, and are designed so that you can reference the same media with different codecs. For example, you might want to be able to play the same playback tone in different codecs; here, you would specify the file name and the encoding for each one you have stored.

   ACMEPACKET (playback-config)# entries
   ACMEPACKET(entries)#

   • encoding—Enter the codec name for this media file entry, such as PCMU. This value must match the encoding name negotiated in the SDP. This parameter has no default and is required.

   • filename—Enter the name of the raw binary media file you stored in the /code/media directory on the E-SBC.

   • bytes-per-second—Enter the playback rate for this media file in bytes per second. Default: to 8000. Range:100-99999.

6. Type done, and save the configuration.

Set Playback Options on Realms, Session Agents, and SIP Interfaces

To set playback options for realms, session agents, and SIP interfaces on the Oracle® Enterprise Session Border Controller (E-SBC), you can set the spl-options parameter under each of those objects in the ACLI. The spl-options parameter allows you to set the following options:

• playback-on-183-to-originator—Playback enabled upon the receipt of a 183 Session Progress destined for the originator and stops when a either a 200-299 or 400-699 final response is sent.
• playback-on-183-from-terminator—Playback enabled upon the receipt of a 183 Session Progress response is received from the terminator and stops when a 200-299 or 400-699 final response is received.
• playback-on-refer—Playback enabled for the caller being transferred when the E-SBC receives a REFER message that is locally terminated (i.e., processed on the E-SBC on REFER completion).
• playback-on-header—Starts or stops playback based on the presence of the P-Acme-Playback header and its definitions.

Note:

The E-SBC supports a maximum of 100 simultaneous playbacks.

With each of these options, you set the name of the playback configuration you want to use for the associated scenario. Except with playback-on-header, if there is one file to play, the E-SBC loops it continuously until a stop event occurs. If multiple media files can be used for the same events, the E-SBC queues them in the order you specify in your configuration and plays them consecutively until a stop event occurs. For playback-on-header, you can define how you want playback to work by setting the duration mode in the P-Acme-Playback header to once, continuous, or the amount of time in milliseconds you want the media to play.

The following example shows you how to configure the playback-on-refer SPL option for a session agent. The steps are the same for the spl-options parameter in realms, session agents, and SIP interfaces. Simply set the option you want in the configuration where it needs to be applied.

Procedure

1. Access the session-agent configuration element.

   ORACLE# configure terminal
   ORACLE(configure)# session-router
   ORACLE(session-router)# session-agent
   ORACLE(session-agent)

2. Type spl-config , and press Enter.

   ACMEPACKET(session-agent)# spl-config
   ACMEPACKET(spl-config)#

3. Type spl-options, followed by the option name pre-pending with the plus sign (+). If you do not use the plus sign, the system overwrites any other options that you configured previously.

   ACMESYSTEM(spl-config)# spl-options +playback-on-refer=media1,media2

   In the previous example, the E-SBC will play media1 and then media2.

4. Type done and save the configuration.