.\" hey, Emacs: -*- nroff -*- .\" scli is free software; you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by .\" the Free Software Foundation; either version 2 of the License, or .\" (at your option) any later version. .\" .\" This program is distributed in the hope that it will be useful, .\" but WITHOUT ANY WARRANTY; without even the implied warranty of .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the .\" GNU General Public License for more details. .\" .\" You should have received a copy of the GNU General Public License .\" along with this program; see the file COPYING. If not, write to .\" the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. .\" .TH SCLI 1 "Jan 2, 2007" .\" Please update the above date whenever this man page is modified. .\" .\" Some roff macros, for reference: .\" .nh disable hyphenation .\" .hy enable hyphenation .\" .ad l left justify .\" .ad b justify to both left and right margins (default) .\" .nf disable filling .\" .fi enable filling .\" .br insert line break .\" .sp insert n+1 empty lines .\" for manpage-specific macros, see man(7) .SH NAME scli \- SNMP Command Line Interface .SH SYNOPSIS .B scli .RI [ options ] .I [hostname] .RI [ community ] .SH DESCRIPTION \fBscli\fP provides a simple command line interface on top of the Simple Network Management Protocol (SNMP). It can be used to read data from devices and to configure them with simple commands. It relies on the capabilities of the devices and thus not all commands may work with all devices. .PP The optional \fIhostname\fR argument is the name or the IP address of the remote host. \fBscli\fP talks to this host's SNMP agent on the default port number 161 using the SNMP over UDP transport mapping. .PP The optional \fIcommunity\fR argument is the community string used to communicate with the remote SNMP agent. The default string is \fIpublic\fR. Please check the configuration of the SNMP agent to get a clue about the community string to use, if the default community string does not work. .PP .SH OPTIONS \fBscli\fP accepts the following options: .TP .B \-V, \-\-version Show version of program. .TP .B \-c, \-\-command Process the given commands and exit. .TP .B \-d seconds, \-\-delay=seconds Set delay between screen updates in seconds. The default delay between updates is 5 seconds. .TP .B \-f, \-\-file Process commands from a file and exit. .TP .B \-h, \-\-help Show summary of scli options. .TP .B \-i, \-\-inet Execute in inet mode. This option implies -q, -n and -x. .TP .B \-n, \-\-norc Do not evaluate ~/.sclirc on startup. .TP .B \-q, \-\-quiet This flag causes scli to supress some informational messages. .TP .B \-s, \-\-dry-run Parse scli commands but do not actually execute them. This allows to perform syntax checking on scli scripts. .TP .B \-x, \-\-xml Generate XML output instead of the default output which is optimized for humans and more difficult to parse by programs. .SH COMMAND OVERVIEW \fBscli\fP is a simple command interpreter. \fBscli\fP commands are organized in a hierarchy. This section only describes the top-level commands. Invoke the \fIhelp\fP command described below to get a complete list of all commands supported by \fBscli\fP. .TP 10 .B open Establish an association to a remote SNMP agent. .TP .B close Close the association to a remote SNMP agent. .TP .B exit Exit the \fBscli\fP command interpreter. .TP .B help Display help information about the \fBscli\fP command interpreter including a full list of the \fBscli\fP command hierarchy. .TP .B history Show the history of the last \fBscli\fP commands. .TP .B create Create new object instances on the remote SNMP agent. This command has many sub-commands which are used to instantiate very different things. .TP .B delete Delete object instances from the remote SNMP agent. This command has many sub-commands which are used to delete very different things. .TP .B run Execute a specific action. This command has many sub-commands which are used run very different actions. .TP .B set Modify object instances on the remote SNMP agent by assigning new values. This command has many sub-commands which are used to set very different things. .TP .B show Show information provided by the remote SNMP agent. This command has many sub-commands focusing on various aspects of the system. .TP .B monitor Monitor information provided by the remote SNMP agent. This command has many sub-commands focusing on various aspects of the system. \fBscli\fP monitors provide a live display of network and device activities. Information is shown in a compact human readable format and updated in regular intervals. The initial update interval length is determined by the delay command line option. .TP .B dump Dump scli command sequences to restore the configuration of the remote SNMP agent. .PP \fBscli\fP supports recursive command evaluation. When a command is entered which is not a leaf of the command tree, then the interpreter will recursively invoke all commands in the subtree identified by the entered command. In particular, entering \fIshow\fR will cause \fBscli\fP to retrieve and display all information accessible from the remote SNMP agent. 100-scli version (c) 2001-2007 Juergen Schoenwaelder .SH 3COM MODE .PP The 3com scli mode allows to manipulate virtual lans (vlans) on 3com bridges. It is based on the PRODUCTMIB which is implemented at least on 3Com SuperStack II switches. .TP .B create 3com bridge vlan .TP .B delete 3com bridge vlan .TP .B set 3com bridge vlan name .TP .B set 3com bridge vlan ports .TP .B show 3com bridge vlan info [] .TP .B dump 3com bridge vlan .PP The \fIcreate 3com bridge vlan\fP command is used to create a new virtual LAN with the given and . .PP The \fIdelete 3com bridge vlan\fP command deletes all selected virtual LANs. The regular expression is matched against the virtual LAN names to select the vlans that should be deleted. .PP The \fIset 3com bridge vlan name\fP command changes the name of a virtual LAN. .PP The \fIset 3com bridge vlan ports\fP command allows to assign ports to port-based virtual LANs. The regular expression is matched against the virtual LAN names to select the vlans that should be modified. The argument contains a comma separated list of port numbers or port number ranges, e.g. 1,5,7-8. .PP The \fIshow 3com bridge vlan info\fP command shows summary information about all selected virtual LANs. The optional regular expression is matched against the virtual LAN names to select the virtual LANs of interest. The command generates a table with the following columns: .PP VLAN virtual LAN number STATUS status of the virutal LAN (see below) NAME name of the virutal LAN INTERFCE virtual LAN interface number PORTS ports assigned to the virtual LAN .PP The status is encoded in two characters. The first character indicates the status of the row (A=active, S=not in service, R=not ready). The second character indicates virutal LAN type (P=port, I=IP-subnet, O=protocol, S=src address, D=dst address). .PP The \fIdump 3com bridge vlan\fP command generates a sequence of scli commands which can be used to restore the virtual LAN configuration. .SH ATM MODE .PP The atm scli mode is based on the ATM-MIB as published in RFC 2515. This mode is intended to display and configure ATM parameters. .TP .B show atm interface info .TP .B show atm interface details .PP The \fIshow atm interface info\fP command displays summary information for all selected ATM interfaces. The optional regular expression is matched against the interface descriptions to select the interfaces of interest. The command generates a table with the following columns: .PP INTERFACE network interface number DESCRIPTION description of the network interface .PP The \fIshow atm interface details\fP command describes the selected ATM interfaces in more detail. The optional regular expression is matched against the interface descriptions to select the interfaces of interest. .SH BRIDGE MODE .PP The scli bridge mode is based on the BRIDGE-MIB as published in RFC 4188 and the Q-BRIDGE-MIB as published in RFC 4363. It provides commands to browse information specific to IEEE 802.1 LAN bridges (also known as layer two switches). .TP .B show bridge info .TP .B show bridge ports .TP .B show bridge stp ports .TP .B show bridge forwarding .TP .B show bridge filter .TP .B show bridge stats .TP .B monitor bridge stats .TP .B show bridge vlan info [] .TP .B show bridge vlan details [] .PP The \fIshow bridge info\fP command displays summary information about a bridge, such as the number of ports and the supported bridging functions and associated parameters. .PP The \fIshow bridge ports\fP command displays information about the bridge ports. .PP The \fIshow bridge stp ports\fP command displays information about the bridge ports which participate in the spanning tree protocol. The command generates a table with the following columns: .PP PORT port number PRIO spanning tree priority of the port STATE spanning tree status of the port P-COST path costs for this port D-ROOT designated root port D-COST designated costs D-BRIDGE designated bridge D-PORT designated port .PP The status is encoded in two characters. The first character indicates whether STP on the port is enabled (E) or disabled (D). The second character indicates the current status (D=disabled, B=blocking, I=listening, L=learning, F=forwarding, X=broken). .PP The \fIshow bridge forwarding\fP command displays the forwarding data base used by transparent bridges. The command generates a table with the following columns: .PP PORT port number STATUS status of the forwarding entry ADDRESS address associated with the port NAME name of the address (where known) VENDOR vendor info derived from the address .PP The \fIshow bridge filter\fP command shows filtering information. .PP The \fIshow bridge stats\fP command displays per port statistics for transparent bridges. The command generates a table with the following columns: .PP PORT port number I-FPS input frames per second O-FPS output frames per second D-FPS discarded frames per second DESCRIPTION description of the port .PP The \fImonitor bridge stats\fP command shows the same information as the show bridge stats command. The information is updated periodically. .PP The \fIshow bridge vlan info\fP command shows summary information about configured VLANs. The command generates a table with the following columns: .PP VLAN VLAN number (between 1 and 4094) STATUS status of the VLAN NAME name of the VLAN PORTS ports assigned the the VLAN .PP The \fIshow bridge vlan details\fP command describes the selected VLANs in detail. The optional regular expression is matched against the VLAN names to select the VLANs of interest. .SH CISCO MODE .PP The cisco scli mode is used to display and configure cisco parameters. It also supports retrieval of accounting data from devices that support the old cisco accounting mib. This mode is based on the OLD-CISCO-IP-MIB published in May 1994. .TP .B show cisco processes .TP .B show cisco ip accounting info .TP .B show cisco ip accounting current sorted .TP .B show cisco ip accounting current raw .TP .B show cisco ip accounting snapshot sorted .TP .B show cisco ip accounting snapshot raw .TP .B monitor cisco ip accounting current .TP .B monitor cisco ip accounting snapshot sorted .TP .B set cisco ip accounting checkpoint .TP .B show cisco dot11 interface info .TP .B show cisco dot11 clients stats .TP .B monitor cisco dot11 clients stats .PP The \fIshow cisco processes\fP command displays information about all processes running on a CISCO device. The command generates a table with the following columns: .PP CPU processor executing a given process PID process indentification number on a CPU P priority of the process MEMORY memory used by the process TIME CPU time used by the process COMMAND command executed by the process .PP The \fIshow cisco ip accounting info\fP command displays general status information concerning the simple cisco IPv4 accounting mechanism supported by many older cisco devices. In particular, it displays the starting point of the current and snapshot data tables, information about the available accounting capacity, and statistics about lost bytes and packets. .PP cisco IP current accounting data .PP The \fIshow cisco ip accounting current raw\fP command displays the raw accounting data retrieved from the current table. The command generates a table with the following columns: .PP SOURCE source IPv4 address in dotted notation DESTINATION destination IPv4 address in dotted notation PACKETS packets sent from source to destination BYTES bytes sent from source to destination .PP cisco IP snapshot accounting data .PP The \fIshow cisco ip accounting snapshot raw\fP command displays the raw accounting data retrieved from the snapshot table. The command generates a table with the following columns: .PP SOURCE source IPv4 address in dotted notation DESTINATION destination IPv4 address in dotted notation PACKETS packets sent from source to destination BYTES bytes sent from source to destination .PP cisco IP current accounting data .PP cisco IP snapshot accounting data .PP The \fIset cisco ip accounting checkpoint\fP command takes a snapshot of the current accounting table by copying it to the snapshot accounting table. The current accounting table is reinitialized before it is updated again. The command returns the serial number of the snapshot. .PP The \fIshow cisco dot11 interface info\fP command displays information about all IEEE 802.11 interfaces on a CISCO device. The command generates a table with the following columns: .PP IFACE network interface number SPEED speed in bits per second NAME name of the network interface CLNT number of associated clients BRDG number of assiciated bridges RPRT number of assiciated repeaters ASSCI total number of associated stations ASSCO total number of deassociated stations ROAMI total number of roamed-in stations ROAMO total number of roamed-away stations AUTHI total number of authenticated stations AUTHO total number of deauthenticated stations .PP The \fIshow cisco dot11 clients stats\fP command displays information about all IEEE 802.11 clients associated with a CISCO device. The command generates a table with the following columns: .PP IF network interface number SSID SSID to which client is associated ADDRESS client MAC address IPv4-ADDRESS client\fPs IPv4 address (if supplied) SGNL client\fPs signal strength UPTIME lifetime of client\fPs association I-BPS input bytes per second O-BPS output bytes per second ERR errors per second .PP The \fImonitor cisco dot11 clients stats\fP command shows the same information as the show cisco dot11 clients stats command. The information is updated periodically. .SH DISMAN MODE .PP The scli disman mode is based on the DISMAN-SCRIPT-MIB as published in RFC 3165 and the DISMAN-SCHEDULE-MIB as published in RFC 3231. It allows to browse and configure distributed managers. .TP .B create disman script .TP .B create disman run .TP .B show disman languages .TP .B show disman script info .TP .B show disman script details .TP .B show disman launch info .TP .B show disman launch details .TP .B show disman run info .TP .B show disman run details .TP .B show schedule info .TP .B show schedule details .TP .B create schedule .TP .B delete schedule .TP .B dump schedule .TP .B monitor schedule info .TP .B monitor disman run .PP languages supported by the distributed manager .PP script summary information .PP scripts installed at the distributed manager .PP launch summary information .PP launch buttons installed on the distributed manager .PP summary information about running scripts .PP running scripts on the distributed manager .PP The \fIshow schedule info\fP command displays summary information about the scheduled actions. .PP schedules on the distributed manager .PP The \fIdump schedule\fP command generates a sequence of scli commands which can be used to restore the schedule configuration. .PP scheduler information .PP monitor running scripts .SH ENTITY MODE .PP The entity scli mode is based on the ENTITY-MIB as published in RFC 2737. It provides commands to browse the physical entities or physical components that make up a managed system. .TP .B show entity info .TP .B show entity details .TP .B show entity containment .TP .B show entity sensors .PP The \fIshow entity info\fP command displays summary information about the physical entities that compose the system. The command generates a table with the following columns: .PP ENTITY entity number CLASS class of the entity (see below) NAME name of the entity DESCRIPTION description of the entity .PP The \fIshow entity details\fP command describes the physical entities in more detail. .PP The \fIshow entity containment\fP command displays the physical entity containment hierarchy. .PP The \fIshow entity sensors\fP command describes the physical sensor entities in more detail. .SH ETHERNET MODE .PP The ethernet scli mode is based on the EtherLike-MIB as published in RFC 2665 and the MAU-MIB as published in RFC 2668. .TP .B show ethernet mau .TP .B show ethernet stats .TP .B show ethernet history .TP .B monitor ethernet stats .PP The \fIshow ethernet mau\fP command displays information about the medium attachment units (MAUs) for each ethernet port. The command generates a table which has the following columns: .PP INTERFACE network interface number MAU medium attachment unit number per interface STATUS status of the medium attachment unit MEDIA media availability JABBER jabber state of the medium attachment unit AUTONEG autonegation capabilities TYPE type of the medium attachment unit .PP The \fIshow ethernet stats\fP command displays ethernet specific statistics for each ethernet interface. The command outputs a table which has the following columns: .PP INTERFACE network interface number ALIGN alignement errors per second FCS frame check sequence errors per second RCV MAC receive errors per second LONG frames exceeding maximum frame size per second DEFER deferred transmission per second SCOL single collisions per second MCOLR multiple collisions per second XCOL excessive collisions per second LCOL late collisions per second XMIT MAC transmit errors per second CARR carrier sense errors per second .PP The \fImonitor ethernet stats\fP command shows the same information as the show ethernet stats command. The information is updated periodically. .SH HP MODE .PP The hp scli mode is used to display and configure hp parameters. .TP .B show hp fault log .PP .SH XXX .SH INTERFACE MODE .PP The scli interface mode is based on the IF-MIB as published in RFC 2863. It provides commands to browse, monitor and configure arbitrary network interfaces. .TP .B create interface stack .TP .B delete interface stack .TP .B set interface status .TP .B set interface alias .TP .B set interface notifications .TP .B set interface promiscuous .TP .B show interface info [] .TP .B show interface details [] .TP .B show interface stack [] .TP .B show interface stats [] .TP .B monitor interface stats [] .TP .B loop interface stats [] .TP .B check interface status [] .TP .B dump interface .PP .PP .PP .PP .PP The \fIset interface status\fP command modifies the administrative status of all selected interfaces. The regular expression is matched against the interface descriptions to select the interfaces of interest. The parameter must be one of the strings "up", "down", or "testing". .PP The \fIset interface alias\fP command assigns the alias name to the selected interfaces. The alias name provies a non-volatile handle which can be used by management applications to better identify interfaces. The regular expression is matched against the interface descriptions to select the interfaces. .PP The \fIset interface notifications\fP command controls whether the selected interfaces generate linkUp and linkDown notifications. The regular expression is matched against the interface descriptions to select the interfaces. The parameter must be one of the strings "enabled" or "disabled". .PP The \fIset interface promiscuous\fP command controls whether the selected interfaces operate in promiscuous mode or not. The regular expression is matched against the interface descriptions to select the interfaces. The parameter must be one of the strings "true" or "false". .PP The \fIshow interface info\fP command displays summary information for all selected interfaces. The optional regular expression is matched against the interface descriptions to select the interfaces of interest. The command generates a table with the following columns: .PP INTERFACE network interface number STATUS interface status (see below) MTU maximum transfer unit TYPE type of the network interface SPEED speed in bits per second NAME name of the network interface DESCRIPTION description of the network interface .PP The status is encoded in four characters. The first character indicates the administrative status (U=up, D=down, T=testing). The second character indicates the operational status (U=up, D=down, T=testing, ?=unknown, O=dormant, N=not-present, L=lower-layer-down). The third character indicates whether a connector is present (C=connector, N=none) and the fourth character indicates whether the interface is in promiscuous mode (P=promiscuous, N=normal). .PP The \fIshow interface details\fP command describes the selected interfaces in detail. The optional regular expression is matched against the interface descriptions to select the interfaces of interest. .PP The \fIshow interface stack\fP command shows the stacking order of the interfaces. The command generates a table with the following columns: .PP INTERFACE network interface number STACK indication of the stacking order TYPE type of the network interface DESCRIPTION description of the network interface .PP The \fIshow interface stats\fP command displays network interface statistics for all selected interfaces. The optional regular expression is matched against the interface description to select the interfaces. The command outputs a table which has the following columns: .PP INTERFACE network interface number STATUS interface status (see above) I-BPS input bytes per second O-BPS output bytes per second I-PPS input packets per second O-PPS output packets per second I-ERR input errors per second O-ERR output errors per second I-DIS input packets discarded per second O-DIS output packets discarded per second I-UNK input packets with unknown protocols per second DESCRIPTION description of the network interface .PP The \fImonitor interface stats\fP command shows the same information as the show interface stats command. The information is updated periodically. .PP The \fIloop interface stats\fP command shows the same information as the show interface stats command. The information is updated periodically. .PP The \fIcheck interface status\fP command checks the status of interfaces. The optional regular expression is matched against the interface description to select the interfaces In particular, the check interface status commands detects fault conditions if (a) ifAdminStatus is not down and ifOperStatus is down or (b) ifAdminStatus is down and ifOperStatus is not down and not notPresent .PP The \fIdump interface\fP command generates a sequence of scli commands which can be used to restore the interface configuration. .SH IP MODE .PP The ip scli mode is based on the IP-MIB as published in RFC 2011, the IP-FORWARD-MIB as published in RFC 2096, the IP-TUNNEL-MIB as published in RFC 2667 and the RFC1213-MIB as published in RFC 1213. It provides commands to browse, monitor and configure IP protocol engines. .TP .B set ip forwarding .TP .B set ip ttl .TP .B show ip info .TP .B show ip forwarding .TP .B show ip addresses .TP .B show ip tunnel .TP .B show ip mapping .TP .B dump ip .PP The \fIset ip forwarding\fP command controls whether the IP protocol engine forwards IP datagrams or not. The parameter must be one of the strings "enabled" or "disabled". .PP The \fIset ip ttl\fP command can be used to change the default time to live (TTL) value used by the IP protocol engine. The parameter must be a number between 1 and 255 inclusive. .PP The \fIshow ip info\fP command displays parameters of the IP protocol engine, such as the default TTL or whether the node is forwarding IP packets. .PP The \fIshow ip forwarding\fP command displays the IP forwarding data base. The command generates a table with the following columns: .PP DESTINATION destination address and prefix NEXT-HOP next hop towards the destination TOS type of service selector TYPE type (direct/indirect) of the entry PROTO protocol which created the entry INTERFACE interface used for forwarding .PP The \fIshow ip addresses\fP command displays the IP addresses assigned to network interfaces. The command generates a table with the following columns: .PP ADDRESS IP address PREFIX IP address prefix length NAME name of the IP address INTERFACE network interface number DESCRIPTION description of the network interface .PP The \fIshow ip tunnel\fP command displays information about existing IP tunnels. .PP The \fIshow ip mapping\fP command displays the mapping of IP address to lower layer address (e.g., IEEE 802 addresses). The command generates a table with the following columns: .PP INTERFACE network interface number STATUS status of the mapping entry ADDRESS IP address ADDRESS lower layer address .PP The \fIdump ip\fP command generates a sequence of scli commands which can be used to restore the IP configuration. .PP .SH ISDN MODE .PP The scli isdn mode is based on the ISDN-MIB as published in RFC 2127. .TP .B show isdn bri [] .TP .B show isdn bearer .TP .B show isdn endpoints .PP The \fIshow isdn bri\fP command shows information about the ISDN basic rate interfaces. The command outputs a table which has the following columns: .PP INTERFACE network interface number TYPE type of the ISDN interface TOPOLOGY line topology MODE interface mode (te/nt) SIGNALING signaling mode (active/inactive) DESCRIPTION description of the network interface .PP The \fIshow isdn bearer\fP command shows information about the ISDN B (bearer) channels. .PP The \fIshow isdn endpoints\fP command shows information about the ISDN endpoints. .SH NETSNMP MODE .PP The netsnmp scli mode is used to display and configure netsnmp specific parameters. It is based on the UCD-SNMP-MIB. .TP .B set netsnmp debugging .TP .B set netsnmp restart .TP .B show netsnmp info .TP .B show netsnmp load .TP .B show netsnmp exec .TP .B show netsnmp proc .TP .B dump netsnmp .PP The \fIset netsnmp debugging\fP command controls whether the agent generates debug messages or not. The parameter must be one of the strings "enabled" or "disabled". .PP The \fIset netsnmp restart\fP command restarts the agent. .PP The \fIshow netsnmp info\fP command shows general information about the netsnmp/ucdsnmp agent such as the version number and the software configuration. .PP The \fIshow netsnmp load\fP command shows the load indices of the system. This is usually the length of the queue in front of the processor(s) averaged over some time interval. .PP The \fIshow netsnmp exec\fP command shows information about pre-configured commands that can be invoked. .PP The \fIshow netsnmp proc\fP command shows information about which processes netsnmp watches. .PP The \fIdump netsnmp\fP command generates a sequence of scli commands which can be used to restore the netsnmp specific configuration. .PP .SH NORTEL MODE .PP The nortel scli mode allows to manipulate virtual LANs (vlans) on nortel bridges. It is based on the RAPID-CITY MIB which is implemented at least on the baystack bridges. .TP .B create nortel bridge vlan .TP .B delete nortel bridge vlan .TP .B set nortel bridge vlan name .TP .B set nortel bridge vlan ports .TP .B set nortel bridge vlan default .TP .B show nortel bridge vlan info [] .TP .B show nortel bridge vlan details [] .TP .B show nortel bridge vlan ports .TP .B dump nortel bridge vlan .PP The \fIcreate nortel bridge vlan\fP command is used to create a new virtual LAN with the given and . .PP The \fIdelete nortel bridge vlan\fP command deletes all selected virtual LANs. The regular expression is matched against the virtual LAN names to select the vlans that should be deleted. .PP The \fIset nortel bridge vlan name\fP command changes the name of a virtual LAN. .PP The \fIset nortel bridge vlan ports\fP command allows to assign ports to port-based vlans. The regular expression is matched against the vlan names to select the vlans that should be modified. The argument contains a comma separated list of port numbers or port number ranges, e.g. 1,5,7-8. .PP The \fIset nortel bridge vlan default\fP command allows to assign ports to a default vlan. The argument is matched against the vlan names to select the vlan. The argument contains a comma separated list of port numbers or port number ranges, e.g. 1,5,7-8. .PP The \fIshow nortel bridge vlan info\fP command shows summary information about all selected virtual LANs. The optional regular expression is matched against the virtual LAN names to select the virtual LANs of interest. The command generates a table with the following columns: .PP VLAN number of the virtual LAN STATUS status of the virtual LAN (see below) NAME name of the virtual LAN PORTS ports assigned to the virtual LAN .PP The status is encoded in four characters. The first character indicates the status of the row (A=active, S=not in service, R=not ready). The second character indicates virtual LAN type (P=port, I=IP-subnet, O=protocol, S=src address, D=dst address). The third character indicates the priority of the virtual LAN (H=high, N=normal) and the fourth character indicates whether routing is enabled (R=routing, N=no routing). .PP The \fIshow nortel bridge vlan details\fP command describes the selected vlans in more detail. The optional regular expression is matched against the vlan names to select the vlans of interest. .PP The \fIshow nortel bridge vlan ports\fP command shows information for each vlan port. The command generates a table with the following columns: .PP PORT port number FLAGS port vlan flags (see below) DEFAULT default vlan number VLANS vlan numbers the port is member of .PP The flags are encoded in four characters. The first character indicates the port type (A=access, T=trunk). The second character indicates whether the port tags frames (T=tagging, N=none). The third character indicates whether the port discards tagged frames (D=discard, N=none) and the fourth character indicates whether the port discards untagged frames (D=discard, N=none). .PP The \fIdump nortel bridge vlan\fP command generates a sequence of scli commands which can be used to restore the virtual LAN configuration. .SH OSPF MODE .PP The scli ospf mode is used to display and configure OSPF parameters. .TP .B show ospf area .TP .B show ospf info .TP .B show ospf interface .TP .B show ospf lsdb .PP show OSPF areas .PP general OSPF information .PP show OSPF interfaces .PP show OSPF lsdb .SH PRINTER MODE .PP The scli printer mode is based on the Printer-MIB as published in RFC 1759 and some updates currently being worked on in the IETF Printer MIB working group. .TP .B set printer operator .TP .B show printer info .TP .B show printer paths .TP .B show printer inputs .TP .B show printer outputs .TP .B show printer markers .TP .B show printer colorants .TP .B show printer supplies .TP .B show printer interpreters .TP .B show printer channels .TP .B show printer covers .TP .B show printer display .TP .B show printer lights .TP .B show printer alerts .TP .B monitor printer display .TP .B monitor printer lights .TP .B monitor printer alerts .TP .B run printer reboot .PP The \fIset printer operator\fP command configures the name of the person responsible for operating a printer. As a convention, the phone number, fax number or email address should be indicated by the tel:, fax: and mailto: URL schemes. .PP The \fIshow printer info\fP command shows general information about the printer including global status information. .PP The \fIshow printer paths\fP command shows information about the media paths of a printer. .PP The \fIshow printer inputs\fP command shows information about the input sub-units of a printer which provide media for input to the printing process. .PP The \fIshow printer output\fP command shows information about the output sub-units of a printer capable of receiving media delivered from the printing process. .PP The \fIshow printer markers\fP command shows information about the marker sub-units of a printer which produce marks on the print media. .PP The \fIshow printer colorants\fP command shows information about the colorant sub-units of a printer which produce marks on the print media. .PP The \fIshow printer supplies\fP command shows information about the supplies which are consumed and the waste produced by the markers of a printer. .PP The \fIshow printer interpreters\fP command shows information about the page description language and control language interpreters supported by the printer. .PP The \fIshow printer channels\fP command shows information about the channels which can be used to submit data to the printer. .PP The \fIshow printer covers\fP command shows information about the covers of a printer. .PP The \fIshow printer display\fP command shows the current contents of the display attached to the printer. The command generates a table with the following columns: .PP PRINTER logical printer number LINE display line number TEXT contents of the display line .PP The \fIshow printer lights\fP command shows the current status of the lights attached to the printer. The command generates a table with the following columns: .PP PRINTER logical printer number LIGHT number identifying the light/led DESCRIPTION description of the light/led STATUS current status (on, off, blink) COLOR current color of the light .PP The \fIshow printer alerts\fP command displays the list of active printer alerts including the alert code, the alert severity, the alert description, the alert time, the alert location and the personel required to handle the alert. .PP The \fImonitor printer display\fP command shows the same information as the show printer display command. The information is updated periodically. .PP The \fImonitor printer lights\fP command shows the same information as the show printer lights command. The information is updated periodically. .PP The \fImonitor printer alerts\fP command shows the same information as the show printer alerts command. The information is updated periodically. .PP The \fIrun printer reboot\fP command resets the printed. .SH RS232 MODE .PP The rs232 scli mode is based on the RS-232-MIB as published in RFC 1659. .TP .B show rs232 details .PP The \fIshow rs232 details\fP command describes the selected RS 232 interfaces in detail. .SH SCLI MODE .PP The scli mode provides commands that can be used to display and manipulate the internal state of the scli interpreter. .TP .B open [] .TP .B close .TP .B run scli walk [ ...] .TP .B run scli scan [community] .TP .B create scli plugin .TP .B delete scli plugin .TP .B exit .TP .B help .TP .B history .TP .B create scli alias .TP .B delete scli alias .TP .B create scli interp .TP .B delete scli interp .TP .B set scli regex [] .TP .B set scli debugging [] .TP .B set scli pager .TP .B set scli retries .TP .B set scli timeout .TP .B set scli format .TP .B set scli mode .TP .B show scli info .TP .B show scli command info [] .TP .B show scli schema [] .TP .B show scli alarm info .PP The \fIopen\fP command establishes an association to a remote SNMP agent. The argument is the DNS name or the IP address of the remote node. Scli will try to talk to the SNMP agent on this node by using the default port number (usually 161) and the default transport mapping (usually SNMP over UDP). The optional argument is the community string needed to communicate with the remote SNMP agent. The default community string is "public". Opening an association while an association is already established is not considered an error. The existing established association will be closed automatically before an attempt to create a new association is started. .PP The \fIclose\fP command closes an established association to a remote SNMP agent. Invoking the close command when no association is established is not considered an error and will do just nothing. .PP The \fIrun scli walk\fP command is a debugging utility which simply performs a MIB walk. Note that scli does not have general MIB knowledge and hence the output requires some post-processing. .PP The \fIrun scli scan\fP command is a utility which scans an IPv4 address space identified by the argument. The must be specified in the format /. The optional argument is the community string needed to communicate with the remote SNMP agent. The default community string is "public". .PP The \fIcreate scli plugin\fP command dynamically loads an scli mode into a running scli process. This can be used to dynamically extend scli with modules coming from other sources. Dynamic loadable modules also simplify the development and management of site-specific modules. .PP The \fIdelete scli plugin\fP command removes a previously loaded modules from a running scli process. .PP The \fIexit\fP command terminates the scli interpreter. An end of file in the standard input stream will also terminate the the scli interpreter. .PP The \fIhelp\fP command displays some help information including a list of all top-level scli commands. .PP The \fIhistory\fP command displays the scli command history list with line numbers. .PP The \fIcreate scli alias\fP command creates the alias for the scli command (fragment) . If the alias already exists, then the new will be assigned to the existing alias. .PP The \fIdelete scli alias\fP command removes previously defined aliases from the scli interpreter. The regular expression is matched against all alias names in order to select the aliases that are deleted. .PP The \fIcreate scli interp\fP command creates a new internal scli interpreter with the name . .PP The \fIdelete scli interp\fP command deletes previously defined scli interpreters from the main scli interpreter. The regular expression is matched against all alias names in order to select the interpreter(s) to be removed. .PP The \fIset scli regex\fP command controls how scli matches regular expressions. The optional regular expression is matched against the regular expression options. A successful match turns a regular expression option on while an unsuccessful match turns a regular expression option off. Invoking the command without the argument will turn all regular expression options off. The currently defined regular expression options are "extended" for POSIX extended regular expressions and "case-insensitive" for case insensitive matches. .PP The \fIset scli debugging\fP command sets the debugging level of the SNMP engine. The optional regular expression is matched against the debugging levels. A successful match turns a debugging level on while an unsuccessful match turns a debugging level off. Invoking the command without the argument will turn all debugging levels off. The currently defined debugging levels are "session" for the SNMP session layer, "request" for the SNMP request handling layer, "transport" for the SNMP transport layer, "packet" for the SNMP packet layer, and "asn1" for the ASN.1 coding layer. .PP The \fIset scli pager\fP command defines the shell command which is used as a pager if the output produced by an scli command does not fit on a single screen. The output is passed to the shell command via its standard input stream. .PP The \fIset scli retries\fP command defines the number of SNMP request retries before giving up requesting a certain object. .PP The \fIset scli timeout\fP command defines the number milliseconds between subsequent SNMP request retries. .PP The \fIset scli format\fP command defines the output format used by subsequent scli commands. The currently supported formats are "scli" and "xml". The "scli" format is the default output format and described in this documentation. The "xml" output format is experimental and therefore not described here. .PP The \fIset scli mode\fP command defines the scli mode used by subsequent scli commands. Setting the mode to "protocol" will force scli to work in protocol mode. Setting the mode to "normal" causes scli to work in normal mode where certain status messages are suppressed. .PP The \fIshow scli info\fP command displays the current status of the scli interpreter. .PP The \fIshow scli command info\fP command displays summary information about scli commands. The optional regular expression is matched against the command names to select the scli commands. .PP The \fIshow scli command details\fP command displays detailed information about scli commands. The optional regular expression is matched against the command names to select the scli commands. .PP The \fIshow scli command tree\fP command displays the scli command tree. The full command syntax is displayed for each leaf node. .PP The \fIshow scli aliases\fP command lists all scli command aliases. The first column in the generated table lists the aliase names while the second column shows the alias values. .PP The \fIshow scli modes\fP command shows information about the scli modes. An scli mode is a logical grouping of related commands (e.g., all commands that deal with printers). The optional regular expression can be use to select a subset of the available scli modes. .PP The \fIshow scli schema\fP command produces xml schema definitions for the selected scli modes. An scli mode is a logical grouping of related commands (e.g., all commands that deal with printers). The optional regular expression can be use to select a subset of the available scli modes. .PP The \fIshow scli alarm info\fP command displays summary information about all known alarms. .SH SNMP MODE .PP The snmp scli mode is based on the SNMPv2-MIB as published in RFC 1907, the SNMP-FRAMEWORK-MIB as published in RFC 3411, the SNMP-USER-BASED-SM-MIB as published in RFC 3414, the SNMP-VIEW-BASED-ACM-MIB as published in RFC 3415, the SNMP-TARGET-MIB as published in RFC 3413, the SNMP-NOTIFICATION-MIB as published in RFC 3413, and theNOTIFICATION-LOG-MIB as published in RFC 3014. .TP .B create snmp vacm member [] .TP .B delete snmp vacm member [] .TP .B create snmp usm user