help
Syntax
help <(apropos string | reference statement-name | syslog syslog-tag | tip cli number | topic word)>
Description
Display help about available operational
commands, configuration statements, or general information about getting
help. Entering the help command without an option provides
introductory information about how to use the help and ? commands.
Options
apropos string—(Optional) Display command names
and help text that matches the string specified. If the string contains spaces,
enclose it in quotation marks (" " ). You can also specify a regular expression for
the string, using standard UNIX-style regular expression syntax.
reference statement-name—(Optional) Display
summary information for a configuration
statement.
Use the information below to navigate the reference command.
-
Reference information is organized in a similar method as the command hierarchy when configuring Junos. Specific sections of
help referencemay not have as many sub-options as other sections.For example, the information for an optical wavelength bypass is located in
help reference chassis fpc wss-express-inrather thanhelp reference chassis wss-express-in. This is because, in the configuration statement, this command is found underchassis fpc, notchassis. -
Information titles may not perfectly reflect the command string.
-
Each information section has a short description of the command next to it. Options without a text description represent a "level" that you can add to the
help referencecommand. -
This information is based on summary descriptions that appear in the Junos CLI-reference guide.
syslog
syslog-tag—(Optional) Display information about system log
messages.
tip cli
number—(Optional) Display a tip about using the CLI. Specify the
number of the tip you want to view.
topic
word—(Optional) Display usage guidelines for a topic or
configuration statement. This information is based on subjects that appear in the
Junos configuration
guides. If a
topic is not listed, please consult the full documentation guide for Junos OS and
Junos OS Evolved at HPE Juniper Networks
Documentation.
Required Privilege Level
None
Release Information
Command introduced before Junos OS Release 7.4.
The apropos option was added in Junos OS Release 8.0.
The information contained in topic has been removed for Junos OS
Release 25.4R1 due to the extensive amount of information needed to cover topics,
configurations, and features.
The information contained in reference is actively maintained. Not
all features and commands are available on all platforms. Please consult Feature Explorer at https://apps.juniper.net/feature-explorer/ to verify
features and options for your specific platform.