Types of SRC Commands and Statements

[Contents] [Prev] [Next] [Index] [Report an Error]

The SRC CLI supports the following types of commands and statements:

Operational mode commands—Commands that you enter in operational mode are used to monitor system operation.
For more information about using top-level CLI operational mode commands, see SRC CLI Command Categories.
Environment commands—A set of operational mode commands that you can use to control the CLI environment. For example, you can specify editing level for the CLI. For more information, see Overview of Commands to Control the SRC CLI Environment.
Configuration mode commands—Commands that you enter in configuration mode are used to perform general configuration functions; for example, committing a configuration, navigating the hierarchy, and managing configuration files. For more information, see Understanding SRC CLI Configuration Mode.
Configuration statements—Used to define your SRC configuration. Your location in the configuration hierarchy determines which configuration statements are available. For example, the [edit shared sae] hierarchy level includes statements to configure the SAE.

Command Options

When working on the command line, you are bound by specific CLI syntax rules. Some commands function very simply with just a single word necessary to run them. Others have required options that you must enter to complete the command. Some commands may have options that are not required, allowing you to change the way the commands run or the information they return.

The command and statement summaries in the SRC-PE CLI Command Reference show which options are required and which options are not. Options at the top statement level that are not required are shown with angle brackets (<>). (See Figure 8.) Dots after an option indicate that more than one value can be supplied for the option.

Figure 8: Command Options

Image g016105.gif

Configuration Statements and Identifiers

You configure SRC properties by including statements in the configuration. A statement consists of a keyword, which is fixed text, and, optionally, an identifier. An identifier is an identifying name that you define, such as the name of an interface or a username, and that allows you and the CLI to discriminate among a collection of statements.

The following list shows the statements available at the top level of configuration mode:

[edit]
user@host# set ?
Possible completions:
> interfaces           Interfaces on the C-series Controller
> policies             Policy configuration
> redirect-server      Redirect server properties
> routing-options      Protocol-independent routing option configuration
> services             Service configuration
> shared               Shared component information
> slot                 Component configuration
> snmp                 SNMP agent
> subscribers          Subscriber and subscription configuration
> system               System configuration

An angle bracket ( > ) before the statement name indicates that it is a container statement and that you can set values for other statements at levels below it.

The following list shows the statements available at the [edit system ntp] level of configuration mode. This level includes output that shows:

No angle bracket ( > ) before the statement name—A leaf statement. You cannot define other statements at hierarchy levels below it.

Plus sign (+) before the statement name—A statement that can contain a set of values. To specify a set, include the values in brackets.

[edit system ntp]
user@host# set ?
Possible completions:
> authentication-key   Configure NTP authentication keys
  boot-server          Server to query during boot sequence
> broadcast            Configure for broadcast mode
  broadcast-client     Listen for NTP broadcasts
> multicast-client     Listen for NTP multicasts
> peer                 NTP peer properties
> server               NTP server properties
+ trusted-key          List of trusted authentication keys (1..INF)

Listings can also include:

Asterisk (*) before a statement name—A required statement or option that is not configured.
Asterisk and Plus (+*) before a statement name—Required options that can contain a set of values.

When you type a statement, enclose in quotation marks (double quotes) identifiers and any strings that include the following characters: space tab ( ) [ ] { } ! @ # $ % ^ & | ’ = ?

Privilege Levels for Using Commands and Statements

Each CLI command and each configuration statement has an access privilege level associated with it. Users can execute only those commands and configure and view only those statements for which they have access privileges.

For example, users with configure permissions can use the configure command to enter configuration mode, and users with network permissions can access the network by using the telnet and shh commands. The root login account has superuser privileges—with access to all commands and statements.

Note: Although root has superuser privileges, the editing level for root is set to normal.

For information about the editing level, see Overview of Commands to Control the SRC CLI Environment.

Required privilege levels are listed in command and statement summaries. .