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

Configuring Command-Line Help Text

For JUNOS op scripts, you can provide a help-text string that appears in the CLI to describe the script and the script arguments. To configure help text, include the description statement:




description descriptive-text;

You can include this statement at the following hierarchy levels:

[edit system scripts op file filename]
[edit system scripts op file filename arguments name]

The following examples show the configuration and the resulting output.

Examples: Configuring Command-Line Help Text

Configure help text for a filename and for arguments:

For a Filename



[edit system scripts op file interface]
user@host# set description "Test the interface" # Configuration


[edit system scripts op]
user@host# set file ?

Possible completions:
  <name>              Local filename of the script file
  interface.xsl        Test the interface # Output

For Arguments



[edit system scripts op file interface arguments t1]
user@host# set description "Search for T1
interfaces" # Configuration


[edit system scripts op file interface arguments t3]
user@host# set description "Search for T3
interfaces" # Configuration


[edit system scripts op file interface arguments]
user@host# set ?

Possible completions:
  <name>           Name of the argument
  t1                   Search for T1 interfaces # Output
  t3                   Search for T3 interfaces

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