Avocent CCM1640, CCM840 User Manual

CCM840/1640

Installer/User Guide

INSTRUCTIONS

This symbol is intended to alert the user to the presence of important operating and maintenance (servicing) instructions in the literature accompanying the appliance.

DANGEROUS VOLTAGE

This symbol is intended to alert the user to the presence of uninsulated dangerous voltage within the product’s enclosure that may be of sufficient magnitude to constitute a risk of electric shock to persons.

POWER ON

This symbol indicates the principal on/off switch is in the on position.

POWER OFF

This symbol indicates the principal on/off switch is in the off position.

PROTECTIVE GROUNDING TERMINAL

This symbol indicates a terminal which must be connected to earth ground prior to making any other connections to the equipment.

This document is written for use with the CCM840/1640 application version 2.0.

CCM840/1640

Installer/User Guide

Avocent, Equinox and AVWorks are trademarks or registered trademarks of Avocent Corporation or its affiliates. All other marks are the property of their respective owners.

USA Notification

Canadian Notification

Japanese Notification

Agency Approvals

Warning: Changes or modifications to this unit not expressly approved by the party responsible for compliance could void the user's authority to operate the equipment.

Note: This equipment has been tested and found to comply with the limits for a Class A digital device, pursuant to Part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference when the equipment is operated in a commercial environment. This equipment generates, uses and can radiate radio frequency energy and, if not installed and used in accordance with the instruction manual, may cause harmful interference to radio communications. Operation of this equipment in a residential area is likely to cause harmful interference in which case the user will be required to correct the interference at his own expense.

This digital apparatus does not exceed the Class A limits for radio noise emissions from digital apparatus set out in the Radio Interference Regulations of the Canadian Department of Communications.

Le présent appareil numérique n’émet pas de bruits radioélectriques dépassant les limites applicables aux appareils numériques de la classe A prescrites dans le Règlement sur le brouillage radioélectrique édicté par le Ministère des Communications du Canada.

FCC P 15 Class A, EN55022, EN61000-3-2, EN61000-3-3, EN60950, EN55024, ETL (UL 1950), CSA 22.2 No. 950

Chapter 1: Product Overview

Features and Benefits . . . . . . . . . . . . . . . . . . . . . . . . . 3

Safety Precautions . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Using AVWorks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Chapter 2: Installation and Configuration

Hardware Overview . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Installing the CCM . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Configuring the CCM . . . . . . . . . . . . . . . . . . . . . . . 10

Reinitializing the CCM . . . . . . . . . . . . . . . . . . . . . . 14

Chapter 3: Operations

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Configuring Serial Port Settings . . . . . . . . . . . . . . . 17

Connecting to Serial Devices . . . . . . . . . . . . . . . . . . 18

Managing User Accounts . . . . . . . . . . . . . . . . . . . . 28

Using Authentication Modes . . . . . . . . . . . . . . . . . . 31

Using Security Lock-out . . . . . . . . . . . . . . . . . . . . . 33

Managing the Port History Buffer . . . . . . . . . . . . . 34

Managing the CCM Using SNMP . . . . . . . . . . . . . 37

Chapter 4: Using CCM Commands

Accessing the CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Entering Commands . . . . . . . . . . . . . . . . . . . . . . . . 43

Understanding Conventions . . . . . . . . . . . . . . . . . . 44

Command Summary . . . . . . . . . . . . . . . . . . . . . . . . 46

Chapter 5: CCM Commands

Connect Command . . . . . . . . . . . . . . . . . . . . . . . . . 53

Disconnect Command . . . . . . . . . . . . . . . . . . . . . . . 53

Help Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Port Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Quit Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Resume Command . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Server Commands . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Show Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

SPC Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

User Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

Appendices

Appendix A: Technical Specifications . . . . . . . . . . 85

Appendix B: Device Cabling . . . . . . . . . . . . . . . . . . 86

Appendix C: Ports Used . . . . . . . . . . . . . . . . . . . . . . 90

Appendix D: Technical Support . . . . . . . . . . . . . . . 91

Product Overview

Contents

Features and Benefits . . . . . . . . . . . . . . . . . . . . . . . . . 3

Safety Precautions . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Using AVWorks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Chapter 1: Product Overview 3

Chapter 1: Product Overview

Features and Benefits

Overview

The CCM840 and CCM1640 serial over IP network appliances provide nonblocked access and control for serial devices such as routers, power management devices and firewalls.

You may connect up to 8 serial devices to a CCM840, and up to 16 serial devices to a CCM1640. A single 10/100 Ethernet port provides network connectivity on each CCM. Two CCM appliances may be mounted in 1U of vertical space in a standard 19 inch rack.

Serial device access options

You may choose from among several available Telnet options to access the CCM and its attached serial devices:

• The AVWorks™ multiplatform graphic management interface that offers a built-in enhanced Telnet client and a Secure Shell (SSH) client

• Third-party Telnet clients

• Third-party SSH clients

Access to attached serial devices is also possible via a serial Command Line Interface (CLI) connection, a PPP (Point to Point Protocol) dial-in connection to a serial CLI modem or from a third-party SSH client.

User authentication and data security

The CCM user database supports up to 64 user accounts, which include usernames, passwords and/or keys, plus specifications of access rights to CCM ports and commands. User definitions may be changed at any time. You may choose to have user access authenticated locally at the CCM user database or at one or more RADIUS (Remote Access Dial-In User Service) servers. Data security may be enhanced via industry-standard SSH encryption.

Extensive command set

The CCM offers a wide range of commands that allow administrators to easily configure, control and display information about the CCM operating environment, including its ports, user accounts and active sessions. The user interface also offers descriptive error message data and built-in command help information. On-board Trivial File Transfer Protocol (TFTP) support allows administrators to upload new functionality to CCM units in the field.

4 CCM840/1640 Installer/User Guide

Port history

Each CCM port has a buffer that holds the most recent 64K bytes of online and offline serial data. A separate history command mode lets you navigate within a port’s current history file and conduct tailored searches.

Safety Precautions

To avoid potential device problems, if the building has 3-phase AC power, ensure that a computer and its monitor (if used) are on the same phase. For best results, they should be on the same circuit.

To avoid potentially fatal shock hazard and possible damage to equipment, please observe the following precautions:

• Do not use a 2-wire extension cord in any product conﬁ guration.

• Test AC outlets at the computer and monitor (if used) for proper polarity and grounding.

• Use only with grounded outlets at both the computer and monitor. When using a backup Uninterruptible Power Supply (UPS), power the computer, the monitor and the CCM unit off the supply.

NOTE: The AC inlet is the main disconnect.

Rack mount safety considerations

• Elevated Ambient Temperature: If installed in a closed rack assembly, the operation temperature of the rack environment may be greater than room ambient. Use care not to exceed the rated maximum ambient temperature of the unit.

• Reduced Airﬂ ow: Installation of the equipment in a rack should be such that the amount of airﬂ ow required for safe operation of the equipment is not compromised.

• Mechanical Loading: Mounting of the equipment in the rack should be such that a hazardous condition is not achieved due to uneven mechanical loading.

• Circuit Overloading: Consideration should be given to the connection of the equipment to the supply circuit and the effect that overloading of circuits might have on overcurrent protection and supply wiring. Consider equipment nameplate ratings for maximum current.

• Reliable Earthing: Reliable earthing of rack mounted equipment should be maintained. Pay particular attention to supply connections other than direct connections to the branch circuit (for example, use of power strips).

Chapter 1: Product Overview 5

Using AVWorks

The AVWorks graphical management interface may be used to manage CCM840/1640 appliances and access attached devices. Using AVWorks, you may perform most of the operations that are described in this manual. This manual describes how to manage a CCM840/1640 by entering commands using the CLI. The AVWorks Installer/User Guide describes how to manage a CCM840/1640 using the graphical interface.

6 CCM840/1640 Installer/User Guide

Installation and

Configuration

Contents

Hardware Overview . . . . . . . . . . . . . . . . . . . . . . . . . 9

Installing the CCM . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Configuring the CCM . . . . . . . . . . . . . . . . . . . . . . . 10

Reinitializing the CCM . . . . . . . . . . . . . . . . . . . . . . 14

Chapter 2: Installation and Configuration 9

Chapter 2: Installation and Configuration

Hardware Overview

Figure 2.1 shows the front of a CCM1640.

Figure 2.1: CCM1640 Front View

The lower left area of the front panel contains the following LEDs and buttons:

• The POWER LED illuminates when the CCM is connected to a power source.

• The ON LIN E LED illuminates steadily (not blinking) when the CCM

self-test and initialization procedures complete successfully.

• The LIN K LED illuminates when the CCM establishes a connection to the network.

• The TRA FFIC LED blinks when there is network trafﬁ c.

• The 100MBps LED illuminates when the CCM is c onnected to a 100

MBps LAN.

• The RESET button, when pressed, reboots the CCM.

• The INIT button, when pressed, restores the CCM to factory defaults. See

Reinitializing the CCM in this chapter.

Figure 2.2 shows the back panel of a CCM1640.

Figure 2.2: CCM1640 Back Panel

The back panel contains:

• 8 (CCM840) or 16 (CCM1640) RJ-45 connectors for serial cabling

• A LAN connector for a 10BaseT or 100BaseT interface cable

• The AC line cord connector

10 CCM840/1640 Installer/User Guide

Installing the CCM

WARNING: The power outlet should be installed near the equipment and should be

easily accessible.

To install the CCM hardware:

1. Locate the CCM where you can connect cables between the serial devices and the CCM serial ports, and where you can connect a LAN interface cable between the Ethernet hub or switch and the CCM LAN connector.

If you are using a rack mount kit, follow the instructions inc luded with

the kit.

2. Connect serial devices to the CCM serial ports ; see Appendix B for cabling information. Connect each serial device to it s appropriate power source, following the device’s documentation.

3. Attach a 1 0BaseT or 100BaseT LAN interface cable to the LAN connector on the back of the CCM. A CAT 5 cable is required for 100BaseT operation.

4. Insert the power cord into the back of the CCM. Insert the other end of the power cord into a grounded electrical receptacle.

5. Check that the POWER LED on the front of the CCM is illuminated. If not, check the power cable to ensure that it is inserted snugly into the back of the unit. The ONLINE LED will illuminate within one minute to indicate that the unit self-test is complete. If the ONLIN E LED blinks, contact Equinox Technical Support for assistance.

6. Check that the LINK LED is illuminated. If not, check the Ethernet cable to ensure that both ends are correctly inserted into their jacks. If the unit is connected to a 1 00 MB Ethernet hub, the 100MBps LED will be illuminated.

7. Once the POWER, ONLINE and LINK LEDs are illuminated, remove power from the CCM and proceed with the conﬁ guration process.

WARNING: The CCM840/1640 and all attached devices should be powered down before servicing the unit. Always disconnect the power cord from the wall outlet.

Configuring the CCM

To configure the CCM840/1640, you must enter a unique IP address and the network’s subnet mask. This information will be stored in the unit’s configuration database. During initial login, you will specify a password for the Admin user.

Chapter 2: Installation and Configuration 11

Configuring the IP address and subnet mask

You may use any of four methods to configure the CCM IP address and subnet mask: AVWorks, BootP, Telnet Command Line Interface (CLI) or the serial CLI on port 1.

These methods work as documented on most Windows

and UNIX® systems; however, the actual implementation on your system may differ from the instructions provided. Refer to your system administrator guide, or use AVWorks to simplify CCM configuration.

To conﬁ gure the IP address and subnet mask using AVWorks:

Using the AVWorks installation wizard is the easiest method to configure the CCM IP address and subnet mask. See the AVWorks Installer/User Guide for instructions. After the IP address and subnet mask are configured, see Initial CCM login in this chapter.

To conﬁ gure the IP address and subnet mask using BootP:

1. Ensure that there is a BootP server on your network that is conﬁ gured t o

correctly respond to a BootP request from the CCM. BootP servers require the Ethernet MAC address of network devices. The CCM Ethernet MAC address is located on the back of the unit. See your BootP server’s system administrator guide for information about conﬁ guring the BootP server.

2. After you have conﬁ gured your network’s BootP server with the CCM

Ethernet MAC address, IP address and subnet mask, restore power to the CCM and wait for the ONLINE LED to illuminate. Once this occurs, the CCM has completed the BootP protocol, obtained its IP address and subnet mask and stored these in FLASH.

3. You may verify that the BootP process was successful with a ping command,

which tests network connectivity. The ping command is entered as:

ping <ip_address>

For example, the following command tests the network connectivity of a

CCM with the IP address 192.168.0.5.

ping 192.168.0.5

4. If the CCM completes the BootP successfully, you will see a display similar

to the following.

Pinging 192.168.0.5 with 32 bytes of data: Reply from 192.168.0.5: bytes=32 time<10ms TTL=128 Reply from 192.168.0.5: bytes=32 time<10ms TTL=128 Reply from 192.168.0.5: bytes=32 time<10ms TTL=128 Reply from 192.168.0.5: bytes=32 time<10ms TTL=128

12 CCM840/1640 Installer/User Guide

If the CCM did not successfully obtain its IP address with the BootP

protocol, you will see a display similar to the following.

Pinging 192.168.0.5 with 32 bytes of data: Request timed out. Request timed out. Request timed out. Request timed out.

In this case, check the MAC address and IP address provided to the BootP

server to conﬁ rm they are correct. Verify that the Ethernet LAN adaptor cable is correctly installed on the CCM and the Ethernet hub.

After the IP address is configured successfully, launch a Telnet session to the CCM IP address. Then, see Initial CCM login in this chapter.

To conﬁ gure the IP address and subnet mask using a Telnet CLI:

1. Ensure that your server or workstation has a Telnet client and is located on the same LAN segment as the CCM.

2. Use the arp command to update the server or workstation with the CCM IP address and Ethernet MAC address. The CCM Ethernet MAC address is located on the back panel above the LAN connector. The arp command is entered as:

arp -s <ip_address> <mac_address>

For example, the following command assigns the IP address 192.168.0.5

and the Ethernet MAC address 00-80-7d-54-01-54 to the CCM.

arp -s 192.168.0.5 00-80-7d-54-01-54

On a UNIX platform, the MAC address may require colons (:) instead of

dashes (-), for example, 00:80:7d:54:01:54.

3. You may verify that you entered the information correctly by using an arp command with the -a option.

arp -a

This command shows all arp entries for the server or workst ation. S ee

your system administrator guide if you need additional help with the arp command.

4. After the above arp c ommand is ent ered c orrec t ly, launch a Telnet client to the assigned IP address. Then, continue with Initial CCM login in this chapter.

To conﬁ gure the CCM using the serial CLI:

1. By factory default, port 1 of the CCM is conﬁ gured for the serial CLI. To access the serial CLI, attach a compatible device to port 1. The compatible device types are: ASCII, VT52, VT100, VT102, VT220 and VT320.

Chapter 2: Installation and Configuration 13

Appendix B lists the required cables and adaptors. You may also use any

terminal emulation program that is available on your system.

2. Conﬁ gure your terminal or terminal emulation program as follows. Baud rate 9600

Bits per character 8 Parity None Stop bits 1 Flow control None

3. Press the Return or Enter key until a prompt appears, requesting your username. If you do not receive a prompt after pressing the key ﬁ ve t imes, check your cable and serial settings to be sure that they are correct.

4. Proceed to Initial CCM login in this chapter.

After you complete the CCM configuration, you may reconfigure the CLI on another port or disable it completely and use port 1 with an attached device. For more information, see Connecting to devices from the serial CLI port in Chapter 3.

Initial CCM login

The CCM ships with a single user defined in its user database. The first time you connect to the CCM via Telnet or serial CLI, you are prompted for a username.

To log in to the CCM for the ﬁ rst time:

1. At the Username prompt, type Admin. There is no factory default password for the Admin user. At the Password prompt, press Return.

Username: Admin Password: Authentication Complete CCM configuration is required.

2. Once authentication completes, the CCM prompts for any missing conﬁ guration values that are required for operation.

If you already provided the IP address and subnet mask, you will not be

prompted for those values again.

If you have not already provided the IP address and subnet mask, you will

be prompted for them. Enter the CCM IP address and subnet mask using standard dot notation.

CCM configuration is required Enter CCM IP address > 192.168.0.5 Enter CCM Subnet mask > 255.255.255.0

14 CCM840/1640 Installer/User Guide

3. You are prompted for a new Admin password. Passwords are case sensitive and must contain 3-16 alphanumeric characters. You must enter the new password twice to conﬁ rm that you entered it correctly.

Enter CCM New Admin Password > ***** Confirm New Admin Password > *****

After you have provided the required configuration information, a confirmation message appears while the CCM stores the values in its configuration database.

You have now completed the initial login, and you may enter additional commands at the CLI prompt (>). To configure CCM ports, see Configuring Serial Port Settings in Chapter 3.

Reinitializing the CCM

Reinitializing the CCM removes configured information. This may be useful when reinstalling the CCM at another location in your network.

The CCM stores configuration information in FLASH databases. During reinitialization, the FLASH erase has two phases. The first phase erases the CCM configuration database, which contains all nonvolatile data except the IP address. The second phase erases the IP address and restores the CCM to its factory default settings.

To reinitialize the CCM:

1. Locate the recessed INIT button on the front of the CCM. You will need a tool that ﬁ ts inside the recess, such as an opened paper clip.

2. Insert the tool in the recess, then depress and hold the button. The ONLINE LED will blink, indicating a CCM initialization has been requested. You have approximately seven seconds to release the button before any action is taken.

After seven seconds, the ONLINE LED will blink more rapidly to conﬁ rm

that the CCM conﬁ guration database has been erased. Continuing to hold the INIT button for a few more seconds will erase the IP address as well. The ON LIN E LED will blink faster to conﬁ rm the deletion.

If any portion of FLASH is erased, the CCM reboots when the INIT button is released.

Operations

Contents

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Configuring Serial Port Settings . . . . . . . . . . . . . . . 17

Connecting to Serial Devices . . . . . . . . . . . . . . . . . . 18

Managing User Accounts . . . . . . . . . . . . . . . . . . . . 28

Using Authentication Modes . . . . . . . . . . . . . . . . . . 31

Using Security Lock-out . . . . . . . . . . . . . . . . . . . . . 33

Managing the Port History Buffer . . . . . . . . . . . . . 34

Managing the CCM Using SNMP . . . . . . . . . . . . . 37

Chapter 3: Operations 17

Chapter 3: Operations

Overview

The CCM and its ports may be easily configured and managed to meet your requirements for device connection, user authentication, access control, power status monitoring, port history information display and SNMP compliance for use with third-party network management products.

Configuring Serial Port Settings

By default, CCM ports are configured with the following settings. Target device Console

Name xx-xx-xx Pn (last 3 octets of MAC address plus the port number) Baud rate 9600 Bits per character 8 Parity None Stop bits 1 Flow control None Time-out 15 minutes CLI access character Use Server CLI setting (^D) Power None

Most of these settings are standard serial port operating characteristics. The CLI access character parameter specifies how you access the CLI. For

more information, see CLI mode in this chapter. The Power parameter instructs the CCM to monitor the state of a specified

control signal. Signal transitions may be configured to trigger SNMP alerts. The parameter value indicates an inbound control signal (CTS, DCD or DSR) and the state of that signal (low or high). When the defined signal is true, the CCM interprets it as a power on condition for the attached device; when the signal is false, a power off condition for the device is assumed. The signal specified for flow control cannot be used for power control, and vice versa.

To conﬁ gure serial console port settings:

Issue a Port Set command. You may specify settings for one or all ports. PORT [<port>|ALL] SET [NAME=<name>] [BAUD=<baud>]

[SIZE=<size>] [PARITY=<parity>] [STOP=<stop_bits>] [FLOW=<ﬂ ow_ctrl>] [TIMEOUT=<time-out>] [SOCKET=<socket>] [CHAR=^<cli_char>] [TOGGLE=NONE|DTR] [POWER=<signal>] . . .

18 CCM840/1640 Installer/User Guide

For more information and descriptions of all valid parameters, see Port Set command in Chapter 5.

To display serial port settings:

Issue a Show Port command. SHOW PORT [<port>|ALL|NAMES]

When you request information about a port, the display includes configuration information, current power status (if power status monitoring has been enabled), plus transmit, receive and error counts. When you request information about a single port and a user is currently accessing that port, the display also includes the username, access rights and other information about the current session.

When you request information about port names, the display includes the port numbers and names. If a port’s name has not been changed with a Port Set command, the logical name is displayed.

For more information, see Show Port command in Chapter 5.

Connecting to Serial Devices

The CCM offers several methods for connecting to attached serial devices: Telnet, serial CLI, PPP and SSH.

Preemption

Depending on configured access levels, a user who is connecting to a port (the connecting user) may disconnect another user of equal or lower access (the current user).

If the connecting user’s access level is lower than the current user’s access level, the connecting user will receive an In Use message and the connection will be dropped.

If the connecting user’s access level is equal to or higher than the owning user’s access level, an In Use by owning user message will be displayed. The connecting user may then choose to preempt the current user’s session. If the current user’s session is preempted, an appropriate message is displayed.

For more information about access levels, see Access rights and levels in this chapter.

Chapter 3: Operations 19

Connecting to devices using Telnet

Each CCM serial port is directly addressable via a unique TCP port number that provides a connection to the attached serial device.

Plain text (non-encrypted) Telnet connections are enabled by default. For information about enabling both plain text Telnet and SSH connections, see Enabling plain text Telnet and SSH connections in this chapter.

To connect to a device using Telnet:

Type telnet, followed by the CCM IP address and the appropriate TCP port number, which by default is 3000 plus the physical port number, in decimal format. (The TCP port number may be changed for any CCM port.)

For example, the following Telnet command connects to the serial device attached to physical port 14 of a CCM1640.

telnet 192.168.0.5 3014

If an authentication method other than None has been configured for the CCM, you will be prompted for credentials (username and password). Once authentication completes, your connection is confirmed. When you successfully connect to the serial device, you will see a display similar to the following.

Username: Myname Password: ****** Authentication Complete Connected to Port: 14 9600,8,N,1,XON/XOFF

If the authentication method is configured as None, you may Telnet and connect to a serial device without entering credentials; however, credentials are always required when connecting to the CCM CLI.

Data entered at the Telnet client is written to the attached serial device. Any data received by the CCM from the serial device is output to your Telnet client.

You may access the CCM and its ports using Equinox-provided or third-party Telnet client applications. A cross-platform Telnet client is bundled with the AVWorks application. Third-party Telnet client applications may be used in combination with AVWorks or standalone.

You may connect using either SSH (AVWorks provides built-in support for SSH2) or plain text.

AVWorks Telnet

AVWorks is a cross-platform client application provided with each CCM. AVWorks provides a convenient way to select a CCM or attached device and

launch a Telnet session to manage it.

20 CCM840/1640 Installer/User Guide

AVWorks includes a built-in Serial Console Viewer Telnet application that offers several features not found in other Telnet clients. For maximum flexibility, AVWorks allows you to associate a unique Telnet client with each CCM port.

You may specify the built-in Telnet client or a third-party Telnet client. For more information, see the AVWorks Installer/User Guide.

Standalone third-party Telnet clients

You may use third-party Telnet clients to access the CCM directly without AVWorks management software.

Connecting to devices from the serial CLI port

By factory default, port 1 of the CCM is configured with the serial CLI, which prohibits the use of port 1 with an attached serial device. You may configure the CLI on a different port, but only one port may be configured as the serial CLI port at one time. For example, when you enable the CLI interface on port n, and it is already active on port p, then the CLI will automatically be disabled on port p.

You may connect to one serial device at a time through the serial CLI port using a local terminal or a local PC using a terminal emulation program. If you connect an external modem to the serial CLI port, you may also access devices through a remote terminal or PC that can dial into the CCM external modem. For information about modem connections, see Configuring and using dial-in connections in this chapter and Server CLI command in Chapter 5.

To conﬁ gure a port for the serial CLI:

1. Issue a Server CLI command, using the Port parameter to specify the CLI port and the Type parameter to specify the terminal type.

SERVER CLI PORT=<port> TYPE=<type>

2. To disable the CLI that was previously conﬁ gured on a port, issue a Server CLI command, indicating Type=Off.

For more information, see Server CLI command in Chapter 5.

To display CLI port information:

Issue a Show Server CLI command. SHOW SERVER CLI

The display includes the CLI port number and terminal type, plus the CLI access character. For more information, see Show Server CLI command in Chapter 5.

Chapter 3: Operations 21

To connect to a device from the serial CLI port:

1. Issue a Server CLI command, using the Connect parameter to enable the use of the Connect command from the serial CLI port.

SERVER CLI CONNECT=ON

2. Issue a Connect command to the desired port.

CONNECT <port>

3. To end a device session that was initiated with a Connect command, issue a Disconnect command.

DISCONNECT For more information, see Server CLI command, Connect Command and

Disconnect Command in Chapter 5.

Configuring and using dial-in connections

You may attach an external modem to the serial CLI port for dial-in serial CLI access to the CCM. This may be used as a backup connection if the unit is not accessible from the network. It may also be used as a primary connection at remote sites that do not have Ethernet network capability. The modem must be Hayes compatible.

To specify a modem initialization string:

1. Issue a Show Server CLI command to ensure that the port where the modem is connected has been deﬁ ned as the serial CLI port.

SHOW SERVER CLI

2. Issue a Server CLI command, using the Modeminit parameter to specify the modem initialization string.

SERVER CLI MODEMINIT=“<string>” The string must be enclosed in quotes and must include at least the

command settings ATV1 and SO=1, which cause the modem to issue verbose response strings and auto-answer the phone on the ﬁ rst ring. For more information, see Server CLI command in Chapter 5.

The modem initialization string is sent to the cabled modem when any of

the following conditions occur:

• CCM initialization

• Detection of a transition of DSR from low to high

• Completion of a call when DCD changes from high to low

3. Upon successful modem connection, press the Enter key until the login prompt appears.

22 CCM840/1640 Installer/User Guide

To display modem conﬁ guration information:

Issue a Show Server CLI command. SHOW SERVER CLI

For more information, see Show Server CLI command in Chapter 5.

Connecting to devices using PPP

The CCM supports remote PPP access using an auto-answer modem that answers calls. A dial-in client and the CCM establish the PPP protocol.

The PPP dial-in may be used to access a remote CCM that does not warrant a WAN (Wide Area Network) link to the Ethernet interface. In this case, the PPP connection allows a remote PC with Telnet capability to dial the CCM and then establish a Telnet connection to a CCM port.

The PPP dial-in may also be used to access a subnet containing remote CCM devices in the event of a WAN link failure. In this case, the PPP provides an alternate path to one or more remote CCM devices.

Once the PPP connection is established, you must launch an application that connects to the CCM or to one of its ports. The PPP connection is only a communications interface to the CCM.

The CCM implements a PPP server that uses CHAP (Challenge Authentication Protocol). Passwords are not accepted in the clear on PPP connections.

PPP is disabled by default.

To enable or disable a PPP server on the serial CLI port:

1. To enable a PPP server on the serial CLI port, issue a Show Server CLI command to ensure that a serial CLI port has been deﬁ ned.

SHOW SERVER CLI

2. Issue a Server PPP command with the Enable parameter.

SERVER PPP ENABLE LOCALIP=<local_ip> REMOTEIP=<rem_ip>

[MASK=<subnet>]

You must specify local and remote IP addresses to be used for the CCM

and client ends of the PPP connection respectively. You are prompted to conﬁ rm or cancel the changes. Enter Y to conﬁ rm or N to cancel.

3. To disable a PPP server, issue a S erver PPP command with the Disable parameter.

SERVER PPP DISABLE

Chapter 3: Operations 23

For more information, see Show Server CLI command and Server PPP command in Chapter 5.

To display PPP conﬁ guration information:

Issue a Show Server PPP command. SHOW SERVER PPP

For more information, see Show Server PPP command in Chapter 5.

Connecting to devices using SSH

The CCM supports version 2 of the SSH protocol (SSH2). The CCM SSH server operates on the standard SSH port 22. The shell for this connection provides a CLI prompt as if you had established a Telnet connection on port 23. The shell request for this connection is for CLI access.

Additional CCM SSH servers operate on TCP ports that are numbered with values 100 greater than the standard 30xx Telnet ports for the CCM. For example, if port 7 is configured for Telnet access on port 3007, then port 3107 will be a direct SSH connection for port 7. When SSH is enabled, Telnet port 23 connections will be accepted from other clients if the Server Security command includes Encrypt=SSH,None. Connecting to Telnet port 23 may be

tunneled via a connection to SSH port 22.

SSH server keys

When SSH is enabled for the first time, the CCM generates an SSH server key. The key generation process may take up to ten minutes. The key is computed at random and is stored in the CCM configuration database.

In most cases, the SSH server key should not be modified because most SSH clients will associate the key with the IP address of the CCM. During the first connection to a new SSH server, the client will display the fingerprint of the SSH server key and prompt you to indicate if you wish to store it on the SSH client. After the first connection, most SSH clients will validate the key when connecting to the CCM. This provides an extra layer of security because the SSH client can verify the key sent by the server each time it connects.

If you disable SSH and later reenable it, you may either use the existing server key or compute a new one. If you are reenabling the same server at the same IP address, it is recommended that you use the existing key, as SSH clients may be using it for verification. If you are moving the CCM to another location and changing the IP address, you may wish to generate a new SSH server key.

24 CCM840/1640 Installer/User Guide

Authenticating an SSH user

SSH is enabled and disabled with the Server SSH command. When you enable SSH, you may specify the authentication method(s) that will be used for SSH connections. The method may be a password, an SSH key or both. A user’s password and SSH key are specified with a User Add or User Set command. All SSH keys must be RSA keys. DSA keys are not supported.

The following table lists and describes the valid SSH authentication methods that may be specified with a Server SSH command.

SSH Authentication Methods

Method Description

PW (default) SSH connections will be authenticated with a username/

KEY SSH connections will be authenticated with an SSH key. With this

PW|KEY or KEY|PW SSH connections will be authenticated with either a username/

password. With this method, a user’s deﬁ nition must include a valid password in order for that user to authenticate an SSH session. A password may authenticate to a RADIUS server or to the local user database.

method, a user’s deﬁ nition must include valid SSH key information in order for that user to authenticate an SSH session. Key authentication is always local; RADIUS is not supported. For more information, see SSH user keys in this chapter.

password or an SSH key. If a user has only a password deﬁ ned, that user must authenticate an SSH session with a username/password. If a user has only an SSH key deﬁ ned, that user must authenticate an SSH session using the key. If a user has both a password and an SSH key deﬁ ned, that user may use either a username/password or the SSH key to authenticate an SSH session. This method allows the CCM administrator to deﬁ ne how each user will authenticate an SSH session based on information provided in the User Add/Set command.

PW authentication will be local or RADIUS as speciﬁ ed in the Auth parameter of the Server Security command. Key authentication is always local.

PW&KEY or KEY&PW SSH connections will be authenticated using both a username/

password and an SSH key. With this method, a user’s deﬁ nition must include a password and SSH key information for that user to authenticate an SSH session.

PW authentication will be local or RADIUS as speciﬁ ed in the Auth parameter of the Server Security command. Key authentication is always local.

A user’s access rights are determined from the authentication method used. SSH key authentication always uses the access rights from the local user database. Depending on the server authentication mode specified with the

Chapter 3: Operations 25

Server Security command, SSH password authentication will use either the access rights from the local user database or the values returned by the RADIUS server.

With either of the “or” methods (PW|KEY and KEY|PW), the user access rights are determined from the method used to authenticate the user.

With either of the “and” methods (PW&KEY and KEY&PW), the user access rights are determined from the first method specified. If PW&KEY is specified, the access rights from the password authentication will be used. If KEY&PW is specified, the access rights from the key authentication will be used.

For more information, see Using Authentication Modes in this chapter.

SSH user keys

A user’s SSH key is specified in a User Add or User Set command. You may define a key even if SSH is not currently enabled. The key may be specified in one of two ways:

• When using the SSHKEY and FTPIP keyword pair to deﬁ ne the network location of a user’s SSH key ﬁ le, the SSHKEY parameter speciﬁ es the name of the uuencoded (UNIX to UNIX encoded) public key ﬁ le on an FTP server. The maximum ﬁ le size that can be received is 4K bytes. The FTPIP parameter speciﬁ es the FTP server’s IP address.

When this method is speciﬁ ed, the CCM initiates an FTP client request to

the speciﬁ ed IP address. The CCM then prompts the user for an FTP user- name and password for connection. When connected, the CCM will GET the speciﬁ ed key ﬁ le and the FTP connection will be closed. The CCM then stores the SSH key with the username in the CCM user database.

• When using the KEY keyword to specify the SSH key, the KEY param- eter speciﬁ es the act ual uuenc oded SSH key. This is for c onﬁ gurations that do not implement an FTP server. The CCM st ores t he spec iﬁ ed key in the CCM user database.

The CCM processes a uuencoded SSH2 public key file with the format described in the IETF document draft-ietf-secshpublickeyfile-02. The key must follow all format requirements. The UNIX ssh-keygen2 generates this file format. The CCM also processes a uuencoded SSH1 public key file. The UNIX ssh-keygen generates this file format.

You may also generate SSH user keys via AVWorks. See the AVWorks Installer/ User Guide.

26 CCM840/1640 Installer/User Guide

To enable SSH session access to the CCM:

1. Issue a Show Server Security command to ensure that you are using an authentication method other than None.

SHOW SERVER SECURITY

2. Issue a Server SSH command with the Enable parameter. You may also specify an authentication method.

SERVER SSH ENABLE AUTH=<auth> If an authentication method is not speciﬁ ed, the previous authentication

parameter will be used. The default value is AUTH=PW.

3. If you are enabling SSH for the ﬁ rst time, you are advised that all other CCM sessions will be terminated. Enter Y to continue or N to cancel.

4. If you are reenabling SSH, you are prompted to use the existing SSH server key or generate a new key. Enter Y to use the existing key or N to generate a new key.

For more information, see Server SSH command in Chapter 5.

To disable SSH session access to the CCM:

Issue a Server SSH command with the Disable parameter. SERVER SSH DISABLE When SSH is disabled, the CCM operates in plain text mode.

To display SSH information:

Issue a Show Server Security command. SHOW SERVER SECURITY If SSH is enabled, the display will include SSH2. Regardless of whether SSH is

enabled, the display will indicate the authentication method that was speciﬁ ed with the Server SSH command.

Enabling plain text Telnet and SSH connections

Plain text (non-encrypted) Telnet connections are enabled by default. If you enable SSH connections using the Server Security command and the

Encrypt=SSH parameter, plain text Telnet connections will be disabled. However, if you enable SSH connections with the Server SSH command, both plain text and SSH connections will be allowed.

Chapter 3: Operations 27

To enable both Telnet and SSH connections:

Issue a Server Security command, indicating Encrypt=SSH,None.

Telnet CLI mode

While you are connected to an attached serial device, you may enter CLI mode and enter CCM commands.

To enter or exit CLI mode when connected to a serial device:

1. To enter CLI mode, type the CLI access character, which is Ctrl-D by default. At the CLI prompt (>), you may enter CCM commands.

2. To exit CLI mode and return to the session with the attached device, issue a Resume command.

RESUME For more information, see Resume Command in Chapter 5.

To change the CLI access character:

Issue a Server CLI command or a Port Set command, using the Char parameter to specify the CLI access character.

SERVER CLI CHAR=^<char>

- or PORT SET CHAR=^<char>

If you issue a Port Set command with Char=None, then the CLI access character specified in the Server CLI command will be used. The Port Set command may be used to override the Server CLI access character on a per-port basis. For more information, see Server CLI command and Port Set command in Chapter 5.

To display CLI access character information:

Issue a Show Server CLI command. SHOW SERVER CLI

For more information, see Show Server CLI command in Chapter 5.

Ending device sessions

To end your device session:

Enter CLI mode and issue a Quit command or a User Logout command. QUIT

28 CCM840/1640 Installer/User Guide

- or If you initiated the device session with a Connect command, enter CLI mode

and issue a Disconnect command. DISCONNECT

- or Allow the port to time-out due to inactivity. In this case, a notification message is issued and the serial CLI session returns to CLI mode. This time-out may occur while you are in CLI mode.

- or For modem connections, if a carrier drop occurs, the serial CLI session is automatically logged off.

Session time-outs

The CCM monitors data traffic when you are connected to an attached serial device. You may specify a time-out value with the Server CLI command. You may also specify a time-out value for each port with the Port Set command. When no data is received from the connected user for the configured number of minutes, the connection is terminated.

The following time-out values are used:

• For a Telnet session, the Server CLI time-out value is used.

• For a serial port session, if the port’s conﬁ gured time-out value is Ø, the Server CLI time-out value is used, even if it is also Ø.

• For a serial port session, if the port’s conﬁ gured time-out value is non-Ø,

that value is used.

Managing User Accounts

The CCM user database may store information for up to 64 user accounts.

To add a user:

Issue a User Add command. USER ADD <username> [PASSWORD=<pwd>] [SSHKEY=<keyﬁ le>]

[FTPIP=<ftpadd>] [KEY=<sshkey>] [ACCESS=<access>]

You must specify a username. You must also specify a password or SSH user key information, or you may specify both. You may also include an access level or access rights. For more information, see Connecting to devices using SSH and Access rights and levels in this chapter and User Add command in Chapter 5.

Chapter 3: Operations 29

To change a user’s conﬁ guration information:

Issue a User Set command. USER SET <username> [PASSWORD=<pwd>] [SSHKEY=<keyﬁ le>]

[FTPIP=<ftpadd>] [KEY=<sshkey>] [ACCESS=<access>]

You may change your own password at any time. You must have USER access rights to change another user’s password or to change any user’s SSH user key information and access rights.

To remove an SSH user key or password, specify Key=“” or Password=“”. You cannot remove both the password and the SSH key from a user’s definition; one must remain in the user database. Also, you cannot remove a user’s key or password if that removal would result in no valid users having USER access rights.

For more information, see Connecting to devices using SSH and Access rights and levels in this chapter and User Set command in Chapter 5.

To end another user’s CCM session:

Issue a User Logout command. USER LOGOUT <username> A message is sent and the Telnet or SSH connection is dropped. For more

information, see User Logout command in Chapter 5.

To delete a user:

Issue a User Delete command. USER DELETE <username>

If the specified user is currently logged in, a message is sent to the user indicating that access is no longer permitted, and the user’s Telnet session is terminated. For more information, see User Delete command in Chapter 5.

To display user conﬁ guration information:

1. To display information about one user, issue a Show User command, specifying the username.

SHOW USER <username>

2. To display information about all users, issue a Show User command with the All parameter.

SHOW USER ALL

30 CCM840/1640 Installer/User Guide

For more information, see Show User command in Chapter 5.

Access rights and levels

Most CCM commands require the user to have access rights to use the commands. The access rights for each CCM command are listed in Chapter 4. The following table describes the access rights a user may be given.

Access Rights

Access Right Description

PCON The Port Conﬁ guration access right should be given to users who

SCON The Server Conﬁ guration access right should be given to users

SMON The Server Monitor access right should be given to users who need

USER The User access right should be given to users who need to modify

BREAK The Break access right allows users to send a serial break sequence

P The Port access right gives users access to one or more serial ports.

must modify port settings. Grant PCON access rights only to users who need to issue the Port Set command.

who must change the CCM conﬁ gurations, including setting the IP address and updating the CCM program load in FLASH. Grant SCON access only to users who need to administer the CCM.

to view CCM status and monitor serial port activity. Grant SMON access only to users who need to assist other users in accessing attached serial devices.

the user database. Grant USER access only to users who must add, change or delete user accounts. At least one user must have USER access rights; otherwise, the user database cannot be changed.

to the attached serial device. On certain devices, this sequence has a special meaning. Grant BREAK access only to users who need to use the Port Break command.

This confers the right to access that serial port and connect to the attached serial device. You may grant Port access rights to speciﬁ c ports (Pn), a range of ports (Px-y) or all ports (PALL).

The Admin user is preconfigured in the user database with all access rights.

Access levels

When you specify a user’s access rights, you may either specify the individual rights or you may use a shortcut that specifies an access level. The APPLIANCEADMIN and ADMIN levels (which are used in AVWorks in lieu of individual specifications other than port access rights) are equivalent to the following individual specifications:

• The APPLIANCEADMIN level is equivalent to PALL, USER, SCON, SMON, PCON and BREAK.

• The ADMIN level is equivalent to PALL, USER, SMON, PCON and BREAK.

Chapter 3: Operations 31

A user’s access level may be used for preemption. For example, assume User A is connected to a port. User B tries to connect to the same port. If User B has an access level equal to or greater than User A’s access level, then User B will be given the option of preempting User A.

To manage a user’s access rights/level:

1. To conﬁ gure a user’s access rights/level, issue a User Add command, using the Access parameter to specify the rights or a level.

USER ADD <username> ACCESS=<access>

2. To change a user’s access rights/level, issue a User Set command, using the Access parameter to specify the rights or a level.

USER SET <username> ACCESS=<access>

3. To display the access rights and level for one or all users, issue a Show User command.

SHOW USER <username>|ALL For more information, see Managing Users in this chapter, plus User Add

command, User Set command and Show User command in Chapter 5.

Using Authentication Modes

The CCM supports several methods for authenticating users: RADIUS, local and none. Multiple connection and authentication methods may operate concurrently. By default, authentication is done at the local CCM user database.

Local authentication

Local authentication uses the CCM internal user database to authenticate users.

RADIUS authentication

RADIUS authentication uses an external third-party RADIUS server containing a user database to authenticate CCM users. The CCM, functioning as a RADIUS client, sends usernames and passwords to the RADIUS server. If a username and password do not agree with equivalent information on the RADIUS server, the CCM is informed and the user is denied CCM access. If the username and password are successfully validated on the RADIUS server, the RADIUS server returns an attribute that indicates the access rights defined for that username.

To use RADIUS authentication, you must specify information about the primary RADIUS server and optionally, a secondary RADIUS server to be used as a backup.

32 CCM840/1640 Installer/User Guide

The RADIUS server definition values specified in CCM commands must match corresponding values configured on the RADIUS server. On the RADIUS server, you must include CCM-specific information: the list of valid users and their access rights for the CCM. Each user-rights attribute in the RADIUS server’s dictionary must be specified as a string containing the user’s access rights for the CCM, exactly matching the syntax used in the CCM User Add command.

Consult your RADIUS administrator’s manual for information about specifying users and their attributes. The exact process depends on the RADIUS server you are using.

No authentication

When authentication is disabled, users are not authenticated. Telnet sessions to serial ports are accepted immediately, and users are not prompted for a username or password. In this case, users are granted access only to the port to which they are connected, including Break access.

Connections to the Telnet port (23), serial CLI and PPP are still authenticated, even when authentication is expressly disabled. Generally, these communications paths are used only by administrators, and authentication is enforced in order to establish appropriate access rights.

Authentication may not be disabled when SSH session access is enabled.

Authentication summary

The CCM allows concurrent use of multiple authentication modes. This allows Telnet and SSH clients to all access a single CCM as long as the appropriate values are enabled.

You may optionally specify both RADIUS and local authentication, in either order. In this case, authentication will be attempted initially on the first method specified. If that fails, the second method will be used for authentication.

For example, if you enable local and RADIUS authentication (in that order), authentication uses the CCM user database. If that fails, authentication goes to the defined RADIUS servers. If you enable RADIUS and local authentication (in that order), authentication goes first to the defined RADIUS servers. If that fails, the local user database is used.

To specify the authentication mode:

1. For RADIUS authentication, issue a Server RADIUS command. SERVER RADIUS PRIMARY|SECONDARY IP=<radius_ip>

SECRET=<secret> USER-RIGHTS=<attr> [AUTHPORT=<udp>] [TIMEOUT=<time-out>] [RETRIES=<retry>]

Chapter 3: Operations 33

You must specify the server’s IP address, the UDP port to be used and a

“secret” to be used. You must also specify a user-rights attribute value that matches a value in the RADIUS server’s dictionary.

You may also use this command to delete a RADIUS server deﬁ nition. SERVER RADIUS PRIMARY|SECONDARY DELETE

For more information, see Server RADIUS command in Chapter 5.

2. Issue a Server Security command, using the Authentication parameter to specify the authentication mode. Use the Encrypt parameter to enable plain text Telnet connections, SSH connections or both.

SERVER SECURITY AUTHENTICATION=<auth_mode>

ENCRYPT=<conns>

3. You are prompted to sav e the information. Enter Y to co n ﬁ rm or N to cancel.

To display authentication conﬁ guration information:

1. Issue a Show Server Security command.

SHOW SERVER SECURITY The display includes the current CCM authentication settings that were

conﬁ gured with the Server Security command. If SSH access has been enabled, the display indicates SSH2. Regardless of whether SSH is enabled, the display includes the authentication method speciﬁ ed with the Server SSH command.

2. To display CCM RADIUS settings that were conﬁ gured with the Server RADIUS command, issue a Show Server RADIUS command.

SHOW SERVER RADIUS For more information, see Server Security command, Show Server Security

command and Show Server RADIUS command in Chapter 5, plus Connecting to devices using SSH and Enabling plain text Telnet and SSH connections in

this chapter.

Using Security Lock-out

When the Security Lock-out feature is enabled, a user will be locked-out after five consecutive authentication failures. A successful authentication will reset the counter to zero. You may configure a lock-out period of from 1-99 hours. Specifying a lock-out period of Ø disables the feature; that is, users will not be locked-out.

34 CCM840/1640 Installer/User Guide

A locked-out user will remain locked-out until the specified time elapses, the CCM is power-cycled or the user is unlocked by an administrator with the User Unlock command.

A user with the ADMIN access level may unlock all users except a user with the APPLIANCEADMIN level. A user with the APPLIANCEADMIN level may unlock all users.

To enable or disable Security Lock-out:

1. To enable Security Lock-out, issue a Server Security command, using the Lockout parameter with a value between 1-99.

2. To disable Security Lock-out, issue a Server Security command, using the Lockout=Ø parameter.

To unlock a locked-out user:

Issue a User Unlock command with the username.

Managing the Port History Buffer

Each CCM serial port has a circular history buffer that contains the latest 64K bytes of data received from the attached serial device. This information may be helpful in analyzing attached device anomalies.

The history buffer begins filling with received data upon completion of CCM initialization, even if no user is connected. When you connect to a serial port, the data that was received from the attached serial device prior to the connection is available in the buffer. Once online, new data continues to be stored in the buffer. You may choose whether to display the history buffer’s content automatically when you connect and whether to keep or discard the history buffer’s content at the end of a session.

When more than 64K bytes of data are sent to the history buffer, data at the top of the buffer is discarded to make room for the new data. As a result, the buffer always contains the most recent 64K bytes of port history.

Using port history mode commands

Once you issue a Port History command to enter port history mode, you may issue the commands listed in the following table. Only the first letter of the command is required.

Chapter 3: Operations 35

Port History Mode Commands

Command Description Bottom B sets the view location to the bottom of the ﬁ le minus 23 history

display lines, if available.

Clear C clears the port history buffer. Next N increments the current history display line by the number of lines

per page and outputs a new history display page.

Prev P decrements the current history display line by the number of lines

per page and outputs a new history display page.

Quit Q returns to the normal CLI. Resume R leaves port history mode and CLI mode and resumes the session

with the attached serial device. This single command is equivalent to sequentially using the Quit and Resume commands.

Search S searches the port history buffer for a speciﬁ ed text string. Search

strings with embedded spaces must be enclosed in quotes. By default, the search is case sensitive. To ignore case, enter -i before

the string. To specify direction, type line toward the top of the buffer or line toward the bottom of the buffer. The search direction remains in effect for subsequent searches until you change the search direction.

If the string is found, the current history display line is set to the line containing the string, and the CCM outputs a history display page. If the string is not found, an error message is displayed, no other information is output and the current history display line is not changed.

Entering the Search command with no parameters searches again for the previous string in the same direction as the previous search.

Top T sets the current history display line to one and outputs a history

display page.

-u to search up from the current

-d to search down from the current

The following examples assume the user is in port history mode. The following command searches the history buffer in the upward direction

for the string Abort Process.

PORT HISTORY> s -u “Abort Process”

The following command searches the history buffer for the string Process, ignoring case.

PORT HISTORY> s -i Process

For more information, see Server CLI command and Port History command in Chapter 5.

36 CCM840/1640 Installer/User Guide

To access port history mode:

Issue a Port History command. PORT HISTORY

The PORT HISTORY > prompt appears.

To control the port history buffer display when you connect:

Issue a Server CLI command, using the History parameter to specify the Hold or Auto option:

SERVER CLI HISTORY=HOLD|AUTO

• If Hold is speciﬁ ed, the number of bytes in the history buffer is displayed, but none of the history data is output. In this case, you must access the CLI and use the Port History command to view the port’s history buffer content. This is the default mode.

• If Auto is speciﬁ ed, the number of bytes in the history buffer is displayed and the entire content of the buffer is output to the Telnet session. In this mode, the history buffer’s content may be reviewed in the Telnet client’s scrolling window. You may also use the Port History command to view the

port’s history buffer content.

To control the port history buffer content when you end a session:

Issue a Server CLI command, using the History parameter to specify the Clear or Keep option:

SERVER CLI HISTORY=CLEAR|KEEP

• If Clear is speciﬁ ed, the port history buffer is cleared and all data is discarded at the end of a session.

• If Keep is speciﬁ ed, the port history buffer’s content is retained at the end of a session.

To clear and discard all data in a port history buffer:

Issue a Clear command while you are in port history mode. CLEAR

- or -

Issue a Server CLI command, indicating History=Clear. SERVER CLI HISTORY=CLEAR In this case, the port’s history buffer is cleared at the end of each device session.

Chapter 3: Operations 37

Managing the CCM Using SNMP

The CCM provides a set of commands that create and manage SNMP structures for use by third-party network management products. These commands cover the following operations:

• Enabling and disabling SNMP UDP port 161 SNMP processing

• Deﬁ ning read, write and trap community names

• Deﬁ ning and deleting up to four SNMP management entity IP addresses

• Enabling and disabling SNMP traps

• Deﬁ ning and deleting up to four trap destination IP addresses

• Deﬁ ning, copying and deleting up to ten alert strings for each port

SNMP is disabled by default.

To enable or disable SNMP processing:

1. To enable SNMP processing, issue a Server SNMP command with the Enable parameter. This is the default setting.

SERVER SNMP ENABLE

2. To disable SNMP processing, issue a Server SNMP command with the Disable parameter.

SERVER SNMP DISABLE For more information, see Server SNMP command in Chapter 5.

To specify SNMP community names:

Issue a Server SNMP Community command, using the Readcomm, Writecomm and Trapcomm parameters to specify community names.

NOTE: The default community names are “public”; if you enable SNMP, you are encouraged to change the community values to prevent access to the MIB.

SERVER SNMP COMMUNITY READCOMM=<name>

WRITECOMM=<name> TRAPCOMM=<name>

Although all three community names default to public, if you specify a trap community name with this command, it must be different from the read and write community names.

For more information, see Server SNMP Community command in Chapter 5.

38 CCM840/1640 Installer/User Guide

To add or delete SNMP management entity addresses:

1. To add an SNMP management entity address, issue a Server SNMP Manager command with the Add parameter and the management entity’s IP address. You may deﬁ ne up to four SNMP management entity addresses, using separate commands.

SERVER SNMP MANAGER ADD <ip_address> When you deﬁ ne at least one SNMP manager , SNMP requests are processed

if they are from one of the deﬁ ned SNMP managers. If a request is not from one of the deﬁ ned SNMP managers, the SNMP request is discarded.

2. To delete an SNMP management entity address, issue a Server SNMP Manager command with the Delete parameter and the management entity’s IP address.

SERVER SNMP MANAGER DELETE <ip_address> If no management entities are defined, any SNMP manager may access the

MIB. For more information, see Server SNMP Manager command in Chapter 5.

To enable or disable SNMP traps:

1. To enable SNMP traps, issue a Server SNMP Trap command with the Enable parameter.

SERVER SNMP TRAP ENABLE The CCM will display a numbered list of traps that are currently disabled

with a prompt requesting you to select trap(s) to enable. Indicate the traps to be enabled by entering a trap’s list number, several numbers separated by commas, a range of numbers separated by a dash or a combination of numbers with commas and dashes. To enable all traps, type ALL. To cancel the command, press Enter.

- or To enable all SNMP traps, issue a Server SNMP Trap command with the Enable and All parameters. In this case, the numbered list is not displayed.

SERVER SNMP TRAP ENABLE ALL

2. To disable SNMP traps, issue a Server SNMP Trap command with the Disable parameter.

SERVER SNMP TRAP DISABLE The CCM will display a numbered list of traps that are currently enabled

with a prompt requesting you to select trap(s) to disable. Indicate the traps to be disabled by entering a trap’s list number, several numbers separated by commas, a range of numbers separated by a dash or a combination of numbers with commas and dashes. To disable all traps, type ALL. To cancel the command, press Enter.

Chapter 3: Operations 39

- or To disable all SNMP traps, issue a Server SNMP Trap command with the

Disable and All parameters. In this case, the numbered list is not displayed. SERVER SNMP TRAP DISABLE ALL For more information, see Server SNMP Trap command in Chapter 5. The

Equinox web site www.equinox.com/support describes the supported traps.

To add or delete SNMP trap destination addresses:

1. To add an SNMP t rap dest ination address, issue a S erver S NMP Trap

Destination command with t he Add parameter and the dest ination’s

IP address. You may deﬁ ne up t o four dest ination addresses, using

separate commands. SERVER SNMP TRAP DESTINATION ADD <ip_address>

2. To delete an S NM P t rap dest ination address, issue a S erver SNM P Trap

Destination command with t he Delet e paramet er and t he dest ination’s

IP address. SERVER SNMP TRAP DESTINATION DELETE <ip_address> For more information, see Server SNMP Trap Destination command in Chapter 5.

To add, copy or delete port alert strings:

1. To add a port alert string, issue a Port Alert Add command, specifying the

port number and a 3-32 character string. You may deﬁ ne up to ten strings

for each port, using separate commands. The alert string will only generate

a trap if the portAlert trap is enabled with a Server SNMP Trap command. PORT <port> ALERT ADD “<string>”

2. To delete a port alert string, issue a Port Alert Delete command, specifying

a port number. PORT <port> ALERT DELETE

The CCM displays a numbered list of alert strings that have been deﬁ ned

for the speciﬁ ed port with a prompt requesting you to select alert string(s)

to delete. Indicate the alert strings to be deleted by entering an alert

string’s list number, several numbers separated by commas, a range of

numbers separated by a dash or a combination of numbers with commas

and dashes. To delete all alert strings, type ALL. To cancel the command,

press Enter.

3. To copy the deﬁ ned alert strings from one port to another port, issue a Port

Alert Copy command, specifying the port numbers to be copied to and from. PORT <to_port> ALERT COPY <from_port>

40 CCM840/1640 Installer/User Guide

At the conﬁ rmation prompt, press Y to conﬁ rm or N to cancel. When the

copy operation occurs, all previously deﬁ ned strings on the port to which you are copying will be replaced.

For more information, see Port Alert Add command, Port Alert Copy command and Port Alert Delete command in Chapter 5.

To display SNMP conﬁ guration information:

Issue a Show Server SNMP command. SHOW SERVER SNMP

The display includes information specified with the Server SNMP, Server SNMP Community, Server SNMP Manager, Server SNMP Trap and Server SNMP Trap Destination commands.

For more information, see Show Server SNMP command in Chapter 5.

To display port alert string information:

Issue a Show Port Alert command, specifying a port number. SHOW PORT <port> ALERT

The display lists all the port’s defined alert strings. For more information, see Show Port Alert command in Chapter 5.

Using CCM Commands

Contents

Accessing the CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Entering Commands . . . . . . . . . . . . . . . . . . . . . . . . 43

Understanding Conventions . . . . . . . . . . . . . . . . . . 44

Command Summary . . . . . . . . . . . . . . . . . . . . . . . . 46

Chapter 4: Using CCM Commands 43

Chapter 4: Using CCM Commands

Accessing the CLI

You may access the CLI in three ways: using the Telnet CLI, using the serial CLI or entering the CLI access character during a session to a serial device. When the CLI is accessed, its prompt appears (>), indicating you may type a command.

Entering Commands

At the command prompt, type a command and then press Return or Enter. When the key is pressed, the command line comprises all characters to the left of the cursor. The character at the cursor and any characters to the right of the cursor are ignored. The following table lists the line editing operations for VT100 compatible devices.

Line Editing Operations for VT100 Compatible Devices

Operation Action Backspace The character immediately before the cursor is erased and all text at

and to the right of the cursor moves one character to the left.

Left Arrow If the cursor is not at the beginning of the line, the cursor moves one

character to the left. If the cursor is at the beginning of the line, no action is taken.

Right Arrow If the cursor is not at the end of the line, the cursor moves one

character to the right. If the cursor is at the end of the line, no action is taken.

Up Arrow The CLI maintains a buffer containing the last 16 typed command

lines. If there is a previous command line, it will be output as the current command line and may be edited. If there is no previous command line in the command line buffer, the command line is set to blanks and you may enter a new command.

Down Arrow The next command in the CLI command line buffer is made available

for edit. If there is no next command line, the command line is set to blanks and you may enter a new command.

Delete The character at the cursor position is deleted and all characters to

the right of the cursor position are moved left one character.

The following table lists the line editing operations for ASCII TTY devices. There is no command line buffer available on an ASCII TTY device.

Line Editing Operations for ASCII TTY Devices

Operation Action Backspace Erases the last character typed. Esc Erases the current command line.

44 CCM840/1640 Installer/User Guide

When commands take effect

Each command is completely processed before the next command may be entered. Some commands prompt for confirmation before they are processed. In these cases, you must confirm or cancel by entering Y or N respectively.

If you enter a Server FLASH command or if you change the CCM IP address with a Server Set command, a CCM reboot is required before the change becomes effective. In these cases, the CCM database is updated when you enter the command and you are prompted that the change will not take effect until the CCM reboots. You may choose to reboot at that time, or you may decline. When the CCM reboots, your session and all other sessions on the CCM are terminated.

Understanding Conventions

This section describes the parts of a CCM command and the conventions used in this document to describe a command’s syntax.

Command syntax

A command may have four types of syntax: positional commands, positional parameters, keyword parameters and keyword values. The following examples demonstrate the syntax types.

The following Set Port command changes the baud rate and flow control settings for port 2.

> PORT 2 SET BAUD=57600 FLOW=XONXOF

Command Syntax Types in Example Command

Value Syntax

PORT Positional command. 2 Positional parameter that indicates the port number for the command. SET Positional command that indicates port settings are to be changed. BAUD Keyword parameter, which is always followed by an equal (=) sign. 57600 Keyword value indicating the baud rate value for the BAUD

keyword parameter. FLOW Keyword parameter, which is always followed by an equal (=) sign. XONXOF Keyword value.

Not every command will contain all syntax types. For example, the following command reboots the CCM.

>SERVER REBOOT

Chapter 4: Using CCM Commands 45

In this case, both SERVER and REBOOT are positional commands. In most cases, one or more spaces separate positional commands, positional

parameters and keyword parameters. For most positional commands, positional parameters or keyword parameters,

you only need to enter the first three characters. The exceptions are:

• When you specify a terminal type with the Type parameter in the Server CLI command, you must enter all characters.

• When you specify an authentication method with the Auth parameter in the Server SSH command, you must enter all characters.

• When you specify control signal monitoring with the Power parameter in the Port Set command, you must enter all characters.

With the exception of usernames and passwords, commands are not case sensitive; they may be entered in uppercase, lowercase or a combination. For example, all of the following commands are correct.

> PORT 2 SET BAUD=57600 FLOW=XON > POR 2 SET BAU=57600 FLOW=XON > por 2 Set Baud=57600 flow=xon > port 2 set baud=57600 flow=xon

NOTE: Usernames and passwords are case sensitive. These values are stored exactly as you enter them. For example, the username “Ann” must be entered with an uppercase “A” and all other letters lowercase. The username “ANN” will not be accepted by the CCM as the username “Ann.” Usernames and passwords must contain 3-16 alphanumeric characters.

Any syntax errors are displayed, and where applicable, the error is underlined. In the following example, the keyword parameter “baud” is misspelled. Even if

more than three characters are entered, they must all be correct.

> port 2 Set Baux=57600 flow=xon

---ERR 26 - SET keyword parameter invalid

In the following example, the keyword value “576” is not valid. Numeric keyword values must be fully specified and may not be shortened to three characters.

> POR 2 SET BAUD=576 FLOW=XON

--ERR 27 - SET keyword value invalid

46 CCM840/1640 Installer/User Guide

In the following example, there are spaces between BAUD, the equal sign and the value 57600. Spaces are not permitted between keyword parameters and their values.

> POR 2 SET BAUD = 57600 FLOW=XON

-----------ERR 26 - SET keyword parameter invalid

Syntax conventions

This manual uses the following command syntax conventions:

• Brackets [ ] surround optional keywords and values.

• Angle brackets < > surround user-supplied positional parameters and

keyword parameter values.

• In most cases, choices are separated by a vertical bar |. The description indicates if you may specify more than one of the choices and how to separate multiple values. The exception is the Server SSH command. In this case, the vertical bar is speciﬁ ed on the command line when you enable the “password or key” method (PW|KEY) or the “key or password” method (KEY|PW).

Command Summary

The following table lists the CCM commands, including a brief description plus the required access rights and level.

CCM Command Summary

Command Description, Access Right and Access Level

Connect Accesses devices from the serial CLI port.

Access right: port-speciﬁ c Access level: ADMIN or APPLIANCEADMIN **

Disconnect Ends a device session initiated with Connect command.

Access right: port-speciﬁ c Access level: ADMIN or APPLIANCEADMIN **

Help Displays information about commands.

Access right: none needed Access level: all

Port Alert Add Adds a port alert string.

Access right: SCON or PCON Access level: ADMIN or APPLIANCEADMIN

Port Alert Copy Copies a port’s alert strings to another port.

Access right: SCON or PCON Access level: ADMIN or APPLIANCEADMIN

** Users who do not have the ADMIN or APPLIANCEADMIN level must have the appropriate port access conﬁ gured to issue this command.

Chapter 4: Using CCM Commands 47

CCM Command Summary (Continued)

Command Description, Access Right and Access Level

Port Alert Delete Deletes one or more port alert strings.

Access right: SCON or PCON Access level: ADMIN or APPLIANCEADMIN

Port Break Sends a break signal to the attached device.

Access right: BREAK Access level: ADMIN or APPLIANCEADMIN

Port History Accesses the port history buffer.

Access right: none needed Access level: all

Port Logout Terminates the CCM session on a speciﬁ ed port.

Access right: USER Access level: ADMIN or APPLIANCEADMIN

Port Set Changes port settings.

Access right: SCON or PCON Access level: ADMIN or APPLIANCEADMIN

Quit Terminates the current CCM session.

Access right: none needed Access level: all

Resume Resumes device connection after being in CLI mode.

Access right: none needed Access level: all

Server CLI Speciﬁ es the serial CLI port, port type and access

character; enables/disables device connection from the CLI port; speciﬁ es a modem initialization string; speciﬁ es port history mode operations and a port time-out value. Access right: SCON Access level: APPLIANCEADMIN

Server FLASH Updates the CCM FLASH.

Access right: SCON Access level: APPLIANCEADMIN

Server PPP Enables/disables a PPP server on the serial CLI port.

Access right: SCON Access level: APPLIANCEADMIN

Server RADIUS Speciﬁ es RADIUS server parameters.

Access right: SCON Access level: APPLIANCEADMIN

Server Reboot Reboots the CCM.

Access right: SCON Access level: APPLIANCEADMIN

Server Security Speciﬁ es user authentication mode, allowed access

methods and security lock-out. Access right: SCON Access level: APPLIANCEADMIN

48 CCM840/1640 Installer/User Guide

CCM Command Summary (Continued)

Command Description, Access Right and Access Level

Server Set Changes CCM addresses.

Server SNMP Enables/disables UDP port 161 SNMP processing.

Server SNMP Community Deﬁ nes read, write and trap SNMP community strings.

Server SNMP Manager Deﬁ nes/deletes SNMP management entities.

Server SNMP Trap Enables/disables SNMP traps.

Server SNMP Trap Destination Deﬁ nes/deletes destinations for enabled SNMP traps.

Server SSH Enables/disables SSH session access to the CCM and

Show Port Displays port c o n ﬁ guration information and statistics.

Show Port Alert Displays a port’s alert strings.

Show Server Displays CCM conﬁ guration, statistics and session information.

Show Server CLI Displays information speciﬁ ed with the Server CLI command.

Show Server PPP Displays PPP settings.

Show Server RADIUS Displays RADIUS settings.

Show Server Security Displays authentication, encryption and lock-out settings.

Access right: SCON Access level: APPLIANCEADMIN

speciﬁ es the SSH authentication method. Access right: SCON Access level: APPLIANCEADMIN

Access right: SMON Access level: ADMIN or APPLIANCEADMIN

Chapter 4: Using CCM Commands 49

CCM Command Summary (Continued)

Command Description, Access Right and Access Level

Show Server SNMP Displays SNMP conﬁ guration information.

Access right: SMON Access level: ADMIN or APPLIANCEADMIN

Show User Displays user conﬁ guration and session information.

Access right: SMON

Access level: ADMIN or APPLIANCEADMIN SPC Reserved for future functionality. User Add Adds a new user.

Access right: USER

Access level: ADMIN or APPLIANCEADMIN User Delete Deletes a user.

Access right: USER

Access level: ADMIN or APPLIANCEADMIN User Logout Terminates a user’s session.

Access right: USER

Access level: ADMIN*** or APPLIANCEADMIN User Set Changes a user’s conﬁ guration information.

Access right: USER

Access level: ADMIN or APPLIANCEADMIN User Unlock Unlocks a locked-out user.

Access right: USER

Access level: ADMIN*** or APPLIANCEADMIN ** Users who do not have the ADMIN or APPLIANCEADMIN level must have the appropriate

port access conﬁ gured to issue this command. *** A user with ADMIN level may issue a User Logout or User Unlock command for users with any level other than APPLIANCEADMIN.

50 CCM840/1640 Installer/User Guide

CCM Commands