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.

 

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.