Appendix A - CLI Command Quick Reference
| Command | Description Common/Root Level Commands | User Roles | |||||
|---|---|---|---|---|---|---|---|
| Admin | Sec Admin |
Maint | Read Only |
||||
| ? | Typing ?, provides context-sensitive help, listing the commands, actions, parameters and possible parameter values for the current context. | ✔ | ✔ | ✔ | ✔ | ||
| exit (<ctrl>-d) | Exits from current enable command level. When at root level, quits the active telnet session. | ✔ | ✔ | ✔ | ✔ | ||
| help (h) | The help command lists available commands in the current context, | ✔ | ✔ | ✔ | ✔ | ||
| history | Displays a history of commands executed. Using this information commands can be re-run by typing !<cmd #>. The last command can be re-run by typing !!. |
✔ | ✔ | ✔ | ✔ | ||
| interactive | Enable, or disable, interactive mode. Interactive mode, when enabled(default), causes the user to be prompted for required parameters or attributes of commands. | ✔ | ✔ | ✔ | ✔ | ||
| quit (<ctrl>+d) | Exists user from their current command level. When at the root level, it terminates the current telnet session. | ✔ | ✔ | ✔ | ✔ | ||
| sleep | Places an active telnet session in sleep mode for a specified period of time. The period can be 1 to 3600 seconds. Entering <ctrl>+c exits the sleep condition. | ✔ | ✔ | ✔ | ✔ | ||
| Status/Display and Provisioning Mode Commands | |||||||
| adduser | Allows Admin or Security Admin users to add local users to the element user database. | ✔ | ✔ | ||||
| alarms | Display the current autonomous alarms and conditions for the ONT or selected card. | ✔ | ✔ | ✔ | |||
| cistbstat | Display Common and Internal Spanning Tree (CIST) bridge statistics. | ✔ | ✔ | ✔ | |||
| cistpstat | Display Common and Internal Spanning Tree (CIST) port statistics. | ✔ | ✔ | ✔ | |||
| closehttpports | Close HTTP ports. | ✔ | |||||
| connect | Allows the user to connect to the CLI of a remote card. | ✔ | ✔ | ✔ | ✔ | ||
| Cross-Connect (cc) | All Cross-Connect related actions. | ✔ | ✔ | ✔ | |||
| deluser | Allows an Admin user to delete local users from the element user database. | ✔ | ✔ | ||||
| disablemirroring | Stops a previously started mirroring session. | ✔ | ✔ | ✔ | |||
| displayprovlog | Allows the Admin or Security Admin user to display the local provisioning log for the network element. | ✔ | ✔ | ||||
| disprc | Display RADIUS server information. | ✔ | ✔ | ✔ | |||
| enableuser | Allows an Admin or Security Admin user to enable or disable a user in the element user database. | ✔ | ✔ | ||||
| enableusersecurity | Allows an Admin or Security Admin user to enable or disable password aging and craft account access for a user in the element user database. | ✔ | ✔ | ||||
| erasedb | Erases the ESU database. | ✔ | ✔ | ||||
| flowcounting | Count packets on a specified flow. | ✔ | ✔ | ||||
| flowmirroring | Mirror flow to a selected port. | ✔ | ✔ | ||||
| Forwarding-DataBase (fdb) | Forwarding-Database-related commands and actions | ✔ | ✔ | ✔ | |||
| ↳ | Layer-2 (l2) | Ethernet (layer 2) Forwarding Database (MAC table) operations | ✔ | ✔ | ✔ | ||
| getflowcounts | Retrieves the packet count for a flow counting/mirroring session. | ✔ | |||||
| httpgetlogs | Opens HTTP ports for log retrieval. | ✔ | |||||
| InterFaCe (ifc) | Interface (Internet Protocol (IP) and NET (up-link/Linear)) related commands and actions. | ✔ | ✔ | ||||
| ↳ | 10gigabit-ethernet | All 10 gigabit-ethernet commands and actions. | ✔ | ||||
| ↳ | Gigabit-Ethernet (ge) | All gigabit-ethernet port-related commands and actions. | ✔ | ||||
| ↳ | net | Net configuration-related commands and actions | ✔ | ||||
| ↳ | pon | PON interface-related commands consisting of edit, show, statistics, and status. | ✔ | ✔ | ✔ | ||
| ↳ | port | Port interface-related commands, consisting of create, delete, edit, match, show, status, and sync. | ✔ | ✔ | |||
| inv | Allows users to display hardware inventory information. | ✔ | ✔ | ✔ | |||
| logins | Displays information on all user logins. | ✔ | ✔ | ||||
| logoff | Exits the current active telnet session and returns to the command prompt. | ✔ | ✔ | ✔ | ✔ | ||
| logout | Closes the active telnet session. | ✔ | ✔ | ✔ | ✔ | ||
| mcast | Display information relative to downstream multicast groups. Output can be displayed for all groups, or filtered by IP address or downstream port. | ✔ | ✔ | ✔ | |||
| mccount | Display the statistics of active multicast channels on the device. | ✔ | ✔ | ✔ | |||
| mstibstat | Display the current Multi Spanning Tree Instance (MSTI) Bridge parameters/status. | ✔ | ✔ | ✔ | |||
| menu | Launches the menu interface of the CLI. | ✔ | ✔ | ✔ | ✔ | ||
| mstibstat | Display MSTI Bridge Parameters/Status | ✔ | ✔ | ✔ | |||
| msticonfig | Read the MSTI configuration Identifier for the network element | ✔ | ✔ | ✔ | |||
| mstilist | Display the current Multiple Spanning Tree Instance (MSTI) configuration. | ✔ | ✔ | ✔ | |||
| mstipstat | Allows user to display Multiple Spanning Tree Instance (MSTI) port statistics or status. | ✔ | ✔ | ✔ | |||
| ne | Provides all ONT-related commands. | ✔ | ✔ | ✔ | |||
| ↳ | net | Enable/disable/edit authentication, authorization, and accounting attributes (see Configuring Security for procedures to provision security options). | ✔ | ✔ | |||
| ↳ | bridge | Display ethernet-bridge configurations. | ✔ | ✔ | |||
| ↳ | clock | Set date, time, and global time-zone attributes. | ✔ | ✔ | |||
| ↳ | EQuipment (eq) | Equipment related operations | ✔ | ✔ | |||
| ↳ | icmp | ICMP configuraction | ✔ | ✔ | |||
| ↳ | ip | Global IP-related commands | ✔ | ✔ | ✔ | ||
| ↳ | lacp | Display ethernet-bridge lacp configuration. | ✔ | ✔ | ✔ | ✔ | |
| ↳ | Link-Layer-Discovery-Protocol (lldp) | Edit or display Link Layer Discovery Protocol (LLDP) network port configuration. Display LLDP statistics. | ✔ | ✔ | ✔ | ✔ | |
| ↳ | logging | Display logging edit command. | ✔ | ✔ | ✔ | ||
| ↳ | monitor | Ethernet Packet Monitor related commands. | ✔ | ✔ | |||
| ↳ | Network-Time-Protocol (ntp) | Set Network Time Protocol (NTP) attributes. | ✔ | ✔ | ✔ | ✔ | |
| ↳ | Power-Over-Ethernet (poe) | Edit or display Power-over-Ethernet (PoE) attributes. | ✔ | ||||
| ↳ | radius-server-group | Enable/disable RADIUS-server-group attributes. | ✔ | ||||
| ↳ | Spanning-Tree-Protocol (stp) | Display spanning tree configurations. | ✔ | ||||
| ↳ | template | All template related commands. | ✔ | ✔ | ✔ | ||
| ↳ | ont | ONT template related operations | ✔ | ✔ | ✔ | ||
| ↳ | port | Port template related operations | ✔ | ✔ | ✔ | ||
| ont | Optical Network Terminal (ONT) related actions. | ✔ | ✔ | ✔ | |||
| passwd | Allows Admin or Security Admin users to change a user password. | ✔ | ✔ | ||||
| ping | Send a specified number of Internet Control Message Protocol (ICMP) ping packets to a downstream processor card or external IP address. | ✔ | ✔ | ✔ | |||
| portmirroring | Mirror traffic to a selected port. | ✔ | ✔ | ||||
| portstat | Display spanning tree statistics for the network element and ports. | ✔ | ✔ | ✔ | |||
| profile | Provides all profile related commands and actions. | ✔ | ✔ | ✔ | |||
| ↳ | Access-Control-List (acl) | Access Control List (ACL) profile-related operations. Provides options to create, delete, edit, or display ACL profiles. | ✔ | ✔ | ✔ | ||
| ↳ | Cross-Connect (cc) | Cross-Connect (CC) profile related operations. | ✔ | ✔ | ✔ | ||
| ↳ | DiffServ-CodePoint (dscp) | DSCP mapping profile related operations. | ✔ | ✔ | ✔ | ||
| ↳ | Link-Layer-Discovery-Protocol (lldp) | Link Layer Discovery Protocol (LLDP) profile related operations. Provides options to create, delete, edit, or display LLDP profiles. | ✔ | ✔ | ✔ | ||
| ↳ | Network-ACcess (nac) | Network Access Control (NAC) profile-related operations. Provides options to create, delete, edit, or display NAC profiles. | ✔ | ✔ | ✔ | ||
| ↳ | pon | Provides options to create, delete, edit, or display Passive Optical Network (PON) profiles. | ✔ | ✔ | ✔ | ||
| ↳ | poncp | PON circuitpack profile related operations. | ✔ | ✔ | ✔ | ||
| ↳ | port | Provides options to create, delete, edit, or display Ethernet Port profiles. | ✔ | ✔ | ✔ | ||
| ↳ | Port-Access-Entity (pae) | Port Access Entity (PAE) profile-related operations. Provides options to create, delete, edit, or display PAE profiles. | ✔ | ✔ | ✔ | ||
| ↳ | Power-Over-Ethernet (poe) | Power over Ethernet (PoE) profile-related operations. Provides options to create, delete, edit, or display POE profiles. | ✔ | ✔ | ✔ | ||
| ↳ | radius | RADIUS profile related to operations. Provides options to create, delete and show RADIUS profiles. | ✔ | ✔ | ✔ | ||
| ↳ | Rapid-Spanning-Tree-Protocol (rstp) | Rapid Spanning Tree Protocol (RSTP) profile related operations. Provides options to create, delete, edit, or display RSTP profiles. | ✔ | ✔ | ✔ | ||
| ↳ | SerViCe (svc) | Service (SVC) profile-related operations. | ✔ | ✔ | ✔ | ||
| resetdefaults | Allows the Admin user to reset the ESU to factory defaults. | ✔ | |||||
| resetpasswd | Allows Admin or Security Admin users to reset a user password. | ✔ | ✔ | ||||
| rtpmon | Enables or disables real-time transport protocol (RTP) monitoring. | ✔ | ✔ | ||||
| rtpstat | Displays the statistical counters for currently-monitored flows. | ✔ | ✔ | ||||
| sfpinfo | Display the status of the small form-factor pluggable (SFP) interfaces on the ESU or IO cards. | ✔ | ✔ | ✔ | |||
| stopuser | Stops all login sessions for a user. | ✔ | ✔ | ||||
| stpconf | Display spanning tree configuration for the ONT and its ports. | ✔ | ✔ | ✔ | |||
| swinv | Display software inventory for all installed cards. | ✔ | ✔ | ✔ | |||
| switchloads | Switch components to the software load in the standby banks. | ✔ | ✔ | ||||
| template | Template related actions for Ports and ONTs | ✔ | ✔ | ✔ | |||
| ↳ | ont | ONT template related to operations | ✔ | ✔ | ✔ | ||
| ↳ | port | Port template related to operations | ✔ | ✔ | ✔ | ||
| trunkconf | Display link configuration and LACP configuration information for each port in the LAG (Link Aggregation Group) | ✔ | ✔ | ✔ | |||
| trunkstat | Display LAG status and LACP statistics and states for each port in the LAG. | ✔ | ✔ | ✔ | |||
| userinfo | Allows Admin or Security Admin user to display user information. | ✔ | ✔ | ||||
| version | Shows the current version of software. | ✔ | ✔ | ✔ | |||
| vlan | VLAN configuration operations. | ✔ | ✔ | ✔ | |||
| whereami | Displays the location of this card within the ONT. | ✔ | ✔ | ✔ | ✔ | ||
| WIZard | Run available Wizards (e.g. ElementManagement(aka Turnup),...) | ✔ | ✔ | ||||
| ↳ | ne | All Element Management related wizards (Turnup, IPAddr, MgmtVlan,...). | ✔ | ✔ | |||
|
↳
|
IPaddr(ip) | Wizard used to change/show NE IP Address-related data. | ✔ | ✔ | |||
| ↳ | MGmtVlan (mgv) | Wizard used to change/show Management VLAN-related data. | ✔ | ✔ | |||
| ↳ | TurNup (tn) | Wizard used for TYPICAL/Shortened turnup. | ✔ | ✔ | |||
.
FEEDBACK: Are you happy with this material?
Thank you Your feedback helps us to continually improve our content.