type enum choice

Mode: Operational Mode

Description:

An enumerated type in DDL is analogous to that in C and other languages: it permits any of several specified values to be used for a given object or attribute. The values are specified using the choice statement.

Using choice with type enum limits the subordinates available under an argument.

For type enum string, it provides the list of acceptable string choices predefined by the programmer.

Example:

            command newbie {
                help "Show newbie";
                EXAMPLED_ACTION;

                argument usergroup {
                    help "Check user group";
                    type enum string {
                        choice ipg-all {
                            help "All IPG subscribes this";
                        }
                        choice hw {
                            help "Only HW subscribes this";
                        }
                        choice sw {
                            help "Only SW subscribes this";
                        }
                    }
                }
            }

Display:

        user@router> show example newbie ?
        Possible completions:
          <[Enter]>            Execute this command
          usergroup            Check user group
          |                    Pipe through a command
        user@router> show example newbie usergroup ?
        Possible completions:
          hw                   Only HW subscribes this
          ipg-all              All IPG subscribes this
          sw                   Only SW subscribes this
        user@router> show example newbie usergroup hw 

        user@router>

See also:

Reference (to programmers guide/style guide):

---