1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834
|
.\" 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 <n> 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 <vlanid> <name>
.TP
.B delete 3com bridge vlan <regexp>
.TP
.B set 3com bridge vlan name <vlanid> <name>
.TP
.B set 3com bridge vlan ports <regexp> <ports>
.TP
.B show 3com bridge vlan info [<regexp>]
.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 <vlanid> and <name>.
.PP
The \fIdelete 3com bridge vlan\fP 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.
.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 <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.
.PP
The \fIshow 3com bridge vlan info\fP 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:
.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 <regexp>
.TP
.B show atm interface details <regexp>
.PP
The \fIshow atm interface info\fP 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:
.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
<regexp> 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 [<regexp>]
.TP
.B show bridge vlan details [<regexp>]
.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 <regexp>
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 <owner> <name> <description>
.TP
.B create disman run <owner> <name> <args>
.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 <owner> <name> <expression>
.TP
.B delete schedule <owner> <name>
.TP
.B dump schedule
.TP
.B monitor schedule info
.TP
.B monitor disman run
.PP
...
.PP
...
.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
...
.PP
...
.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
...
.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 <lower-regexp> <higher-regexp>
.TP
.B delete interface stack <lower-regexp> <higher-regexp>
.TP
.B set interface status <regexp> <status>
.TP
.B set interface alias <regexp> <string>
.TP
.B set interface notifications <regexp> <value>
.TP
.B set interface promiscuous <regexp> <bool>
.TP
.B show interface info [<regexp>]
.TP
.B show interface details [<regexp>]
.TP
.B show interface stack [<regexp>]
.TP
.B show interface stats [<regexp>]
.TP
.B monitor interface stats [<regexp>]
.TP
.B loop interface stats [<regexp>]
.TP
.B check interface status [<regexp>]
.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
<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".
.PP
The \fIset interface alias\fP 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.
.PP
The \fIset interface notifications\fP 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".
.PP
The \fIset interface promiscuous\fP 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".
.PP
The \fIshow interface info\fP 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:
.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
<regexp> 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 <regexp> 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 <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
.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 <value>
.TP
.B set ip ttl <number>
.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 <value> 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
<number> 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 [<regexp>]
.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 <value>
.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 <value> 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 <vlanid> <name>
.TP
.B delete nortel bridge vlan <regexp>
.TP
.B set nortel bridge vlan name <vlanid> <name>
.TP
.B set nortel bridge vlan ports <regexp> <ports>
.TP
.B set nortel bridge vlan default <string> <ports>
.TP
.B show nortel bridge vlan info [<regexp>]
.TP
.B show nortel bridge vlan details [<regexp>]
.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 <vlanid> and <name>.
.PP
The \fIdelete nortel bridge vlan\fP 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.
.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 <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.
.PP
The \fIset nortel bridge vlan default\fP 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.
.PP
The \fIshow nortel bridge vlan info\fP 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:
.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
<regexp> 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 <string>
.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 <nodename> [<community>]
.TP
.B close
.TP
.B run scli walk <oid> [<oid> ...]
.TP
.B run scli scan <network> [community]
.TP
.B create scli plugin <module>
.TP
.B delete scli plugin <module>
.TP
.B exit
.TP
.B help
.TP
.B history
.TP
.B create scli alias <name> <value>
.TP
.B delete scli alias <regexp>
.TP
.B create scli interp <name>
.TP
.B delete scli interp <regexp>
.TP
.B set scli regex [<regexp>]
.TP
.B set scli debugging [<regexp>]
.TP
.B set scli pager <pager>
.TP
.B set scli retries <retries>
.TP
.B set scli timeout <milliseconds>
.TP
.B set scli format <fmt>
.TP
.B set scli mode <mode>
.TP
.B show scli info
.TP
.B show scli command info [<regex]
.TP
.B show scli command details [<regex]
.TP
.B show scli command tree
.TP
.B show scli aliases
.TP
.B show scli modes [<regex>]
.TP
.B show scli schema [<regex>]
.TP
.B show scli alarm info
.PP
The \fIopen\fP 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.
.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 <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".
.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 <name> for the
scli command (fragment) <value>. If the alias <name> already
exists, then the new <value> 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
<regexp> 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 <name>.
.PP
The \fIdelete scli interp\fP 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.
.PP
The \fIset scli regex\fP 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.
.PP
The \fIset scli debugging\fP 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.
.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 <pager>
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 <regexp> 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 <regexp> 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 <regex> 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 <regex> 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 <name> <group> [<model>]
.TP
.B delete snmp vacm member <regex-name> <regex-group> [<model>]
.TP
.B create snmp usm user <name> <template>
.TP
.B set snmp authentication traps <status>
.TP
.B show snmp engine
.TP
.B show snmp resources
.TP
.B show snmp vacm member
.TP
.B show snmp vacm access
.TP
.B show snmp vacm views
.TP
.B show snmp usm users
.TP
.B show snmp target addresses
.TP
.B show snmp target parameters
.TP
.B show snmp notification targets
.TP
.B show snmp contexts
.TP
.B show snmp csm
.TP
.B show snmp notification log details
.TP
.B show snmp notification log info
.TP
.B monitor snmp notification log info
.TP
.B dump snmp
.PP
The \fIcreate snmp vacm member\fP commands can be used to assign
new members (security names) to vacm groups. New groups are
created if they do not exist.
.PP
The \fIdelete snmp vacm member\fP commands can be used to delete
members (security names) from vacm groups. Groups are deleted
if the last member is deleted.
.PP
The \fIcreate snmp usm user\fP commands can be used to create a
new user by cloning an existing template.
.PP
The \fIset snmp authentication traps\fP command controls whether the
SNMP engine generates authentication failure notifications.
The <value> parameter must be one of the strings "enabled"
or "disabled".
.PP
The \fIshow snmp engine\fP 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.
.PP
The \fIshow snmp resources\fP command displays information about the
MIB resources supported by the SNMP agent.
.PP
The \fIshow snmp vacm member\fP command displays the mapping of
security names to group names. The command generates a table
with the following columns:
.PP
ROW row storage type and status
MOD security model
NAME member name (security name)
GROUP name of the vacm group
.PP
The \fIshow snmp vacm access\fP command display the access control
rules for the security groups. The command generates a table
with the following columns:
.PP
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
.PP
The \fIshow snmp vacm views\fP command displays MIB view definitions.
The command generates a table with the following columns:
.PP
ROW row storage type and status
VIEW view name
TYPE access to the view subtree (incl/excl)
PREFIX object identifier wildcard prefix
.PP
The \fIshow snmp usm users\fP command displays the configured users.
The command generates a table with the following columns:
.PP
ROW row storage type and status
USER USM user name
NAME security name of the USM user
AUTH authentication protocol
PRIV privacy protocol
.PP
The \fIshow snmp target addresses\fP command displays information
about the configured SNMP target addresses. The command
generates a table with the following columns:
.PP
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
.PP
The \fIshow snmp target parameters\fP command displays information
about the configured SNMP target parameters. The command
generates a table with the following columns:
.PP
ROW row storage type and status
PARAMS parameter name
NAME security name
.PP
The \fIshow snmp notification targets\fP command displays information
about the configured SNMP notification targets. The command
generates a table with the following columns:
.PP
ROW row storage type and status
NAME notification target name
TYPE notification type
TAG tag reference to targets
.PP
The \fIshow snmp contexts\fP command displays information
about the available SNMP contexts.
.PP
The \fIshow snmp csm communities\fP command displays information
about the configured SNMP communities.
.PP
The \fIshow snmp notification log details\fP command displays
detailed information about logged SNMP notifications.
.PP
The \fIshow snmp notification log info\fP command displays
summary information about logged SNMP notifications.
.PP
The \fImonitor snmp notification log info\fP command displays
summary information about logged SNMP notifications.
.PP
The \fIdump snmp\fP command generates a sequence of scli commands
which can be used to restore the engine configuration.
.PP
.SH SONET MODE
.PP
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.
.TP
.B show sonet media [<regexp>]
.TP
.B show sonet section stats [<regexp>]
.TP
.B show sonet section history [<regexp>]
.TP
.B monitor sonet section stats [<regexp>]
.PP
The \fIshow sonet media\fP command displays information about the
configuration of SONET/SDH interfaces. The command outputs a
table which has the following columns:
.PP
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
.PP
The \fIshow sonet section stats\fP command displays statistics
about SONET/SDH section errors. The command outputs a table
which has the following columns:
.PP
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
.PP
The \fIshow sonet section history\fP command displays 15 minute
history statistics about SONET/SDH section errors. The command
outputs a table which has the following columns:
.PP
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
.PP
The \fImonitor sonet section stats\fP command shows the same
information as the show sonet section stats command. The
information is updated periodically.
.SH SYSTEM MODE
.PP
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.
.TP
.B set system contact <string>
.TP
.B set system name <string>
.TP
.B set system location <string>
.TP
.B show system info
.TP
.B show system devices
.TP
.B show system storage
.TP
.B show system mounts
.TP
.B show system processes [<regexp>]
.TP
.B show system software [<regexp>]
.TP
.B monitor system storage
.TP
.B loop system storage
.TP
.B monitor system processes [<regexp>]
.TP
.B check system contact
.TP
.B check system storage
.TP
.B check system process [<regexp>] [<n>*<m>]
.TP
.B dump system
.PP
The \fIset system contact\fP command configures the system contact
information. The <string> argument should include information
on how to contact a person who is responsible for this system.
.PP
The \fIset system name\fP command configures the name of the system.
By convention, this is the fully-qualified domain name.
.PP
The \fIset system location\fP command configures the physical
location of the system.
.PP
The \fIshow system info\fP command shows general information about the
system.
.PP
The \fIshow system devices\fP command shows a list of system devices.
The command generates a table with the following columns:
.PP
INDEX device number
STATUS current status of the device
DESCRIPTION description of the device
.PP
The \fIshow system storage\fP command displays information about the
logical areas attached in the system. The command generates a
table with the following columns:
.PP
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
.PP
The \fIshow system mounts\fP command shows the list of filesystems
mounted on the system. The command generates a table with the
following columns:
.PP
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
.PP
The \fIshow system processes\fP 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:
.PP
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
.PP
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.
.PP
The \fIshow system software\fP 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:
.PP
SID software identification number
T type of the software (see below)
DATE software installation date
NAME software name
.PP
The software type values are ?=unknown, O=operating system,
D=device driver, and A=application.
.PP
The \fImonitor system storage\fP command shows the same
information as the show system storage command. The
information is updated periodically.
.PP
The \fIloop system storage\fP command shows the same
information as the show system storage command. The
information is updated periodically.
.PP
The \fImonitor system processes\fP command show the same
information as the show system processes command. The
information is updated periodically.
.PP
The \fIcheck system contact\fP command xxx.
.PP
The \fIcheck system storage\fP command checks xxx.
.PP
The \fIcheck system process\fP command checks xxx.
.PP
The \fIdump system\fP command generates a sequence of scli commands
which can be used to restore the system configuration.
.PP
.SH TCP MODE
.PP
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.
.TP
.B show tcp info
.TP
.B show tcp listener
.TP
.B show tcp connections
.TP
.B show tcp states
.TP
.B monitor tcp connections
.TP
.B monitor tcp states
.PP
The \fIshow tcp info\fP command displays parameters of the TCP
protocol engine.
.PP
The \fIshow tcp listener\fP command displays the listening TCP
endpoints. The command generates a table with the following
columns:
.PP
LOCAL local TCP endpoint
STATE transmission control block state (listen)
.PP
The \fIshow tcp connections\fP 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:
.PP
LOCAL local TCP endpoint
REMOTE remote TCP endpoint
STATE transmission control block state
.PP
The transmission control block state is either closed, synSent,
synReceived, established, finWait1, finWait2, closeWait, lastAck,
closing, or timeWait.
.PP
The \fIshow tcp states\fP 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:
.PP
COUNT number of transmission control blocks per state
STATE transmission control block state
PORTS well-known ports associated with the state
.PP
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).
.PP
The \fImonitor tcp connections\fP 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.
.PP
The \fImonitor tcp states\fP command displays the distribution of TCP
connection states. The information is updated periodically.
.SH UDP MODE
.PP
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.
.TP
.B show udp listener
.TP
.B show udp stats
.PP
The \fIshow udp listener\fP command displays the listening UDP
endpoints.
.PP
The \fIshow udp statistics\fP about datagrams received or sent.
.SH INTERACTIVE MONITOR COMMANDS
Several single-key commands are recognized while \fBscli\fP is running
in monitor mode:
.TP 8
.B space
Update the display.
.TP
.B ^L
Redraw the screen.
.TP
.B h or ?
Print a help page.
.TP
.B c
Toggle display of contact summary information.
.TP
.B d
Set the delay in seconds between updates.
.TP
.B m
Toggle display of mode specific summary information.
.TP
.B n
Toggle display of network layer summary information.
.TP
.B q
Quit the monitoring mode.
.TP
.B x
Exit scli immediately.
.TP
.B t
Toggle display of transport layer summary information.
.TP
.B w
Freeze the screen until someone hits a key.
.SH UNITS
\fBscli\fP displays numbers in a compact format. It uses several
abbreviations to explain the units of the numbers. Here are some
explanations:
.TP
.B bps
Bits per second.
.TP
.B fps
Frames per second.
.TP
.B pps
Packets per second.
.TP
.B sps
Segments per second.
.PP
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).
.SH ALIASES
Long command names can be abbreviated by using aliases. The \fBscli\fP
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.
.P
Aliases are not expanded when the \fBscli\fP interpreter is running
in non-interactive mode.
.SH REGULAR EXPRESSIONS
\fBscli\fP generally uses POSIX.2 Extended Regular Expressions. The
regular expression matching is case sensitive.
.SH READLINE
\fBscli\fP 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.
.SH HISTORY
\fBscli\fP 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.
.SH PAGER
\fBscli\fP 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.
.SH FILES
.TP
.I ~/.scli_history
The history of scli commands.
.TP
.I ~/.sclirc
The scli startup file.
.TP
.I ~/.inputrc
Individual readline initialization file.
.SH "FURTHER INFORMATION"
More information can be found on the scli web page which is
available at:
.PP
<https://trac.eecs.iu-bremen.de/projects/scli/>
.SH "SEE ALSO"
.BR regex(7)
.SH AUTHOR
Juergen Schoenwaelder <j.schoenwaelder@iu-bremen.de>.
|