CLI Command Modes
The CLI provides two separate command modes – OPERATIONAL and CONFIG.
Each command mode has a separate set of commands available for configuration and monitoring of the application. Entering a “?” at the command problem will indicate the list of available commands for execution within a given mode.
When you start a session, the default mode is OPERATIONAL mode. From this mode, you can access monitoring “show” commands, debugging commands and system maintenance commands. You can enter CONFIG mode to change configuration by issuing the “config” command at the OPERATIONAL prompt.
OPERATIONAL Mode
Logging into the master VM on port 2024 via SSH will allow you to access OPERATIONAL mode. The login into the system will require the use of a username and password. You may attempt to enter a correct password up to three times before the connection attempt is refused.
The commands available at the OPERTIONAL level are separate from the ones available at the CONFIG level. In general, the OPERATIONAL commands encompass monitoring, debugging, and maintenance activity a user will perform.
To list the available OPERATIONAL commands, use the following command:
|
Command |
Purpose |
|---|---|
|
scheduler# ? |
Lists the user OPERATIONAL commands |
Example:
scheduler# ?
Possible completions:
aaa AAA management
apply
autowizard Automatically query for mandatory elements
cd Change working directory
clear Clear parameter
commit Confirm a pending commit
compare Compare running configuration to another configuration or a file
complete-on-space Enable/disable completion on space
config Manipulate software configuration information
db DB connection and monitoring
debug Debug commands
describe Display transparent command information
devtools Enable/disable development tools
display-level Configure show command display level
docker Docker Management
exit Exit the management session
file Perform file operations
help Provide help information
history Configure history size
id Show user id information
idle-timeout Configure idle timeout
ignore-leading-space Ignore leading whitespace (true/false)
job Job operations
logger Log level management
logout Logout a user
monitor Application monitoring
no Negate a command or set its defaults
output-file Copy output to file or terminal
paginate Paginate output from CLI commands
prompt1 Set operational mode prompt
prompt2 Set configure mode prompt
pwd Display current mode path
quit Exit the management session
screen-length Configure screen length
screen-width Configure screen width
script Script actions
send Send message to terminal of one or all users
show Show information about the system
show-defaults Show default values when showing the configuration
source File to source
system System management
terminal Set terminal type
timestamp Enable/disable the display of timestamp
who Display currently logged on users
write Write configuration
scheduler#
The list of commands will vary based on the version of software installed.
CONFIG Mode
Within OPERATIONAL mode, you can enter CONFIG mode by issuing the “config” command. In general, the CONFIG commands modify the system configuration.
To enter CONFIG mode, use the following command:
|
Command |
Purpose |
|---|---|
|
scheduler# config |
Enter CONFIG mode of the CLI |
In CONFIG mode, the prompt changes to include a “(config)” at the end of the prompt.
Example:
scheduler# config
Entering configuration mode terminal
scheduler(config)# To list the available CONFIG commands, use the following command:
|
Command |
Purpose |
|---|---|
|
scheduler(config)# ? |
List the user CONFIG commands |
Example:
scheduler(config)# ?
Possible completions:
aaa AAA management
alert Alert status
alias Create command alias.
binding Binding DB connections
control-plane Cross data center control plane
docker Docker Management
license CPS License Management
nacm Access control
ntp NTP configuration
scheduling Service scheduling
session Global default CLI session parameters
statistics Application statistics
system System configuration
user User specific command aliases and default CLI session parameters
webui Web UI specific configuration
---
abort Abort configuration session
annotate Add a comment to a statement
clear Remove all configuration changes
commit Commit current set of changes
compare Compare configuration
copy Copy a list entry
describe Display transparent command information
do Run an operational-mode command
end Terminate configuration session
exit Exit from current mode
help Provide help information
insert Insert a parameter
load Load configuration from an ASCII file
move Move a parameter
no Negate a command or set its defaults
pwd Display current mode path
rename Rename an identifier
resolved Conflicts have been resolved
revert Copy configuration from running
rollback Roll back database to last committed version
save Save configuration to an ASCII file
service Modify use of network based services
show Show a parameter
tag Manipulate statement tags
top Exit to top level and optionally run command
validate Validate current configuration
Feedback