1. ACLI Reference Guide
  2. About This Guide

About This Guide

The ACLI Reference Guide provides a comprehensive explanation of all commands and configuration parameters available to you in the Acme Command Line Interface (ACLI). This document does not explain configurations and the logic involved in their creation.

This publication is used with Oracle Communications Session Border Controller and Oracle Enterprise Session Border Controller.

Document Organization

  • About this Guide—This chapter
  • How to Use the ACLI—Explains how to use the ACLI, the CLI-based environment for configuring the Oracle Communications Session Border Controller
  • Commands A-M—Lists commands starting with A-M, their syntax, and their usage
  • Commands N-Z—Lists commands starting with N-Z, their syntax, and their usage
  • Configuration Elements A-M—Lists configuration elements starting with A-M, their syntax, and their usage. Subelements are listed directly after the element where they are located.
  • Configuration Elements N-Z—Lists configuration elements starting with N-Z, their syntax, and their usage. Subelements are listed directly after the element where they are located.

Conventions

This section explains the documentation conventions used in this guide. Each of the following fields is used in the ACLI Reference Guide. The following are the fields associated with every command or configuration element in this guide. When no information is applicable, the field is omitted (this occurs mostly with the Notes field).
  • Description—Describes each command, its purpose, and use.
  • Syntax—Describes the proper syntax needed to execute the command. Syntax also includes syntax-specific explanation of the command.
  • Arguments—Describes the argument place holders that are typed after a command. For commands only.
  • Parameters—Describes the parameters available in a configuration element. For configuration elements only.
    • Default—Default value that populates this parameter when the configuration element is created.
    • Values—Valid values to enter for this parameter.
  • Notes—Lists additional information not included in the above fields.
  • Mode—Indicates whether the command is executed from User or Superuser mode.
  • Path—Describes the ACLI path used to access the command.
  • Example—Gives an example of how the command should be entered using one of the command’s valid arguments.

This guide uses the following callout conventions to simplify or explain the text.

Caution or Note: This format is used to advise administrators and users that failure to take or avoid a specified action can result in loss of data or damage to the system.

Documentation Set

The following table describes the documentation set for this release.

Document Name Document Description
Acme Packet 3900 Hardware Installation Guide Contains information about the components and installation of the Acme Packet 3900.
Acme Packet 4600 Hardware Installation Guide Contains information about the components and installation of the Acme Packet 4600.
Acme Packet 6100 Hardware Installation Guide Contains information about the components and installation of the Acme Packet 6100.
Acme Packet 6300 Hardware Installation Guide Contains information about the components and installation of the Acme Packet 6300.
Acme Packet 6350 Hardware Installation Guide Contains information about the components and installation of the Acme Packet 6350.
Release Notes Contains information about the current documentation set release, including new features and management changes.
ACLI Configuration Guide Contains information about the administration and software configuration of the Service Provider Session Border Controller (SBC).
ACLI Reference Guide Contains explanations of how to use the ACLI, as an alphabetical listings and descriptions of all ACLI commands and configuration parameters.
Maintenance and Troubleshooting Guide Contains information about SBC logs, performance announcements, system management, inventory management, upgrades, working with configurations, and managing backups and archives.
MIB Reference Guide Contains information about Management Information Base (MIBs), Oracle Communication's enterprise MIBs, general trap information, including specific details about standard traps and enterprise traps, Simple Network Management Protocol (SNMP) GET query information (including standard and enterprise SNMP GET query names, object identifier names and numbers, and descriptions), examples of scalar and table objects.
Accounting Guide Contains information about the SBC’s accounting support, including details about RADIUS and Diameter accounting.
HDR Resource Guide Contains information about the SBC’s Historical Data Recording (HDR) feature. This guide includes HDR configuration and system-wide statistical information.
Administrative Security Essentials Contains information about the SBC’s support for its Administrative Security license.
SBC Family Security Guide Contains information about security considerations and best practices from a network and application security perspective for the SBC family of products.
Installation and Platform Preparation Guide Contains information about upgrading system images and any pre-boot system provisioning.
Call Traffic Monitoring Guide Contains information about traffic monitoring and packet traces as collected on the system. This guide also includes WebGUI configuration used for the SIP Monitor and Trace application.
FIPS Compliance Guide Contains conceptual and procedural information for configuration using the tools and protocols required to manage call traffic on the SBC.
HMR Resource Guide Contains information about configuring and using Header Manipulation Rules to manage service traffic.
TSCF SDK Guide Contains information about the client-side SDK that facilitates the creation of secure tunnels between a client application and the TSCF of the SBC.
REST API Guide Contains information about the supported REST APIs and how to use the REST API interface.

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.