Day One Tips
Highlighted
Day One Tips

Tip: Accessing "help" in JUNOS

‎11-04-2010 06:39 PM

JUNOS provides you with the flexibility to summon "help" on a command or topic from the CLI.

The help feature is similar to "man" pages in UNIX.

 

There are three help options:

 

1) help topic: This command displays usage guidelines for a statement.

 

For example;

 

user@host# help topic interfaces address   
Nov 05 11:16:35
Configuring the Interface Address

   You assign an address to an interface by specifying the address when
   configuring the protocol family. For the inet family, configure the
   interface's IP address. For the iso family, configure one or more
   addresses for the loopback interface. For the ccc, tcc, mpls, tnp, and
   vpls families, you never configure an address.

.................<snip>

 

2) help reference: This command offers configuration syntax help.

 

For example;

 

user@host# help reference interfaces address
Nov 05 11:26:07
                                    address

    Syntax

   address address {
           arp ip-address (mac | multicast-mac) mac-address <publish>;
           broadcast address;
           destination address;
           destination-profile name;
           eui-64;
           master-only;
           multipoint-destination address dlci dlci-identifier;

................<snip>

 

Hierarchy Level

   [edit interfaces interface-name unit logical-unit-number family family],

   [edit logical-systems logical-system-name interfaces interface-name unit
   logical-unit-number family family]

.............<snip>

 

3) help apropos: This command displays the contexts (typically set commands) that reference a specified variable.

 

For example;

 

user@host# help apropos vpls
Nov 05 11:28:11
set dynamic-profiles <profile-name> interfaces encapsulation <encapsulation> ether-vpls-ppp
    Ethernet VPLS over PPP (bridging) device
set dynamic-profiles <profile-name> interfaces encapsulation <encapsulation> ethernet-vpls
    Ethernet virtual private LAN service
set dynamic-profiles <profile-name> interfaces encapsulation <encapsulation> vlan-vpls
    VLAN virtual private LAN service
set dynamic-profiles <profile-name> interfaces encapsulation <encapsulation> extended-vlan-vpls
    Extended VLAN virtual private LAN service
set dynamic-profiles <profile-name> interfaces unit encapsulation <encapsulation> ether-vpls-over-atm-llc
    Ethernet VPLS over ATM (bridging) encapsulation

...............<snip>

 

 

Note: While help topic and help reference will give the same result when run in operational mode or configuration mode, help apropos will provide contextual help only in configuration mode. In operational mode, help apropos will display only the operational level commands for the specified variable:

 

user@host> help apropos vpls
Nov 05 11:29:48
clear vpls
    Clear learned Layer 2 MAC address information
clear vpls mac-address
    Clear a VPLS media access control address
clear vpls mac-address instance <instance>
    VPLS instance name
show system statistics vpls
    Virtual private LAN service
show route forwarding-table family <family> vpls
    Virtual private LAN service
show vpls
    Show VPLS information

...........<snip>

------------------------------------------------------------------------------------------------------------------------------------
If this solution resolved your problem, please flag my post as an "Accepted Solution" for the benefit of others.
Click the "Star" under my name for Kudos if you think I've earned it.
Feedback