Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved


Chapter 2 Using the Command Line Interface (CLI) : CLI Command Structure

CLI Command Structure
Many CLI commands require input as part of the command. These fields are either required or optional depending on how the information is bracketed.
CLI Command Syntax
To get a quick display of available options at a CLI level or for the next option in a command string, enter a single question mark ? at the prompt, or press Tab. The option information is presented using certain syntax:
logging {<SubsystemId> | all} [level <level>] [mask <mask>]
 
When an item is not enclosed by < >, [ ], or { } symbols, the item is a required keyword.
Listing CLI Commands
To view all available commands at the user EXEC level, enter a double question mark (??) at the User EXEC CLI level:
tibco> ??
 
Commands available in the current mode:
enable - Use this command to enter the Privileged EXEC level of
the CLI to perform system configuration.
 
Global commands available in any mode:
[no] alarm-display - Use this command to enable the display of
P-7500 system alarms in the
current CLI session on a
session-by-session basis. The no version
disables the displaying of system
alarms in the current CLI session.
cd - Use this command to change the current
working directory on the system.
dir - Use this command to list the contents of
a directory on the system.
end - Use this command to exit the current
CONFIG command level of the CLI and
return to the Privileged EXEC level.
exit - Use this command to exit the current
command level of the CLI and return to
the previous level. From the User EXEC
level, use it to exit the CLI.
help - Use this command to display the Help
facility for the command line interface.
home - Use this command to exit the current
command level of the CLI and return to
the User EXEC level.
logout - Use this command to log out of a current
CLI session.
more - Use this command to display the contents
of a text file in a directory.
[no] paging - Use this command to control the output
page size for show commands. The no
version disables paging.
ping - Use this command to send ICMP
ECHO_REQUEST packets to a specified host.
pwd - Use this command to display the present
working directory (pwd).
session - Use this command to change the CLI
inactivity timeout setting for your
current CLI user session on the
system.
show - Use this command to display a variety of
configuration and statistical information
about the system.
source - Use this command to run a cli script.
[no] strict-column-wrapping - By default, this is enabled. Use the
'no' version of this command to allow
designated columns to be displayed
without wrapping. A column may be
designated to be controlled by this
setting if it is identified as a column
where the content would need to be
frequently cut and pasted. This is more
easily performed if the content is not
wrapped.
tree - Use this command to show the CLI command
tree, starting from the current mode.
 
Complete help for a command can be displayed by entering:
"<command> ?"
 
Output of any command can be redirected to overwrite a file using '>':
"show version > version.txt"
 
Output of any command can be redirected to append to a file using '>>':
"show version >> version.txt"
tibco>
Note: You also can enter the question mark (?) with an individual command to see all available options or to check context.
Listing show Command Options
To view possible show command options, enter:
tibco> show ?
 
COMMAND:
show
DESCRIPTION:
Use this command to display a variety of configuration and statistical
information about the system.
 
PARAMETERS:
acl - Show ACL configuration
alarm - Show current alarm status
backup - Show information on configuration backups
client - Show client information
client-profile - Show information about the client-profile.
clock - Show system clock
console - Show console configuration
debug - Show internal debug information
disk - Show local disk usage and the RAID status
environment - Show system environment information
hardware - Show system hardware information
hostname - Show hostname
interface - Show the parameters configured for the interface
ip - Show Internet Protocol Parameters
log - Show the system log
logging - Show logging information
memory - Show memory usage
name-server - Show DNS name server configuration
ntp-server - Show the NTP server
paging - Use this command to control the output page size
for show commands. The no version disables
paging.
process - Show system process information. Given a pid,
displays detailed information for that process.
product-key - Show installed product-keys and the features
they unlock
profile-mapping - Show profile mapping
redundancy - Show redundancy configuration
routing - Show routing configuration
rv - Show rv configuration and service information
session - Show information regarding currently active CLI
sessions.
snmp - Show SNMP agent configuration
stats - Show global level stats
subscriptions - Show subscriptions
syslog - Show the configured syslog destinations
username - Show the names of all the CLI and file transfer
users configured on a system
version - Show information on software loads
 
tibco>
CLI Command Line Prompts
Within the CLI, the command line prompt identifies both the hostname and the command mode. The hostname is the name of your system (set using the hostname command). The command mode indicates your location within the CLI command structure.
For example:
For some actions, the CLI prompts you for a response. The acceptable default responses are:
press y or Enter to agree with the prompt and continue
CLI Keywords and Parameters
CLI commands are made up of two primary elements, keywords and parameters.
Keywords
Every command requires at least one keyword. However, a command can contain other optional keywords. Keywords must be typed into the CLI accurately to be recognized. These are examples of keywords:
Keywords identify the operation to be performed. You can abbreviate keywords, but you must enter enough initial characters to unambiguously identify the command. For example, if the keyword you want to specify is source and you enter only s, an error appears. The error indicates that one or more possible keywords begin with s, making your entry ambiguous.
Parameters
Parameters are often required elements of a command, but for some commands, parameters are not required. A parameter is most often a value that you specify after the keyword. There are different types of parameters, such as strings, integers, or IP addresses. The CLI indicates the type of parameter that you must enter. When you see a range of numbers or uppercase letters, it indicates that you must specify a value.
Keywords and Parameters Together
By combining keywords and parameters in the correct sequence, you can begin using the CLI to configure and monitor your system. For example, you could specify the command hostname to change the name of your system by entering a keyword and a parameter. You need to type only the portion of the keyword that makes it unambiguous, such as hostn. Here, the value of the parameter, which is the name you assign to the host, is a string of up to 64 characters.
For example:
When you enter this command, the new hostname appears in the command line prompt:
tibco(config)#

Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved