Command Description Format - Alaxala AX6700S Software Manual

1. Reading the Manual

Command description format

Each command is described in the following format:
Function
Describes the purpose of the command.
Syntax
Defines the input format of the command. The format is governed by the following rules:
1. Parameters for setting values or character strings are enclosed in angle brackets (<>).
2. Characters that are not enclosed in angle brackets (<>) are keywords that must be typed
exactly as they appear.
3. indicates that either
{A|B}
4. Parameters or keywords enclosed in square brackets (
5. For details on the parameter input format, see Specifiable values for parameters.
Input mode
Indicates the mode required to enter the command.
Parameters
Describes in detail the parameters that can be set by the command. For details on the behavior of
a command when all omissible parameters are omitted, see Operation when all parameters are
omitted.
For details on the behavior when only a specific parameter is omitted, see Operation when this
parameter is omitted. For details on the behavior when each parameter is omitted, see Operation
when each parameter is omitted.
Example
Provides examples of appropriate command usage.
Display items
Describes the display items generated by the example.
The following table describes the
the example is executed.
Table 1-1: Display of the time the command was received
Item
Date
The Switch assigns names to corresponding interfaces set by configuration. If <interface name>
is shown in Display items, the Switch displays any of the interface names shown in the following
table.
Table 1-2: List of interface names assigned for input format
Input format
interface gigabitethernet
2
or must be selected.
A B
display items displayed immediately after the command in
Date
yyyy/mm/dd hh:mm:ss timezone year/month/day hour:minute:second time zone
The time the command was accepted is displayed.
) are optional and can be omitted.
[]
Displayed information
Interface name <interface name>
geth1/1
The numeric values represent <nif no.>/<port no.>.