CLI Overview

[ Contents ] [ Avaya website ]

Administrators use the CLI to control Access Point operation and monitor network statistics. This guide describes working with network parameters to configure the Access Point, and does not cover network statistics in detail. Network Statistics typically show read-only counters of low-level elements, such as transmission retries, byte counts, and so on.

CLI Variations

The AP-3 supports two types of CLI: the "Bootloader" variation and the normal CLI.

The Bootloader CLI provides a limited command set, and is used when the current AP Image is bad or missing. The Bootloader CLI allows you to assign an IP Address and download a new image. Once the image is downloaded and running, the Access Point uses the normal CLI.

This guide provides procedures for using the Bootloader CLI in the "Procedures" section; otherwise, the guide covers the normal CLI.

Important terminology

  • Config Files - Database files containing the current Access Point configuration. Configuration items include the IP Address and other network-specific values. Config files may be downloaded to the Access Point or uploaded for backup or troubleshooting.
  • Download Vs. Upload - Downloads transfer files to the Access Point. Uploads transfer files from the Access Point. The TFTP server performs file transfers in both directions.
  • Group - A logical collection of network parameter information. For example, the System Group is composed of several related parameters. Groups can also contain Tables. All items for a given Group can be displayed with a "show" <Group> CLI Command.
  • Image File - The Access Point software executed from RAM. To update an Access Point you typically download a new Image File. This file is often referred to as the "AP Image".
  • Parameter - A fundamental network value that can be displayed and may be changeable. For example, the Access Point must have a unique IP Address and the Radio PC Cards must know which channel to use. Change parameters with the CLI set Command, and view them with the CLI show Command
  • Table - Tables hold parameters for several related items. For example, you can add several potential managers to the SNMP IP Access Table. All items for a given Table can be displayed with a show <Table> CLI Command.
  • TFTP - Refers to the TFTP Server, used for file transfers.

CLI Command types

This guide divides CLI Commands into two categories: Operational and Parameter Control.

Operational CLI Commands

This type affects Access Point behavior, such as downloading, rebooting, and so on. After entering commands (and parameters if any) press the Enter key to execute the Command Line.

Operational commands include.

  • ? - (Question Mark) Lists CLI Commands or parameters, depending on usage.
  • done, exit, quit - Terminates the CLI session
  • download - Uses TFTP server to download "image", "config", or "bootloader upgrade" files to Access Point.
  • help - Displays general CLI help information or command help information, such as command usage and syntax
  • history - Remembers commands to help avoid re-entering complex statements
  • passwd - Sets the Access Point CLI password
  • reboot - Reboots the Access Point in specified time
  • search - Lists the parameters in a specified Table
  • upload - Uses TFTP server to upload "config" files from Access Point to TFTP default directory or specified path.

Parameter Control Commands

The two Parameter Control Commands are show and set. These allow you to view (show) all parameters and statistics, and to change (set) parameters.

  • show - To see any Parameter or Statistic values, you specify a single parameter, a Group, or a Table. Fore more details, refer to "set and show command examples" later in this guide.
  • set - Use this CLI Command to change parameter values. You can use a single CLI Statement to modify Tables, or modify each parameter separately. Fore more details, refer to "set and show command examples" later in this guide.

The following sections cover each CLI Command, and include several tables showing parameter properties.