About the Command Line Interface
The Cast Iron® Command Line Interface (CLI) is available to administrators to manage the Integration Appliance and to maintain and update its configuration information.
The CLI is preinstalled on the Integration Appliance and is ready to respond to the commands described in this documentation.
Only a user logged in as an administrator can use the CLI. More than one administrator can be logged in to an Integration Appliance at the same time.
Logging into the CLI
You can log in to the CLI on the Integration Appliance through a secure shell (SSH) session, terminal emulation, or telnet. By default. secure management is enabled on the Integration Appliance and you must use secure connections to access the Integration Appliance. Secure connections use the default host key provided with the Integration Appliance at installation.
When using an SSH client or a telnet client to log in to the CLI, the 5th consecutive log-in failure (regardless of which user or any span of time) triggers a lock-out. The lock-out is characterized by a limit of one log in attempt per minute without regard for the user. A successful log-in by any user resets the log-in failure count and ends the lock-out.
Logging out of the CLI
At the command prompt, use the exit command to log out of the CLI. This also closes the terminal emulation or telnet session connection.
Viewing CLI help
In the CLI, you can view a list of command categories by typing help or ?. To view syntax help for the commands in a specific category, enter Category help. For example, net help or net ? lists syntax information for each network command.
Tab completion also guides you through the CLI syntax. From the CLI, you can enter a partial command and press the Tab key. Pressing the Tab key completes the command or provides a list of options to complete the command syntax
Command conventions
Convention | Description |
---|---|
keyword <value> |
Most command parameters combine a keyword and a value. Some parameters might not require a value. |
<value> |
Values for parameters are enclosed in angle brackets. In many cases, the text shown indicates the type of information you supply, such as <hostname>. Values may be explicit, such as <yes> |
[x] |
Optional parameters are enclosed in brackets. |
{x y z} |
Groups of mandatory parameters are enclosed in braces. |
x | y | z |
Choices are separated by bars, select only one. |
x... |
Parameters that may occur more than once are followed by an ellipse. |