Cyclades ACS 6000 Command Reference
Cyclades ACS 6000 Command Reference
Cyclades ACS 6000 Command Reference
Notice about FCC Compliance for All Cyclades ACS Advanced Console Server Models
To comply with FCC standards, the Cyclades ACS advanced console server requires the use of a shielded CAT 5 cable for the Ethernet interface. Notice that this cable is not supplied with either of the products and must be provided by the customer.
Avocent, the Avocent logo, The Power of Being There, DSView and Cyclades are registered trademarks of Avocent Corporation or its affiliates in the US and other countries. All other marks are the property of their respective owners. 2010 Avocent Corporation. 590-770-501D
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 products 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.
iii
T A B L E O F C ON T E N T S
Table of Contents
List of Tables .................................................................................................................. vii Chapter 1: Introduction, Navigation and Commands ................................................... 1 Access Options and How to Log Into the CLI ................................................................................... 3 Configuration Tasks Performed With the CLI ................................................................................... 3 CLI Navigation .................................................................................................................................. 4 Autocompletion .................................................................................................................................. 5 Parameters......................................................................................................................................... 6 Command Line Syntax ....................................................................................................................... 6 Chapter 2: CLI Command Set ......................................................................................... 9 Commands Used for the CLI ............................................................................................................. 9 help ............................................................................................................................................. 9 add ............................................................................................................................................ 10 delete......................................................................................................................................... 10 cd............................................................................................................................................... 10 pwd............................................................................................................................................ 11 connect...................................................................................................................................... 11 sniff ........................................................................................................................................... 12 share ......................................................................................................................................... 12 disconnect ................................................................................................................................. 12 exit/quit ..................................................................................................................................... 12 ftp .............................................................................................................................................. 13 scp ............................................................................................................................................. 13 set.............................................................................................................................................. 13 commit....................................................................................................................................... 14 revert......................................................................................................................................... 14 ls................................................................................................................................................ 14 show .......................................................................................................................................... 14 list_configuration...................................................................................................................... 14 cycle, on, off, lock and unlock................................................................................................... 15 passwd ...................................................................................................................................... 16
iv
opiepasswd................................................................................................................................ 16 Special Multi-session Commands .................................................................................................... 17 list_shared_session ................................................................................................................... 17 kill_shared_session................................................................................................................... 17 sendmsg..................................................................................................................................... 17 show_databuf and show_appliance_databuf............................................................................ 18 cleandbuf and clean_appliance_databuf.................................................................................. 18 wiz ............................................................................................................................................. 18 CLI Equivalent Actions to Web Manager Checkbox Selection........................................................ 19 Chapter 3: Port Access and Configuration Examples................................................ 21 View Information About the Console Server and Connected Devices............................................. 22 Connect to a Device Console Connected to a Serial Port ............................................................... 23 Accessing Serial Ports using ts_menu ............................................................................................. 24 Manage Power for a Device Connected to an Outlet on a PDU..................................................... 25 Port Configuration Examples .......................................................................................................... 25 Chapter 4: CLI Overview for Administrators ............................................................... 29 System .............................................................................................................................................. 29 System/Security ................................................................................................................................ 29 System/Boot Configuration....................................................................................................... 31 System/Date and Time .............................................................................................................. 31 System/Help and Language ...................................................................................................... 32 System/Information ................................................................................................................... 32 System/Usage............................................................................................................................ 32 Network ............................................................................................................................................ 33 Network/Settings ....................................................................................................................... 33 Network/IPv4 and IPv6............................................................................................................. 34 Network/Devices ....................................................................................................................... 34 Network/Hosts .......................................................................................................................... 35 Network/Firewall...................................................................................................................... 37 Network/IPSec(VPN) ................................................................................................................ 37 Network/SNMP ................................................................................................................................ 38 Wiz command............................................................................................................................ 38 Ports................................................................................................................................................. 39 Auxiliary ports .......................................................................................................................... 42
Table of Contents
Pluggable Devices ........................................................................................................................... 43 Authentication .................................................................................................................................. 44 Users ................................................................................................................................................ 44 Syslog ............................................................................................................................................... 45 Events_and_Logs ............................................................................................................................. 46 Power Management ......................................................................................................................... 47 Active Sessions Information............................................................................................................. 48 Appendices..................................................................................................................... 51 Appendix A: Enabling Firmware Upgrades When the Boot Image is not in Flash......................... 51 Appendix B: Migration CLI ............................................................................................................. 52 Access rights ............................................................................................................................. 52 Exceptions................................................................................................................................. 52 Appendix C: Su and Sudo Commands ............................................................................................. 57 Su command.............................................................................................................................. 57 Sudo command.......................................................................................................................... 58 Appendix D: Technical Support....................................................................................................... 59
vi
vii
LIST OF TABLES
t of Tables
Table 1.1: ACS 6000 Advanced Console Server Port Descriptions .................................................. 2 Table 3.1: Port Access and Configuration Tasks ............................................................................ 21 Table 3.2: Access Parameters ......................................................................................................... 22 Table 3.3: ts_menu Parameters ....................................................................................................... 25 Table 4.1: System/Security Options ................................................................................................. 30 Table 4.2: System/Boot Configuration Options ............................................................................... 31 Table 4.3: Date and Time Options................................................................................................... 31 Table 4.4: Help and Language Options........................................................................................... 32 Table 4.5: System/Usage Options .................................................................................................... 33 Table 4.6: Network Options............................................................................................................. 33 Table 4.7: Network/IPv4 and IPv6 Options..................................................................................... 34 Table 4.8: Network/Devices Options ............................................................................................... 35 Table 4.9: Network/Hosts Options................................................................................................... 37 Table 4.10: Network/Firewall Options ............................................................................................ 37 Table 4.11: Network/IPSec(VPN) Options ...................................................................................... 38 Table 4.12: Network/SNMP Options ............................................................................................... 38 Table 4.13: Ports Options................................................................................................................ 39 Table 4.14: Serial Port Commands ................................................................................................. 41 Table 4.15: Pluggable Devices Options .......................................................................................... 43 Table 4.16: Authentication Options................................................................................................. 44 Table 4.17: Users Options ............................................................................................................... 44 Table 4.18: Syslog Options .............................................................................................................. 45 Table 4.19: Events_and_Logs Options ............................................................................................ 46 Table 4.20: Power Management Options Descriptions................................................................... 47 Table 4.21: Active Sessions Field Descriptions............................................................................... 48 Table B.1: Access Rights Groups .................................................................................................... 52 Table B.2: Commands Not Supported by the Migration CLI .......................................................... 53
viii
CHAPTER
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 information on how to install or operate your console server using the Web Manager, see the Cyclades ACS 6000 Installation/ Administration/User Guide. 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. Console server ports are shown in the following figure, and descriptions are listed in Table 1.1.
Table 1.1: ACS 6000 Advanced Console Server Port Descriptions Number 1 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
2 3 4
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. 2. Access the CLI through the console port, with Telnet, SSH or through the Web Manager. Enter the username and password at the prompt. The cli-> prompt appears.
Welcome to ACS6000 <host name>. Type help for more information --:- / 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.
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: system_tools. 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 (/).
For example, in the Web Manager, user configuration is done when an administrator selects 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 use the cd command followed by the path: cd /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 Chapter 2.
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 / level.
--:- / 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 / prompt, the following navigation options (path elements) appear.
--:- / cli-> cd<Tab><Tab> access/ active_sessions/ system_tools/ authentication/ change_password/ events_and_logs/ pluggable_devices/ ports/ power_management/ users/ monitoring/ network/ system/
When a regular user types the cd command and then presses Tab Tab at the / prompt, the following navigation options appear.
--:- / cli-> cd<Tab><Tab> access/ power_management/
Enter cd <one_or_more_path_elements> to move down one or more levels of the navigation tree:
At any level, you can press Tab Tab at the prompt to see the commands that can be entered at the current level.
---:- system_tools cli-><Tab><Tab> batch_mode cd commit echo exit ftp help hostname list_configuration ls opiepasswd passwd pwd quit reboot restore_configuration revert save_configuration scp shell show shutdown upgrade_firmware whoami wiz
If you know the path, you can enter multiple path elements in a single command separated with forward slashes (/).
--:- / cli-> cd 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 ../.. --:- / 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 acc and press Tab at the CLI prompt from the / level, the access option will be completed.
--:- / cli-> cd acc<Tab>
If you then press Enter, you are changed to the access level, and the access level prompt appears.
--:- access cli->
The following example illustrates a case when more than one command matches the letters typed.
--:- / cli-> sh<Tab> shell show
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.
Syntax used:
^ * | : beginning of the element : 0 - many : or
() : group
CHAPTER
help
Generate a help message about how to navigate the CLI. Syntax:
--:- / 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.
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
10
Other hints: Use backslash '\' to escape spaces, '\' and other control characters when assigning values to parameters.
add
Add a node. Syntax:
--:- / cli-> add <Path>
Example:
--:- / cli-> add network/hosts --:#- [hosts] cli->
delete
Delete a node. Syntax:
--:- / cli-> delete <Path> <parameter>
cd
Change directory (level). Syntax:
--:- / cli-> cd <Path>
Example:
--:- / cli-> cd access
Example:
--:- access cli-> cd .. -or--:- access cli-> cd ../
11
Example:
--:- access cli-> cd /
Example:
--:- access cli-> cd /information
pwd
Display the path to the current level (print working directory). Syntax:
--:- / cli-> pwd
connect
Connect to a serial port. Syntax:
--:- access cli-> connect <port_name>
Example:
--:- access cli-> connect 77-77-70-p-2
12
sniff
Connect to a serial port as an additional, view-only user. Syntax:
--:- access cli-> sniff <port_name>
Example:
--:- access cli-> sniff 77-77-70-p-2
share
Connect to a serial port as an additional, read/write user. Syntax:
--:- access cli-> share <port_name>
Example:
--:- access cli-> share 77-77-70-p-2
disconnect
Use the text session hot key to suspend the target session and return to the CLI. Syntax:
Ctrl+z
exit/quit
Exit the CLI and return to the login prompt. Syntax:
13
ftp
Connect to a remote FTP server. Syntax:
--:- / cli-> ftp [<server_IP_address>|<hostname>]
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:
--:- / cli-> scp [[user@]host1:]file1 [...] [[user@]host2:]file2
set
Set a parameter. Syntax:
--:- / 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.
**:- / cli->
14
commit
Save settings. Syntax:
**:- settings cli-> commit
revert
Undo a previous parameter setting. Syntax:
**:- / cli-> revert
ls
Show the available directories or subnodes at the current location. Syntax:
--:- / cli-> ls
Example:
--:- / cli-> ls authentication appliance_authentication/ authentication_servers/ --:- / cli->
show
Show the content of the current location (shows tables and parameters with current values). Syntax:
--:- / cli-> show
Example:
--:- language cli-> show appliance_languate = english --:- / cli->
list_configuration
List the configuration in a format that allows pasting the output directly on the appliance session (console, SSH or Telnet) in order to (re)configure the unit. All configurable parameters are listed under the current node. When the parameter is not configured, the parameter name has the number sign character (#) as its prefix. Syntax:
15
Example:
.list configuration of network device eth0: --:- cli-> cd network/devices/eth0 --:- eth0 cli-> list_configuration echo off cd /network/devices/eth0 batch_mode set status=enabled set ipv4_method=dhcp #set ipv4_method=static #ipv4_address=192.168.160.10 #ipv4_mask=255.255.255.0 #set ipv4_method=ipv4_address_unconfigured #set ipv6_method=stateless #set ipv6_method=dhcpv6 #set ipv6_method=static #ipv6_address= #ipv6_prefix_length= set ipv6_method=ipv6_address_unconfigured set mode=auto submit echo on commit --:- eth0 cli->
NOTE: Check the configuration of the program used to open a session against the appliance (SSH/Telnet, TeraTerm / HypertTerminal for console, and so on) to avoid the inclusion of a line feed character in lines that exceed terminal width, because this will affect the past operation.
To power control (on, off, cycle) all outlets of PDUs or outlets merged to a target (serial port configured as CAS profile with merged outlets): 1. 2. Go to the access level.
--:- / cli-> cd/access
Launch the power command with the argument being the target name or PDU ID.
--:- access cli-> [cycle|on|off][<PDU_ID>]|<target name>]
16
To power control (on, off, cycle) outlets of one specific PDU: 1. 2. Go to the PDU level under access.
--:- / cli-> cd access/<PDU_ID>
Launch the power command with a specific outlet (number or name), range of outlets (use a hyphen to specify the range) or list of outlets (number or name separated by a comma).
--:- <PDU_ID> cli-> [cycle|on|off][<outlet name>|<outlet number>]
To power control (on, off, cycle, lock, unlock) outlets of one specific PDU under the power management level: 1. 2. Go to the outlet level for the specific PDU.
--:- / cli-> cd power_management/pdus/<PDU_ID>/outlets
Launch the power command with a specific outlet number, range of outlets (use a hyphen to specify the range) or list of outlets (number or name separated by a comma).
--:- outlets cli-> [cycle|on|off] [<outlet number>]
passwd
Configure the password for the current user. The terminal does not echo the password. Syntax:
--:- / 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:
--:- / cli-> opiepasswd
Example:
opiepasswd -f -c teste Adding teste:
17
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 FOOD HUGH SKI ALMA LURK BRAD
list_shared_session
List the users connected to the shared serial port. Syntax:
--:- <serial_port_ID> cli-> list_shared_session
kill_shared_session
Terminate the connection of a user on the port. The user is returned to the cli-> prompt. Syntax:
--:- <serial_port_ID> cli-> kill_shared_session <username>
Example:
--:- <serial_port_ID> cli-> kill_shared_session 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.
18
View the data logging for the appliance. Appliance Session Data logging must be enabled in Events and Logs/Appliance Logging Syntax:
--:- / cli -> show_appliance_databuf
Clear the data logging for the appliance. Appliance Session Data logging must be enabled in Events and Logs/Appliance Logging Syntax:
--:- / cli -> clean_appliance_dbuf
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)
19
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.
To configure IPv6 (example of how to perform the equivalent of Web Manager checkbox selection/deselection): 1. 2. Log into the CLI and enter cd network/settings.
--:- / cli-> cd network/settings
3.
Type set enable_ipv6= and press Tab to view the options for the parameter.
--:- ipv6 cli-> set enable_ipv6=<Tab> no yes
4.
5.
6.
20
7.
Enter commit.
21
CHAPTER
By default, all serial ports and the AUX/Modem port are disabled. An administrator must enable and configure the ports before anyone can use them. Configuration of ports differs based on the type of connected device, which can be either a device console, a PDU or modem. By default, all users can access all enabled and configured ports. The administrator must decide whether to restrict user access to ports by the assignment of authorizations to user groups. A user who is in an authorized group is referred to as an authorized user. Some port configuration tasks are provided as examples of how to use the CLI. See the Cyclades ACS 6000 Installation/Administration/User Guide for an overview of the tasks the administrator must do to configure restricted access to ports. For more information about how to follow the Web Manager procedures in the CLI, see Configuration Tasks Performed With the CLI on page 3. This section describes the following tasks related to port access, configuration, power management and where the tasks are performed in the CLI.
Table 3.1: Port Access and Configuration Tasks Task View information about the console server and the connected devices Authorized users access enabled and configured ports Authorized users manage power on outlets Where Performed access show
access/<PDU_ID>/outlets -orpower_management/PDUs/<PDU_ID>/outlet_table
Administrators configure ports connected to the ports consoles of devices NOTE: See Chapter 3 for all Ports options.
22
Table 3.2: Access Parameters Field For Appliance Name Port Type Status For Serial Port Name Either the default name [XX-XX-XX-p-n (where n=port_number)], an administratorassigned alias or an auto-discovered server name Number of the serial port Serial Idle / In-Use Name assigned to the appliance (for example, ACS6048-1357908642) N/A N/A N/A Description
PDU ID (either the default name in the format XX-XX-XXPXX_n or an administratorassigned alias, such as myPDU) Number of the serial port/position on the chain PDU model Number of Outlets ON | Total outlets NOTE: Enter cd <PDU_ID>/outlets and enter show to see list of outlets and the actions that can be taken (commands that can be executed) for each outlet as shown below. Either the default XX-XX-XXPXX_n_n or an administrator-assigned name
Name
23
Table 3.2: Access Parameters (Continued) Field Port Type Status Action Description PDU outlet number Outlet ON / OFF None
To view information about the console server and connected devices: 1. 2. Log into the CLI and enter cd access to change to the Access level.
--:- / cli-> cd access
Enter show. Information about the console server and the ports the current user is authorized to access appears.
--:- access cli-> show Name Port Type Status ===================================== ACS6016-0011223344 21-67-72-p-1 1 serial in-use 21-67-72-p-2 2 serial idle 21-67-72-p-4 4 serial idle myPDU 3|1 PM8|15A 8|8 Type ls to see available sub-nodes --:- access cli->ls ACS6016-0011223344/ 21-67-72-p-1/ 21-67-72-p-2/ 21-67-72-p-4/ myPDU/ Type show to see the content of the page --:- access cli->
24
1.
Log into the CLI and enter cd access to navigate to the Access level.
--:- / cli-> cd access --:- access cli->
2.
Enter connect <serial_port_name>. If authentication is configured for the port, the Password prompt appears when single sign-on is disabled.
--:- access cli-> connect 77-77-70-p-2 password:
NOTE: The connect command above shows a connection to a port that has an alias of 77-77-70-p-2.
3. 4.
If prompted, enter the password for the port. The following prompt appears.
Type the hot key to suspend the connection: <CTRL>z
Press Enter to continue. You are connected to the device that is connected to the port. The window shows the initial display for the device (usually a console banner and login prompt). An example is shown below.
Ubuntu 6.06.1 LTS fremont-techpubs ttyS2 fremont-techpubs login: fred Password: Last login: Tue Oct 2 13:09:04 2007 on :0 Linux fremont-techpubs 2.6.15-28-386 #1 PREEMPT Wed Jul 18 22:50:32 UTC 2007 i68 6 GNU/Linux #
25
ts_menu options
-u <user> [-l] [-ro] <console port>
Table 3.3: ts_menu Parameters Parameter Description Invokes ts_menu as the user named by <user>. This requires a password to be entered. The user only has access to authorized serial ports. Generates a list of ports the user can access. Port aliases are shown if defined. Invokes ts_menu in read-only mode. You may connect in read-only mode to any port you have access to. If issued, produces a direct connection to that port. If you have no access rights to the port or if the port does not exist, the application returns a console not found message and terminates. The console port may be the port alias or the port number. Display TCP port. Display Local IP assigned to the serial port. Username to be used in SSH/Telnet or Raw command. Escape character used to close the target session. The default escape character is
Ctrl-X.
To close the target session: 1. 2. 3. Enter the escape character shown when you connect to the port. The menu with ports is displayed. Select the exit option to return to the shell prompt.
26
--:- / cli->
2.
Enter cd ports/serial_ports/ followed by the number of the port you want to configure (port 1 is used as an example).
--:- / cli-> cd ports/serial_ports/set_cas 1
3.
4.
Enter set port_settings/status=enabled, then enter commit and show as shown to enable the configured port, save the settings and verify the configuration.s
--:- serial_ports/physical cli-> set status=enabled --:- serial_ports/physical cli-> show
To enable a power management port: 1. Log onto the CLI as an administrator and enter cd ports/serial_ports/<port_name> to select a port with a PDU connected (port 3 is used as an example).
--:- / cli-> cd ports/serial_ports/set_power 3
2.
27
speed = 9600 parity = none data_bits = 8 stop_bits = 1 flow_control = none Type ls to see available sub-nodes --:- serial_ports/physical cli->
3. 4.
Enter set status=enabled then enter save to set the Serial_Profile to Power, enable the port and commit the changes. Enter show to verify the configuration.
--:- serial_ports cli-> show Port ==== 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 Device ====== ttys1 ttys2 ttys3 ttys4 ttys5 ttys6 ttys7 ttys8 ttys9 ttys10 ttys11 ttys12 ttys13 ttys14 ttys15 ttys16 Name ================== ACS6016-0088664422 21-67-72-p-2 power 21-67-72-p-4 21-67-72-p-5 21-67-72-p-6 21-67-72-p-7 21-67-72-p-8 21-67-72-p-9 21-67-72-p-10 21-67-72-p-11 21-67-72-p-12 21-67-72-p-13 21-67-72-p-14 21-67-72-p-15 Profile ======= cas cas cas cas cas cas cas cas cas cas cas cas cas cas cas dial-in Settings ========================= 9600_8N1_telnet-ssh_local 9600_8N1_telnet-ssh_local 9600_8N1_telnet-ssh_local 9600_8N1_telnet-ssh_local 9600_8N1_telnet-ssh_local 9600_8N1_telnet-ssh_local 9600_8N1_telnet-ssh_local 9600_8N1_telnet-ssh_local 9600_8N1_telnet-ssh_local 9600_8N1_telnet-ssh_local 9600_8N1_telnet-ssh_local 9600_8N1_telnet-ssh_local 9600_8N1_telnet-ssh_local 9600_8N1_telnet-ssh_local 9600_8N1_telnet-ssh_local 38400
28
29
CHAPTER
This chapter describes using the Command Line Interface for administrators. Only administrators and authorized users can access the commands listed in this chapter. These procedures assume you have logged into the CLI as an administrator and are at the --:- / cli-> prompt.
NOTE: In the tables that show output from the show command, when an option that is followed by an equal sign (=) is left blank, that option is not assigned a value by default.
System
1. 2. Enter cd system to navigate to the System level.
--:- / cli-> cd system
3.
Enter show followed by an option name to view information about each option.
--:- security cli-> show security_profile
System/Security
Enter cd security to navigate to the security level.
30
31
System/Boot Configuration
Enter cd system/boot_configuration to navigate to the boot_configuration level.
--:- / cli-> cd system/boot_configuration
Table 4.2: System/Boot Configuration Options Boot Configuration Navigation Tree boot mode= console_speed= eth0_mode= eth1_mode= watchdog_timer= boot_mode/ flash image=image
32
Table 4.3: Date and Time Options (Continued) Date and Time Navigation Tree time_zone predefined zone=set
To set the online help URL: Perform this procedure if you have downloaded the online help files to a web server that is accessible to the console server. 1. 2. Enter the following command.
--:- / cli> cd system/help_and_language/
3.
System/Information
1. 2. Enter cd system/information to navigate to the Information level.
--:- / cli> cd system/information/
System/Usage
Enter cd system/usage to navigate to the Usage level.
33
Network
1. 2. Enter cd network to navigate to the Network level
--:- / cli-> cd network/
Network/Settings
1. 2. Enter cd network/settings to navigate to the Network settings level.
--:- / cli-> cd network/settings/
Table 4.6: Network Options Network Navigation Tree settings domain= enable_bonding= enable_ipv6=
34
Table 4.6: Network Options (Continued) Network Navigation Tree hostname= primary_dns= secondary_dns= enable_ipv6 get_dns_from_dhcpv6= get_domain_from_dhcpv6=
Network/Devices
The procedure to configure a static IP address for the primary Ethernet interface is usually performed during installation so that administrators have a fixed IP address for access to the Web Manager and can finish configuration. To configure a IPv4 or IPv6 static IP address:
NOTE: This procedure configures either an IPv4 or IPv6 static IP address for the ETH0 (eth0) or the ETH1 (eth1) port. You can configure an IPv6 static IP address only if IPv6 is enabled.
1.
Enter cd network/devices/<eth0|eth1>/settings to navigate to the Settings level for the desired interface.
35
2. 3.
Enter set ipv<4|6>_method=static to set the method to static for IPv4 or IPv6.
**:- eth0 cli-> set ipv4_method=static
Enter set ipv<4|6>_address=<IP_Address> ipv<4|6>_mask=<netmask> to set the IP address and subnet mask, then enter commit to save the change.
--:- eth0 cli-> set ipv4_address=172.26.31.10 ipv4_mask=255.255.255.0 **:- eth0 cli-> commit
4.
Table 4.8: Network/Devices Options Devices Navigation Tree devices eth0 ipv4_method= ipv6_method= mode= status= eth1 ipv4_method= ipv6_method=
Network/Hosts
The following procedure describes how to add a host to the hosts table. To add a host to the host table: 1. 2. Enter cd network/hosts to navigate to the Hosts level.
--:- / cli-> cd network/hosts
36
127.0.0.1/
3.
4.
Enter set hostname=<hostname> ip=<IP_address> to add the name of a host and the IP address for the host.
NOTE: Each parameter that follows the add command is separated by a space.
5. 6.
Enter commit.
--:#- [hosts] cli-> save
Enter show to verify the changes took place and to view the new host entry.
--:- hosts cli-> show 127.0.0.1 ip: 127.0.0.1 hostname: localhost alias: 172.26.31.164 ip: 172.26.31.164 hostname: sharedacs6000 alias: 127.0.0.1/add 172.26.31.164/
7.
Enter cd <IP_address>/settings to navigate to the level where you can perform additional configuration of the host entry.
--:- hosts cli-> cd 172.26.31.164/settings
8.
Enter show to view the additions to the host table and the Settings option.
--:- 172.26.31.164 cli-> show ip: 172.26.31.164 sharedacs6000
hostname =
37
alias =
Table 4.9: Network/Hosts Options Hosts Navigation Tree hosts 127.0.0.1 alias= hostname=
Network/Firewall
Enter cd network/firewall to navigate to the firewall level.
--:- / cli-> cd network/firewall
NOTE: To set a rule, you must enable the interface, set the rule for the interface and physically connect the interface to the network. Table 4.10: Network/Firewall Options Firewall Navigation Tree firewall ipv ipv4_filter_table FORWARD INPUT OUTPUT ipv6_filter_table FORWARD INPUT OUTPUT
Network/IPSec(VPN)
Enter cd network/ipsec(vpn) to navigate to the ipsec(vpn) level.
38
Network/SNMP
Enter cd network/snmp to navigate to the snmp level.
--:- / cli-> cd network/snmp
Table 4.12: Network/SNMP Options SNMP Navigation Tree snmp public_v1|v2/ oid= permission= source=
Wiz command
The wiz command allows administrators to easily and quickly perform the initial network configuration of the eth0. At the command prompt at the / level, enter wiz to view the current IP configuration. To change the IP configuration, press Tab to move through the parameters, and press Esc + Tab to edit the selected parameter. When you are finished, enter yes to confirm that all parameters are correct and to save the new parameters.
--:- / cli-> wiz Current IPv4 address: 172.26.30.249 Current IPv6 address: eth0: device_status = enabled ipv4_method = dhcp ipv4_address = 192.168.160.10 ipv4_mask = 255.255.255.0
39
ipv4_default_gateway = ipv6_method = ipv6_address_unconfigured ipv6_address = ipv6_prefix_length = ipv6_default_gateway = MAC Address: 00:e0:86:21:67:72 dns: primary_dns = 172.26.29.4 secondary_dns = domain = corp.avocent.com hostname = ACS6016-0011223344
Some basic and useful keys are: - tab (once/twice) - shows the next possible commands/option(s) - esc tab - gets the current parameter value for editting Other hints: - Use backslash '\' to escape spaces, '\' and other control characters when assigning values to parameters.
Current IPv4 address: 172.26.30.249 Current IPv6 address: eth0: device_status (disabled, enabled) [enabled]:
Ports
Enter cd ports to navigate to the Ports level.
--:- / cli-> cd ports
Table 4.13: Ports Options Ports Navigation Tree serial ports auxiliary ports ttyA1
40
Table 4.13: Ports Options (Continued) Ports Navigation Tree cas_profile auto_discovery settings auto_discovery_timeout_(seconds)= default_speed_on_auto_discovery_failure= probe_speed_115200= probe_speed_1200= probe_speed_19200= probe_speed_230400= probe_speed_2400= probe_speed_38400= probe_speed_4800= probe_speed_57600= probe_speed_9600= probe_timeout_(seconds)= pool_of_ports pool_name= pool_tcp_port_alias= pool_ipv4_alias= pool_ipv4_alias_interface= pool_ipv6_alias= pool_ipv6_alias_interface= pool_members= dial-in_profile secure_dial-in callback_users settings
41
Table 4.13: Ports Options (Continued) Ports Navigation Tree log_in_to_appliance= otp_login_authentication= ppp_connection= ppp|pap_authentication=
Table 4.14: Serial Port Commands Command set_cas Summary Edits the command to configure a list of serial ports with the CAS profile. Syntax: set_cas<serial port number>, <serial port number> This command has five sub-nodes: physical, cas, data_buffering, alerts and power. Edits the command to configure one serial port with the Dial-In profile. Syntax: set_dialin<serial port number> Edits the command to configure a list of serial ports with the Power profile. Syntax: set_power<serial port number>, [<serial port number>] This edit has two sub-nodes: physical and power. Copies the configuration from one port to a list of serial ports. Syntax: clone_ports<serial port number> Resets the serial ports to factory configuration. (This is disabled for CAS profile.) Syntax: reset_port_to_factory<serial port number>, [<serial port number>] Enables serial ports. Syntax: enable_ports<serial port number>, [<serial port number>] Disables serial ports. Syntax: disable_ports<serial port number>, [<serial port number>]
set_dial_in
set_power
clone_ports
reset_port_to_factory
enable_ports
disable_ports
Example of how to set a list of serial ports 2,5 and 6 with the CAS Profile and enable the status:
--:- serial_ports cli-> cd /ports/serial_ports --:- serial_ports cli-> set_cas 2,5,6 --:#- [serial_ports/physical] cli-> set status=enabled --:#- [serial_ports/physical] cli-> show
42
Selected items: 2|5|6 Port: 2 enable_cisco_rj45_pin-out = no status = enabled speed = 9600 parity = none data_bits = 8 stop_bits = 1 flow_control = none Type ls to see availables sub-nodes. --:#- [serial_ports/physical] cli-> ls cas/ data_buffering/ alerts/ power/ Type show to see the content of the page. --:#- [serial_ports/physical] cli->save --:- serial_ports cli->
Auxiliary ports
Enter cd ports/auxiliary_ports to navigate to the auxiliary ports level.
--:-cli-> cd /ports/auxiliary_ports/
If an internal modem is factory installed, the two available serial_profile options are Unconfigured and Dial-in. If an internal modem is not installed, either an external modem or a PDU can be connected to the port and a third serial_profile option, Power, is available.
43
Appliance with an internal modem When an internal modem is factory installed, the port name is ttym1. To enable the internal modem:
--:-cli-> cd /ports/auxiliary_ports/ --:- auxiliary_ports cli-> show Device Name: ttyM1 status = disabled speed = 38400 init_chat = "" \d\d\d+++\d\d\dATZ OK ppp_address = no_address ppp_authentication = none chap-interval = 0 chap-max-challenge = 10 chap-restart = 3 ppp_idle_timeout = 0 --:- auxiliary_ports cli->set status=enabled --:- auxiliary_ports cli->commit
Appliance without an internal modem: If no internal modem is installed, the port name is ttya1. Enter the commands: set_dial-in or set_power to configure the auxiliary port.
--:- / cli-> cd ports/auxiliary_ports/ --:- auxiliary_ports cli-> show Port Device Status Profile ===== ====== ======== ============ ttyA1 ttyA1 disabled unconfigured Type ls to see availables sub-nodes. --:- auxiliary_ports cli->
Pluggable Devices
Enter cd pluggable_devices to navigate to the pluggable_devices level.
--:- / cli-> cd pluggable_devices
Table 4.15: Pluggable Devices Options Pluggable Devices Navigation Tree device_name
44
Table 4.15: Pluggable Devices Options (Continued) Pluggable Devices Navigation Tree device_type card device_info
Authentication
Enter cd authentication to navigate to the authentication level.
--:- / cli-> cd authentication
NOTE: Kerberos does not work unless the administrator copies the /etc/krb5.keytab file from the Kerberos server and overwrites the /etc/krb5.keytab file in the console server. Table 4.16: Authentication Options Authentication Navigation Tree appliance_authentication authentication_servers radius tacacs+ ldap(s)/ad kerberos nis dsview
Users
Enter cd users to navigate to the users level.
--:- / cli-> cd users
Table 4.17: Users Options Users Navigation Tree local_accounts user_names root
45
Table 4.17: Users Options (Continued) Users Navigation Tree admin password_rules password enforcement default expiration authorization groups admin appliance-admin user
To add a user and password: 1. 2. Enter cd users/local_accounts/user_names to navigate to the user_names level.
--:- / cli-> cd users/local_accounts/user_names
Enter add. Then enter set with the parameters all on one line separated by spaces as shown.
--:- user_names cli-> add --:#- [user_name] cli-> set user_information/ user_name=fred password=smith123abc confirm_password=smith123abc --:#- [user_names] cli->
3. 4.
Enter save.
--:#- [user_names] cli-> save
Enter show to verify that the new user has been added.
--:#- [user_names] cli-> show
Syslog
Enter cd appliance_settings/syslog to navigate to the syslog level.
--:- / cli-> cd appliance_settings/syslog
Table 4.18: Syslog Options Syslog Navigation Tree remote_server_ipv4 server_ip_or_hostname (to specify multiple servers, separate the entries with commas)
46
Table 4.18: Syslog Options (Continued) Syslog Navigation Tree remote_server_ipv6 server_ip_or_hostname (to specify multiple servers, separate the entries with commas) appliance_console root_session
Events_and_Logs
Enter cd events_and_logs to navigate to the events_and_logs level.
--:- / cli-> cd events_and_logs
Table 4.19: Events_and_Logs Options Events_and_Logs Navigation Tree event list event destinations syslog snmp trap sms email dsview data_buffering local_data_buffering_settings segment_size_(kbytes) = spare_segements= nfs_data_buffering_settings nfs_server = nfs_path = segment_size_(kbytes) = spare_segments =
47
Table 4.19: Events_and_Logs Options Events_and_Logs Navigation Tree syslog_data_buffering_settings syslog_facility = sensors current_temperature: (deg_c, display only) maximum_temperature_(deg_c) = maximum_temperature_threshold_(deg_c) = (positive integer between 0 and 4) minimum_temperature_ (deg_c) = minimum_ temperature_threshold_(deg_c) = (positive integer between 0 and 4)
Power Management
The Power Management Options are described in Table 4.20.
Table 4.20: Power Management Options Descriptions Option pdus Description Allows an authorized user to reboot, restore factory default settings or to rename PDU(s). Also allows the authorized user to view information about each PDU, monitor sensors, clear sensor values, set up syslogging of events related to the PDU, configure an alarm and the LED display mode, and to manage outlets on the PDU. Lists all configured outlet groups that the current user is authorized to manage (to manage outlet groups, the user must be in a user group that is authorized to manage all the outlets in the outlet group). An administrator can configure outlet groups.
outlet_groups
To rename a PDU: 1. Log onto the CLI as an administrator and enter cd power_management/pdus to navigate to the pdus level.
--:- / cli-> cd power_management/pdus
2. 3.
NOTE: See the Cyclades ACS 6000 Installation/Administration/User guide for how to perform other authorized PDU configuration options.
48
To manage power for a selected outlet: See cycle, on, off, lock and unlock on page 15 for how to manage power at the power_management level.
To view and kill Active_Sessions: 1. From the / level CLI prompt, enter cd active_sessions.
--:- / cli-> cd active_sessions --:- active_sessions cli->
2.
49
3.
To kill a session (if authorized), enter kill followed by the session number.
50
51
APP ENDICE S
Appendices
Appendix A: Enabling Firmware Upgrades When the Boot Image is not in Flash
To enable firmware upgrades when the boot image is not in Flash: 1. Connect to the console of the console server as root.
Welcome to ACS6000 <host name>. Type help for more information. --:- / cli->
2.
3.
The Flash memory is formatted, and the version of firmware in memory is stored in Flash. The command prompt reappears. 4. Enter reboot.
[root@ACS6048-3131313131 ~]# reboot
When the system reboot completes, the Web Manager supports firmware upgrades.
52
In the ACS 6000 console server, the login profile for the user root goes directly to the shell prompt. This will allow the root user to run Migration CLI commands out of the ACS 6000 console server. A new group, login-profile-shell, is created with only root as a member. To run commands based from an ACS advanced console server, a root user should type CLI before the command.
Access rights
The access rights on the ACS 6000 console server are based on authorization groups. The administrator configures the serial ports the group can access. To allow you to configure access rights, the following table displays authorization groups that will be created on the ACS 6000 console server when using the Migration CLI.
Table B.1: Access Rights Groups Group cli_mus_ttySxx Members Users who can open a second session to a serial port. Users who have power control in a serial port. Users who can access a serial port in a single session. <username> Permissions Access to a serial port in a mulisession (read/write or read only) Power control (on/off/cycle) of outlets merged to a serial port. Access to a serial port in a single read/write session. Power control of the outlet.
cli_power_ttySxx
cli_access_ttySxx
cli_pmd_ <username>
Exceptions
This section will list all ACS advanced console server CLI commands not available in the Migration CLI for the ACS 6000 console server. For a list of available commands, see the Cyclades ACS Installation/Administration/User Guide.
Appendices
53
The following commands or values are not supported by the Migration CLI:
Table B.2: Commands Not Supported by the Migration CLI Command administration backupconfig loadfrom sd backupconfig saveto sd upgradefw checkum application connect pm view config administration bootconf bootype flashtest maxevents ramtest config administration notifications addemail addpager addsnmptrap alarm delete edit config application pmdconfig general add delete config application terminalmenu add delete N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A bootp/both/ftp full/skip <number> full/quick/skip N/A N/A N/A N/A N/A N/A Value or Descriptions
54
Table B.2: Commands Not Supported by the Migration CLI (Continued) Command menutitle config network hostSettings secipaddress secsubnetmask mtu config physicalports access users/groups authtype termshell logintimeout config physicalports databuffering mode showmenu syslogsize config physicalports general pmsessions protocol none/ssh/ssh_telnet/telnet bidirectionaltelnet, consoleraw, cslip, local, rawsocket, slip, sshv1, sshv2, telnet cir/lin file/fileanderase/no/noerase/yes <record length in bytes[40-255]> accepts only list of usernames assume local <shell command> <login timeout in seconds> <nnn.nnn.nnn.nnn> <nnn.nnn.nnn.nnn> N/A Value or Descriptions N/A
config physicalports multiuser users sniffmode config physicalports other SSHexitkey banner host sttyoptions tcpkeepalive <SSH exit key> <login banner> <host> <stty options> <number> accepts only list of users in/inout/no/out
Appendices
55
Table B.2: Commands Not Supported by the Migration CLI (Continued) Command terminaltype Value or Descriptions aixterm, att6386, linux-lat, vt100, vt320, xtermcolor, ansi, ibm3151, scoansi, vt102, vt52, at386, linux, sun, vt220, xterm no/yes <number>
winems idletimeout
config physicalports power management enableIPMI disableIPMI key server config security addgroup/delgroup config security adduser shell comments config security profile custom ports auth2sport ports bidirect ports raw2sport ports ssh2sport ports telnet2sport ssh ssh_x509 config virtualport config ipmi security authentication authtype pppauthtype timeout Otp, Otp/Local Otp, Otp/Local <all or range/list[1-numberOfPorts]> no/yes no/yes no/yes no/yes no/yes no/yes <shell cmd but ts_menu> <comments> N/A N/A N/A N/A N/A
56
Table B.2: Commands Not Supported by the Migration CLI (Continued) Command -t<time> -T config security loadkey url username N/A N/A Value or Descriptions Time-out in minutes Disable the idle time-out. Same as -t0
Appendices
57
Su command
Using the su (switch user) command, a user can switch to another user account to execute commands not authorized with their normal account. If used without a username, the su command defaults to root. Only users who are members of the wheel group can execute the su command to log in as root.
NOTE: The wheel group is a Linux group and is included in the firmware by default.
You will be prompted for the password of the account youre trying to switch to with the su command. You will remain logged into that account until you either press Ctrl-D or type exit.
NOTE: The su command will open a shell session instead of the restricted shell. The user will receive the shell prompt. Improper use of shell commands could lead to data loss. Double-check your syntax when using shell commands.
Syntax:
su [options][-][username[arguments]]
The following table describes options that can be used with the su command.
Table C.1: Su Command Options Option -, -l, --login Description Uses an environment similar to that had the user logged in directly. NOTE: When - is used, it must be specified as the last su option.
Optional arguments may be provided after the username, in which case they are supplied to the shell (/bin/sh). To add a member to the wheel group: 1. 2. 3. 4. Create the user using the On-Board Web Interface (OBWI) or CLI. Open a session in the appliance and log in as root. In the shell prompt, run the usermod command to add the user to the wheel group.
# usermod -G wheel <username>
58
Sudo command
Using the sudo (superuser do) command, a user can execute a command using the privileges of another user (often root), as specified in the /etc/sudoers file. The user is authenticated using his own password, not the root password. The /etc/sudoers file logs all commands and arguments. Syntax:
sudo <command>
Configuring sudo A system administrator configures the /etc/sudoers file to give groups or users access to some or all commands not authorized with their normal account. An administrator should log into the console server as a root user and edit the /etc/sudoers file by using the /usr/sbin/visudo command to configure sudo. The sudoers file is composed of aliases and user specifications. When multiple entries match for a user, they are applied in order. Where there are conflicting values, the last match is used. Since the sudoers file is parsed in a single pass, order is important. You should structure sudoers so that the Host_Alias, User_Alias, and Cmnd_Alias specifications come first, followed by any Default_Entry lines, and finally the Runas_Alias and user specifications. An example of an /etc/sudoers file:
#User alias specification User_Alias FULLTIMERS = millert, mikef, dowdy User_Alias PARTTIMERS = bostley, jwfox, crawl #Cmnd alias specification Cmnd_Alias KILL = /bin/kill Cmnd_Alias SHUTDOWN = /sbin/shutdown Cmnd_Alias REBOOT = /sbin/reboot Cmnd_Alias SU = /bin su FULLTIMERS PARTTIMERS ALL ALL = = KILL, SHUTDOWN, REBOOT, SU SHUTDOWN, REBOOT
In the preceding example, the users millert, mikef and dowdy can execute the kill, shutdown, reboot and su commands while the users bostley, jwfox and crawl can only shut down and reboot the console server.
Appendices
59
60
590-770-501D