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


Get Help about Statements

In configuration mode, you can use the help command to display help based on a text string contained in a statement name. This command displays help for statements at the current hierarchy level and below.

user@host# help  string 

You can also display help based on a text string contained in a statement name using the help topic and help reference commands. The help topic command displays usage guidelines for the statement, whereas the help reference command displays summary information about the statement.

user@host# help topic string
user@host# help reference string

If you do not type an option for a statement that requires one, a message indicates the type of information expected. In this example, you need to type an area number to complete the command:

[edit]
user@host# set protocols ospf area<Enter>

syntax error, expecting <identifier>.

In this example, you need to type a value for the hello interval to complete the command:

[edit]
user@host# set protocols ospf area 45 interface so-0/0/0     
                  hello-interval<Enter>

syntax error, expecting <data>

If you have omitted a required statement at a particular hierarchy level, when you attempt to move from that hierarchy level or when you issue the show command in configuration mode, a message indicates which statement is missing. For example:

[edit protocols pim interface so-0/0/0]
user@host# top
Warning: missing mandatory statement: 'mode'
[edit]
user@host# show
protocols {
    pim {
        interface so-0/0/0 {
            priority 4;
            version 2;
            # Warning: missing mandatory statement(s): 'mode'
        }
    }
}



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