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


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

Using Help
The P-7500 CLI provides a variety of useful context-sensitive help features. An important thing to remember about using the help features is that the use of a space or the lack of a space before the ? gives different results. Table 4 summarizes the help system.
Table 4 Help Commands 
Lists all commands or command options available in the current CLI level.
Lists commands or command options available in both the current and global CLI levels.
Completes the partial command you entered, if you have provided an unambiguous abbreviation. Otherwise, if ambiguous, the CLI lists the available command options.
command<space>?
Gives detailed help on the specific command and its available parameters in the current CLI level.
? (Question Mark Key)
You can enter the question mark (?) key whenever you need additional information. When you enter ?, all available choices are displayed. When you enter ? on a line by itself or when it is preceded by one or more spaces, a list of all next available choices is displayed. Refer to Example 1.
Alternatively, the user can terminate a command with a ? to display the complete help on that command. This feature is most powerful when the command keyword is known, but the list and format of parameters is not. Refer to Example 2.
Example 1
From the prompt, you can enter ? to display the online help:
tibco# ?
 
Commands available in the current mode:
admin - Use this command to reach the Admin EXEC level.
backup - Use this command to immediately create a manual
local backup of your configuration database file on
the system.
boot - Use this command to upgrade or downgrade the system
software to a new or old software load and
activate it, or to revert to and run the previous
software version that was running before the
last upgrade.
clear - Use this command to clear various system statistics.
configure - Use this command to reach the Global CONFIG level by
entering configure from the privileged EXEC level.
copy - Use this command to copy files to and from the
system.
delete - Use this command to delete files from the system.
Note: Some files are not allowed to be deleted (for
example, rotating system event logs such as
solcbr.log.X files).
delete-load - Use this command to delete a software version
already installed in the /loads subdirectory on the
system (as displayed through the show version User
EXEC command), which may not be the current version
or the backout version.
disable - Use this command to return yourself to the User EXEC
level of the CLI from the Privileged EXEC level.
disconnect - Disconnect a CLI session
power-down - Use this command to turn off power to the system, on
a system by system basis. Note: The system does NOT
restart automatically after this command is run.
reload - Use this command to restart the system using the
currently installed software version. Optionally,
the system configuration can be set to a backed-up
configuration or the system default configuration
during the restart.
rename - Use this command to rename a regular (that is,
Pathname) system file in the jail subdirectory.
setup - Use this command to quickly set the hostname,
interfaces, clock and time zone on the system.
shell - Use this command to access the shell.
 
Global commands (available in all modes) can be displayed by entering:
"??"
 
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#
Example 2
You can terminate a CLI command with a ? to display the complete help on that command:
tibco(config)# name-server ?
 
COMMAND:
name-server <ip-addr>*
no name-server [<ip-addr>]*
 
DESCRIPTION:
Configure the DNS name server
 
PARAMETERS:
<ip-addr> [nnn.nnn.nnn.nnn] - IP address
help Command
From the prompt, you can enter the help command when you want to display a brief description of the context-sensitive help system.
tibco# help
 
Commands available in the current mode:
admin - Use this command to reach the Admin EXEC level.
backup - Use this command to immediately create a manual
local backup of your configuration database file on
the system.
boot - Use this command to upgrade or downgrade the system
software to a new or old software load and
activate it, or to revert to and run the previous
software version that was running before the
last upgrade.
clear - Use this command to clear various system statistics.
configure - Use this command to reach the Global CONFIG level by
entering configure from the privileged EXEC level.
copy - Use this command to copy files to and from the
system.
delete - Use this command to delete files from the system.
Note: Some files are not allowed to be deleted (for
example, rotating system event logs such as
solcbr.log.X files).
delete-load - Use this command to delete a software version
already installed in the /loads subdirectory on the
system (as displayed through the show version User
EXEC command), which may not be the current version
or the backout version.
disable - Use this command to return yourself to the User EXEC
level of the CLI from the Privileged EXEC level.
disconnect - Disconnect a CLI session
power-down - Use this command to turn off power to the system, on
a system by system basis. Note: The system does NOT
restart automatically after this command is run.
reload - Use this command to restart the system using the
currently installed software version. Optionally,
the system configuration can be set to a backed-up
configuration or the system default configuration
during the restart.
rename - Use this command to rename a regular (that is,
Pathname) system file in the jail subdirectory.
setup - Use this command to quickly set the hostname,
interfaces, clock and time zone on the system.
shell - Use this command to access the shell.
 
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"
Partial Keyword <Tab>
At any point in the command line, the user can press Tab to display the valid inputs onward.
When you cannot recall a complete command name or keyword, type in the first few letters, press Tab, and the system completes your partial entry. However, you must type enough characters to provide a unique abbreviation. If your partially entered command is not unique, the CLI presents you with a list of valid options:
tibco> show pro<Tab>
tibco> show process
A subsequent Tab displays the valid parameters for the command/argument pair:
tibco> show process <Tab>
COMMAND:
show process [pid <pid>]
tibco> show process
tree Command
From the prompt, you can enter:
tree to display a list of commands or command options available in just the current CLI level
tree all to display a list of commands or command options available in both the current and global CLI levels
tree global to display a list of commands or command options available in just the global CLI level
tibco> tree global
 
GLOBAL COMMANDS - available in all modes:
[no] alarm-display
cd [<directory>]
dir [<pattern>]
end
exit
help
home
logout
more <pattern>
[no] paging [size <size>]
ping <vrf-ip-addr-or-host> [ip-interface <ip-interface>]
pwd
session timeout <idle-timeout>
show*
acl*
client-connect
profile <name> [detail]
alarm
backup
client <ip-and-port> [service <service>] [stats
[congestion | queues] |
subscriptions | connections [wide]]
[primary | backup]
client-profile <name>
clock [timezones [<pattern>]]
console
debug [process-name <process-name>] [process-instance
<process-instance>] [timeout <seconds>]
<command> [<parmeter-list>]
disk [detail]
environment
hardware [details]
hostname
interface [<phy-interface>] [detail]
ip route
ip vrf [<name> [route]]
log*
acl [client-connect | publish-subject
| subscribe-subject] [wide]
command [lines <num-lines>] [find
<search-string>]
debug [lines <num-lines>] [find <search-string>]
event [lines <num-lines>] [find <search-string>]
logging command
logging debug [<subsystem-id>]
memory
name-server
ntp-server
paging
process [pid <pid>]
product-key
profile-mapping [username <username>] [service
<service>] [default]*
redundancy
routing
rv config
rv network-mapping
rv service <service> [stats | subscriptions]
[primary | backup]
rv service-mapping
session
snmp [trap [<name>]]
stats acl
stats client
subscriptions [service <service>] [subject
<subject-string> | subject-starts
<subject-start-string> | summary]
[primary | backup]
syslog [<name>]
username [<username-pattern>]
version
source script <script-name> [stop-on-error]
[no-prompt]
[no] strict-column-wrapping
tree [all | global]
 
* indicates a mode that can be "typed through"

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