flag mandatory

Mode: Operational Mode

Description:

flag mandatory indicates that the command or argument for which it is defined must be present in the command hierarchy. It can be applied to both command and argument.

When the direct parent of a mandatory command or argument is specified, the mandatory command or argument needs to be set as well. Otherwise, commit will fail and an error message will be present when that section of the configuration is displayed.

When the command or argument has the mandatory flag specified, <Enter> is not an option in the parent command.

Example 1:

        command newbie {
            help "Show newbie";
            EXAMPLED_ACTION;

            argument phone-number {
                help "Example newbie information";
                flag mandatory;
                type string;
            }
        }

Display:

        user@router> show example newbie ?
        Possible completions:
          phone-number         Example newbie information

Topics for further reading:

See also:

Reference (to programmers guide/style guide):


2007-2008 Juniper Networks, Inc. All rights reserved. The information contained herein is confidential information of Juniper Networks, Inc., and may not be used, disclosed, distributed, modified, or copied without the prior written consent of Juniper Networks, Inc. in an express license. This information is subject to change by Juniper Networks, Inc. Juniper Networks, the Juniper Networks logo, and JUNOS are trademarks of Juniper Networks, Inc.
Generated on Sun May 30 20:23:13 2010 for DDL Reference Guide by doxygen 1.4.5