[ Contents] [ Prev] [ Next] [ Index] [ Report an Error]

Getting Help About a String in a Statement or Command

You can use the help command to display help about a text string contained in a statement or command name:




help apropos string

string is a text string about which you want to get help. This string is used to match statement or command names as well as to match the help strings that are displayed for the statements or commands.

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.

In configuration mode, this command displays statement names and help text that match the string specified. In operational mode, this command displays command names and help text that match the string specified.

Example: Getting Help About a String in a Statement Name

Get help about statements that contain the string "traps":



[edit]
user@host# help apropos traps 

set interfaces <interface_name>
    Enable SNMP notifications on state changes
set interfaces <interface_name> unit <interface_unit_number>
    Enable SNMP notifications on state changes
set snmp trap-group
    Configure traps and notifications
set snmp trap-group <group_name> version <version>
all
    Send SNMPv1 and SNMPv2 traps
set snmp trap-group <group_name> version <version>
v1
    Send SNMPv1 traps
set snmp trap-group <group_name> version <version>
v2
    Send SNMPv2 traps
set protocols mpls log-updown
    Send SNMP traps
set firewall filter <filter-name> term <rule-name>
from source-port snmptrap
    SNMP traps
set firewall filter <filter-name> term <rule-name>
from source-port-except snmptrap
    SNMP traps
set firewall filter <filter-name> term <rule-name>
from destination-port snmptrap
    SNMP traps
set firewall filter <filter-name> term <rule-name>
from destination-port-except snmptrap
    SNMP traps
set firewall filter <filter-name> term <rule-name>
from port snmptrap
    SNMP traps
set firewall filter <filter-name> term <rule-name>
from port-except snmptrap
    SNMP traps
[edit]
user@host# edit interfaces at-5/3/0

[edit interfaces at-5/3/0]
user@host# help apropos traps

set <interface_name>
    Enable SNMP notifications on state changes
set <interface_name> unit <interface_unit_number>
    Enable SNMP notifications on state changes

[ Contents] [ Prev] [ Next] [ Index] [ Report an Error]