Table Of Contents

Command Line Interface

Logging into and Exiting the CLI

Using CLI Commands

Syntax Conventions

Variable Argument Conventions

CLI Command Keyboard Shortcuts

Understanding CLI Syntax Checking and Error Messages

Getting CLI Help

CLI Reference

delete

delete admin

delete lb

delete route

download log

edit admin

enable

ping

quit

reboot

set

set admin

set am

set condenser

set console

set date

set dns

set hostname

set interface

set lb cluster

set lb server

set lb status

set log-server

set ntp

set route

show

show admin

show am

show condenser

show console

show date

show dns

show hostname

show interface

show lb

show log

show log-server

show ntp

show route

show sys-stat

show timezone

sysopen

traceroute

Command Line Interface

---

This chapter documents the command line interface (CLI) that you can use to configure certain basic operating parameters of the AVS software. The CLI is available on both the application appliance and the management station, though certain commands apply only to one device. This is noted in the command description.

---

Note The CLI is available only on the AVS 3120 and AVS 3180 devices. It is not available on older hardware or software products.

---

This chapter includes the following sections:

•Logging into and Exiting the CLI

•Using CLI Commands

•Getting CLI Help

•CLI Reference

Logging into and Exiting the CLI

To log in to the AVS device and access the CLI, you can use a terminal device connected to the console port on the AVS device, or you can use SSH over the network.

You can use the CLI from any terminal device that is compatible with ANSI, VT52, or VT100 characteristics. ANSI and VT100 devices let you use cursor-control and cursor-movement keys: left-arrow, up-arrow, down-arrow, right-arrow, Delete, and Backspace. The CLI senses the use of cursor-control keys and automatically uses the optimal device characteristics.

---

Note The first time you log in to the CLI, use the default login name of fgn and the default password of fineground.

---

To exit from the CLI, use the quit command.

Using CLI Commands

This section provides information on:

•Syntax Conventions

•Variable Argument Conventions

•CLI Command Keyboard Shortcuts

•Understanding CLI Syntax Checking and Error Messages

Syntax Conventions

To help you identify the parts of a CLI command, this chapter uses conventions to show the syntax of commands. Table 4-1 lists these syntax conventions and their descriptions.

Table 4-1 Syntax Conventions

Syntax Convention	Description
boldface	Identifies commands and options you must enter exactly as shown.
italics	Identifies variables you must supply. For more information on variable arguments, see the next section.
... (ellipsis)	Identifies the continuation of the command.
| (vertical bar)	Identifies mutually exclusive choices.
{ } (braces)	Encloses alternatives or variables that are required.
[ ] (square brackets)	Encloses optional keywords or variables.

---

Note Do not enter the ellipsis, brackets, vertical bar, or braces in command lines. This guide uses these symbols only to show the types of entries.

---

CLI commands and options are in lowercase and are case-sensitive. For example, when you enter the ping command, enter it all in lowercase, not PING or Ping. Text entries you create are also case-sensitive. For example, if you set a username to Sys1, enter it exactly, not sys1 or SYS1.

Variable Argument Conventions

Some commands require variable arguments for information you must supply. CLI command variable arguments generally consist of integers, quoted and unquoted text strings, IP addresses and subnet masks, host names, and interfaces.

Table 4-2 lists the types of arguments you may encounter and the conventions to enter this information.

Table 4-2 Variable Arguments 

Variable Argument	Convention
host names	Enter host names in mnemonic host-name format. For example: myhost.mydomain.com
integers	Enter only whole numbers with no decimal points. For example: 200
Internet Protocol (IP) Addresses and Subnet Masks	Enter IP addresses and subnet masks in dotted-decimal notation. This notation is four groups of up to three decimal numbers, separated by periods. Each group has a maximum number of 255. For example: 192.168.11.1 255.255.255.0
Interface	Interface entries specify physical interfaces present in the AVS. Enter interfaces in groups of four characters, like this: eth0 eth1
text strings, unquoted	Enter unquoted text strings as contiguous alphanumeric characters without spaces or quotation marks. For example: Sys_1 MyLink

CLI Command Keyboard Shortcuts

Table 4-3 lists the CLI keyboard shortcuts to help you enter and edit command lines.

Table 4-3 CLI Command Keyboard Shortcuts 

Action		Keyboard Shortcut
Cancel the current operation, or delete the current line.		Ctrl-C
Capitalize the character at the cursor.		Esc-C
Change:	The word at the cursor to lowercase.	Esc-L
	The word at the cursor to uppercase.	Esc-U
Delete:	A character at the cursor.	Ctrl-D
	A character to the left of the cursor.	Ctrl-H, or Backspace
	All characters from the cursor to the beginning of the line.	Ctrl-U
	All characters from the cursor to the end of the line.	Ctrl-K
	All characters from the cursor to the end of the word.	Esc-D
	The word to left of the cursor.	Ctrl-W or Esc-Backspace
Display the buffer's:	Next line.	Ctrl-N or Down Arrow
	Previous line.	Ctrl-P or Up-Arrow
Display multi- screen output:	Continue to next page of output.	any key except q
	Exit from displaying output.	q
Enter an Enter or Return key character.		Ctrl-M
Expand the command or abbreviation.		Ctrl-I or Tab
Move the cursor:	One character to the left (back).	Ctrl-B or Left Arrow
	One character to the right (forward).	Ctrl-F or Right Arrow
	One word to the left (back), to the beginning of current or previous word.	Esc-B
	One word to the right (forward), to the end of the current or next word.	Esc-F
	To the beginning of the line.	Ctrl-A
	To the end of the line.	Ctrl-E
Redisplay the current line.		Ctrl-L or Ctrl-R
Transpose a character at the cursor with a character to left of the cursor.		Ctrl-T

Understanding CLI Syntax Checking and Error Messages

If you enter an invalid or incomplete command, the CLI responds with an error message. The following example shows the CLI response when you enter an invalid command:

velocity>show time-zone

ERROR 5:

        Unknown/Unacceptable token

The following example shows the CLI response when you enter an incomplete command:

velocity>show timezone

ERROR 6:

        a required option was not found

        required option "current" is missing

Getting CLI Help

The question mark (?) character allows you to get the following type of help about a command at the command line:

Question Mark Usage	Command Help Type
? at command prompt	All commands for that mode
command ?	All options for a command
command option ?	All arguments for a command and its option

CLI Reference

This section provides detailed information for the CLI commands. The description for each command includes:

•The syntax for the command

•Any related commands, when appropriate

The following commands are available:

•delete •download log •edit admin •enable •ping •quit

•reboot •set •show •sysopen •traceroute

delete

To delete an administrator account, a load balancing configuration, or a static route, use the delete command. The options for this command are:

delete admin	Deletes an administrator account
delete lb	Deletes a load balancing configuration
delete route	Deletes a static route

delete admin

To delete an administrator account, use the delete admin command.

delete admin name name

Syntax Description

name name

Username of the account to delete

Usage Guidelines

Only the fgn account can delete other accounts.

Related Commands

edit admin
set admin
show admin

delete lb

To delete a load balancing configuration, use the delete lb command.

delete lb cluster name [server {all | name}]

Syntax Description

cluster name	Name of the load balancing virtual server to delete; or the name of the virtual server that contains the real server to delete
server all	(Optional) Delete all load balancing real servers from the specified cluster
server name	(Optional) Name of the load balancing real server to delete

Usage Guidelines

The delete lb command is available only on the AVS 3120. For more information about configuring load balancing, see "Availability Manager Clustering."

Related Commands

set lb cluster
set lb server

delete route

To delete a static route, use the delete route command.

delete route ip ip netmask mask gateway g_ip

Syntax Description

ip ip	The destination IP address
netmask mask	The IP subnet mask
gateway g_ip	The gateway IP address

Related Commands

set route
show route

download log

To download a log file, use the download log command.

download log {security | event} to user index {id | all}

Syntax Description

security | event	Download the security log or the event log
to user	The destination user and system IP address to download the log to, in the format user@ip_address
index	Specifies which log file(s) to download.
id	The integer index of the log file to download. There may be multiple security or event log files and this specifies which one you want.
all	Download all log files of the type specified (security or event)

Usage Guidelines

The download log command requires a ssh server at the remote end (corresponding to the specified IP address). The log file is placed in the user's home directory on the destination server. This behavior can be overridden by additional sshd/ssh configuration in the destination server.

To list the indexes of the log files that are available, use the command show log security | event index all

This will list the log files in order, beginning with index 0, like this:

velocity>show log security index all

 Log File Order                 Last Modification

 0-secure                    Wed Oct 26 15:45:38 2005

 1-secure                    Tue Oct 25 11:11:16 2005

The index is the number at the left of each row.

Related Commands

set log-server
show log-server
show log

edit admin

To change the username or password for an administrator account, use the edit admin command.

edit admin current-name name [new-name newname] [new-password password]

Syntax Description

name	Current username of the account to edit
new-name newname	(Optional) Specifies a new username for the account
new-password password	(Optional) Specifies a new password for the account

Usage Guidelines

Only the fgn account can change other accounts.

Related Commands

delete admin
set admin
show admin

enable

To enable the writing of system configuration parameters, use the enable command.

enable

Usage Guidelines

The enable command must be used in a console session before any of the set commands can be used.

If the user that is logged in does not have write privileges, this command will fail because this user is not allowed to use set commands. Write privileges are set by the set admin command that creates an account. Write privileges can be enabled for only one logged-in user at a time.

ping

To send Internet Control Message Protocol (ICMP) echo requests to test network connectivity, use the ping command.

ping ip_or_host

Syntax Description

ip_or_host

IP address for the host you want to test. Enter an IP address in dotted-decimal notation (for example, 192.168.11.1) or in mnemonic host-name format (for example, myhost.mydomain.com).

Related Commands

traceroute

quit

To exit the console session and log off the device, use the quit command.

quit

reboot

To reboot the device, use the reboot command.

reboot [safe-mode]

Syntax Description

safe-mode

(Optional) Directs the device to reboot in safe mode. This mode is used only for upgrade and maintenance procedures and not in normal operation.

set

To set a system configuration parameter, use the set command. The options for this command are:

set admin	Creates a new administrator account
set am	Configures the Availability Manager global settings
set condenser	Starts, stops or restarts the Condenser
set console	Starts, stops or restarts the Management Console
set date	Sets the system date
set dns	Sets the DNS servers
set hostname	Sets the system hostname
set interface	Configures the network interface
set lb cluster	Configures the load balancing cluster parameters for the Availability Manager
set lb server	Configures the load balancing server parameters for the Availability Manager
set lb status	Activates or deactivates the Availability Manager
set log-server	Configures remote logging
set ntp	Configures an NTP server
set route	Configures a static route

set admin

To create an administrator account, use the set admin command.

set admin name name password password {read | write}

Syntax Description

name name	Username of the new account
password password	Password for the account
read | write	Enables the account for read-only access or for read/write access

Usage Guidelines

Only the fgn account can create accounts.

Related Commands

delete admin
edit admin
show admin

set am

To configure the Availability Manager global settings, use the set am command.

set am [enable | disable] [backup-server {active | inactive}] [primary p_ip] [secondary s_ip] [frequency f_secs] [dead-detection-interval d_secs]

Syntax Description

enable | disable	(Optional) Enables or disables the AM feature
backup-server active | inactive	(Optional) Activates or deactivates AM failover
primary p_ip	(Optional) IP address of the primary AM server
secondary s_ip	(Optional) IP address of the secondary (standby) AM server
frequency f_secs	(Optional) Number of seconds between heartbeats (a check to see if the active AM is still operating). Typically you use a short interval, like 1.
dead-detection-interval d_secs	(Optional) Number of seconds to wait before declaring a non-responding AM dead and initiating failover. Typically you use a short interval, like 3, that is a multiple of the frequency option.

Usage Guidelines

The set am command is available only on the AVS 3120. For more information about configuring the Availability Manager, see "Availability Manager Clustering."

Related Commands

delete lb
set lb cluster
set lb server
set lb status
show am

set condenser

To start, stop or restart the Condenser, use the set condenser command.

set condenser {start | stop | restart} [ssl {enable | disable}]

Syntax Description

start | stop | restart	Starts, stops, or restarts the Condenser
ssl enable | disable	(Optional) Enables or disables SSL mode when starting the Condenser

Usage Guidelines

The set condenser command is available only on the AVS 3120.

Related Commands

set console
show condenser

set console

To start, stop or restart the Management Console, use the set console command.

set console {start | stop | restart}

Syntax Description

start | stop | restart

Starts, stops, or restarts the Management Console

Usage Guidelines

On the AVS 3180, the set console command also controls the starting and stopping of the Postgres database in addition to the Management Console.

Related Commands

set condenser
show console

set date

To set the system date, use the set date command.

set date [time MM:DD:hh:mm:YYYY] [tz timezone]

Syntax Description

time MM:DD:hh:mm:YYYY	(Optional) The time to set in the format MM:DD:hh:mm:YYYY (that is, month:day:hour:minute:year)
tz timezone	(Optional) The current city/time zone name, such as America/New_York. To see a list of available city/time zone names, use the command show timezone all

Related Commands

set ntp
show date
show ntp
show timezone

set dns

To set the DNS servers, use the set dns command.

set dns [primary ip_or_value] [secondary ip_or_value]

Syntax Description

primary ip_or_value	(Optional) The IP address or hostname value of the primary DNS server.
secondary ip_or_value	(Optional) The IP address or hostname value of the secondary DNS server.

Related Commands

show dns

set hostname

To set the hostname of the AVS device, use the set hostname command.

set hostname name

Syntax Description

name	The hostname.

Related Commands

show hostname

set interface

To configure the network interface, use the set interface command.

set interface [ip ip] [netmask mask] [default-gateway g_ip] [duplex {half | full}]
[speed {10 | 100 | 1000}] [auto-neg {on | off}]

Syntax Description

ip ip	(Optional) The device interface IP address
netmask mask	(Optional) The device interface IP subnet mask
default-gateway g_ip	(Optional) The gateway IP address
duplex {half | full}	(Optional) To manually set the duplex of the interface, specify half or full. Do not specify this option if you specify the auto-neg on option, because that causes the duplex and speed to be auto-negotiated.
speed {10 | 100 | 1000}	(Optional) To manually set the speed of the interface, specify 10, 100, or 1000 (Mbits/sec). Do not specify this option if you specify the auto-neg on option, because that causes the duplex and speed to be auto-negotiated.
auto-neg {on | off}	(Optional) Specify on to auto-negotiate the interface duplex and speed, or off to disable auto-negotiation. The default is on.

Related Commands

set dns
show dns
show interface

set lb cluster

To configure the load balancing cluster parameters for the Availability Manager, use the set lb cluster command.

set lb cluster name name vip ip [netmask mask] [active | inactive [port port] [persistence p_sec] [re-entry r_sec] [timeout t_sec]

Syntax Description

name	The virtual server name. The name must have the prefix fgncluster, for example: fgncluster_http
ip	The virtual server IP address. This is a floating IP address that has been associated with a fully-qualified domain name.
netmask mask	(Optional) The virtual server IP subnet mask
active | inactive	(Optional) To enable this virtual IP address, specify active; to disable it, specify inactive
port port	(Optional) The virtual server listening port
persistence p_sec	(Optional) If greater than zero, enables persistent connection support and specifies a timeout value in seconds. In order to use delta optimization, you must specify a value greater than zero.
re-entry r_sec	(Optional) The number of seconds that a restored performance node must remain alive before being re-added to the routing table
timeout t_sec	(Optional) The number of seconds that must lapse before a performance node determined to be dead is removed from the routing table.

Usage Guidelines

The set lb cluster command is available only on the AVS 3120. For more information about configuring the Availability Manager, see "Availability Manager Clustering."

Related Commands

delete lb
set am
set lb server
set lb status
show lb

set lb server

To configure the load balancing server parameters for the Availability Manager, use the set lb server command.

set lb server [cluster v_name] [server name] [ip ip] [weight num] [active | inactive]

Syntax Description

cluster v_name	(Optional) The virtual server name under which this real server appears. This is the name specified for the virtual server in the set lb cluster command.
server name	(Optional) The real server name. This name must be unique.
ip ip	(Optional) The real server IP address. It must be on the same subnet of the VIP.
weight num	(Optional) An integer that specifies this server's processing capacity relative to that of other performance nodes. For example, a server assigned 2000 has twice the capacity of a server assigned 1000.
active | inactive	(Optional) To enable this performance node, specify active; to disable it, specify inactive

Usage Guidelines

You must configure each AM server separately, using a set lb server command.

The set lb cluster command is available only on the AVS 3120. For more information about configuring the Availability Manager, see "Availability Manager Clustering."

Related Commands

delete lb
set am
set lb cluster
set lb status
show lb

set lb status

To activate or deactivate the Availability Manager, use the set lb status command.

set lb status {am-active | am-inactive | server-only}

Syntax Description

am-active	Activates the AM on this server
am-inactive	Deactivates the AM on this server
server-only	Configures this server to operate as an additional performance node only, not as the primary or standby AM server

Usage Guidelines

The set lb status command is available only on the AVS 3120. For more information about configuring the Availability Manager, see "Availability Manager Clustering."

Related Commands

delete lb
set am
set lb cluster
set lb server
show lb

set log-server

To configure remote logging, use the set log-server command.

set log-server {local | remote ip}

Syntax Description

local	Configures logs to be stored on the local system
remote ip	Configures logs to be stored on a remote system, identified by its IP address

Usage Guidelines

On the AVS 3180, when you specify remote, two log files are not sent to the remote host: the jboss server log and the localhost-access log. For more information about logging, see "Logs."

Related Commands

download log
show log
show log-server

set ntp

To configure an NTP server, use the set ntp command.

set ntp {stop | start} [ntp_ ip]...

Syntax Description

stop | start	Stops or starts using an NTP server to set the system time
ntp_ip	(Optional) The IP address or hostname of one or more NTP servers (separated by spaces)

Related Commands

set date
show date
show ntp
show timezone

set route

To configure a static route, use the set route command.

set route ip ip netmask mask gateway g_ip

Syntax Description

ip ip	The destination IP address
netmask mask	The IP subnet mask
gateway g_ip	The gateway IP address

Related Commands

delete route
show route

show

To display current system information, use the show command. The options for this command are:

show admin	Displays a list of administrator accounts
show am	Displays the Availability Manager global settings
show condenser	Displays the Condenser status
show console	Displays the Management Console status
show date	Displays the system date and time zone
show dns	Displays the DNS servers
show hostname	Displays the hostname of the AVS device
show interface	Displays the network interface settings
show lb	Displays the load balancing cluster, server, and status settings for the Availability Manager
show log	Displays a log file
show log-server	Displays the remote logging configuration
show ntp	Displays the NTP servers
show route	Displays static routes
show sys-stat	Displays system information
show timezone	Displays the current time zone or all time zones

show admin

To display a list of administrator accounts, use the show admin command. The information includes a list of the accounts that have read-only access and a list of those with read-write access.

show admin

Related Commands

delete admin
edit admin
set admin

show am

To display the Availability Manager global settings, use the show am command.

show am

Usage Guidelines

The show am command is available only on the AVS 3120. For more information about configuring the Availability Manager, see "Availability Manager Clustering."

Related Commands

set am
set lb cluster
set lb server
set lb status
show lb

show condenser

To display the Condenser status, use the show condenser command. The status shows if the Condenser is running and if SSL is configured.

show condenser

Usage Guidelines

The show condenser command is available only on the AVS 3120.

Related Commands

set condenser
show console

show console

To display the Management Console status, use the show console command. The status shows if Java, the database, and the node manager are running.

show console

Related Commands

set console
show condenser

show date

To display the system date and time zone, use the show date command.

show date

Related Commands

set date
set ntp
show ntp
show timezone

show dns

To display the DNS servers, use the show dns command.

show dns

Related Commands

set dns
set interface

show hostname

To display the hostname of the AVS device, use the show hostname command.

show hostname

Related Commands

set hostname

show interface

To display the network interface settings, use the show interface command.

show interface

Related Commands

set dns
set interface

show lb

To display the load balancing cluster, server, and status settings for the Availability Manager, use the show lb command.

show lb {[cluster name | all] | status}

Syntax Description

cluster name	(Optional) The name of the virtual server whose settings to display
all	(Optional) Display settings for all virtual servers
status	(Optional) Display Availability Manager status

Usage Guidelines

The show lb command is available only on the AVS 3120. For more information about configuring the Availability Manager, see "Availability Manager Clustering."

Related Commands

delete lb
set lb cluster
set lb server
set lb status
show am

show log

To display a log file, use the show log command.

show log {security | event | condenser | console | nmgr | postgres} index {id | all}} [tail]

Syntax Description

security | event | condenser | console | nmgr | postgres	The name of the log to display. On the AVS 3180, the condenser and ngmr logs are not available.
index	Specifies which log file to display.
id	The integer index of the log file to display. There may be multiple log files of one type and this specifies which one you want.
all	Display a list of log files of the specified type
tail	(Optional) Display the last several lines of the selected log file. You cannot use this option in conjunction with the index all option.

Usage Guidelines

To list the indexes of the log files that are available, use the index all option. This will list the log files in order, beginning with index 0, like this:

velocity>show log security index all

 Log File Order                 Last Modification

 0-secure                    Wed Oct 26 15:45:38 2005

 1-secure                    Tue Oct 25 11:11:16 2005

The index is the number at the left of each row.

Related Commands

download log
set log-server

show log-server

To display the remote logging configuration, use the show log-server command.

show log-server

Related Commands

set log-server

show ntp

To display the NTP servers, use the show ntp command.

show ntp

Related Commands

set date
set ntp
show date
show timezone

show route

To display static routes, use the show route command.

show route

Related Commands

delete route
set route

show sys-stat

To display system information, use the show sys-stat command.

show sys-stat {cpu | memory | io} [help]

Syntax Description

cpu | memory | io	The type of system information to display
help	(Optional) Display help information about the returned statistics

show timezone

To display the current time zone or all time zones, use the show timezone command.

show timezone {all | current}

Syntax Description

all	List all time zones
current	Display the current time zone

Related Commands

set date
show date
show ntp

sysopen

To access the system shell, use the sysopen command.

sysopen

traceroute

To trace the connectivity and the path to an IP address, use the traceroute command.

traceroute ip_or_host

Syntax Description

ip_or_host

IP address you want to trace. Enter an IP address in dotted-decimal notation (for example, 192.168.11.1) or in mnemonic host-name format (for example, myhost.mydomain.com).

Related Commands

ping