|
|
The VPN 3002 Hardware Client command-line interface (CLI) is a menu- and command-line-based configuration, administration, and monitoring system built into the VPN 3002. You use it via the system console or a Telnet (or Telnet over SSL) session.
You can use the command-line interface to completely manage the system. You can access and configure the same parameters as the HTML-based VPN 3002 Hardware Client Manager.
This chapter describes general features of the command-line interface and how to access and use it. It does not describe the individual menu items and parameter entries. For information on specific parameters and options, see the corresponding section of the Manager in this manual. For example, to understand Ethernet interface configuration parameters and choices, see Configuration | Interfaces | Private/Public in Chapter 2, "Interfaces".
You can access the command-line interface in two ways: via the system console or a Telnet (or Telnet over SSL) client.
1. Connect a PC to the VPN 3002 via an RJ-45 serial cable (which Cisco supplies with the system) between the console port on the VPN 3002 and the COM1 or serial port on the PC. For more information, see the VPN 3002 Hardware Client Getting Started guide.
2. Start a terminal emulator (e.g., HyperTerminal) on the PC. Configure a connection to COM1 with port settings of:
9600 bits per second.
8 data bits.
No parity.
1 stop bit.
Set the emulator for VT100 emulation, or let it auto-detect the emulation type.
3. Press Enter on the PC keyboard until you see the login prompt. (You might see a password prompt and error messages as you press Enter; ignore them and stop at the login prompt.)
To access the command-line interface via a Telnet or Telnet/SSL client:
1. Enable the Telnet or Telnet/SSL server on the VPN 3002. (They are both enabled by default on the private network.) See the Configuration | System | Management Protocols | Telnet screen on the Manager.
2. Start the Telnet or Telnet/SSL client, and connect to the VPN 3002 using these parameters:
Host Name or Session Name = The IP address on the VPN 3002 private interface; e.g., 10.10.147.2
Port = Telnet (default Telnet port is 23, Telnet/SSL port is 992)
3. The VPN 3002 displays a login prompt.
You start the command-line interface by logging in.
Login usernames and passwords for both console and Telnet access are the same as those configured and enabled for administrators. See the Administration | Access Rights | Administrators screen. By default, only admin is enabled.
This example uses the factory-supplied default admin login and password. If you have changed them, use your entries.
At the prompts, enter the administrator login name and password. Entries are case-sensitive.
The CLI displays the opening welcome message, the main menu, and the Main -> prompt.
The command-line interface displays menus or prompts at every level to guide you in choosing configurable options and setting parameters. The prompt always shows the menu context.
To use the command-line interface, enter a number at the prompt that corresponds to the desired menu item, and press Enter.
For example, this is the Configuration > System > General > System Identification menu:
Enter 1 to set the system name.
The command-line interface shows any current or default value for a parameter in brackets [ ]. To change the value, enter a new value at the prompt. To leave the value unchanged, just press Enter.
Continuing the example above, this is the prompt to enter a value for the system name:
You can enter a new name at the prompt, or just press Enter to keep the current name.
There are two ways to move quickly through the command-line interface: shortcut numbers, and the Back/Home options. Both ways work only when you are at a menu, not when you are at a value entry.
When you become familiar with the structure of the interface, which parallels the HTML-based
VPN 3002 Hardware Client Manager, you can quickly access any level by entering a series of numbers separated by periods. For example, suppose you want to change the Access Rights for Administrators. The series of menus that gets to that level from the main menu is:
> Which Administrator to Modify
As a shortcut, you can just enter 2.4.1.1 at the Main-> prompt, and move directly to the Modify Administrators menu:
> Which Administrator to Modify
 |
Note At this last prompt, you cannot use a number shortcut. At this prompt, you must type in the name of the administrator you want to modify, for example, config. |
The prompt always shows the current context in the menu structure.
Most menus include a numbered Back choice. Instead of entering a number, you can just enter b or B to move back to the previous menu.
Also, at any menu level, you can just enter h or H to move home to the main menu.
To display a brief help message, enter 5 at the main menu prompt. The command-line interface explains how to navigate through menus and enter values. This help message is available only at the main menu.
To return to the main menu from this help menu, enter h or H (for home), or 2 or b or B (for back) at the prompt.
Configuration and administration entries take effect immediately and are included in the active, or running, configuration. However, if you reboot the VPN 3002 without saving the active configuration, you lose any changes.
To save changes to the system configuration (CONFIG) file, navigate to the main menu. At the prompt, enter 4 for Save changes to Config file.
The system writes the active configuration to the CONFIG file and redisplays the main menu.
To stop the command-line interface, navigate to the main menu and enter 6 for Exit at the prompt:
Make sure you save any configuration changes before you exit from the CLI.
What you see and can configure depends on administrator access rights. If you do not have permission to configure an option, you see -), rather than a number, in menus. For example, here is the main menu for the default Monitor administrator:
The default Monitor administrator can only monitor the VPN 3002, not configure system parameters or administer the system.
See Administration | Access Rights | Administrators in Chapter 11, "Administration", for more information.
This section shows all the menus in the first three levels below the main menu. (There are many additional menus below the third level; and within the first three levels, there are some non-menu parameter settings. To keep this chapter at a reasonable size, we show only the menus here.)
The numbers in each heading are the keyboard shortcut to reach that menu from the main menu. For example, entering 1.3.1 at the main menu prompt takes you to the Configuration > System Management> IP Routing menu.
|
Note The menus and options, and thus the keyboard shortcuts, might change with new software versions. Please check familiar shortcuts carefully when using a new release. |
See the VPN 3002 Hardware Client Getting Started guide for complete information about Quick Configuration.
Posted: Wed Feb 4 10:50:35 PST 2004
All contents are Copyright © 1992--2004 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.