Cyclades AlterPath ACS, Command Reference Manual

Page: 19 / 420

| 3
1.3 How to use the CLI (Command Line Interface)
Throughout the manual a number of features can be configured using the CLI interface
instead of the vi editor. The CLI, or Command Line Interface tool is preferred by many
network and system administrators since it allows for automation of configuration
through scripting and provides a simple way to document and record a systems
configuration. This section introduces the CLI tool and provides information on how to
use the interface.
Modes of Operation
1. Interactive mode - commands will be read from standard input.
2. File batch mode - commands will be taken from a file (-f <file>).
3. Batch mode - commands will be taken from the command line arguments
•
Each invocation of the CLI should return a value to the shell indicating success or
failure of the command.
•
Each invocation of the CLI should return a text string if any error occurred. If the
command is successful then no text is returned.
For example, from the ACS prompt, to change the hostname you can directly do:
[root@CAS root]#/bin/CLI config network hostsettings hostname <host_name>
Both modes are oriented by keywords that allow the moving from one state to another.
Each state will have a specific set of keywords attached to it.
IMPORTANT: Strings with spaces in CLI Batch Mode must be quoted with single and double
quotes. To enter strings with spaces using the Batch Mode the user must type '"<string1
string2>"' . Example:
# CLI config network hostsettings banner "'Welcome to ACS'"
Keywords meanings
1. Changing from one state to another. For example: entering in configuration mode or
exiting from configuration mode. Once the CLI goes to one state it will remain in
this state until another keyword is entered to change the state.
2. Specifying a function or an action to be performed. For example: Apply changes
(runconfig), Save changes into flash (savetoflash), back up configuration script
(backupconfig), upgrade firmware (upgradefw), connect to a console (console), etc.
3. Specifying a set of parameters to be configured. For example:
cli> config security
security>adduser username john password john12 admin yes biouser no shell /bin/sh