Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation  Back up to About Overview 
ContentIndex
  
[+] Expand All
[-] Collapse All

Symbols  A  C  D  E  F  H  I  K  L  M  N  O  P  Q  R  S  T  U  W  X

 

Symbols

* in completion list
+ in completion list
+* in completion list
> in completion list
| (pipe) filter for command output
 

A

active configuration
 

C

C Series Controllers    
directories    12
files
C Series controllers    
status
C Series platforms    
version
candidate configuration
CLI    
command hierarchy
command history
command mode
configuration mode    
command completion
commands    12
comparing
entering    12
exiting
hierarchy    123
navigation commands
overview    12
statement description
symbols in statement lists    12
verifying configurations
editing level    12
environment settings
help    12
interface elements
keyboard sequences
messages
modes    
changing    12
overview
operating systems
overview    12
password
prerequisites
privilege levels
prompt strings
tutorial
working directory
command output    
MORE prompt
number of lines
pagination
saving to a file
See also regular expressions
XML format, displaying
commands    
categories
completion    12
configuration mode
filenames in
operational mode
options
types
URLs in
commit and-quit command    12
commit check command
commit command    12
configuration    
backup
changes by multiple users
committing    123
default
deleting statements
displaying current configuration
example
loading    123
local
merge
modifying
replacement    12
rollback
saving
slot
statements.     See configuration statements    
storage
verifying
configuration files    
attributes
overview
preparation to load
set format
text format
XML format
configuration hierarchy
configuration mode     See CLI    
configuration statements    
deleting
overview    12
symbols in statements
configure command
conventions    
notice icons
text
count filter
cursor, moving
customer support    1
contacting JTAC
 

D

delete command    12
directories on C Series Controller
documentation    
comments on
 

E

edit command    12
enable command
environment settings, CLI    1
command completion
editing level
prompt string
screen dimensions    12
terminal language
terminal type
working directory
except filter
exit command    12
 

F

file commands
files    
saving command output to
specifying names in commands
find filter
 

H

help command
history command
history, CLI commands
 

I

identifiers    
inserting in sequential lists
renaming
insert command    12
 

K

keyboard sequences at MORE prompt
 

L

load command
load factory-default command
load merge command
load override command
load replace command
load set command    123
 

M

manuals    
comments on
messages    
CLI
MORE filter
MORE prompt
 

N

notice icons
 

O

online help     See CLI, help    
operational mode
 

P

privilege levels for CLI
prompt strings for CLI
 

Q

quit command
 

R

redrawing screen
regular expressions    
displaying first match
displaying matching output
disregarding nonmatching output
overview
rename command    12
request system halt command
request system reboot
restart command    12
rollback command    12
run command
 

S

save command
screen    
dimensions    12
redrawing
set cli complete-on-space command
set cli directory command    12
set cli language command
set cli level command
set cli password command
set cli prompt command
set cli screen-length command
set cli screen-width command
set cli terminal command
set command    12
show cli authorization command
show cli command
show cli history command
show cli level command
show command
show component command    12
show configuration command
show system information command
SRC CLI    
starting    
C Series platform
SRC components    
disabling
enabling
managing
restarting    12
status
SRC modules    
managing
restarting
SRC software    
rebooting
stopping
statements     See configuration statements, names of individual statements    
support, technical     See technical support    
symbols in statements
 

T

technical support    
contacting JTAC
terminal type
text conventions defined
Text format, XML format, Set format
top command
 

U

up command
URLs in commands
user accounts    
configuration example
 

W

working directory
 

X

XML format, command output in

Types of SRC Commands and Statements

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 Commands to Control the SRC CLI Environment Overview.
  • 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

Command Options

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
      disable-monitor      NTP disable monitor configuration
    > 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 ssh 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 Commands to Control the SRC CLI Environment Overview.

Required privilege levels are listed in command and statement summaries.

Related Documentation

Modified: 2016-05-26