A short help description is displayed immediately when the question mark (?) is entered (without needing to press Enter). The following displays help from the operational root level.
[/]
A:admin@node-2# ?
admin + Enter the administrative context for system operations
bof + Enter the bof context
clear + Clear statistics or reset operational state
configure + Enter the configuration context
debug + Enter the debug context
environment + Enter the environment configuration context
file + Perform file operations
li + Enter the lawful intercept context
monitor + Show operational information at an interval
password - Change the local user password
show + Show operational information
state + Show state information
tools + Enter the tools context for troubleshooting and
debugging
Global commands:
back - Move back one or more levels
delete - Delete an element
edit-config - Enter a candidate configuration mode
enable - Enable administrative mode
exec - Execute commands from a file
exit - Return to the previous context or to operational root
history - Show the command history
info - Show the information under the present working context
logout - Exit the CLI session
oam - Perform OAM tests
ping - Ping an IP address or DNS name
pwc - Show the present working context
pyexec - Execute a Python application
ssh - SSH to an IP address or DNS name
telnet - Telnet to the IP address or DNS name
top - Move to the top level of the context
traceroute - Show the route taken to an IP address or DNS name
tree - Show the command tree under the present working contextThe ? help is context-sensitive. The following ? help output lists additional commands available in exclusive configuration mode.
(ex)[/]
A:admin@node-2# ?
admin + Enter the administrative context for system operations
clear + Clear statistics or reset operational state
configure + Enter the configuration context
environment + Enter the environment configuration context
file + Perform file operations
monitor + Show operational information at an interval
password - Change the local user password
show + Show operational information
state + Show state information
tools + Enter the tools context for troubleshooting and
debugging
Global commands:
back - Move back one or more levels
delete - Delete an element
edit-config - Enter a candidate configuration mode
enable - Enable administrative mode
exec - Execute commands from a file
exit - Return to the previous context or to operational root
history - Show the command history
info - Show the information under the present working context
insert - Insert an element into a user-ordered list
logout - Exit the CLI session
oam - Perform OAM tests
ping - Ping an IP address or DNS name
pwc - Show the present working context
pyexec - Execute a Python application
quit-config - Exit the candidate configuration mode
ssh - SSH to an IP address or DNS name
telnet - Telnet to the IP address or DNS name
top - Move to the top level of the context
traceroute - Show the route taken to an IP address or DNS name
tree - Show the command tree under the present working context
Configuration commands:
annotate - Annotate a configuration element with a comment
commit - Commit the candidate configuration
compare - Compare changes between datastores
copy - Copy a configuration element to another
discard - Discard changes in the candidate datastore
rename - Rename a list element
update - Update the candidate baseline
validate - Validate changes in the candidate datastoreThe help results may depend on the cursor position. The following example shows the router command syntax, followed by available commands after entering the router context.
[ex:/configure]
A:admin@node-2# router?
router [[router-name] <string>]
[router-name] - Administrative router name
aggregates + Enter the aggregates context
allow-icmp-redirect - Allow ICMP redirects on the management interface
allow-icmp6-redirect - Allow IPv6 ICMP redirects on the management interface
apply-groups - Apply a configuration group at this level
apply-groups-exclude - Exclude a configuration group at this level
autonomous-system - AS number advertised to peers for this router
bfd + Enter the bfd context
bgp + Enable the bgp context
bier + Enable the bier context
class-forwarding - Allow class-based forwarding over IGP shortcuts
confederation + Enter the confederation context
description - Text description
dhcp-server + Enter the dhcp-server context
dns + Enter the dns context
ecmp - Maximum equal-cost routes for routing table instance
---snip---
In the following ? output, similar information is shown, with more details provided for configuring the router command, including the allowable string length and default value for the command.
[ex:/configure]
A:admin@node-2# router ?
router [[router-name] <string>]
[[router-name] <string>]
<string> - <1..64 characters>
Default - "Base"
Administrative router name
aggregates + Enter the aggregates context
allow-icmp-redirect - Allow ICMP redirects on the management interface
allow-icmp6-redirect - Allow IPv6 ICMP redirects on the management interface
apply-groups - Apply a configuration group at this level
apply-groups-exclude - Exclude a configuration group at this level
autonomous-system - AS number advertised to peers for this router
bfd + Enter the bfd context
bgp + Enable the bgp context
bier + Enable the bier context
class-forwarding - Allow class-based forwarding over IGP shortcuts
confederation + Enter the confederation context
description - Text description
dhcp-server + Enter the dhcp-server context
dns + Enter the dns context
ecmp - Maximum equal-cost routes for routing table instance
---snip---| Symbol | Description |
|---|---|
|
+ |
Indicates a container or list |
|
- |
Indicates a leaf, a leaf-list, a list or container with no leafs, or a global command (if in the operational root) |
|
^ |
Indicates a mandatory element (an element that must be configured before the configuration is considered valid) |
|
: |
Indicates the first element of a group of choice elements that are mutually exclusive |
In the following help display example, the containers are eth-cfm, domain, and association. The leafs are apply-groups, apply-groups-exclude, dns, format, level, mac, md-index, and name, while level is also a mandatory element.
[ex:/configure]
A:admin@node-2# eth-cfm ?
eth-cfm
apply-groups - Apply a configuration group at this level
apply-groups-exclude - Exclude a configuration group at this level
domain + Enter the domain list instance[ex:/configure eth-cfm]
A:admin@node-2# domain ?
[md-admin-name] <string>
<string> - <1..64 characters>
Unique domain name[ex:/configure eth-cfm]
A:admin@node-2# domain dom-name ?
domain
Immutable fields - level, dns, mac, name, format, md-index
apply-groups - Apply a configuration group at this level
apply-groups-exclude - Exclude a configuration group at this level
association + Enter the association list instance
level ^ Maintenance Domain Level (MD Level)
md-index - The index of the Maintenance Domain (MD)
Mandatory choice: md-name
dns :- Domain name like text string derived from a DNS name
format :- Maintenance domain name not to be provided
mac :- Maintenance domain MAC name
name :- Maintenance domain name as an ASCII stringWhen online help is entered for a leaf or leaf-list, a short description of the element is displayed after the element type. The valid input values for the element are also listed, as shown in the following examples.
The description string for the VPRN service can have a length of 1 to 80 characters:
*[ex:/configure service vprn "5"]
A:admin@node-2# description ?
description <string>
<string> - <1..80 characters>
Text description
The ? help for the autonomous-system command lists the valid number range, followed by a short description of the parameter:
*[ex:/configure service vprn "5"]
A:admin@node-2# autonomous-system ?
autonomous-system <number>
<number> - <1..4294967295>
AS number advertised to peers for this router
A parameter value may have a unit type associated with it, as shown in the following example of the ingress-buffer-allocation command:
*[ex:/configure qos sap-ingress "sap-pname" policer 6]
A:admin@node-2# mbs ?
mbs (<number> | <keyword>)
<number> - <0..16777216> - bytes
<keyword> - auto - bytes
Default - auto
High priority violate threshold of PIR leaky bucketThis example shows a parameter that is a reference to another parameter. The owner command refers to the script policy name that is configured through the configure system script-control script-policy context. The name is a string of 1 to 32 characters.
*[ex:/configure log event-handling handler "h-name" entry 5]
A:admin@node-2# script-policy owner ?
owner <reference>
<reference> - <1..32 - configure system script-control script-
characters> policy <./name> owner <owner>
Default - TiMOS CLI
Script policy owner
An immutable element can only be configured in the transaction in which the parent element is created. It cannot be modified while the parent element exists. Any modification to an immutable element in model-driven interfaces causes SR OS to automatically delete the parent element and recreate it with the new value for the immutable element.
Immutable elements are identified in the online help, as seen in the following examples:
[ex:/configure eth-cfm]
A:admin@node-2# domain dom-name ?
domain
Immutable fields - level, dns, mac, name, format, md-index
apply-groups - Apply a configuration group at this level
apply-groups-exclude - Exclude a configuration group at this level
association + Enter the association list instance
level ^ Maintenance Domain Level (MD Level)
md-index - The index of the Maintenance Domain (MD)
Mandatory choice: md-name
dns :- Domain name like text string derived from a DNS name
format :- Maintenance domain name not to be provided
mac :- Maintenance domain MAC name
name :- Maintenance domain name as an ASCII string(ex)[/configure eth-cfm]
A:admin@node-2# domain dom-name level ?
level <number>
<number> - <0..7>
'level' is: mandatory, immutable
Maintenance Domain Level (MD Level)
Warning: Modifying this element recreates
'configure eth-cfm domain "dom-name"' automatically for the new value to
take effect.
Elements that are part of a choice are listed in a separate section in the online help. Mandatory choices are listed first. Each choice contains a set of mutually exclusive elements or groups of elements. The first element of a group is indicated with a colon (:).
The following example shows a set of two mutually exclusive choice elements for an ingress queue rate. If configuring one of the choice elements, either the cir and fir values can be configured or the police value.
*[ex:/configure qos sap-ingress "ing-1" queue 1 rate]
A:admin@node-2# ?
pir - Administrative PIR
Choice: rate-cir-fir-or-police
cir :- Administrative CIR
fir - Administrative FIR
police :- Drop the traffic feeding into queue above the PIR rateThe following help display is an example of optional indicators.
The square brackets ([]) around slot-number indicate that the slot-number keyword is optional when entering the command.
[ex:/configure]
A:admin@node-2# card ?
[slot-number] <number>
<number> - <1..20>
IOM slot within a chassis
The card context can be entered as:
[ex:/configure]
A:admin@node-2# card slot-number 5
or
[ex:/configure]
A:admin@node-2# card 5
Angle brackets (<>) indicate a variable name and the vertical bar (|) indicates a choice. For the sub-group command, a number in the range of 1 to 8 can be entered, or one of the keywords auto-iom or auto-mda.
*(ex)[/configure lag 8 port 1/1/1]
A:admin@node-2# sub-group ?
sub-group (<number> | <keyword>)
<number> - <1..8>
<keyword> - (auto-iom|auto-mda)
Default - 1
'sub-group' is: immutable
Subgroup of the port in the LAG
Warning: Modifying this element recreates 'configure lag 8 port 1/1/1'
automatically for the new value to take effect.