Wednesday, August 3, 2016

what's the Command Syntax and Format?

Format

  • The command format is command name keyword1 parameter1 ... keyword"n" parameter"n". Each command consists of a name, several keywords and parameters, and each parameter has a name and value.
  • The total length of a command cannot exceed 255 bytes. A complete command includes the command name, keyword, parameter name, and entered parameter value.
    NOTE:
    • The NMS does not support Chinese characters and question mark (?) by default. The following characters are supported by hosts but not by the NMS: !#$%^&*+=<>,|:;'"`~\{}[]
    • The character set supported by the CLI is wider than that supported by the NMS. Therefore, use only the character set supported by the NMS in CLI configurations.
  • The symbols used in this document represent the optional and mandatory relations between the keyword and the parameter.
Format Description
Boldface The keywords of a command are in boldface.
Italics Command parameters are in italics.
[ ] Items in square brackets [ ] are optional.
{ x | y | ... } Alternative items are grouped in braces and separated by vertical bars. One is selected.
[ x | y | ... ] Alternative items that are optional are grouped in square brackets and separated by vertical bars. One or none is selected.
{ x | y | ... } * Alternative items are grouped in braces and separated by vertical bars. A minimum of one or a maximum of all can be selected.
[ x | y | ... ] * Optional alternative items are grouped in square brackets and separated by vertical bars. Multiple or none is selected.
#<1-n> The latter input parameter can overwrite the former one. It indicates that the parameter before the symbol # can repeat one or n times, but only the last value is valid.
&<1-n> The latter input parameter cannot overwrite the former one. It indicates that the parameter before the symbol & can repeat one or n times, and each input value is valid.

Characters Used in the System

  • All the command names, keywords and parameter names consist of uppercase or lowercase letters (a-z or A-Z) or digits (0-9).
  • The user password is case sensitive, and it consists of visible characters but it does not contain a space.
  • Other input information in the system, except the password is not case sensitive.

Command Confirmation and Default Values

Some commands, such as the command for resetting the system, and that for changing the IGMP mode, have great influence on the system. To avoid improper operations, after such a command is input, the information for prompting you to confirm the operation is displayed, as shown follows:
huawei#reboot system
  Please check whether data has saved, the unsaved data will lose if reboot     
system, are you sure to reboot system? (y/n)[n]:
Where: Items in bracket ( ) are optional; items in square brackets [] are the default values, namely, the output when you press the Enter key directly.

Deletion and Cancellation of Configuration Items

Most configuration commands have the corresponding commands for canceling the configuration or restoring the default value. The format of those commands is: undo + the original configuration command.
A command with undo has different purposes in different cases.
  • It is used to restore the default configuration for the configuration items with default values.
  • It is used to delete the specified configuration for those items without default values.

No comments:

Post a Comment