DragonFly On-Line Manual Pages
SCLI(1) DragonFly General Commands Manual SCLI(1)
NAME
scli - SNMP Command Line Interface
SYNOPSIS
scli [options] [hostname] [community]
DESCRIPTION
scli 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.
The optional hostname argument is the name or the IP address of the
remote host. scli talks to this host's SNMP agent on the default port
number 161 using the SNMP over UDP transport mapping.
The optional community argument is the community string used to
communicate with the remote SNMP agent. The default string is public.
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.
OPTIONS
scli accepts the following options:
-V, --version
Show version of program.
-c, --command
Process the given commands and exit.
-d seconds, --delay=seconds
Set delay between screen updates in seconds. The default delay
between updates is 5 seconds.
-f, --file
Process commands from a file and exit.
-h, --help
Show summary of scli options.
-i, --inet
Execute in inet mode. This option implies -q, -n and -x.
-n, --norc
Do not evaluate ~/.sclirc on startup.
-q, --quiet
This flag causes scli to supress some informational messages.
-s, --dry-run
Parse scli commands but do not actually execute them. This
allows to perform syntax checking on scli scripts.
-x, --xml
Generate XML output instead of the default output which is
optimized for humans and more difficult to parse by programs.
COMMAND OVERVIEW
scli is a simple command interpreter. scli commands are organized in a
hierarchy. This section only describes the top-level commands. Invoke
the help command described below to get a complete list of all commands
supported by scli.
open Establish an association to a remote SNMP agent.
close Close the association to a remote SNMP agent.
exit Exit the scli command interpreter.
help Display help information about the scli command interpreter
including a full list of the scli command hierarchy.
history Show the history of the last scli commands.
create Create new object instances on the remote SNMP agent. This
command has many sub-commands which are used to instantiate
very different things.
delete Delete object instances from the remote SNMP agent. This
command has many sub-commands which are used to delete very
different things.
run Execute a specific action. This command has many sub-commands
which are used run very different actions.
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.
show Show information provided by the remote SNMP agent. This
command has many sub-commands focusing on various aspects of
the system.
monitor Monitor information provided by the remote SNMP agent. This
command has many sub-commands focusing on various aspects of
the system. scli 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.
dump Dump scli command sequences to restore the configuration of
the remote SNMP agent.
scli 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 show will cause scli to
retrieve and display all information accessible from the remote SNMP
agent. 100-scli version (c) 2001-2007 Juergen Schoenwaelder
3COM MODE
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.
create 3com bridge vlan <vlanid> <name>
delete 3com bridge vlan <regexp>
set 3com bridge vlan name <vlanid> <name>
set 3com bridge vlan ports <regexp> <ports>
show 3com bridge vlan info [<regexp>]
dump 3com bridge vlan
The create 3com bridge vlan command is used to create a new virtual LAN
with the given <vlanid> and <name>.
The delete 3com bridge vlan command deletes all selected virtual LANs.
The regular expression <regexp> is matched against the virtual LAN
names to select the vlans that should be deleted.
The set 3com bridge vlan name command changes the name of a virtual
LAN.
The set 3com bridge vlan ports command allows to assign ports to port-
based virtual LANs. The regular expression <regexp> is matched against
the virtual LAN names to select the vlans that should be modified. The
<ports> argument contains a comma separated list of port numbers or
port number ranges, e.g. 1,5,7-8.
The show 3com bridge vlan info command shows summary information about
all selected virtual LANs. The optional regular expression <regexp> is
matched against the virtual LAN names to select the virtual LANs of
interest. The command generates a table with the following columns:
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
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).
The dump 3com bridge vlan command generates a sequence of scli commands
which can be used to restore the virtual LAN configuration.
ATM MODE
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.
show atm interface info <regexp>
show atm interface details <regexp>
The show atm interface info command displays summary information for
all selected ATM interfaces. The optional regular expression <regexp>
is matched against the interface descriptions to select the interfaces
of interest. The command generates a table with the following columns:
INTERFACE network interface number
DESCRIPTION description of the network interface
The show atm interface details command describes the selected ATM
interfaces in more detail. The optional regular expression <regexp> is
matched against the interface descriptions to select the interfaces of
interest.
BRIDGE MODE
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).
show bridge info
show bridge ports
show bridge stp ports
show bridge forwarding
show bridge filter
show bridge stats
monitor bridge stats
show bridge vlan info [<regexp>]
show bridge vlan details [<regexp>]
The show bridge info command displays summary information about a
bridge, such as the number of ports and the supported bridging
functions and associated parameters.
The show bridge ports command displays information about the bridge
ports.
The show bridge stp ports command displays information about the bridge
ports which participate in the spanning tree protocol. The command
generates a table with the following columns:
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
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).
The show bridge forwarding command displays the forwarding data base
used by transparent bridges. The command generates a table with the
following columns:
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
The show bridge filter command shows filtering information.
The show bridge stats command displays per port statistics for
transparent bridges. The command generates a table with the following
columns:
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
The monitor bridge stats command shows the same information as the show
bridge stats command. The information is updated periodically.
The show bridge vlan info command shows summary information about
configured VLANs. The command generates a table with the following
columns:
VLAN VLAN number (between 1 and 4094)
STATUS status of the VLAN
NAME name of the VLAN
PORTS ports assigned the the VLAN
The show bridge vlan details command describes the selected VLANs in
detail. The optional regular expression <regexp> is matched against the
VLAN names to select the VLANs of interest.
CISCO MODE
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.
show cisco processes
show cisco ip accounting info
show cisco ip accounting current sorted
show cisco ip accounting current raw
show cisco ip accounting snapshot sorted
show cisco ip accounting snapshot raw
monitor cisco ip accounting current
monitor cisco ip accounting snapshot sorted
set cisco ip accounting checkpoint
show cisco dot11 interface info
show cisco dot11 clients stats
monitor cisco dot11 clients stats
The show cisco processes command displays information about all
processes running on a CISCO device. The command generates a table with
the following columns:
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
The show cisco ip accounting info 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.
cisco IP current accounting data
The show cisco ip accounting current raw command displays the raw
accounting data retrieved from the current table. The command generates
a table with the following columns:
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
cisco IP snapshot accounting data
The show cisco ip accounting snapshot raw command displays the raw
accounting data retrieved from the snapshot table. The command
generates a table with the following columns:
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
cisco IP current accounting data
cisco IP snapshot accounting data
The set cisco ip accounting checkpoint 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.
The show cisco dot11 interface info command displays information about
all IEEE 802.11 interfaces on a CISCO device. The command generates a
table with the following columns:
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
The show cisco dot11 clients stats command displays information about
all IEEE 802.11 clients associated with a CISCO device. The command
generates a table with the following columns:
IF network interface number
SSID SSID to which client is associated
ADDRESS client MAC address
IPv4-ADDRESS clients IPv4 address (if supplied)
SGNL clients signal strength
UPTIME lifetime of clients association
I-BPS input bytes per second
O-BPS output bytes per second
ERR errors per second
The monitor cisco dot11 clients stats command shows the same
information as the show cisco dot11 clients stats command. The
information is updated periodically.
DISMAN MODE
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.
create disman script <owner> <name> <description>
create disman run <owner> <name> <args>
show disman languages
show disman script info
show disman script details
show disman launch info
show disman launch details
show disman run info
show disman run details
show schedule info
show schedule details
create schedule <owner> <name> <expression>
delete schedule <owner> <name>
dump schedule
monitor schedule info
monitor disman run
languages supported by the distributed manager
script summary information
scripts installed at the distributed manager
launch summary information
launch buttons installed on the distributed manager
summary information about running scripts
running scripts on the distributed manager
The show schedule info command displays summary information about the
scheduled actions.
schedules on the distributed manager
The dump schedule command generates a sequence of scli commands which
can be used to restore the schedule configuration.
scheduler information
monitor running scripts
ENTITY MODE
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.
show entity info
show entity details
show entity containment
show entity sensors
The show entity info command displays summary information about the
physical entities that compose the system. The command generates a
table with the following columns:
ENTITY entity number
CLASS class of the entity (see below)
NAME name of the entity
DESCRIPTION description of the entity
The show entity details command describes the physical entities in more
detail.
The show entity containment command displays the physical entity
containment hierarchy.
The show entity sensors command describes the physical sensor entities
in more detail.
ETHERNET MODE
The ethernet scli mode is based on the EtherLike-MIB as published in
RFC 2665 and the MAU-MIB as published in RFC 2668.
show ethernet mau
show ethernet stats
show ethernet history
monitor ethernet stats
The show ethernet mau command displays information about the medium
attachment units (MAUs) for each ethernet port. The command generates a
table which has the following columns:
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
The show ethernet stats command displays ethernet specific statistics
for each ethernet interface. The command outputs a table which has the
following columns:
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
The monitor ethernet stats command shows the same information as the
show ethernet stats command. The information is updated periodically.
HP MODE
The hp scli mode is used to display and configure hp parameters.
show hp fault log
XXX
INTERFACE MODE
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.
create interface stack <lower-regexp> <higher-regexp>
delete interface stack <lower-regexp> <higher-regexp>
set interface status <regexp> <status>
set interface alias <regexp> <string>
set interface notifications <regexp> <value>
set interface promiscuous <regexp> <bool>
show interface info [<regexp>]
show interface details [<regexp>]
show interface stack [<regexp>]
show interface stats [<regexp>]
monitor interface stats [<regexp>]
loop interface stats [<regexp>]
check interface status [<regexp>]
dump interface
The set interface status command modifies the administrative status of
all selected interfaces. The regular expression <regexp> is matched
against the interface descriptions to select the interfaces of
interest. The <value> parameter must be one of the strings "up",
"down", or "testing".
The set interface alias command assigns the alias name <string> 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 <regexp> is matched against the interface
descriptions to select the interfaces.
The set interface notifications command controls whether the selected
interfaces generate linkUp and linkDown notifications. The regular
expression <regexp> is matched against the interface descriptions to
select the interfaces. The <value> parameter must be one of the strings
"enabled" or "disabled".
The set interface promiscuous command controls whether the selected
interfaces operate in promiscuous mode or not. The regular expression
<regexp> is matched against the interface descriptions to select the
interfaces. The <bool> parameter must be one of the strings "true" or
"false".
The show interface info command displays summary information for all
selected interfaces. The optional regular expression <regexp> is
matched against the interface descriptions to select the interfaces of
interest. The command generates a table with the following columns:
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
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).
The show interface details command describes the selected interfaces in
detail. The optional regular expression <regexp> is matched against the
interface descriptions to select the interfaces of interest.
The show interface stack command shows the stacking order of the
interfaces. The command generates a table with the following columns:
INTERFACE network interface number
STACK indication of the stacking order
TYPE type of the network interface
DESCRIPTION description of the network interface
The show interface stats command displays network interface statistics
for all selected interfaces. The optional regular expression <regexp>
is matched against the interface description to select the interfaces.
The command outputs a table which has the following columns:
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
The monitor interface stats command shows the same information as the
show interface stats command. The information is updated periodically.
The loop interface stats command shows the same information as the show
interface stats command. The information is updated periodically.
The check interface status command checks the status of interfaces. The
optional regular expression <regexp> 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
The dump interface command generates a sequence of scli commands which
can be used to restore the interface configuration.
IP MODE
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.
set ip forwarding <value>
set ip ttl <number>
show ip info
show ip forwarding
show ip addresses
show ip tunnel
show ip mapping
dump ip
The set ip forwarding command controls whether the IP protocol engine
forwards IP datagrams or not. The <value> parameter must be one of the
strings "enabled" or "disabled".
The set ip ttl command can be used to change the default time to live
(TTL) value used by the IP protocol engine. The <number> parameter must
be a number between 1 and 255 inclusive.
The show ip info command displays parameters of the IP protocol engine,
such as the default TTL or whether the node is forwarding IP packets.
The show ip forwarding command displays the IP forwarding data base.
The command generates a table with the following columns:
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
The show ip addresses command displays the IP addresses assigned to
network interfaces. The command generates a table with the following
columns:
ADDRESS IP address
PREFIX IP address prefix length
NAME name of the IP address
INTERFACE network interface number
DESCRIPTION description of the network interface
The show ip tunnel command displays information about existing IP
tunnels.
The show ip mapping 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:
INTERFACE network interface number
STATUS status of the mapping entry
ADDRESS IP address
ADDRESS lower layer address
The dump ip command generates a sequence of scli commands which can be
used to restore the IP configuration.
ISDN MODE
The scli isdn mode is based on the ISDN-MIB as published in RFC 2127.
show isdn bri [<regexp>]
show isdn bearer
show isdn endpoints
The show isdn bri command shows information about the ISDN basic rate
interfaces. The command outputs a table which has the following
columns:
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
The show isdn bearer command shows information about the ISDN B
(bearer) channels.
The show isdn endpoints command shows information about the ISDN
endpoints.
NETSNMP MODE
The netsnmp scli mode is used to display and configure netsnmp specific
parameters. It is based on the UCD-SNMP-MIB.
set netsnmp debugging <value>
set netsnmp restart
show netsnmp info
show netsnmp load
show netsnmp exec
show netsnmp proc
dump netsnmp
The set netsnmp debugging command controls whether the agent generates
debug messages or not. The <value> parameter must be one of the strings
"enabled" or "disabled".
The set netsnmp restart command restarts the agent.
The show netsnmp info command shows general information about the
netsnmp/ucdsnmp agent such as the version number and the software
configuration.
The show netsnmp load 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.
The show netsnmp exec command shows information about pre-configured
commands that can be invoked.
The show netsnmp proc command shows information about which processes
netsnmp watches.
The dump netsnmp command generates a sequence of scli commands which
can be used to restore the netsnmp specific configuration.
NORTEL MODE
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.
create nortel bridge vlan <vlanid> <name>
delete nortel bridge vlan <regexp>
set nortel bridge vlan name <vlanid> <name>
set nortel bridge vlan ports <regexp> <ports>
set nortel bridge vlan default <string> <ports>
show nortel bridge vlan info [<regexp>]
show nortel bridge vlan details [<regexp>]
show nortel bridge vlan ports
dump nortel bridge vlan
The create nortel bridge vlan command is used to create a new virtual
LAN with the given <vlanid> and <name>.
The delete nortel bridge vlan command deletes all selected virtual
LANs. The regular expression <regexp> is matched against the virtual
LAN names to select the vlans that should be deleted.
The set nortel bridge vlan name command changes the name of a virtual
LAN.
The set nortel bridge vlan ports command allows to assign ports to
port-based vlans. The regular expression <regexp> is matched against
the vlan names to select the vlans that should be modified. The <ports>
argument contains a comma separated list of port numbers or port number
ranges, e.g. 1,5,7-8.
The set nortel bridge vlan default command allows to assign ports to a
default vlan. The <string> argument is matched against the vlan names
to select the vlan. The <ports> argument contains a comma separated
list of port numbers or port number ranges, e.g. 1,5,7-8.
The show nortel bridge vlan info command shows summary information
about all selected virtual LANs. The optional regular expression
<regexp> is matched against the virtual LAN names to select the virtual
LANs of interest. The command generates a table with the following
columns:
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
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).
The show nortel bridge vlan details command describes the selected
vlans in more detail. The optional regular expression <regexp> is
matched against the vlan names to select the vlans of interest.
The show nortel bridge vlan ports command shows information for each
vlan port. The command generates a table with the following columns:
PORT port number
FLAGS port vlan flags (see below)
DEFAULT default vlan number
VLANS vlan numbers the port is member of
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).
The dump nortel bridge vlan command generates a sequence of scli
commands which can be used to restore the virtual LAN configuration.
OSPF MODE
The scli ospf mode is used to display and configure OSPF parameters.
show ospf area
show ospf info
show ospf interface
show ospf lsdb
show OSPF areas
general OSPF information
show OSPF interfaces
show OSPF lsdb
PRINTER MODE
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.
set printer operator <string>
show printer info
show printer paths
show printer inputs
show printer outputs
show printer markers
show printer colorants
show printer supplies
show printer interpreters
show printer channels
show printer covers
show printer display
show printer lights
show printer alerts
monitor printer display
monitor printer lights
monitor printer alerts
run printer reboot
The set printer operator 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.
The show printer info command shows general information about the
printer including global status information.
The show printer paths command shows information about the media paths
of a printer.
The show printer inputs command shows information about the input sub-
units of a printer which provide media for input to the printing
process.
The show printer output command shows information about the output sub-
units of a printer capable of receiving media delivered from the
printing process.
The show printer markers command shows information about the marker
sub-units of a printer which produce marks on the print media.
The show printer colorants command shows information about the colorant
sub-units of a printer which produce marks on the print media.
The show printer supplies command shows information about the supplies
which are consumed and the waste produced by the markers of a printer.
The show printer interpreters command shows information about the page
description language and control language interpreters supported by the
printer.
The show printer channels command shows information about the channels
which can be used to submit data to the printer.
The show printer covers command shows information about the covers of a
printer.
The show printer display command shows the current contents of the
display attached to the printer. The command generates a table with the
following columns:
PRINTER logical printer number
LINE display line number
TEXT contents of the display line
The show printer lights command shows the current status of the lights
attached to the printer. The command generates a table with the
following columns:
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
The show printer alerts 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.
The monitor printer display command shows the same information as the
show printer display command. The information is updated periodically.
The monitor printer lights command shows the same information as the
show printer lights command. The information is updated periodically.
The monitor printer alerts command shows the same information as the
show printer alerts command. The information is updated periodically.
The run printer reboot command resets the printed.
RS232 MODE
The rs232 scli mode is based on the RS-232-MIB as published in RFC
1659.
show rs232 details
The show rs232 details command describes the selected RS 232 interfaces
in detail.
SCLI MODE
The scli mode provides commands that can be used to display and
manipulate the internal state of the scli interpreter.
open <nodename> [<community>]
close
run scli walk <oid> [<oid> ...]
run scli scan <network> [community]
create scli plugin <module>
delete scli plugin <module>
exit
help
history
create scli alias <name> <value>
delete scli alias <regexp>
create scli interp <name>
delete scli interp <regexp>
set scli regex [<regexp>]
set scli debugging [<regexp>]
set scli pager <pager>
set scli retries <retries>
set scli timeout <milliseconds>
set scli format <fmt>
set scli mode <mode>
show scli info
show scli command info [<regex]
show scli command details [<regex]
show scli command tree
show scli aliases
show scli modes [<regex>]
show scli schema [<regex>]
show scli alarm info
The open command establishes an association to a remote SNMP agent. The
<nodename> 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 <community> 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.
The close 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.
The run scli walk 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.
The run scli scan command is a utility which scans an IPv4 address
space identified by the <network> argument. The <network> must be
specified in the format <ipv4address>/<prefix>. The optional
<community> argument is the community string needed to communicate with
the remote SNMP agent. The default community string is "public".
The create scli plugin 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.
The delete scli plugin command removes a previously loaded modules from
a running scli process.
The exit command terminates the scli interpreter. An end of file in the
standard input stream will also terminate the the scli interpreter.
The help command displays some help information including a list of all
top-level scli commands.
The history command displays the scli command history list with line
numbers.
The create scli alias command creates the alias <name> for the scli
command (fragment) <value>. If the alias <name> already exists, then
the new <value> will be assigned to the existing alias.
The delete scli alias command removes previously defined aliases from
the scli interpreter. The regular expression <regexp> is matched
against all alias names in order to select the aliases that are
deleted.
The create scli interp command creates a new internal scli interpreter
with the name <name>.
The delete scli interp command deletes previously defined scli
interpreters from the main scli interpreter. The regular expression
<regexp> is matched against all alias names in order to select the
interpreter(s) to be removed.
The set scli regex command controls how scli matches regular
expressions. The optional regular expression <regexp> 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
<regexp> 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.
The set scli debugging command sets the debugging level of the SNMP
engine. The optional regular expression <regexp> 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 <regexp> 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.
The set scli pager 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 <pager> shell command via
its standard input stream.
The set scli retries command defines the number of SNMP request retries
before giving up requesting a certain object.
The set scli timeout command defines the number milliseconds between
subsequent SNMP request retries.
The set scli format 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.
The set scli mode 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.
The show scli info command displays the current status of the scli
interpreter.
The show scli command info command displays summary information about
scli commands. The optional regular expression <regexp> is matched
against the command names to select the scli commands.
The show scli command details command displays detailed information
about scli commands. The optional regular expression <regexp> is
matched against the command names to select the scli commands.
The show scli command tree command displays the scli command tree. The
full command syntax is displayed for each leaf node.
The show scli aliases 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.
The show scli modes 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 <regex> can
be use to select a subset of the available scli modes.
The show scli schema 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 <regex> can be use to select a subset of the
available scli modes.
The show scli alarm info command displays summary information about all
known alarms.
SNMP MODE
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.
create snmp vacm member <name> <group> [<model>]
delete snmp vacm member <regex-name> <regex-group> [<model>]
create snmp usm user <name> <template>
set snmp authentication traps <status>
show snmp engine
show snmp resources
show snmp vacm member
show snmp vacm access
show snmp vacm views
show snmp usm users
show snmp target addresses
show snmp target parameters
show snmp notification targets
show snmp contexts
show snmp csm
show snmp notification log details
show snmp notification log info
monitor snmp notification log info
dump snmp
The create snmp vacm member commands can be used to assign new members
(security names) to vacm groups. New groups are created if they do not
exist.
The delete snmp vacm member commands can be used to delete members
(security names) from vacm groups. Groups are deleted if the last
member is deleted.
The create snmp usm user commands can be used to create a new user by
cloning an existing template.
The set snmp authentication traps command controls whether the SNMP
engine generates authentication failure notifications. The <value>
parameter must be one of the strings "enabled" or "disabled".
The show snmp engine command displays information about the SNMP
protocol engine such as the number of boots, the current time relative
to the last boot and the maximum message size.
The show snmp resources command displays information about the MIB
resources supported by the SNMP agent.
The show snmp vacm member command displays the mapping of security
names to group names. The command generates a table with the following
columns:
ROW row storage type and status
MOD security model
NAME member name (security name)
GROUP name of the vacm group
The show snmp vacm access command display the access control rules for
the security groups. The command generates a table with the following
columns:
ROW row storage type and status
GROUP security group name
MOD security model
LVL security level (--, a-, ap)
CTX context name
MATCH match (exact or prefix)
READ view name for read access
WRITE view name for write access
NOTIFY view name for notification
The show snmp vacm views command displays MIB view definitions. The
command generates a table with the following columns:
ROW row storage type and status
VIEW view name
TYPE access to the view subtree (incl/excl)
PREFIX object identifier wildcard prefix
The show snmp usm users command displays the configured users. The
command generates a table with the following columns:
ROW row storage type and status
USER USM user name
NAME security name of the USM user
AUTH authentication protocol
PRIV privacy protocol
The show snmp target addresses command displays information about the
configured SNMP target addresses. The command generates a table with
the following columns:
ROW row storage type and status
TARGET target name
DOMAIN transport domain
ADDRESS transport address
TMOUT timeout value in ms
RETRY number of retries
PARAMS associated parameters
TAGS tag list
The show snmp target parameters command displays information about the
configured SNMP target parameters. The command generates a table with
the following columns:
ROW row storage type and status
PARAMS parameter name
NAME security name
The show snmp notification targets command displays information about
the configured SNMP notification targets. The command generates a table
with the following columns:
ROW row storage type and status
NAME notification target name
TYPE notification type
TAG tag reference to targets
The show snmp contexts command displays information about the available
SNMP contexts.
The show snmp csm communities command displays information about the
configured SNMP communities.
The show snmp notification log details command displays detailed
information about logged SNMP notifications.
The show snmp notification log info command displays summary
information about logged SNMP notifications.
The monitor snmp notification log info command displays summary
information about logged SNMP notifications.
The dump snmp command generates a sequence of scli commands which can
be used to restore the engine configuration.
SONET MODE
The sonet scli mode is based on the SONET-MIB as published in RFC 2558.
It provides commands to manage Synchronous Optical Network/Synchronous
Digital Hierarchy (SONET/SDH) interfaces.
show sonet media [<regexp>]
show sonet section stats [<regexp>]
show sonet section history [<regexp>]
monitor sonet section stats [<regexp>]
The show sonet media command displays information about the
configuration of SONET/SDH interfaces. The command outputs a table
which has the following columns:
INTERFACE network interface number
SIGNAL type of the signal (SONET/SDH)
CODING line coding (B3ZS, CMI, NRZ, RZ)
LINE optical or electrical line type
DESCRIPTION description of the network interface
The show sonet section stats command displays statistics about
SONET/SDH section errors. The command outputs a table which has the
following columns:
INTERFACE network interface number
INTERVAL measurement interval
ES errored seconds
SES severely errored seconds
SEFS severely errored framing seconds
CV coding violations
LOSS flags indicating loss of signal/frame
DESCRIPTION description of the network interface
The show sonet section history command displays 15 minute history
statistics about SONET/SDH section errors. The command outputs a table
which has the following columns:
INTERFACE network interface number
INTERVAL measurement interval start offset
ES errored seconds
SES severely errored seconds
SEFS severely errored framing seconds
CV coding violations
DESCRIPTION description of the network interface
The monitor sonet section stats command shows the same information as
the show sonet section stats command. The information is updated
periodically.
SYSTEM MODE
The system scli mode is primarily based on the SNMPv2-MIB as published
in RFC 1907 and the HOST-RESOURCES-MIB as publisched in RFC 2790. It
can be used to browse and configure system parameters and
characteristics.
set system contact <string>
set system name <string>
set system location <string>
show system info
show system devices
show system storage
show system mounts
show system processes [<regexp>]
show system software [<regexp>]
monitor system storage
loop system storage
monitor system processes [<regexp>]
check system contact
check system storage
check system process [<regexp>] [<n>*<m>]
dump system
The set system contact command configures the system contact
information. The <string> argument should include information on how to
contact a person who is responsible for this system.
The set system name command configures the name of the system. By
convention, this is the fully-qualified domain name.
The set system location command configures the physical location of the
system.
The show system info command shows general information about the
system.
The show system devices command shows a list of system devices. The
command generates a table with the following columns:
INDEX device number
STATUS current status of the device
DESCRIPTION description of the device
The show system storage command displays information about the logical
areas attached in the system. The command generates a table with the
following columns:
INDEX logical storage area number
DESCRIPTION description of the storage area
TYPE logical storage area type
SIZE total size of the storage area
USED amount of storage in use
FREE amount of storage available
USE% used storage in percent
The show system mounts command shows the list of filesystems mounted on
the system. The command generates a table with the following columns:
INDEX filesystem identification number
LOCAL local root path name of the filesystem
REMOTE remote server and root path name (if any)
TYPE filesytem type (if known)
OPTIONS access mode (ro/rw) and boot flag
The show system processes command display information about the
processes currently running on the system. The regular expression
<regexp> is matched against the command executed by the process to
select the processes of interest. The command generates a table with
the following columns:
PID process identification number
S status of the process (see below)
T type of the process (see below)
MEMORY memory used by the process
TIME CPU time used by the process
COMMAND command executed by the process
The process status values are C=running, R=runnable, S=not runnable,
and Z=invalid. The process types values are ?=unknown, O=operating
system, D=device driver, and A=application.
The show system software command display information about the software
installed on the system. The regular expression <regexp> is matched
against the software name to select the software of interest. The
command generates a table with the following columns:
SID software identification number
T type of the software (see below)
DATE software installation date
NAME software name
The software type values are ?=unknown, O=operating system, D=device
driver, and A=application.
The monitor system storage command shows the same information as the
show system storage command. The information is updated periodically.
The loop system storage command shows the same information as the show
system storage command. The information is updated periodically.
The monitor system processes command show the same information as the
show system processes command. The information is updated periodically.
The check system contact command xxx.
The check system storage command checks xxx.
The check system process command checks xxx.
The dump system command generates a sequence of scli commands which can
be used to restore the system configuration.
TCP MODE
The scli tcp mode is based on the TCP-MIB as published in RFC 2012. It
provides commands to browse information specific to the TCP transport
protocol.
show tcp info
show tcp listener
show tcp connections
show tcp states
monitor tcp connections
monitor tcp states
The show tcp info command displays parameters of the TCP protocol
engine.
The show tcp listener command displays the listening TCP endpoints. The
command generates a table with the following columns:
LOCAL local TCP endpoint
STATE transmission control block state (listen)
The show tcp connections command displays the connected TCP endpoints
including the current state of the connection as seen by the remote
SNMP agent. The command generates a table with the following columns:
LOCAL local TCP endpoint
REMOTE remote TCP endpoint
STATE transmission control block state
The transmission control block state is either closed, synSent,
synReceived, established, finWait1, finWait2, closeWait, lastAck,
closing, or timeWait.
The show tcp states command displays the distribution of TCP
transmission control block states together with a list of known port
names in each state. The command generates a table with the following
columns:
COUNT number of transmission control blocks per state
STATE transmission control block state
PORTS well-known ports associated with the state
The command uses some heuristics to identify the interesting port
numbers. First, all local port numbers are considered where the local
port number matches one of the listening port numbers. From the
remaining connections, all local port numbers are considered with a
well known name. From the remaining connections, all remote port
numbers are considered with a well known name. All remaining
connections are aggregated under the pseudo name - (hyphen).
Unspecified port numbers are show using the pseudo name * (star).
The monitor tcp connections command displays the connected TCP
endpoints including the current state of the connection as seen by the
remote SNMP agent. The information is updated periodically.
The monitor tcp states command displays the distribution of TCP
connection states. The information is updated periodically.
UDP MODE
The scli udp mode is based on the UDP-MIB as published in RFC 2013. It
provides commands to browse information specific to the UDP transport
protocol.
show udp listener
show udp stats
The show udp listener command displays the listening UDP endpoints.
The show udp statistics about datagrams received or sent.
INTERACTIVE MONITOR COMMANDS
Several single-key commands are recognized while scli is running in
monitor mode:
space Update the display.
^L Redraw the screen.
h or ? Print a help page.
c Toggle display of contact summary information.
d Set the delay in seconds between updates.
m Toggle display of mode specific summary information.
n Toggle display of network layer summary information.
q Quit the monitoring mode.
x Exit scli immediately.
t Toggle display of transport layer summary information.
w Freeze the screen until someone hits a key.
UNITS
scli displays numbers in a compact format. It uses several
abbreviations to explain the units of the numbers. Here are some
explanations:
bps Bits per second.
fps Frames per second.
pps Packets per second.
sps Segments per second.
Large numbers are usually displayed with a scaling factor (k=10^3,
m=10^6, g=10^9, t=10^12, p=10^15, K=2^10, M=2^20, G=2^30, T=2^40m,
P=2^50).
ALIASES
Long command names can be abbreviated by using aliases. The scli
interpreter maintains a list of aliases. Every command is first checked
whether the first word matches an alias. If the first word matches an
alias, then the first word will be replaced by the value of the alias.
Alias expansion only happens once.
Aliases are not expanded when the scli interpreter is running in non-
interactive mode.
REGULAR EXPRESSIONS
scli generally uses POSIX.2 Extended Regular Expressions. The regular
expression matching is case sensitive.
READLINE
scli supports the GNU readline library. The GNU readline library
provides command line editing as well as command completion
capabilities. Please consult the GNU readline documentation for a
detailed description of the readline features.
HISTORY
scli supports the GNU history library. The GNU history library provides
a history expansion feature that is similar to the history expansion
provided by 'csh'. Please consult the GNU history library documentation
for a detailed description of the history features.
PAGER
scli respects the PAGER environment variable when running
interactively. If the PAGER environment variable exists and the output
generated by an scli command does not fit on the terminal, then the
output is written to the standard input of the PAGER.
FILES
~/.scli_history
The history of scli commands.
~/.sclirc
The scli startup file.
~/.inputrc
Individual readline initialization file.
FURTHER INFORMATION
More information can be found on the scli web page which is available
at:
<https://trac.eecs.iu-bremen.de/projects/scli/>
SEE ALSO
regex(7)
AUTHOR
Juergen Schoenwaelder <j.schoenwaelder@iu-bremen.de>.
January 2, 2007 SCLI(1)