Introduction, Navigation and Commands. Avocent Cyclades ACS 6000, ACS 6000

C H A P T E R

1

Introduction, Navigation and

Commands

The Cyclades ACS 6000 advanced console server is a 1U appliance that serves as a single point for access and administration of connected devices, such as target device consoles, modems and power devices. ACS 6000 console servers support secure remote data center management and out-of-band management of IT assets from any location worldwide.

On ACS 6000 advanced console servers, administration can be performed and connected devices can be accessed with the Command Line Interface (CLI) utility, with the Web Manager or with

DSView ® 3 management software (version 3.5.1 and greater). Multiple users and administrators can be logged into the console server and connected to ports at the same time.

This manual describes how to access and navigate the CLI utility and how to use it after the console server has been installed and assigned an IP address. For required additional information about actions users can perform, configuration options and tasks that an administrator needs to perform, and for how to install the console server and configure the IP address, see the Cyclades ACS 6000

Installation/Administration/User Guide.

Either the consoles of servers, external modems or Power Distribution Units (PDUs) can be connected to serial ports on the ACS 6000 advanced console server. Supported PDUs include

Avocent PM1000/2000/3000s, Cyclades PM IPDUs, Avocent SPC power devices and Server

Technology CDUs. Either a PDU or an external modem can be connected to the AUX/Modem port if the port is not factory-configured for an internal modem.

The figure that follows shows the console server ports, and Table 1.1 describes how they are

numbered (for use during configuration).

1

2 Cyclades ACS 6000 Advanced Console Server Command Reference Guide

1

2 4

3 5

Figure 1.1: ACS 6000 Advanced Console Server Ports

2

3

4

Table 1.1: ACS 6000 Advanced Console Server Port Descriptions

Number

1

5

Description

Serial Port 1

NOTE: Serial ports are also referred to with tty device names, such as ttSy1, ttyS2 and so forth.

Eth1 (eth1)

Eth0 (eth0)

AUX/Modem Port (ttyM1 or ttyA1)

NOTE: If an internal modem is ordered and factory installed, this port is configured internally as a modem port. If an internal modem is not installed, the port is configured as an auxiliary port, and a PDU or an external modem can be connected to it. The figure shows an external modem connected.

Console Port

Chapter 1: Introduction, Navigation and Commands 3

Access Options and How to Log Into the CLI

The CLI utility can be accessed in the following ways:

• Through a local terminal or a computer that has a terminal emulation program connected to the console port of the console server with session settings of 9600, 8, N and 1, with no flow control.

• After the console server is connected to the network and has an IP address, it can be accessed by either of the following methods:

• By use of an SSH or Telnet client on a remote computer (if the SSH or Telnet protocol is enabled in the selected Security Profile).

• With the Web Manager - Overview - Appliance Session button.

NOTE: For details on the remote access methods and IP address configuration options, see the Cyclades ACS

6000 Installation/Administration/User Guide.

Administrators have full access to the CLI and to connected devices. An administrator can authorize regular users to access ports, manage power, manage data buffer storage and use one or more console server administration tools. Users can always change their own passwords.

To start the CLI:

1.

Access the CLI through the console port, with Telnet or SSH or through the Web Manager.

2.

Enter the username and password at the prompt. The cli-> prompt appears.

CLI 2.0 (<build date>)

--:- units cli->

NOTE: The default password for admin is avocent and for root is linux. The password for these users may have been changed during installation of the console server. If not, change the default root and admin passwords to avoid potential security breaches.

Configuration Tasks Performed With the CLI

NOTE: This manual provides some configuration procedures as examples of how to use the CLI; an administrator who wants to use the CLI for configuration should reference the installation/administration/user guide for more information.

The navigation structure of the CLI mirrors that of the Web Manager. Options and parameters are also the same, except that spaces in Web Manager options and parameters are replaced with underscores (_), as in: appliance_settings. Examples that show how to select an option in the Web

Manager use a dash surrounded by two spaces ( - ). In the CLI, two similar options in a path are separated by a forward slash (/).

4 Cyclades ACS 6000 Advanced Console Server Command Reference Guide

For example, in the Web Manager, user configuration is done when an administrator selects

Appliance Settings - Users - Local Accounts - User Names to get to the User Names screen. To navigate to the equivalent configuration level in the CLI, an administrator would navigate in the

CLI with the cd command followed by the path: cd appliance_settings/users/local_accounts/ user_names .

Administrators should log into the CLI in one window and log into the Web Manager in another window to see how the menu options in the Web Manager map to the navigation options in the

CLI. Configuration with the CLI also requires mastery of the following information on CLI

navigation and of the CLI commands shown in CLI Command Set on page 7.

CLI Navigation

The CLI navigation options are in a nested tree configuration.

NOTE: When a command line is shown in an example, and the step starts with “Enter,” or when a syntax example is given, the user should type the command as shown and then press Enter. The Enter key is not shown in command line examples unless needed for clarity.

When a user logs in the CLI, the prompt indicates the user is at the /units level.

--:- units cli->

No parameters can be set at this level of the navigation tree.

At any CLI prompt at any level, if you type cd and press Tab Tab , the navigation options (path elements) for that level are listed. Different options appear for administrators and for authorized users.

• When an administrator types the cd command and then presses Tab Tab at the units prompt, the following Units navigation options (path elements) appear.

--:- units cli-> cd< Tab><Tab> active_sessions/ monitoring/ topology/ appliance_settings/ overview/ user_profile/ information/ power_management/

• When a regular user types the cd command and then presses Tab Tab at the units prompt, the following Units navigation options appear.

--:- units cli-> cd< Tab><Tab> overview/ power_management/ topology/ user_profile/

Enter cd <one_or_more_path_elements> to move down one or more levels of the navigation tree:

--:- units cli-> cd appliance_settings

Chapter 1: Introduction, Navigation and Commands 5

A prompt like the following appears at each level:

--:- appliance_settings cli->

NOTE: CLI commands are case sensitive.

At any level, you can press Tab Tab at the prompt to see the commands that can be entered at the current level.

---:- appliance_settings cli->< Tab><Tab>

? del ls quit set add exit opiepasswd refresh shell cd ftp passwd revert show commit help pwd scp

If you know the path, you can enter multiple path elements in a single command separated with forward slashes (/).

--:- units cli-> cd appliance_settings/ports/physical_ports/serial_ports/

--:- serial ports cli->

Enter cd ..

to move up one level of the navigation tree. Enter cd ../..

[ /..

] to move up multiple levels.

--:- serial ports cli-> cd ../..

--:- ports cli->

Autocompletion

Autocompletion allows you to type the first few letters of a command or navigation option and then press Tab . The rest of the name is filled in automatically if the letters typed are unique to one command or to a navigation option at that level. If the letters match more than one of the commands or navigation options for that level, the matching options are listed.

For example, if you type cd ov and press Tab at the CLI prompt from the /units level, the overview option will be completed.

--:- units cli-> cd ov <Tab>

--:- units cli-> cd overview

If you then press Enter , you are changed to the overview level, and the overview level prompt appears.

--:- overview cli->

The following example illustrates a case when more than one command matches the letters typed.

--:- units cli-> sh <Tab> shell show

6 Cyclades ACS 6000 Advanced Console Server Command Reference Guide

Parameters

Some CLI commands take parameters. If you press Tab Tab after a command that requires a parameter, you are prompted to enter the parameter.

Command Line Syntax

NOTE: Square brackets ([ ]) denote an optional element. Each element is separated by a space. There are no spaces between sub-elements.

Command only (help, pwd):

--:- <current_level> cli-> <command>

Commands with paths only (cd, ls, add):

--:- <current_level> cli-> <command> [Path]

Commands with targets (del):

--:- <current_level> cli-> <command> [Path] <Targets>

Commands that require parameters (set):

--:- <current_level> cli-> <command> [Path] <Params>

Commands with values only (sendmsg, ftp...):

--:- <current_level> cli-> <command> [Path] <Values> where:

Path := path_elem[/path_elem]* path_elem := . | .. | Section_Label | ^/

Targets := Row_Label(,Row_Label)

Params := Param_Names=PValues

Param_Names := Param_Label(:Param_Label)*

PValues := Value_text(,Value_text)*

Values := Value_text Value_text

Section_Label

Param_Label

Value_text := labels or data from the UIC.

Syntax used:

^ : beginning of the element

* : 0 - many

Chapter 1: Introduction, Navigation and Commands 7

| : or

() : group

CLI Command Set

NOTE: Most of the commands work from any location when the path to the command parameter is included.

NOTE: The word “node” refers to an entity such as a route, host or user, which can be added, configured or deleted.

help

Generate a help message about how to navigate the CLI.

Syntax:

--:- units cli-> help

- Thank you for using the cli -

This interface allows you to easily modify configurations to customize and define the functionality of your unit.

Press <tab> <tab> to see the list of available commands.

Please refer to the Reference Guide for a description of commands, special keys and additional information on how to use this interface.

Some basic and useful keys are:

up/down arrow - navigates up/down in the command history

tab (once/twice) - shows the next possible option(s)

Other hints:

Use backslash '\' to escape spaces, '\' and other control

characters when assigning values to parameters.

add

Add a node.

8 Cyclades ACS 6000 Advanced Console Server Command Reference Guide

delete

Syntax:

--:- units cli-> add <Path>

Example:

--:- units cli-> add appliance_settings/network/hosts

--:#- [hosts] cli->

Delete a node.

Syntax:

--:- units cli-> delete <Path> <parameter>

cd

Change directory (level).

Syntax:

--:- units cli-> cd <Path>

Example:

--:- units cli-> cd topology

Displays the following:

--:- topology cli->

Example:

--:- topology cli-> cd ..

-or-

--:- topology cli-> cd ../

Moves up one directory level and displays the following:

--:- units cli->

Example:

--:- topology cli-> cd /

Moves to the top level and displays the following:

--:- / cli->

Example:

--:- topology cli-> cd /units/overview

Displays the following:

Chapter 1: Introduction, Navigation and Commands 9

--:- overview cli->

pwd

Display the path to the current level (print working directory).

Syntax:

--:- units cli-> pwd

connect

Connect to a serial or auxiliary port.

Syntax:

--:- topology cli-> connect <port_name>

Example:

--:- topology cli-> connect 77-77-70-p-2

-or-

(Optional) From the default directory:

--:- units cli-> connect topology/77-77-70-p-2

Displays the following:

Password:

-or-

Type the hotkey to suspend the connection:

Ctrl + z

NOTE: The connect, sniff and share commands allow you to connect to the serial ports. These commands require authentication when single sign-on is disabled, so the password must be entered to authenticate the user in the authentication type configured for the serial port. If single sign-on is enabled or the user has already been authenticated, the session is opened.

sniff

Connect to a serial or auxiliary port as an additional, view-only user.

Syntax:

--:- topology cli-> sniff <port_name>

Example:

--:- topology cli-> sniff 77-77-70-p-2

Displays the following:

10 Cyclades ACS 6000 Advanced Console Server Command Reference Guide

Password:

-or-

Type the hotkey to suspend the connection:

Ctrl + z

share

Connect to a serial or auxiliary port as an additional, read/write user.

Syntax:

--:- topology cli-> share <port_name>

Example:

--:- topology cli-> share 77-77-70-p-2

Displays the following:

Password:

-or-

Type the hotkey to suspend the connection:

Ctrl + z

disconnect

Use this escape sequence to return to the CLI from a connection to a device through a serial port.

Syntax:

Ctrl+z

exit/quit

Exit the CLI and return to the login prompt.

Syntax:

--:- units cli-> exit

-or-

--:- units cli-> quit

ftp

Connect to a remote FTP server.

Syntax:

--:- units cli-> ftp [<server_IP_address>|<hostname>]

Chapter 1: Introduction, Navigation and Commands 11

NOTE: You must log into the CLI as root to have full control over the local directory path. All normal FTP commands apply.

scp

Perform a secure shell copy.

Syntax:

--:- units cli-> scp [[user@]host1:]file1 [...] [[user@]host2:]file2

set

Set a parameter.

Syntax:

--:- units cli-> set <Path> <Parameter>=<Value>

After a parameter has been changed using the set command, a pair of asterisks appear at the beginning of the CLI prompt.

**:- units cli->

Save the change:

**:- units cli-> commit

-or-

Undo the change:

**:- units cli-> revert

NOTE: After a commit or revert command, the asterisks at the beginning of the CLI prompt are replaced by hyphens. Asterisks will not appear after the execution of the set command if using wizard mode, which can be recognized by a prompt that has a pound sign after the colon and the current directory in square brackets

(example, --:#- [hosts] cli->).

commit

Save settings.

Syntax:

**:- port_settings cli-> commit

revert

Undo a previous parameter setting.

Syntax:

**:- units cli-> revert

12 Cyclades ACS 6000 Advanced Console Server Command Reference Guide

show/ls

Show the available directories, commands or parameters at the current location.

Syntax:

--:- units cli-> show

-or-

--:- units cli-> ls

Example:

--:- units cli-> show user_profile user_profile

change_password/

--:- units cli->

power_cycle, power_off and power_on

Control power on a server connected to the serial port or outlets on a PDU that is either connected to a serial port or to the AUX/Modem port from the Topology level when the port is enabled and configured with the Power Profile.

NOTE: Only one outlet can be managed with the commands at this level.

Syntax:

--:- units cli-> cd topology/<PDU_ID>/outlets/

--:- outlets cli-> [power_cycle|power_off|power_on] <outlet_name>

Example:

--:- units cli-> cd topology/14-35-60P15_1/outlets

--:- outlets cli-> power_cycle 14-35-60P15_1_8

Selected outlet(s) will be switched ON after this operation. Are you sure you want to power cycle the selected outlet(s)? y/n : y

cycle, on, off, lock and unlock

Control power on outlets on a PDU that is either connected to a serial port or to the AUX/Modem port from the power_management level when the port is enabled and configured with the Power

Profile.

NOTE: Lock and unlock commands are only supported on Cyclades PDUs.

NOTE: Enter commas (,) between multiple outlet numbers. Using a hyphen (-) to specify a range is not supported in CLI power management.

Chapter 1: Introduction, Navigation and Commands 13

--:- units cli-> cd power_management/management/<PDU_ID>/outlet_table

--:- outlet_table cli-> [cycle|on|off|lock|unlock]

<outlet_number[,..,outlet_number]>

Examples:

--:- units cli-> cd power_management/management/myPDU/outlet_table

--:- outlet_table cli-> off 1,2,5,8

Are you sure you want to turn off the outlet(s)? y/n : y

The cycle, on and off commands can be used from the units/topology level, where they are enabled and configured with the Power Profile.

--:- units cli -> [cycle|on|off] topology/<PDU_ID>

These three commands can also be used to configure the CAS profile ports that are configured to control outlets of power devices.

--:- units cli -> [cycle|on|off] topology/<PORT_ID>

passwd

Configure the password for the current user. The terminal does not echo the password.

Syntax:

--:- units cli-> passwd

opiepasswd

Configure a one time password (OTP) for the local user. After you type the command, you will be asked for the pass phrase to use for the OTP.

Syntax:

--:- units cli-> opiepasswd

Example: opiepasswd -f -c teste

Adding teste:

Only use this method from the console; NEVER from remote. If you are using telnet, xterm, or a dial-in, type ^C now or exit with no password.

Then run opiepasswd without the -c parameter.

Using MD5 to compute responses.

Enter new secret pass phrase:

Again new secret pass phrase:

ID teste OTP key is 499 AC0241

14 Cyclades ACS 6000 Advanced Console Server Command Reference Guide

FOOD HUGH SKI ALMA LURK BRAD

Special Multi-session Commands

The following commands require navigation to an enabled and configured port to which one or more users are simultaneously connected. To get to the port, enter the following command.

--:- units cli-> cd topology/<serial_port_ID>

listuser

List the users connected to the shared serial port.

Syntax:

--:- <serial_port_ID> cli-> listuser

killuser

Terminate the connection of a user on the port. The user is returned to the cli-> prompt.

Syntax:

--:- <serial_port_ID> cli-> killuser <username>

Example:

--:- <serial_port_ID> cli-> killuser admin@139

sendmsg

Send a message to a user connected to the port.

Syntax:

--:- <serial_port_ID> cli-> sendmsg <username> <message>

Example:

--:- <serial_port_ID> cli-> sendmsg admin@139 You are being terminated.

inspectdbuf

View the data buffer files for the port. Data buffering must be enabled in the CAS Profile for the port and the user must be authorized for data buffer management.

Syntax:

--:- <serial_port_ID> cli-> inspectdbuf

View the data logging for the appliance. Appliance Session Data logging must be enabled in the global_settings/sessions level.

Syntax:

Chapter 1: Introduction, Navigation and Commands 15

--:- units cli -> inspectdbuf overview/appliance_data_logging

The following commands are available for inspectdbuf:

• Return - Scroll forward one line.

• Ctrl + F - Scroll forward one window.

• Ctrl + B - Scroll backward one window.

• /pattern - Search foward in the file for the first line containing the pattern.

• ?pattern

- Search backward in the file for the first line containing the pattern.

• n - Repeat the search.

• q - Quit.

cleandbuf

Clear the data buffer. Data buffering must be enabled in the CAS Profile or the port and the user must be authorized for data buffer management.

Syntax:

--:- <serial_port_ID> cli-> cleandbuf

Clear the data logging for the appliance. Appliance Session Data logging must be enabled in the global_settings/sessions level.

Syntax:

--:- units cli -> cleandbuf overview/appliance_data_logging

wiz

Configures the IP parameters for the Eth0 interface. Shows the current configuration and asks for new values for the following parameters:

• Status of the interface (enabled or disabled)

• IPv4 method (dhcp or static)

• IPv6 method (dhcp or static)

• IP address, mask and gateway (if static is chosen for either of the previous parameters)

• DNS Primary Server, Secondary Server, Domain Name and Hostname

After setting all parameters, confirm that all parameters are correct to save them.

16 Cyclades ACS 6000 Advanced Console Server Command Reference Guide

CLI Equivalent Actions to Web Manager Checkbox Selection

NOTE: The following example procedure, which configures IPv6, illustrates the actions to use in the CLI to enable or disable an option when a checkbox would be selected or deselected in the Web Manager.

To configure IPv6 (example of how to perform the equivalent of Web Manager checkbox selection/deselection):

1.

Log into the CLI and enter cd appliance_settings/network/ip .

--:- units cli-> cd appliance_settings/network/ipv6

2.

Enter show to view the status of IPv6 configuration.

--:- ipv6 cli-> show

IPv6

[X] enable_IPv6

[ ] get_dns_from_dhcpv6

[ ] get_domain_from_dhcpv6

NOTE: At this location, you can use '=' to change the value or '/' to select a parameter inside the section.

3.

Type set enable_ipv6= and press Tab to view the options for the parameter.

--:- ipv6 cli-> set enable_ipv6=< Tab> no yes

4.

Type set enable_ipv6: and press Tab to view the child parameters.

--:- ipv6 cli-> set enable_ipv6/< Tab> get_dns_from_dhcpv6= get_domain_from_dhcpv6=

5.

Enter set enable_ipv6=no to disable IPv6.

--:- ipv6 cli-> set enable_ipv6=no

-or-

Enter set enable_ipv6=yes to enable IPv6.

--:- ipv6 cli-> set enable_ipv6=yes

6.

(Optional) Enter either of the following commands to enable subparameters.

**:- ipv6 cli-> set enable_ipv6/ get_dns_from_dhcpv6=yes

**:- ipv6 cli-> set enable_ipv6/ get_domain_from_dhcpv6=yes

7.

Enter show to verify the change.

**:- ipv6 cli-> show ipv6

[X] enable_ipv6

[X] get_dns_from_dhcpv6

Chapter 1: Introduction, Navigation and Commands 17

[X] get_domain_from_dhcpv6

8.

Enter commit .

18 Cyclades ACS 6000 Advanced Console Server Command Reference Guide