2
CLI Command Set
Commands Used for the CLI
This chapter describes the general commands used when accessing the console server with the command line interface.
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:
--:- / 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.
7
8 Cyclades™ ACS 6000 Advanced Console Server
add delete
Delete a node.
Syntax:
--:- / cli->
delete <Path> <parameter>
cd
Add a node.
Syntax:
--:- / cli->
add <Path>
Example:
--:- / cli->
add network/hosts
--:#- [hosts] cli->
Change directory (level).
Syntax:
--:- / cli->
cd <Path>
Example:
--:- / cli->
cd access
Displays the following:
--:- access cli->
Example:
--:- access cli->
cd ..
-or-
--:- access cli->
cd ../
Moves up one directory level and displays the following:
--:- / cli->
Example:
--:- access cli->
cd /
Moves to the top level and displays the following:
--:- / cli->
Example:
--:- access cli->
cd /information
Displays the following:
--:- information cli->
Chapter 2: CLI Command Set
9 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
-or-
(Optional) From the default directory:
--:- / cli->
connect access/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 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 port as an additional, view-only user.
Syntax:
--:- access cli->
sniff <port_name>
Example:
--:- access cli->
sniff 77-77-70-p-2
Displays the following:
Password:
-or-
Type the hotkey to suspend the connection:
Ctrl + z
10 Cyclades™ ACS 6000 Advanced Console Server
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
Displays the following:
Password:
-or-
Type the hotkey to suspend the connection:
Ctrl + z 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:
--:- / cli->
exit
-or-
--:- / cli-> quit
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
Chapter 2: CLI Command Set
11 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->
Save the change:
**:- / cli->
commit
-or-
Undo the change:
**:- / 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:
**:- 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->
12 Cyclades™ ACS 6000 Advanced Console Server
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:
--:- / cli->
list_configuration
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->
Chapter 2: CLI Command Set
13
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.
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 when the port is enabled and configured with the Power Profile.
NOTE: Lock and unlock commands are only supported on Cyclades and Avocent PDUs.
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.
Go to the access level.
--:- / cli->
cd/access
2.
Launch the power command with the argument being the target name or PDU ID.
--:- access cli->
[cycle|on|off][<PDU_ID>]|<target name>]
To power control (on, off, cycle) outlets of one specific PDU:
1.
Go to the PDU level under access.
--:- / cli->
cd access/<PDU_ID>
2.
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>]
-or-
--:- <PDU_ID> cli->
[cycle|on|off]<outlet number>-<outlet number]
-or-
--:- <PDU_ID> cli->
[cycle|on|off]<outlet number>,<outlet number>
To power control (on, off, cycle, lock, unlock) outlets of one specific PDU under the power management level:
1.
Go to the outlet level for the specific PDU.
--:- / cli->
cd power_management/pdus/<PDU_ID>/outlets
2.
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>]
-or-
--:- outlets cli->
[cycle|on|off] <outlet number>-<outlet number]
-or-
--:- outlets cli->
[cycle|on|off] <outlet number>,<outlet number>
14 Cyclades™ ACS 6000 Advanced Console Server
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.
NOTE: Use this command to restart the sequence number.
Syntax:
--:- / cli->
opiepasswd -f -c <username>
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
FOOD HUGH SKI ALMA LURK BRAD
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
• Enable or disable IPv6 support
After setting all parameters, confirm that all parameters are correct to save them.
Chapter 2: CLI Command Set
15
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.
--:- / cli->
cd access/<serial_port_ID>
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.
show_databuf and show_appliance_databuf
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-> show_databuf
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
The following commands are available for show data buffering:
•
Return - Scroll forward one line.
16 Cyclades™ ACS 6000 Advanced Console Server
•
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 and clean_appliance_databuf
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 Events and
Logs/Appliance Logging
Syntax:
--:- / cli ->
clean_appliance_dbuf
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. The sub-parameters will be available after the option is enabled.
To configure IPv6 (example of how to perform the equivalent of web manager checkbox selection/deselection):
1.
Log into the CLI and enter cd network/settings.
--:- / cli->
cd network/settings
2.
Enter show to view the status of IPv6 configuration.
--:- settings cli->
show
hostname = ACS6048 primary_dns = 110.126.129.4
secondary_dns = domain = corp.tst.com
enable_ipv6 = no enable_bonding = no enable_ipv4_multiple_routing_tables = no
3.
Type set enable_ipv6= and press Tab to view the options for the parameter.
--:- ipv6 cli-> set enable_ipv6=<
Tab> no yes
4.
Enter set enable_ipv6=no to disable IPv6.
Chapter 2: CLI Command Set
17
--:- ipv6 cli-> set enable_ipv6=no
-or-
Enter set enable_ipv6=yes to enable IPv6.
--:- ipv6 cli-> set enable_ipv6=yes
5.
(Optional) Enter either of the following commands to enable subparameters.
**:- ipv6 cli->
set get_dns_from_dhcpv6=yes
**:- ipv6 cli->
set get_domain_from_dhcpv6=yes
6.
Enter show to verify the change.
**:- settings cli->
show
hostname = ACS6048 primary_dns = 110.126.129.4
secondary_dns = domain = corp.tst.com
enable_ipv6 = yes get_dns_from_dhcpv6 = no get_domain_from_dhcpv6 = no enable_bonding = no
7.
Enter commit.
18 Cyclades™ ACS 6000 Advanced Console Server
