![]() |
VPN 3000 Series Concentrator Reference Volume II: Administration and Monitoring, Release 4.0
|
|||||||||||||||||||||||||||||||||||
Using the Command-Line Interface
![]() |
||||||||||||||||||||||||||||||||||||
|
Table of ContentsUsing the Command-Line InterfaceAccessing the CLI Starting the CLI Using the CLI Choosing Menu Items
CLI Menu ReferenceEntering Values Specifying Configured Items Navigating Quickly through the CLI Getting Help Information Saving the Configuration File Stopping the CLI Understanding CLI Access Rights Main Menu
1 Configuration 1.1 Configuration > Interface Configuration
2 Administration1.1.1, 1.1.2, or 1.1.3 Configuration > Interface Configuration > Configure Ethernet #1 or #2 or #3 1.1.4 Configuration > Interface Configuration > Configure Power Supplies 1.1.3 Configuration > Interface Configuration > Configure Power Supplies 1.2 Configuration > System Management 1.2.1 Configuration > System Management > Servers 1.2.2 Configuration > System Management > Address Management 1.2.3 Configuration > System Management > Tunneling Protocols 1.2.4 Configuration > System Management > IP Routing 1.2.5 Configuration > System Management > Management Protocols 1.2.6 Configuration > System Management > Event Configuration 1.2.7 Configuration > System Management > General Config 1.2.8 Configuration > System Management > Client Update 1.2.9 Configuration > System Management > Load Balancing 1.3 Configuration > User Management 1.3.1 Configuration > User Management > Base Group 1.3.2 Configuration > User Management > Groups 1.3.3 Configuration > User Management > Users 1.4 Configuration > Policy Management 1.4.1 Configuration > Policy Management > Access Hours 1.4.2 Configuration > Policy Management > Traffic Management 2.1 Administration > Administer Sessions
3 Monitoring2.2 Administration > Software Update 2.3 Administration > System Reboot 2.3.2 Administration > System Reboot > Schedule Reboot 2.3.3 Administration > System Reboot > Schedule Shutdown 2.4 Administration > Reboot Status 2.6 Administration > Access Rights 2.6.1 Administration > Access Rights > Administrators 2.6.2 Administration > Access Rights > Access Control List 2.6.3 Administration > Access Rights > Access Settings 2.6.4 Administration > Access Rights > Admin AAA Servers 2.7 Administration > File Management 2.7.6 Administration > File Management > Swap Configuration File 2.8 Administration > Certificate Management 2.8.1 Administration > Certificate Management > Enrollment 2.8.2 Administration > Certificate Management > Installation 2.8.3 Administration > Certificate Management > Certificate Authorities 2.8.4 Administration > Certificate Management > Identity Certificates 2.8.5 Administration > Certificate Management > SSL Certificate 2.8.6 Administration > Certificate Management > Enrollment Status 3.1 Monitoring > Routing Table
3.2 Monitoring > Event Log 3.2.2 Monitoring > Event Log > View Event Log 3.3 Monitoring > System Status 3.3.2 Monitoring > System Status > View Card Status 3.4 Monitoring > Sessions 3.4.1 Monitoring > Sessions > View Session Statistics 3.4.2 Monitoring > Sessions > View Top Ten Lists 3.4.3 Monitoring > Sessions > View Session Protocols 3.4.4 View Session SEPS 3.4.4 (3.4.5 on Models 3015-3080) Monitoring > Sessions > View Session Encryption 3.4.5 (3.4.6 on Models 3015-3080) Monitoring > Sessions > Filter Sessions on Group 3.5 Monitoring > General Statistics 3.5.1 Monitoring > General Statistics > Protocol Statistics 3.5.2 Monitoring > General Statistics > Server Statistics 3.5.3 Monitoring > General Statistics > Event Statistics 3.5.4 Monitoring > General Statistics > MIB II Statistics 3.6 Monitoring > Dynamic Filters Using the Command-Line InterfaceThe VPN 3000 Concentrator Series Command-Line Interface (CLI) is a menu- and command-line-based configuration, administration, and monitoring system built into the VPN Concentrator. You use it via the system console, an SSH session, or Telnet (including SSL Telnet). You can use the CLI to completely manage the system. You can access and configure the same parameters as the HTML-based VPN 3000 Concentrator Series Manager, except for IPSec LAN-to-LAN configuration.
This chapter describes general features of the CLI 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 VPN Concentrator Manager in the VPN 3000 Series Concentrator Reference. For example, to understand Ethernet interface configuration parameters and choices, see Configuration | Interfaces | Ethernet 1 2 3 in the "Interfaces" chapter of VPN 3000 Series Concentrator Reference Volume I: Configuration. Accessing the CLIYou can access the CLI in three ways: Console accessTo access the CLI via console: Step 1 Connect a PC to the VPN Concentrator via a straight-through RS-232 serial cable (which Cisco supplies with the system) between the Console port on the VPN Concentrator and the serial port on the PC. For more information, see the VPN Concentrator Getting Started manual. Step 2 Start a terminal emulator (e.g., HyperTerminal) on the PC. Configure a connection to COM1 with port settings of: Step 3 Set the emulator for VT100 emulation, or let it auto-detect the emulation type. Step 4 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.) Telnet or Telnet/SSL AccessTo access the CLI via a Telnet or Telnet/SSL client: Step 1 Enable the Telnet or Telnet/SSL server on the VPN Concentrator. (They are both enabled by default.) See the Configuration | System | Management Protocols | Telnet screen on the VPN Concentrator Manager. Step 2 Start the Telnet or Telnet/SSL client, and connect to the remote system using these parameters:
Step 3 The VPN Concentrator displays a login prompt: SSH AccessTo access the CLI via an SSH client: Step 1 Enable the SSH server on the VPN Concentrator. (It is enabled by default.) See the Configuration | System | Management Protocols | SSH screen on the VPN Concentrator Manager. Step 2 Start the SSH client, and connect to the remote system using these parameters: Step 3 A security warning might appear stating: "There is no entry for this server in your list of know hosts." If this warning appears, continue. Step 4 Enter your administrative password, and connect to the VPN Concentrator. When your connection is established, you are already logged in. Starting the CLIYou start the CLI by logging in. CLI login usernames and passwords for console, Telnet, and SSH 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 does not show your password entry.) The CLI displays the opening welcome message, the main menu, and the Main -> prompt: Using the CLIThe CLI displays menus or prompts at every level to guide you in choosing configurable options and setting parameters. The prompt always shows the menu context. Choosing Menu ItemsTo use the CLI, enter a number at the prompt that corresponds to the desired menu item, and press Enter. For example, this is the Configuration > System Management> General Config> System Identification menu: Enter 1 to set the system name. Entering ValuesThe CLI 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. Specifying Configured ItemsMany menus give choices that act on configured itemssuch as groups, users, filter rules, etc.and the CLI lists those items with a number and their name. To specify an item, you can usually enter either its number or its name. The CLI indicates when you must use a specific identifier (usually the item's number). For example, the Configuration > User Management > Groups menu lists configured groups: To delete QuickGroup, enter 3 at the prompt. The CLI displays: At the prompt you can enter either its number (1) or its name (QuickGroup). However, this next example shows the prompt for a specific identifier. The Configuration > System Management > Servers > Authentication Servers menu lists configured servers: To delete the RADIUS server, enter 3 at the prompt. The CLI displays: At the prompt, you must enter 2 for the RADIUS server. Navigating Quickly through the CLIThere are two ways to move quickly through the CLI: 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. Using Shortcut NumbersOnce you become familiar with the structure of the CLIwhich parallels the HTML-based VPN Concentrator Manageryou can quickly access any level by entering a series of numbers separated by periods. For example, suppose you want to change the General Parameters for the Base Group. The series of menus that gets to that level from the main menu is: As a shortcut, you can just enter 1.3.1.1 at the Main-> prompt, and move directly to the Base Group General Parameters menu: The prompt always shows the current context in the menu structure. Using Back and HomeMost 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. Getting Help InformationTo display a brief help message, enter 5 at the main menu prompt. The CLI 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 (for home), or 2 or b (for back) at the prompt. Saving the Configuration FileConfiguration and administration entries take effect immediately and are included in the active, or running, configuration. However, if you reboot the VPN Concentrator without saving the active configuration, you lose all 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. Stopping the CLITo stop the CLI, 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. Understanding CLI Access RightsWhat you see and can configure with the CLI depends on administrator access rights. If you don't have permission to configure an option, you see the designation "-)" (rather than a number) in menus. For example, here is the main menu for the default User administrator: The default user administrator can only monitor the VPN Concentrator, not configure system parameters or administer the system. See the "Administration | Access Rights | Administrators" section for more information. CLI Menu ReferenceThis section of the documentation shows all the menus in the first three levels below the CLI 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 > User Management> Base Group menu.
Main Menu1 Configuration1.1 Configuration > Interface Configuration
1.1.1, 1.1.2, or 1.1.3 Configuration > Interface Configuration > Configure Ethernet #1 or #2 or #3
1.1.4 Configuration > Interface Configuration > Configure Power Supplies
1.1.3 Configuration > Interface Configuration > Configure Power Supplies
1.2 Configuration > System Management1.2.1 Configuration > System Management > Servers1.2.2 Configuration > System Management > Address Management1.2.3 Configuration > System Management > Tunneling Protocols
1.2.4 Configuration > System Management > IP Routing1.2.5 Configuration > System Management > Management Protocols1.2.6 Configuration > System Management > Event Configuration1.2.7 Configuration > System Management > General Config1.2.8 Configuration > System Management > Client Update1.2.9 Configuration > System Management > Load Balancing1.3 Configuration > User Management1.3.1 Configuration > User Management > Base Group1.3.2 Configuration > User Management > Groups1.3.3 Configuration > User Management > Users1.4 Configuration > Policy Management1.4.1 Configuration > Policy Management > Access Hours1.4.2 Configuration > Policy Management > Traffic Management2 Administration2.1 Administration > Administer Sessions2.2 Administration > Software Update2.3 Administration > System Reboot2.3.2 Administration > System Reboot > Schedule Reboot2.3.3 Administration > System Reboot > Schedule Shutdown2.4 Administration > Reboot Status2.6 Administration > Access Rights2.6.1 Administration > Access Rights > Administrators2.6.2 Administration > Access Rights > Access Control List2.6.3 Administration > Access Rights > Access Settings2.6.4 Administration > Access Rights > Admin AAA Servers2.7 Administration > File Management2.7.6 Administration > File Management > Swap Configuration File2.8 Administration > Certificate Management2.8.1 Administration > Certificate Management > Enrollment2.8.2 Administration > Certificate Management > Installation2.8.3 Administration > Certificate Management > Certificate Authorities2.8.4 Administration > Certificate Management > Identity Certificates2.8.5 Administration > Certificate Management > SSL Certificate2.8.6 Administration > Certificate Management > Enrollment Status3 Monitoring3.1 Monitoring > Routing Table3.2 Monitoring > Event Log3.2.2 Monitoring > Event Log > View Event Log3.3 Monitoring > System Status
3.3.2 Monitoring > System Status > View Card Status
3.4 Monitoring > Sessions
3.4.1 Monitoring > Sessions > View Session Statistics3.4.2 Monitoring > Sessions > View Top Ten Lists3.4.3 Monitoring > Sessions > View Session Protocols3.4.4 View Session SEPS
3.4.4 (3.4.5 on Models 3015-3080) Monitoring > Sessions > View Session Encryption3.4.5 (3.4.6 on Models 3015-3080) Monitoring > Sessions > Filter Sessions on Group3.5 Monitoring > General Statistics3.5.1 Monitoring > General Statistics > Protocol Statistics3.5.2 Monitoring > General Statistics > Server Statistics3.5.3 Monitoring > General Statistics > Event Statistics3.5.4 Monitoring > General Statistics > MIB II Statistics3.6 Monitoring > Dynamic Filters
|
|||||||||||||||||||||||||||||||||||
|
|