TRAFFIC.ShELL(1)

NAME
traffic_shell - Traffic Server configuration shell

SYNOPSIS
traffic_shell [-V] [filename]

DESCRIPTION
traffic_shell is a command-line interface to monitor and configure Apache Traffic Server. traffic_shell enables you to monitor and configure Traffic Server using a UNIX shell-like command interface. Using traffic_shell is an alternative to manually editing Traffic Server's configuration files or using the traffic_line(1) interface.

You use traffic_shell interactively by typing individual commands at the trafficserver> prompt. As you enter a command, traffic_shell processes it and displays the result. traffic_shell embeds a Tcl interpreter, so you can use the Tcl language to display status or make configuration changes programmatically.

When invoked with the filename argument, traffic_shell will read and execute commands from the given file prior to entering interactive mode.

USING TRAFFIC SHELL COMMANDS
Once you start traffic_shell , you use one of two modes:

The Monitor mode allows you to run Show commands, which display system information and Traffic Server statistics. You use Show commands to monitor Traffic Server performance. When you start traffic_shell, you are automatically in Monitor mode.

To see a list of Show commands, type ‘show’ at the prompt. To use a Show command, enter the command at the trafficserver> prompt.

The Enable mode allows you to run Config commands, which set Traffic Server and network parameters. The Enable mode is password-protected. To enter Enable mode use the ‘enable’ command.

You must enter Enable mode to use Config commands. You can use both Show and Config commands when you are in Enable mode. It is not necessary to return to Monitor mode to use Show commands.

Once you enter Enable mode, you can use the Config commands. To see a list of Config commands, type ‘config’ at the trafficserver> prompt. To use a Config command, enter the command at the prompt.

To return to Monitor mode, in which you cannot use Config commands to set parameters, use the command.

Type ‘exit’ at the trafficserver> prompt to exit traffic_shell.

TRAFFIC SHELL COMMAND SHORTCUTS
traffic_shell supports the following shortcuts for entering commands.

•   Command completion. Type the initial characters of a valid command, and then press the tab key. Traffic Shell completes the command.

•   Command abbreviation. Type the initial characters of a valid command, and then press the Enter key. traffic_shell displays all commands that begin with the characters that you enter. If only one command begins with those characters, traffic_shell immediately executes that command.

•   Command history. From the trafficserver> prompt, press the Up and Down arrow keys to scroll through commands that you previously entered.

ACCESSING ON-LINE HELP
traffic_shell includes manual pages that describe each command. To access traffic_shell ‘help’, followed by any traffic_shell command at the prompt.

OPTIONS

-V  Print version information and exit.

EXAMPLES
Displaying the on-line help for a command:

trafficserver> help show:security

Use a monitor command to show a Traffic Server configuration setting:

trafficserver> show:http

Use a config command to alter a Traffic Server configuration setting:

trafficserver> config:icp multicast on

Use a Tcl command to show multiple configuration parameters:

trafficserver> foreach i {http proxy socks ssl} {show:$i}

SEE ALSO
traffic_line(1), Tcl(n).