CLI Command Structure
The basic structure and the syntax of the CLI command verbs are defined as follows:
Syntax Conventions
- Angle brackets, < >, indicate a parameter value.
- Names within angle brackets <ABC| XYX> separated by a vertical bar indicate possible values.
- Square brackets [ ] indicate optional arguments.
- An Asterisk* indicates a required value'
- An vertical pipe (|) indicates a choice (or)
- Attribute values are indicated by <attribute name>=<attribute value> as an example AID= in an edit string the AID should follow the action. (i.e. edit auto-enable aid=net5)
- A + before a list of parameters indicates one of the parameters may be selected.
Help
ESUx> ont create ? <enter> [MDS slot]-[PON port]-[ONT ID] serial number expected for new ONT type of ONT to create User defined label for the ONT |
ESUx> ont ? Commands: security - cryptographic security related commands shell - Prompt to a shell Actions: create - create a new ONT delete - delete an ONT edit - edit an ONT find - locate ONTs by user label or serial number reset - reset an ONT show - show details on an ONT or group of ONTs by PON STATisticS - show statistics of an ONT status - show status of an ONT ESUx> ont stats ? Parameters: +all - all onts +card-id - [MDS slot] +ont-id - [MDS slot]-[PON port]-[ONT ID] +pon-id - [MDS slot]-[PON port] verbose - display complete information per ont (+ select one parameter from set) ESUx> ont stats all | Statistics | |=============|=================|===============================================| | | | Traffic | | | BIP Error Rate | Packets | Bytes | | ID | NE(dn) | FE(up)| RX(dn) | TX(up) | RX(dn) | TX(up) | |=============|========|========|===========|===========|============|==========| | MDS1-1-1 | N/A| N/A| 0| 0| 0| 0| | MDS1-1-2 | N/A| N/A| 0| 0| 0| 0| | MDS1-1-3 | N/A| N/A| 0| 0| 0| 0| | MDS1-1-4 | N/A| N/A| 0| 0| 0| 0| | MDS1-2-1 | N/A| N/A|-1288973828| -139851872| 493133411| 97572844| | MDS1-2-2 | N/A| N/A| 0| 0| 0| 0| | MDS1-2-3 | N/A| N/A| 1811278| 2199885| 246649023| 2410990| | MDS1-2-4 | N/A| N/A| 0| 0| 0| 0| | MDS1-2-5 | N/A| N/A| 0| 0| 0| 0| | MDS1-2-6 | N/A| N/A| 0| 0| 0| 0| | MDS1-2-7 | N/A| N/A| 0| 0| 0| 0| | MDS1-2-8 | N/A| N/A| 0| 0| 0| 0| |=============|========|========|===========|===========|============|==========| ESUx> |
Command Ordering
Commands are typically a command verb, followed by attributes to be configured or displayed. The order of the attributes within the command at a given level in the tree is not significant.
The command verbs for Maintenance are as follows by entering a help ? command:
ESUx> ? <enter>
Commands:
adduser - Allows Admin user to add local users to the database
alarms - alarm related operations
cistbstat - Display CIST Bridge Parameters/Status
cistpstat - Display CIST Port Parameters/Status
closehttpports - Close HTTP ports
connect - Connect to remote board
Cross-Connect - all Cross Connection related commands
deluser - Allows Admin user to delete local users from the database
disablemirroring - Stops a previously started mirroring session.
displayprovlog - Allows Security or Admin user to display Local Provisioning Log
disprc - Display RADIUS Server Information
enableuser - Allows Admin user to enable/disable user
enableusersecurity - Allows Admin user to enable/disable password aging and craft account access
erasedb - Erases ESU database
flowcounting - Count packets on a specified flow.
flowmirroring - Mirror flow to selected port
Forwarding-DataBase - all forwarding database commands
getflowcounts - Retrieve the packet count for a flow counting/mirroring session.
httpgetlogs - Open HTTP ports for log retrieval
InterFaCe - interface related commands
inv - Displays hardware inventory
logins - Displays all logins by user
logoff - Exits this craft session
logout - Exits this craft session
mcast - Displays downstream multicast info
mccount - Statistics on all multicast channels
menu - Launches the menu interface
mstibstat - Display MSTI Bridge Parameters/Status
msticonfig - Read MST Configuration Identifier
mstilist - Display Currently Created MST instances
mstipstat - Display MSTI Port Parameters/Status
ne - all network element related commands
ont - all ONT interface related commands
passwd - Allows user to change their password
ping - Sends ICMP ping packets to a node
portmirroring - Mirror traffic to select port
portstat - Display Spanning Tree Port statistics
profile - all profile related commands
resetdefaults - Restore ESU to factory defaults
resetpasswd - Allows Admin user to reset a users' password to a known value
rtpmon - Starts/stops RTP monitoring
rtpstat - Displays RTP info gathered by RTPMON
sfpinfo - Displays the status of optical interfaces
stopuser - Stops all login sessions for the user
stpconf - Display Spanning Tree configuration
swinv - Displays software inventory
switchloads - Switch to Standby load
template - all template related commands
trunkconf - Displays info on uplink trunk (aggregated Ethernet links)
trunkstat - Displays status of uplink trunk (aggregated Ethernet links)
userinfo - Allows Admin user to see all user info
version - VERSION - Show the current version of software
vlan - vlan profile related operations
whereami - Displays location of this card within the NE
WIZard - Run available Wizards (e.g. ElementManagement(aka Turnup),...)
ESUx> _
|
Up/Dn Arrow
Pressing the UP ARROW ↑ key navigates through the history of commands that have been executed. To repeat a command, press the UP ARROW key until the desired command is displayed. It can be edited if necessary. Press Enter to execute the command.
Case Insensitive
Commands are NOT case sensitive. Parameters or commands that are displayed in mixed-case are executed identically. e.g. Power-Over-Ethernet and poe are executed identically.
Command Shorthand
Prompted Mode
Some commands can be entered with or without its required and/or optional parameters. When entered without the required parameters, the system prompts for them.
Explicit Logout
Auto Logout
Tab Completion
ESUx> ont cre<tab> ESUx> ont create |
Hyphens
A hyphen (-) or forward slash (/) can be used as a separator in port ID parameters; i.e., [MDS slot]-[ONT-ID] can be entered as 1-1 or 1/1.
Commands are invoked by pressing the Enter key.
To cancel or exit a command, press Ctrl + C key.
ESUx> ont create{Ctrl+C}
ESUx>
|
<Ctrl>-D
Go up one level in a sub command. This returns the user to the next level up in the command structure.
Command Levels
To help group similar commands, the framework introduces command levels. This is a hierarchy of command groups organized in a tree-like structure. The user is initially placed in the root command level which contains numerous commands and their associated subcommands. Navigation into a sub-level is performed by typing the name of the level, e.g. ip in the example below. The prompt automatically reflects the current command level (and its predecessors), for example:
ESUx>
ESUx> interface
ESUx> interface net
ESUx> interface net lacp {Ctrl+D}
ESUx> interface net {Ctrl+D}
ESUx> interface {Ctrl+D}
ESUx> _
|
A command will insert the commands corresponding to the levels the user is within the hierarchy. The additional parameters will be appended, generating the complete command. The following example shows two equivalent ways to execute the same command.
ESUx> interface ip show name=bvi1is equivalent to: ESUx> interface ESUx> interface> ip ESUx> interface> ip> show name=bvi1 ESUx> interface> ip> quit ESUx> |
Command Actions
Each command typically has one action verb which designates the action to be performed. Typically, the action either before or after the target of the verb. The standard actions are: create, delete, edit, show, statistics and status.
History
Command history can be displayed with the history command. This is often convenient for remembering past successful commands and cutting and pasting them back into the command prompt.
ESUx> history 1 ne security yubikey edit admin=disabled 2 debug; shell 3 sfpinfo 4 ont 5 status 6 ont stat 7 ont stats all 8 ont all stats 9 stats all ont 10 ont show poe 11 ont show poe all 12 ont all statistics show ESUx> |
ESUx> !7 | Statistics | |=============|=================|===============================================| | | | Traffic | | | BIP Error Rate | Packets | Bytes | | ID | NE(dn) | FE(up)| RX(dn) | TX(up) | RX(dn) | TX(up) | |=============|========|========|===========|===========|============|==========| | MDS1-1-1 | N/A| N/A| 0| 0| 0| 0| | MDS1-1-2 | N/A| N/A| 0| 0| 0| 0| | MDS1-1-3 | N/A| N/A| 0| 0| 0| 0| | MDS1-1-4 | N/A| N/A| 0| 0| 0| 0| | MDS1-2-1 | N/A| N/A| 1783762995| 1617926826| -1608174851| 058428128| | MDS1-2-2 | N/A| N/A| 0| 0| 0| 0| | MDS1-2-3 | N/A| N/A| 1810728| 2198885| 246546799| 92200849| | MDS1-2-4 | N/A| N/A| 0| 0| 0| 0| | MDS1-2-5 | N/A| N/A| 0| 0| 0| 0| | MDS1-2-6 | N/A| N/A| 0| 0| 0| 0| | MDS1-2-7 | N/A| N/A| 0| 0| 0| 0| | MDS1-2-8 | N/A| N/A| 0| 0| 0| 0| |=============|========|========|===========|===========|============|==========| ESUx> _ |
Command Line Editing
The command line can be populated using the up error with a previous command, then edited using various keys for navigation.
- <backspace>: Use the backspace key to delete characters.
- <Left Arrow>/<Right arrow>: Use the left and right arrow keys to navigate within the command line.
- <insert>: By default, the line is in insert mode and text added to the command will shift the rest of the command line to the right. Insert/overwrite mode can be toggled by pressing insert.
Many commands have mutually exclusive parameters, i.e. the command requires one parameter from a group but cannot support multiple parameters within that group. Parameters that fall into this category are displayed in context sensitive help as "+" options. Once one parameter is specified, the mutually exclusive parameters are removed from the context sensitive help.
On this page