flag helpful

Mode: Configuration Mode

Description:

When there can be multiple instances of an object where the user-defined value identifies each instance (using flag identifier nokeyword), users can define a string attribute on the same level with flag helpful set to be displayed as the help string during command completion at the parent object level.

If users do not set the value of this string attribute, the default help message is displayed.

Example:

        object newbie {
            help "Newbie settings";
            flag setof list;

            attribute group {
                flag identifier nokeyword;
                help "Business unit";
                type string;
            }
            attribute long-name {
                flag helpful;
                help "Full name";
                type string;
            }
        }

Display:

        user@router# set example newbie IPG long-name "Infrastructure Product Group"

        [edit]
        user@router# show example
        newbie IPG {
            long-name "Infrastructure Product Group";
        }

        [edit]
        user@router# set example newbie ?
        Possible completions:
          <group>              Business unit
          IPG                  Infrastructure Product Group
        [edit]
        user@router# delete example newbie IPG long-name

        [edit]
        user@router# show example
        newbie IPG;

        [edit]
        user@router# set example newbie ?
        Possible completions:
          <group>              Business unit
          IPG                  Business unit
        [edit]

Topics for further reading:

See also:

flag identifier nokeyword

Reference (to programmers guide/style guide):

---