Installation guide

set menu
72 Chapter 2 Command Descriptions
Options for Adding/Updating Custom Menu Items
range=1-32
The index of the custom menu to add menu items to. Either the “range”
or “name” option can be specified to add or update menu items for a
particular menu.
name=string
The name of the custom menu to add or update menu items for. This
option can be used rather than “range.” If the string contains spaces,
enclose it in double quotes.
item=1-32
The index of the menu item to add or update. There are a maximum of
32 menu items for a particular custom menu and are indexed 1 to 32.
key=key
The key to assign to the menu item. This key is displayed on the custom
menu next to the “label” value, and is used to select the particular menu
item. The user presses this key to select the corresponding menu item.
The key must be unique to the custom menu, so that no two menu items
for the same custom menu share the same key. The keys assigned to the
global settings for “quit_key” and “previous_key” are reserved, and may
not be assigned to a menu item.
label=string
The text displayed on the custom menu next to the “key” value that
describes the action that the menu item will take. When using multiple
columns with a custom menu (specified by the “columns” option), it is in
the best interest to keep these strings short in length to avoid scrolling. If
the string contains spaces, enclose it in double quotes.
command=string
The command that is executed when this menu item is selected. This
may be any valid command on the CLI (command line interface). The
user accessing the custom menu must have the necessary permissions
for the supplied command in order to properly execute the command.
Note that this option may not be combined with the “submenu” option. If
the string contains spaces, enclose it in double quotes.
submenu=string
The menu displayed to the user upon selecting the menu item.
Submenus allow multi-level menus to exist, and grouping of information
so that a user may access one or more submenus each with their own
distinct menu items. The string is the menu name identifying the custom
menu to link to. The menu must have already been created. Note that this
option may not be combined with the “command” option. If the string
contains spaces, enclose it in double quotes.