29
1106137-01 Pre-Production 1 Revision 6 CHAPTER 1 About This Manual In This Chapter: Common Design Feature, page 2 Access Levels, page 2 Terminology, page 2 Locating Commands, page 3 Document Headers, page 3 Document Conventions, page 4 This chapter describes the features of this reference manual. The BeamPlex BCT (Base CLI Terminal) is a command line interface used primarily for initial base station setup and commissioning, and for maintenance and upgrade tasks. The BMS (BeamPlex Element Management System) is used for daily operation tasks.

About This Manualgreens.org/~jims/pix/cli.pdf · 1106137-01 Pre-Production 1 Revision 6 CHAPTER 1 About This Manual In This Chapter: Common Design Feature, page 2 Access Levels, page

  • Upload
    others

  • View
    1

  • Download
    0

Embed Size (px)

Citation preview

Page 1: About This Manualgreens.org/~jims/pix/cli.pdf · 1106137-01 Pre-Production 1 Revision 6 CHAPTER 1 About This Manual In This Chapter: Common Design Feature, page 2 Access Levels, page

1106137-01 Pre-Production 1Revision 6

C H A P T E R

1About This Manual

In This Chapter:

Common Design Feature, page 2

Access Levels, page 2

Terminology, page 2

Locating Commands, page 3

Document Headers, page 3

Document Conventions, page 4

This chapter describes the features of this reference manual.

The BeamPlex BCT (Base CLI Terminal) is a command line interface used primarily for initial base station setup and commissioning, and for maintenance and upgrade tasks. The BMS (BeamPlex Element Management System) is used for daily operation tasks.

Page 2: About This Manualgreens.org/~jims/pix/cli.pdf · 1106137-01 Pre-Production 1 Revision 6 CHAPTER 1 About This Manual In This Chapter: Common Design Feature, page 2 Access Levels, page

Ch. 1 About This Manual Base CLI TerminalUser Reference

2 Pre-Production 1106137-01Revision 6

Common Design Feature

The BCT is designed to have similar operating characteristics to Cisco CLI products. This was done because most technical users in broadband telecommunications have experience with Cisco products. This BCT design allows you to become familiar with its operation with minimal learning.

Some examples of Cisco-like features include:

User name and command modes are included inside command prompt as an indicator of logon state and mode level.

Help or “?” displays all available commands for current mode.

Tab key completes partially entered command.

Access Levels

The access level determines which commands are available to the user. Users access the BCT with the field login and password. There are two other access levels that are used by design and production personnel.

Note: This document contains commands for the field access level only.

Terminology

The following terms are used in this manual:

CLI (Command Line Interface): Text-based commands entered into a Telnet window.

BCT (Base CLI Terminal): Any PC or X-terminal that can provide a Telnet window and has an Ethernet interface. The BCT program resides in the NPC module of the base station.

RU (Remote Unit): The transceiver plus related hardware and software at the subscriber’s premise. The CPE (customer premise equipment).

FL (forward link): Transmission from the base station to the remote unit.

RL (reverse link): Transmission from the remote unit to the base station.

Page 3: About This Manualgreens.org/~jims/pix/cli.pdf · 1106137-01 Pre-Production 1 Revision 6 CHAPTER 1 About This Manual In This Chapter: Common Design Feature, page 2 Access Levels, page

Base CLI Terminal Ch. 1 About This ManualUser Reference

1106137-01 Pre-Production 3Revision 6

Locating Commands

This manual contains three main references for locating commands:

Table of Contents – The chapters are organized by modes with the commands listed in alphabetical order.

Index – Alphabetical listing of key words.

Appendix A – A “Where is...” chart of the show commands that lists specific data items categorized by system components.

Document Headers

The headers in this document contain information designed to help you find the information that you are looking for.

Document Title Chapter Title

Section Title

First command on left page and last command on right page.

(Chapters 3, 4 & 5)

Page 4: About This Manualgreens.org/~jims/pix/cli.pdf · 1106137-01 Pre-Production 1 Revision 6 CHAPTER 1 About This Manual In This Chapter: Common Design Feature, page 2 Access Levels, page

Ch. 1 About This Manual Base CLI TerminalUser Reference

4 Pre-Production 1106137-01Revision 6

Document Conventions

The following document conventions are used in this manual:

General Conventions

Note Important information requiring the user’s attention.

Caution A condition or circumstance that may cause damage to the equipment or loss of data.

Warning A condition or circumstance that may cause personal injury.

Italics Italic font style denotes a) emphasis of an important word; b) first use of a new term; c) title of a document.

Screen Name Sans serif, bold font denotes a) on-screen name of a window, dialog box or field; b) keys on a keyboard; c) labels printed on the equipment.

Software Conventions

Command Regular Courier font denotes code or text displayed on-screen.

Command Bold Courier font denotes commands and parameters entered exactly as shown by the user into a command line or dialog box.

{parameter}{<parameter>}

Braces {} surrounding a parameter denote a required value. Multiple choices are separated by vertical bars |. The user must select one of the choices.

Bold Courier font indicates the user enters the value exactly as shown.

Example: {yes|no}Bold, italic Courier font in angle brackets indicates a user-defined value string.

Example: {<host_name> | <host_ipaddress>}

[parameter][<parameter>]

Brackets [] surrounding a parameter denote an optional value. Multiple choices are separated by vertical bars |. The user may select one of the choices.

Bold Courier font indicates the user enters the value exactly as shown.

Example: [yes|no]Bold, italic Courier font in angle brackets indicates a user-defined value string.

Example: [<host_name> | <host_ipaddress>]

Page 5: About This Manualgreens.org/~jims/pix/cli.pdf · 1106137-01 Pre-Production 1 Revision 6 CHAPTER 1 About This Manual In This Chapter: Common Design Feature, page 2 Access Levels, page

1106137-01 Pre-Production 5Revision 6

C H A P T E R

2Modes and Usage

In This Chapter:

Connection and Logon, page 6

Hierarchy of Command Modes, page 8

Navigating Between Modes,

Entering a Mode, page 9

Exiting a Mode, page 9

Logging Off the BCT, page 9

Using Commands

Abbreviating Commands, page 10

Auto-Completing Commands, page 10

Displaying Command History, page 10

Keyboard Shortcuts, page 11

Modules and Slots

Specifying Card Modules, page 12

Specifying Module Slots, page 14

Help

List All Commands, page 15

Configure Sub-Modes Commands, page 16

Command String and Parameters, page 17

This chapter describes the BCT (Base Station CLI Terminal) mode structure under which the commands are organized. User features and help are also explained.

Page 6: About This Manualgreens.org/~jims/pix/cli.pdf · 1106137-01 Pre-Production 1 Revision 6 CHAPTER 1 About This Manual In This Chapter: Common Design Feature, page 2 Access Levels, page

Ch. 2 Modes and Usage Base CLI TerminalConnection and Logon User Reference

6 Pre-Production 1106137-01Revision 6

Connection and Logon

This section describes how to connect a BCT to a base station and how to log on to a base station.

PC Requirements

A standard PC (personal copmputer) can be used to operate the BCT. A portable PC is recommended. The BCT program is stored on the NPC card so no special application are required on the PC.

The PC must be equiped with an Ethernet card and a Telnet client. A Telnet client with file logging capability is recommended.

Connecting to a Base Station

Make an Ethernet connection from your PC to the RJ-45 connector on the master NPC module.

The primary and redundant NPC modules are located in the first card cage from the bottom of the chassis and are in the last two slots (20 and 21) on the right. See the diagram on page 14.

Normally, the primary NPC in slot 20 is the master. This is indicated by the Master LED on the face of the module being illuminated. However, you must connect to the master NPC whether it is the primary or redundant module.

Page 7: About This Manualgreens.org/~jims/pix/cli.pdf · 1106137-01 Pre-Production 1 Revision 6 CHAPTER 1 About This Manual In This Chapter: Common Design Feature, page 2 Access Levels, page

Base CLI Terminal Ch. 2 Modes and UsageUser Reference Connection and Logon

1106137-01 Pre-Production 7Revision 6

Logging On to a Base Station

You establish a Telnet session with the base station by entering the base station’s IP address and port number into the connection dialog box. Port number 2222 is always used.

If you are using the native Telnet client that comes with a Windows operating system, use the Start ⇒ Run dialog box rather than the Telnet’s Connect dial box, which will not accept the port number.

Here is an example of the command string you will enter:

telnet 10.0.0.1 2222

If you foresee the need to save BCT output as text files, you may need to use a third party Telenet client, as not all Windows’ clients have the necessary logging feature.

After connecting with the base station, the BCT will display the following screen for logon. Use the factory login and password: field.

The password cannot be changed from the field login.

___ __ __ / __ )/ / / / / / / / / / \ \__/ /__ / / \___)____)_/

BeamReach Networks, Inc.BCT Command Line Interface. Version 1.0Press CTRL-D to logout ↵

cli_login: field ↵password: field ↵[field]cli>

Page 8: About This Manualgreens.org/~jims/pix/cli.pdf · 1106137-01 Pre-Production 1 Revision 6 CHAPTER 1 About This Manual In This Chapter: Common Design Feature, page 2 Access Levels, page

Ch. 2 Modes and Usage Base CLI TerminalHierarchy of Command Modes User Reference

8 Pre-Production 1106137-01Revision 6

Hierarchy of Command Modes

Figure 2-1 shows the hierarchy of command modes. The screen prompt changes when you enter a mode. Sample prompts are shown below for each level.

Figure 2-1 Command Modes and Prompts

The commands available in each mode are described in Chapter 3. Brief descriptions of the modes are as follows:

• executive mode provides general commands to perform various user functions. These are global commands that are available at all sub-mode levels.

• configure mode provides commands for configuring a base station.

• airlink is a sub-mode for configuring certain parameters of the RF path between the base station and the remote units.

• interface is a sub-mode for configuring the base station’s network interface.

• maintenance is a sub-mode for replacing a circuit card module or initiating a switchover, where mastership is transferred to the standby module.

executive [field]cli>

configure [field]brbase(configure)#

airlink [field]brbase(configure-airlink)#

interface [field]brbase(configure-if)#

fast-ethernet [field]brbase(configure-if-fe)#

atm [field]brbase(configure-if-atm)#

oc3c [field]brbase(configure-if-oc3c)#

maintenance [field]brbase(configure-maintenance)#

Page 9: About This Manualgreens.org/~jims/pix/cli.pdf · 1106137-01 Pre-Production 1 Revision 6 CHAPTER 1 About This Manual In This Chapter: Common Design Feature, page 2 Access Levels, page

Base CLI Terminal Ch. 2 Modes and UsageUser Reference Navigating Between Modes

1106137-01 Pre-Production 9Revision 6

Navigating Between Modes

Navigation covers getting into and out of the various modes.

Entering a Mode

Enter a mode by typing the mode’s name as a command:

[field]cli>configure ↵[field]brbase(configure)#

You can enter any level of sub-mode by typing the commands in sequence:

[field]cli>configure interface atm ↵[field]brbase(configure-if-atm)#

Exiting a Mode

Exit any sub-mode under the configure mode with the end command. This will move you one level up in the hierarchy:

[field]brbase(configure-airlink)#end ↵[field]brbase(configure)#

[field]brbase(configure-if-oc3c)#end ↵[field]brbase(configure-if)#end ↵[field]brbase(configure)#

Exit to the executive mode from any level of sub-mode with the exit command:

[field]brbase(configure)#exit ↵[field]cli>

[field]brbase(configure-upgrade)#exit ↵[field]cli>

Logging Off the BCT

Use the quit command at any mode level to log off from the BCT:

[field]cli> quit ↵

[field]brbase(configure-if-atm)# quit ↵

Page 10: About This Manualgreens.org/~jims/pix/cli.pdf · 1106137-01 Pre-Production 1 Revision 6 CHAPTER 1 About This Manual In This Chapter: Common Design Feature, page 2 Access Levels, page

Ch. 2 Modes and Usage Base CLI TerminalUsing Commands User Reference

10 Pre-Production 1106137-01Revision 6

Using Commands

This section describes techniques for ease of use of BCT commands.

Abbreviating Commands

Commands can be abbreviated. However, you must enter a minimum number of characters to uniquely identify a command. For example, typing con will execute the configure command. But typing ba will result in the following error message because there are several commands that begin with those letters:

[field]brbase(configure)#ba↵base-id backhaul-if-type base-name base-offset-code

% Ambiguous command detected [field]brbase(configure)#

Auto-Completing Commands

If you enter the first few letters of a command and press the Tab key the remaining letters will appear. For example, typing do and pressing Tab results in download.

If there is more than one command that begins with the typed letters, the display will complete the command up to the point where a single command must be identified. For example, typing bas will result in base- being displayed. Pressing Enter results in the same error message shown in the preceding section, Abbreviating Commands.

Displaying Command History

Use the up-arrow key to display a history of the last ten commands, beginning with the most recent. Executive and configuration modes maintain their own history files, so you will see the history of commands executed only within each mode.

Page 11: About This Manualgreens.org/~jims/pix/cli.pdf · 1106137-01 Pre-Production 1 Revision 6 CHAPTER 1 About This Manual In This Chapter: Common Design Feature, page 2 Access Levels, page

Base CLI Terminal Ch. 2 Modes and UsageUser Reference Using Commands

1106137-01 Pre-Production 11Revision 6

Keyboard Shortcuts

The BCT supports the following keyboard shortcuts:

If a display is longer than the Telnet window, the display will stop when the window is full. The last line will be:

--- more ---

Use the following keyboard commands to view the remaining display:

← (left arrow) Moves cursor one space to the left

→ (right arrow) Moves cursor one space to the right

↑ (up arrow) Recalls last command, up to 10 previous commands

Ctrl + A Moves cursor to beginning of the line

Crtl + E Moves cursor to end of the line

Ctrl + D Logout of BCT

Enter Show one additional line

Space bar Show one additional window

Ctrl + C Move to end of display

Page 12: About This Manualgreens.org/~jims/pix/cli.pdf · 1106137-01 Pre-Production 1 Revision 6 CHAPTER 1 About This Manual In This Chapter: Common Design Feature, page 2 Access Levels, page

Ch. 2 Modes and Usage Base CLI TerminalModules and Slots User Reference

12 Pre-Production 1106137-01Revision 6

Modules and Slots

This section provides special instructions you will need to identify modules when entering BCT commands.

Specifying Card Modules

Several commands are implemented at the card module level where you must specify the card and chassis position. A typical list of parameter choices presented by the BCT appears as follows:

npc1 | npc2 | mbp1 | mbp2 | mbp3 | mbp4 | mbp5 | mbp6 | mbp7 | mbp8 | mbp9 | mbp10 | mbp11 | mbp12 | mbp13 | mbp14 | mbp15 | mbp16 | mbp17 | mbp18 | mtm1 | mtm2 | mtm3 | mtm4 | mtm5 | xcvr1 | xcvr2 | xcvr3 | xcvr4 | xcvr5 | lo1 | lo2 | prbt1 | | prbt2 | rfsw1 | rfsw2 | rfsw3 | rfsw4 | gps1 | gps2 | fan_tray1 | fan_tray2 | pm1 | pm2 | pm3 | pm4 | pm5 | pm6 | pm7 | pm8 | pm9 | pm10 | pm11 | pm12 | pm13 | pm14 | pm15 | pm16 | cf1 | cf2 | cf3 | cf4 | cf5 | cf6 | cf7 | cf8 | cf9 | cf10 | cf11 | cf12 | cf13 | cf14 | cf15 | cf16 | prbd1 | prbd2

The numbers do not refer to chassis slot numbers. They indicate the first, second, third, etc. module in the chassis. For example, mbp8 refers to the eighth MultiBeam Processor module, which is in chassis slot 18. Nomenclature and slot numbers are described below.

Page 13: About This Manualgreens.org/~jims/pix/cli.pdf · 1106137-01 Pre-Production 1 Revision 6 CHAPTER 1 About This Manual In This Chapter: Common Design Feature, page 2 Access Levels, page

Base CLI Terminal Ch. 2 Modes and UsageUser Reference Modules and Slots

1106137-01 Pre-Production 13Revision 6

The card module parameters displayed by the BCT correspond to the card module nomenclature as follows:

npc Network Processor/Controller 1 = primary; 2 = redundant

mbp MultiBeam Processor 1-9 = main cabinet | 10-18 = extension (auxiliary) cabinet1-8 = primary; 9 = redundant | 10-17 = primary; 18 = redundant

mtm Quad Multitone Modem 1 - 4 = primary; 5 = redundant

xcvr Quad Transceiver 1 - 4 = primary; 5 = redundant

lo Local Oscillator 1 = primary; 2 = redundant

prbt Probe Transceiver 1 = primary; 2 = redundant

rfsw RF switch 1 - 4; no primary/redundant designation

gps GPS 1 = primary; 2 = redundant

fan_tray Fan tray1 = main cabinet; 2 = extension cabinet

pm Power Module1 - 8 = main cabinet; 9 - 16 = extension cabinetno primary/redundant designation

cf Cavity Filter 1 - 8 = main cabinet; 9 - 16 = extension cabinetno primary/redundant designation

prbd Probe Distribution 1 = main cabinet; 2 = extension cabinetno primary/redundant designation

Page 14: About This Manualgreens.org/~jims/pix/cli.pdf · 1106137-01 Pre-Production 1 Revision 6 CHAPTER 1 About This Manual In This Chapter: Common Design Feature, page 2 Access Levels, page

Ch. 2 Modes and Usage Base CLI TerminalModules and Slots User Reference

14 Pre-Production 1106137-01Revision 6

Specifying Module Slots

Chassis slot numbers and module locations are shown here:

Quad Transceiver

Quad Multitone Modem

MultiBeam Processor

Network Processor / Controller

R R R R

1 2 3 4

1 2 3 4

5 6 7 8 9

Local Oscillator

Probe Transceiver RF Switch

GPS P GPS R

P = Slots for primary modulesR = Slots for redundant modules

Slots shown in white are not used

BS

004

Au

xilia

ry S

hel

fD

igit

al S

hel

f

P R P R

10 11 12 13 14 15 16 17 18 19 20 21

Page 15: About This Manualgreens.org/~jims/pix/cli.pdf · 1106137-01 Pre-Production 1 Revision 6 CHAPTER 1 About This Manual In This Chapter: Common Design Feature, page 2 Access Levels, page

Base CLI Terminal Ch. 2 Modes and UsageUser Reference Help

1106137-01 Pre-Production 15Revision 6

Help

There are several types of help available in the BCT.

List All Commands

Type a question mark at the prompt for a list of all commands available in that mode:

[field]cli>?download performs software image download for Base

and ODU

copy performs software image download for Base and ODU

unlock changes the administrative state of a card to unlocked

unlock-subband-pair changes the administrative state of a subband-pair to unlocked

configure enters the configure mode for configuring the Base

cancel-diagnostics aborts a currently active diagnostic

reset reloads a card on the base

Display continues

Page 16: About This Manualgreens.org/~jims/pix/cli.pdf · 1106137-01 Pre-Production 1 Revision 6 CHAPTER 1 About This Manual In This Chapter: Common Design Feature, page 2 Access Levels, page

Ch. 2 Modes and Usage Base CLI TerminalHelp User Reference

16 Pre-Production 1106137-01Revision 6

Configure Sub-Modes Commands

Within configure mode, type the sub-mode command, space and question mark to see the unique commands for that sub-mode.

[field]brbase(configure)#airlink ?

Enter the sub-mode and type a question mark at the prompt for a list of the unique commands plus the global commands.

[field]brbase(configure)#airlink↵[field]brbase(configure-airlink)#?

Display continues

spectrum configures airlink spectrum attributes on the Base

protocol configures airlink protocol attributes on the Base

spectrum configures airlink spectrum attributes on the Base

protocol configures airlink protocol attributes on the Base

exit Returns to the root shell

end Returns to the parent shell

quit Closes a BCT CLI session

help Display usage information on Help!

ping Ping a given hostname/IP Address

Page 17: About This Manualgreens.org/~jims/pix/cli.pdf · 1106137-01 Pre-Production 1 Revision 6 CHAPTER 1 About This Manual In This Chapter: Common Design Feature, page 2 Access Levels, page

Base CLI Terminal Ch. 2 Modes and UsageUser Reference Help

1106137-01 Pre-Production 17Revision 6

Command String and Parameters

Type a space and question mark after a command for a list of subsequent secondary commands and parameters for that command string:

[field]cli>copy ?

[field]cli>copy odu-image ?

[field]cli>copy odu-image tftp ?Performs the software image download to the specified ODU(s).

copy odu-image tftp <src_file> <target_odu_string> [<host_ip>]

base-image performs software image download to cards on the Base

odu-image performs software image download to ODU(s)

running-config copies base config from RAM to Flash

tftp specifies the TFTP server to perform the software image download

src_file Name of the ODU Software image

target_odu_string String specifying Single, multiple (comma separated) or range of ODU's.

Ex. Possible values are

odu_1

odu_2, odu_5, odu_6, odu_16

odu_1-odu_25, odu_29

(The maximum ODU range is 100)

host_ip TFTP Server IP address to be used for downloading the image

Page 18: About This Manualgreens.org/~jims/pix/cli.pdf · 1106137-01 Pre-Production 1 Revision 6 CHAPTER 1 About This Manual In This Chapter: Common Design Feature, page 2 Access Levels, page

18 Pre-Production 1106137-01Revision 6

Page 19: About This Manualgreens.org/~jims/pix/cli.pdf · 1106137-01 Pre-Production 1 Revision 6 CHAPTER 1 About This Manual In This Chapter: Common Design Feature, page 2 Access Levels, page

1106137-01 Pre-Production 19Revision 6

C H A P T E R

3Executive Mode Commands

Executive mode commands are available in all modes and sub-modes.

Commands are listed in alphabetical order.

Only commands available from the field login are listed.

Configure mode commands are in Chapter 4.

Show commands are in Chapter 5.

executive

configure

airlink

interface

maintenance

upgrade

Page 20: About This Manualgreens.org/~jims/pix/cli.pdf · 1106137-01 Pre-Production 1 Revision 6 CHAPTER 1 About This Manual In This Chapter: Common Design Feature, page 2 Access Levels, page

Ch. 3 Executive Mode Commands Base CLI TerminalExecutive Commands User Reference

copy

20 Pre-Production 1106137-01Revision 6

Executive Commands

copy

This command has four variations:

Download the control software image file into the NPC and MBP modules.

Download the boot image file into the NPC.

Copy and transfer the configuration file (MIB) in the NPC.

Download the software image file and the boot file into a remote unit.

The base station uses both a software image file and a configuration file. It permanently stores these files in flash memory, but operates from RAM (random access memory). On boot-up or reset, data is copied from flash to RAM.

The BCT changes the configuration file in RAM. That file must be copied to flash to permanently save the changes. Both RAM and flash are located in the NPC module.

ControlImage A

ControlImage A

ControlImage B

MIB(configuration)

Flash MemoryRAM

Bootup / Reset

copy running-config flash copy backup-config flash

copy running-config file

configuration

Base station currently set to boot from 'A' sector of flash.

Use switch command to cause boot from 'B' sector.

copy base-image ctrl-software

switch base-image

BCT

BS

020

erase running-config flash

Boot Image copy base-image boot

Page 21: About This Manualgreens.org/~jims/pix/cli.pdf · 1106137-01 Pre-Production 1 Revision 6 CHAPTER 1 About This Manual In This Chapter: Common Design Feature, page 2 Access Levels, page

Base CLI Terminal Ch. 3 Executive Mode CommandsUser Reference Executive Commands

copy

1106137-01 Pre-Production 21Revision 6

The variations of this command are as follows:

base-image ctrl-software – Downloads software image file from remote TFTP server.

base-image boot – Downloads boot file from TFTP remote server.

running-config flash – Saves the configuration file from RAM to flash.

running-config file – Copies the configuration file in flash to a TFTP server.

backup-config flash – Copies a configuration file from a TFTP server to flash memory, replacing the existing file in flash. This operation also prohibits any further updates to flash until the NPC is reset (page 26) or the base station is rebooted. You must initiate a reset or reboot to copy the configuration file from flash to RAM.

odu-image – Downloads either remote unit image file or boot file to the base station, then uploads them to a designated remote unit.

The base-image and odu-image variations are the same as the download command.

SYNTAX copy base-image ctrl-software {<src_file>} {<host_IP>} [<card>]copy base-image boot {<src_file>} {<host_IP>} [<card>]copy odu-image {<src_file>} {<host_ip>} {<gruid>}

Where:

src_file = Name of the image file or boot file to be downloaded. The files must have a .bin extension.

host_IP = IP address of the TFTP server where the source files are stored.

card = npc1 or npc2 for the NPC in slots 20 or 21 respectively. mbp1 through mbp9 for the MBP in slots 11 through 19 respectively.

gruid = ID number of remote unit to receive the upload. Use show ru-config (page 70) to obtain GRUIDs.

See the section Modules and Slots on page 12 for base station module designations.

DEFAULTS The card parameter default is npc1.

Page 22: About This Manualgreens.org/~jims/pix/cli.pdf · 1106137-01 Pre-Production 1 Revision 6 CHAPTER 1 About This Manual In This Chapter: Common Design Feature, page 2 Access Levels, page

Ch. 3 Executive Mode Commands Base CLI TerminalExecutive Commands User Reference

delete

22 Pre-Production 1106137-01Revision 6

EXAMPLE [field]cli>copy base-image ctrl-software image5.bin 123.45.67.89 npc2↵

Downloads the file image5.bin from TFTP server 123.45.67.89 to the standby NPC module.

SYNTAX copy running-config flash copy running-config file {<file>} [<server ip>]copy backup-config flash {<file>} [<server ip>]Where:

file = Name of the configuration file. Up to 24 characters. Add the extension .bin to the file when copying.

server ip = IP address of the server where the file is to be uploaded to or downloaded from. If an address is not specified, the default servers displayed with the show tftp-config command (page 73) will be used.

EXAMPLES [field]cli>copy running-config flash↵[field]cli>copy running-config file 011404.bin 123.34.45.567

Makes a copy of the configuration file in flash naming it 011404.bin and uploads it to server 123.34.45.567.

[field]cli>copy backup-config flash 031004.bin 123.34.45.567↵

Downloads the configuration file 031004.bin from the server 123.34.45.567.

delete

Deletes a remote unit or PVC (permanent virtual circuit) from the base station configuration records. PVCs can be added with the atm command (page 45). Remote units are added automatically by the base station discovery process.

SYNTAX delete ru {<gruid>}delete pvc ru (<id>}Where:

gruid = Integer 1 - 16000. Use show ru-config (page 70) to obtain the GRUID.

id = Integer 1 - 16000. Use show atm pvc (page 55) to obtain PVC IDs.

Page 23: About This Manualgreens.org/~jims/pix/cli.pdf · 1106137-01 Pre-Production 1 Revision 6 CHAPTER 1 About This Manual In This Chapter: Common Design Feature, page 2 Access Levels, page

Base CLI Terminal Ch. 3 Executive Mode CommandsUser Reference Executive Commands

download

1106137-01 Pre-Production 23Revision 6

EXAMPLE [field]cli>delete ru 8[field]cli>delete pvc ru 18

disable-compensation

Disable the transmit/receive compensation, which is used to adjust phase and amplitude in the signal path so forward and reverse link signals maintain the proper relationship. Enable compensation with the enable-compensation command (page 24). See also the restart-compensation command (page 26).

Note: Disabling compensation may seriously affect system performance.

EXAMPLE [field]cli>disable-compensation↵This command will stop compensation and may affect system performance

Do you want to continue ?[y/n]: y↵Compensation is stopped.

display-terminal-width

Displays the current setting for the BCT widow. Change this setting with the display-terminal-width command on page 28.

EXAMPLE [field]cli>display-terminal-width↵Columns : 65

download

Downloads a base station software image file or a boot image file from a TFTP server to flash memory in the NPC or MBP modules. Use the show version command (page 73) to display the current software versions in the base station.

The software image file is automatically stored in the inactive bank of the flash memory. Use the show version command (page 73) to determine the active and inactive banks. To implement the new software, use the switch command (page 28) to change the active bank, then reset the module or reboot the base station.

Page 24: About This Manualgreens.org/~jims/pix/cli.pdf · 1106137-01 Pre-Production 1 Revision 6 CHAPTER 1 About This Manual In This Chapter: Common Design Feature, page 2 Access Levels, page

Ch. 3 Executive Mode Commands Base CLI TerminalExecutive Commands User Reference

enable-compensation

24 Pre-Production 1106137-01Revision 6

This command can also download a remote unit (ODU) image file or boot file. The command directs the base station to download the file from a server, then upload it to a designated remote unit.

See also the copy command (page 20) for uploading and downloading configuration data files.

SYNTAX download base-image ctrl-software {<src_file>} {<host_IP>} [<card>]download base-image boot {<src_file>} {<host_IP>} [<card>]download odu-image {<src_file>} {<host_ip>} {<gruid>}

Where:

src_file = Name of the image file or boot file to be downloaded. The files must have a .bin extension.

host_IP = IP address of the TFTP server where the source files are stored.

card = npc1 or npc2 for the NPC in slots 20 or 21 respectively. mbp1 through mbp9 for the MBP in slots 11 through 19 respectively.

gruid = ID number of remote unit to receive the upload. Use show ru-config (page 70) to obtain GRUIDs.

See the section Modules and Slots on page 12 for base station module designations.

DEFAULTS The card parameter default is npc1.

EXAMPLE [field]cli>download base-image ctrl-software image5.bin 123.45.67.89 npc2↵

Downloads the file image5.bin from TFTP server 123.45.67.89 to the standby NPC module.

enable-compensation

Enables transmit / receive compensation if it was disabled with the disable-compensation command (page 23). See also the restart-compensation command (page 26).

EXAMPLE [field]cli>disable-compensation↵Compensation started....

Page 25: About This Manualgreens.org/~jims/pix/cli.pdf · 1106137-01 Pre-Production 1 Revision 6 CHAPTER 1 About This Manual In This Chapter: Common Design Feature, page 2 Access Levels, page

Base CLI Terminal Ch. 3 Executive Mode CommandsUser Reference Executive Commands

ping

1106137-01 Pre-Production 25Revision 6

end

From a sub-mode under the configuration mode, moves the BCT prompt up one mode level.

EXAMPLE [field]brbase(configure-if-atm)#end↵[field]brbase(configure-if)#end↵brbase(configure)#

erase

Erases the configuration file from flash memory. See also the diagram on page 20.

EXAMPLE [field]cli>erase running-config flash↵

exit

Moves the BCT to the executive mode level from any level of sub-mode.

EXAMPLE [field]brbase(configure-if-atm)#exit↵[field]cli>

help

Displays a narrative about the help functions of the BCT.

EXAMPLE [field]cli>help↵

ping

Sends a “ping” to a specified address and awaits a response to test connectivity.

EXAMPLE [field]cli>ping 123.45.67.89↵

Page 26: About This Manualgreens.org/~jims/pix/cli.pdf · 1106137-01 Pre-Production 1 Revision 6 CHAPTER 1 About This Manual In This Chapter: Common Design Feature, page 2 Access Levels, page

Ch. 3 Executive Mode Commands Base CLI TerminalExecutive Commands User Reference

quit

26 Pre-Production 1106137-01Revision 6

quit

Logs out of the BCT from any mode or sub-mode.

EXAMPLE [field]brbase(configure-if-atm)#quit↵

reset

Resets a specified module (card) in the base station. See also the diagram on page 20.

SYNTAX reset [<card>]Where:

card = The code designation for these modules:

npc1 | npc2 | mbp1 | mbp2 | mbp3 | mbp4 | mbp5 |mbp6 | mbp7 | mbp8 | mbp9 | mbp10 | mbp11 | mbp12| mbp13 | mbp14 | mbp15 | mbp16 | mbp17 | mbp18 |mtm1 | mtm2 | mtm3 | mtm4 | mtm5 | xcvr1 | xcvr2| xcvr3 | xcvr4 | xcvr5 | lo1 | lo2 | prbt1 | prbt2

Note: The lo and prbt modules operate as a pair. Resetting either lo1 or prbt1 will reset both modules. This also applies to lo2 and prbt2 modules.

DEFAULT Resets the master NPC if no other module is specified.

EXAMPLE [field]cli>reset mtm4↵

restart-compensation

Resets transmit/receive compensation to default values and enables fast-adapt compensation mode. See also the disable (page 23) and enable (page 24) commands.

Note: Restarting compensation may seriously affect system performance momentarily.

Page 27: About This Manualgreens.org/~jims/pix/cli.pdf · 1106137-01 Pre-Production 1 Revision 6 CHAPTER 1 About This Manual In This Chapter: Common Design Feature, page 2 Access Levels, page

Base CLI Terminal Ch. 3 Executive Mode CommandsUser Reference Executive Commands

run-cli-script

1106137-01 Pre-Production 27Revision 6

EXAMPLE [field]cli>restart-compensation↵This command will reset and restart compensation and may affect system performance

Do you want to continue ?[y/n] : y↵Weights loaded for Ant 0, path 0, band 0, sbbd 0Weights loaded for Ant 0, path 0, band 1, sbbd 0Weights loaded for Ant 0, path 1, band 0, sbbd 0Weights loaded for Ant 0, path 1, band 1, sbbd 0Weights loaded for Ant 1, path 0, band 0, sbbd 0Weights loaded for Ant 1, path 0, band 1, sbbd 0Weights loaded for Ant 1, path 1, band 0, sbbd 0Weights loaded for Ant 1, path 1, band 1, sbbd 0

...display continues

T/R Compensation restarted successfully

run-cli-script

Runs a text script from a TFTP server. Usually used for configuration scripts. A log file of all commands that were executed in the script can be generated and sent to the TFTP server.

SYNTAX run-cli-script {<tftp-host>} {<script-file>} [<log-file>]Where:

tftp-host = IP address of the TFTP server

script-file = File name of the script file

log-file = User-specified name for the log file. If no name is specified with this parameter, the default name log.txt is used.

EXAMPLE [field]cli>run-cli-script 123.45.67.89 script2.txt↵

Runs the script in the file script2.txt from TFTP server 123.45.67.89.

Page 28: About This Manualgreens.org/~jims/pix/cli.pdf · 1106137-01 Pre-Production 1 Revision 6 CHAPTER 1 About This Manual In This Chapter: Common Design Feature, page 2 Access Levels, page

Ch. 3 Executive Mode Commands Base CLI TerminalExecutive Commands User Reference

set-terminal-width

28 Pre-Production 1106137-01Revision 6

set-terminal-width

Sets the width of the BCT display window. The default is 65 columns. View the current setting with the display-terminal-width command on page 23.

SYNTAX set-terminal-width {<col>}Where:

col = Integer 30 - 200. Number of columns.

switch

Switches the active and inactive memory banks in the NCP and MBP modules. Use the show version command (page 73) to determine which bank is active.

New software downloads are stored in the inactive bank. Initiating the switch command causes the inactive bank to become the active bank on the next reset or reboot. See the download command (page 23) for related information. See also the diagram on page 20.

SYNTAX switch base-image [<card>]Where:

card = npc1 or npc2 for the NPC in slots 20 or 21 respectively mbp1 through mbp9 for the MBP in slots 11 through 19 respectively

DEFAULT npc1 if no other module is specified. Normally, NPC1 is the master module.

EXAMPLE [field]cli>switch base-image npc2↵

Switches the memory banks in the standby NPC.

terminal

Starts and stops the terminal log monitor. With the log monitor started, alarms and events are displayed in real-time as they occur. With the log monitor stopped, you must use the show alarms (page 53) command to view stored alarms.

You will find it more convenient to open a second Telnet window if you want to start the log monitor. Otherwise, real-time alarms and events will interrupt your entering commands into the terminal.

Page 29: About This Manualgreens.org/~jims/pix/cli.pdf · 1106137-01 Pre-Production 1 Revision 6 CHAPTER 1 About This Manual In This Chapter: Common Design Feature, page 2 Access Levels, page

Base CLI Terminal Ch. 3 Executive Mode CommandsUser Reference Executive Commands

terminal

1106137-01 Pre-Production 29Revision 6

Each Telnet window is a separate session. The commands referenced in the next paragraph must be executed in the window in which the log monitor was started.

Filter the display with the configure log command (page 37). View the current filter setting with the show log-filters command (page 67). Use the show terminal-log-monitor command (page 73) to view the current state of the log.

SYNTAX terminal log-monitor {start | stop}

Where:

start = Enable log monitor

stop = Disable log monitor

DEFAULT Stopped

EXAMPLE [field]cli>terminal log-monitor start↵

Received an alarm:Alarm Source : RU Alarm Source Instance: 3Sequence ID : 315 Timestamp (GMT) : Thu Mar 11 22:43:43 2004Alarm Type : Communications Alarm Alarm ID : 405Additional Text : UnresponsiveProbable Cause : Equipment MalfunctionSeverity : Major

Received an event:Event Source : NPC Event Source Instance: 1Sequence ID : 316 Timestamp (GMT) : Thu Mar 11 23:01:29 2004Event Type : Logout Event Event ID : 2Additional Text : BCT user: 'field' logged out

[field]cli>Received an alarm:Alarm Source : RU Alarm Source Instance: 3Sequence ID : 317 Timestamp (GMT) : Thu Mar 11 23:03:44 2004Alarm Type : Communications Alarm Alarm ID : 405Additional Text : UnresponsiveProbable Cause : Equipment MalfunctionSeverity : Cleared