Command Syntax And Conventions; Command Conventions - NETGEAR ProSafe FVS318N Cli Reference Manual

Command Syntax and Conventions

A command is one or more words that can be followed by one or more keywords and
parameters. Keywords and parameters can be required or optional:
• A keyword is a predefined string (word) that narrows down the scope of a command. A
keyword can be followed by an associated parameter or by associated keywords. In
many cases, these associated keywords are mutually exclusive, so you need to select
one of them. In some cases, this manual refers to a group of words as a keyword.
• A parameter is a variable for which you need to type a value. You need to replace the
parameter name with the appropriate value, which might be a name or number. A
parameter can be associated with a command or with a keyword.
This manual lists each command by its full command name and provides a brief description
of the command. In addition, for each command, the following information is provided:
• Format. Shows the command keywords and the required and optional parameters.
• Mode. Identifies the command mode you need to be in to access the command. (With
some minor exceptions, the mode is always described using lower-case letters.)
• Related show command or commands. Identifies and links to the show command or
commands that can display the configured information.
For more complicated commands, in addition to the format, mode, and related show
command or commands, the following information is provided:
• Table. Explains the keywords and parameters that you can use for the command.
• Example. Shows a CLI example for the command.

Command Conventions

In this manual, the following type font conventions are used:
• A command name is stated in bold font.
• A keyword name is stated in bold font.
• A parameter name is stated in italic font.
The keywords and parameters for a command might include mandatory values, optional
values, or choices. The following table describes the conventions that this manual uses to
distinguish between value types:
Table 1. Command conventions
Symbol Example
< > angle brackets
<value>
[ ] square brackets
[value]
ProSafe Wireless-N 8-Port Gigabit VPN Firewall FVS318N
Introduction
Description
Indicate that you need to enter a value in place of the
brackets and text inside them. (value is the parameter.)
Indicate an optional parameter that you can enter in place of
the brackets and text inside them. (value is the parameter.)
8