doc/objects.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html lang="en-gb"><head><title>LuaSNMP - Reference</title>
   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   <link media="screen" href="style.css" rel="stylesheet" type="text/css" />
  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   <link media="print" rel="stylesheet" href="styleprint.css" type="text/css" /></head><body>
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114 <h1>
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134 <div style="top: 12px; height: 129px; left: 0px; text-align: center; width: 925px;" id="logo"><a name="home2" /><a href="http://www.lua.org"><img style="border: 0px solid ; left: 0px; top: 6px; width: 115px; height: 118px; float: left;" id="lualogo" alt="www.lua.org" src="luasnmp2.png" hspace="20" /></a></div>
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154 <div id="header">
 155 <h1 style="height: 120px; margin-left: 0px; width: 928px;"><big><big><a name="home"><br />
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175 LuaSNMP - Reference</a></big><a name="home" /></big><a name="home"> <br />
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194 Simple
 195 Network Management Access with Lua</a></h1>
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215 </div>
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235 <div id="leftnavigation">
 236 <ul>
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256 <a name="home">  </a><li style="margin-left: 0px; width: 185px;"><a class="current" href="index.html">Home</a>
 257   </li>
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277   <li><a href="index.html#license">License</a></li>
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296
 297   <li><a href="index.html#features">Features</a></li>
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317   <li><a href="index.html#download">Download</a></li>
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337   <li><a href="index.html#installation">Installation</a></li>
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357   <li><a href="running.html">MANUAL</a></li>
 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   <ul>
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415     <li><a href="running.html">Running&nbsp;</a></li>
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435     <li><a href="#object_names">Object Names</a></li>
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451     <li><a href="#data_types"><span style="text-decoration: underline;"><span style="font-weight: bold;">Data Types</span></span></a></li>
 452     <ul>
 453       <li><a href="#datatype_general"><span style="text-decoration: underline;"><span style="font-weight: bold;">General</span></span></a></li>
 454       <li><a href="#counter64"><span style="text-decoration: underline;"><span style="font-weight: bold;">Counter64</span></span></a></li>
 455     </ul>
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470     <li><a href="#varbinds">Varbinds</a></li>
 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     <ul>
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506       <li><a href="#varbinds_general">General</a></li>
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517       <li><a href="#varbind_meta">Metamethods</a></li>
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538     </ul>
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549     <li><a href="#sessions">SNMP Sessions</a></li>
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562     <li><a href="#trap_handling">Trap Handling</a></li>
 563
 564
 565
 566
 567
 568
 569
 570
 571     <li><a href="mib.html">Access to MIBs</a></li>
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591     <li><a href="snmp.html">Access to SNMP</a></li>
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611     <li><a href="examples.html">Examples</a> </li>
 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   </ul>
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669   <li><a href="index.html#whatsnew">What's New</a></li>
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689   <li><a href="index.html#credits">Credits</a></li>
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709   <li><a href="index.html#links">Links</a></li>
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729   <li><a href="index.html#todo">ToDo</a></li>
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749 </ul>
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769 </div>
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789 <div id="content">
 790 <h1><a name="object_names">Object Names</a></h1>
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804 <p><a name="object_names">Most functions in LuaSNMP accept either object identifiers in pseudo-numerical dot-notation or symbolic object names&nbsp;&nbsp;</a></p>
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818 <p><a name="object_names">Here are some basic rules:</a></p>
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832 <ul>
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846   <li>Object names <span style="font-style: italic;">may</span> have an index suffix, e.g. sysContact.<span style="font-weight: bold;">0</span></li>
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860   <li>Object identifiers or OIDs <span style="font-style: italic;">must</span> follow a textual dot-notation, e.g. "1.3.6.1.2.1.1.4"</li>
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874   <li>Object identifiers <span style="font-style: italic;">may</span> have an index suffix, e.g. "1.3.6.1.2.1.1.4.<span style="font-weight: bold;">0</span>"</li>
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888   <li>Most function accept a mixed notation using node IDs or symbolic names, e.g. iso.org.dod.internet.mgmt.mib-2.<span style="font-weight: bold;">1</span>.sysContact.<span style="font-weight: bold;">0</span></li>
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902   <li>Any object name or object identifier <span style="font-style: italic;">may</span> be prepended by a module name, separated by a double or a single colon, e.g. <span style="font-weight: bold;">SNMPv2-MIB</span>::sysContact.0 or <span style="font-weight: bold;">SNMPv2-MIB:</span>1.3.6.1.2.1.1.4.0<br />
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917 Note, that the module name becomes an integral part of an object name. The object will not be found if the module name is wrong.</li>
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931 </ul>
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944 <h1>Data Types</h1>
 945 <h3><a name="datatype_general">General</a></h3>
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957 <p>LuaSNMP maps SNMP data types to Lua basic types as specified in the
 958 table below. SNMP basic data types are associated to a set of
 959 numerical "codes". These numerical codes are used by the LuaSNMP
 960 functions when identifying the SNMP data type of a given variable
 961 instance value. Additionally LuaSNMP maintains a database to map the numerical codes to textual type names.</p>
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974 <table style="width: 658px; height: 795px;" border="1" bordercolor="#000000" cellpadding="4" cellspacing="1">
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985   <tbody>
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996     <tr>
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007       <td bgcolor="#ffffff" valign="top" width="23%">
1008       <font size="-1"><b>SNMP Type</b></font></td>
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020       <td bgcolor="#ffffff" valign="top" width="26%">
1021       <font size="-1"><b>LuaSNMP Code</b></font></td>
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033       <td bgcolor="#ffffff" valign="top" width="12%">
1034       <font size="-1"><b>Lua Type</b></font></td>
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046       <td bgcolor="#ffffff" valign="top" width="38%">
1047       <font size="-1"><b>Representation </b></font></td>
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059     </tr>
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071     <tr>
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082       <td valign="top" width="23%">
1083       <font size="-1">OBJECT IDENTIFIER</font></td>
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095       <td valign="top" width="26%">
1096       <font size="-1">snmp.</font><font size="-1">TYPE_OBJID (1)</font></td>
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108       <td valign="top" width="12%">
1109       <font size="-1">string</font></td>
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121       <td valign="top" width="38%">
1122       <font size="-1">Decimal numbers separated by dots (<i>dotted notation</i>). e.g.: "1.3.6.1.2.1.1.5"</font></td>
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134     </tr>
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146     <tr>
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157       <td valign="top" width="23%">
1158       <font size="-1">OCTET STRING</font></td>
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170       <td valign="top" width="26%">
1171       <font size="-1">snmp.</font><font size="-1">TYPE_OCTETSTR (2)</font></td>
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183       <td valign="top" width="12%">
1184       <font size="-1">string</font></td>
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196       <td valign="top" width="38%">
1197       <font size="-1">Hexadecimal numbers (00 to ff) separated by colons. <br />
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208       </font>
1209       <font size="-1">e.g.: "00:00:80:a4:32:f3"</font></td>
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221     </tr>
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233     <tr>
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244       <td valign="top" width="23%">
1245       <font size="-1">INTEGER</font></td>
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257       <td valign="top" width="26%">
1258       <font size="-1">snmp.</font><font size="-1">TYPE_INTEGER (3)</font></td>
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270       <td valign="top" width="12%">
1271       <font size="-1">number</font></td>
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283       <td valign="top" width="38%">
1284       <font size="-1">&nbsp;</font></td>
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296     </tr>
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308     <tr>
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319       <td valign="top" width="23%">
1320       <font size="-1">NetworkAddress</font></td>
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332       <td valign="top" width="26%">
1333       <font size="-1">snmp.</font><font size="-1">TYPE_NETADDR (4)</font></td>
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345       <td valign="top" width="12%">
1346       <font size="-1">string</font></td>
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358       <td valign="top" width="38%">
1359       <font size="-1">Decimal numbers (0 to 255) separated by dots (<i>dotted notation</i>).
1360       <br />
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371       </font><font size="-1">e.g.: "139.82.95.11"</font></td>
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383     </tr>
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395     <tr>
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406       <td valign="top" width="23%">
1407       <font size="-1">IpAddress</font></td>
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419       <td valign="top" width="26%">
1420       <font size="-1">snmp.</font><font size="-1">TYPE_IPADDR (5)</font></td>
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432       <td valign="top" width="12%">
1433       <font size="-1">string</font></td>
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445       <td valign="top" width="38%">
1446       <font size="-1">Similar to NetworkAddress.</font></td>
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458     </tr>
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470     <tr>
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481       <td valign="top" width="23%">
1482       <font size="-1">Counter</font></td>
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494       <td valign="top" width="26%">
1495       <font size="-1">snmp.</font><font size="-1">TYPE_COUNTER (6)</font></td>
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507       <td valign="top" width="12%">
1508       <font size="-1">number</font></td>
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520       <td valign="top" width="38%">
1521       <font size="-1">&nbsp;</font></td>
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533     </tr>
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545     <tr>
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556       <td valign="top" width="23%">
1557       <font size="-1">Gauge32</font></td>
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569       <td valign="top" width="26%">
1570       <font size="-1">snmp.</font><font size="-1">TYPE_GAUGE (7)</font></td>
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582       <td valign="top" width="12%">
1583       <font size="-1">number</font></td>
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595       <td valign="top" width="38%">
1596       <font size="-1">&nbsp;</font></td>
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608     </tr>
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620     <tr>
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631       <td valign="top" width="23%">
1632       <font size="-1">TimeTicks</font></td>
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644       <td valign="top" width="26%">
1645       <font size="-1">snmp.</font><font size="-1">TYPE_TIMETICKS (8)</font></td>
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657       <td valign="top" width="12%">
1658       <font size="-1">table</font></td>
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670       <td valign="top" width="38%">
1671       <font size="-1">A table representing a record structure with fields: <i>ticks </i>(raw value)<i>, days, hours, minutes, seconds e deciseconds</i>. Each field contains a numerical value.</font></td>
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683     </tr>
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695     <tr>
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706       <td valign="top" width="23%">
1707       <font size="-1">Opaque</font></td>
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719       <td valign="top" width="26%">
1720       <font size="-1">snmp.</font><font size="-1">TYPE_OPAQUE (9)</font></td>
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732       <td valign="top" width="12%">
1733       <font size="-1">string</font></td>
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745       <td valign="top" width="38%">
1746       <font size="-1">Similar to OCTET STRING.</font></td>
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758     </tr>
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770     <tr>
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781       <td valign="top" width="23%">
1782       <font size="-1">NULL</font></td>
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794       <td valign="top" width="26%">
1795       <font size="-1">snmp.</font><font size="-1">TYPE_NULL (10)</font></td>
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807       <td valign="top" width="12%">
1808       <font size="-1">nil</font></td>
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820       <td valign="top" width="38%">
1821       <font size="-1"><b>nil</b></font></td>
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833     </tr>
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845     <tr>
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856       <td valign="top" width="23%">
1857       <font size="-1">Counter64</font></td>
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869       <td valign="top" width="26%">
1870       <font size="-1">snmp.</font><font size="-1">TYPE_COUNTER64 (11)</font></td>
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882       <td valign="top" width="12%">
1883       userdata<font size="-1" /></td>
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895       <td valign="top" width="38%">
1896       <font size="-1">see &nbsp;<a href="#counter64">Counter64</a></font></td>
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908     </tr>
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920     <tr>
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931       <td><font size="-1">Bitstring</font></td>
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942       <td><font size="-1">snmp.</font><font size="-1">TYPE_BITSTRING (12)</font></td>
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953       <td><font size="-1">string</font></td>
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964       <td><font size="-1">Binary number, e.g. "10010001"</font></td>
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975     </tr>
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986     <tr>
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997       <td><font size="-1">NsapAddress</font></td>
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008       <td><font size="-1">snmp.</font><font size="-1">TYPE_NSAPADDRESS(13)</font></td>
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019       <td><font size="-1">string</font></td>
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030       <td><font size="-1"><br />
2031 </font></td>
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042     </tr>
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053     <tr>
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064       <td><font size="-1">UInteger</font></td>
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075       <td><font size="-1">snmp.</font><font size="-1">TYPE_UINTEGER (14)</font></td>
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086       <td><font size="-1">number</font></td>
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097       <td><br />
2098 </td>
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109     </tr>
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120     <tr>
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131       <td><font size="-1">Uinteger32</font></td>
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142       <td><font size="-1">snmp.</font><font size="-1">TYPE_UNSIGNED32 (15)</font></td>
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153       <td><font size="-1">number</font></td>
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164       <td><font size="-1"><br />
2165 </font></td>
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176     </tr>
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187     <tr>
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198       <td><font size="-1">Integer32</font></td>
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209       <td><font size="-1">snmp.</font><font size="-1">TYPE_INTEGER32 (16)</font><font size="-1"><font size="-1" /></font></td>
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220       <td><font size="-1">number</font></td>
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231       <td><font size="-1"><br />
2232 </font></td>
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243     </tr>
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254     <tr>
2255
2256
2257       <td><font size="-1">Opaque: Float&nbsp;</font></td>
2258
2259
2260       <td><font size="-1">snmp.TYPE_FLOAT (120)</font></td>
2261
2262
2263       <td><font size="-1">number</font></td>
2264
2265
2266       <td><font size="-1"><br />
2267 </font></td>
2268
2269
2270     </tr>
2271
2272
2273     <tr>
2274
2275
2276       <td><font size="-1">Opaque: Double</font></td>
2277
2278
2279       <td><font size="-1">snmp.TYPE_DOUBLE (121)</font></td>
2280
2281
2282       <td><font size="-1">number</font></td>
2283
2284
2285       <td><font size="-1"><br />
2286 </font></td>
2287
2288
2289     </tr>
2290
2291
2292     <tr>
2293
2294
2295       <td><font size="-1">Opaque: Integer64</font></td>
2296
2297
2298       <td><font size="-1">snmp.TYPE_INTEGER64 (122)</font></td>
2299
2300
2301       <td><font size="-1">number</font></td>
2302
2303
2304       <td><font size="-1"><br />
2305 </font></td>
2306
2307
2308     </tr>
2309
2310
2311     <tr>
2312
2313
2314       <td><font size="-1">Opaque: Unsigned64</font></td>
2315
2316
2317       <td><font size="-1">snmp.TYPE_UNSIGNED64 (123)</font></td>
2318
2319
2320       <td><font size="-1">number</font></td>
2321
2322
2323       <td><font size="-1"><br />
2324 </font></td>
2325
2326
2327     </tr>
2328
2329
2330     <tr align="center">
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341       <td colspan="4" rowspan="1">Special type values</td>
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352     </tr>
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363     <tr>
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374       <td><font size="-1">NO SUCH OBJECT</font></td>
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385       <td><font size="-1">snmp.NOSUCHOBJECT&nbsp;&nbsp; = 128</font></td>
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396       <td><font size="-1"><br />
2397 </font></td>
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408       <td><font size="-1"><br />
2409 </font></td>
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420     </tr>
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431     <tr>
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442       <td><font size="-1">NO SUCH INSTANCE</font></td>
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453       <td><font size="-1">snmp.NOSUCHINSTANCE = 129<br />
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464       </font></td>
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475       <td><font size="-1"><br />
2476 </font></td>
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487       <td><font size="-1"><br />
2488 </font></td>
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499     </tr>
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510     <tr>
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521       <td><font size="-1">END OF MIB VIEW</font></td>
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532       <td><font size="-1">snmp.ENDOFMIBVIEW&nbsp;&nbsp; = 130</font></td>
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543       <td><font size="-1"><br />
2544 </font></td>
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555       <td><font size="-1"><br />
2556 </font></td>
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567     </tr>
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588   </tbody>
2589 </table>
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602 <h3><br />
2603
2604 </h3>
2605 <h3><a name="counter64">Counter64 <br />
2606 </a></h3>
2607 <p>The 64 bit wide SNMP type COUNTER64 cannot be
2608 handled using native Lua types without loosing precision. LuaSNMP
2609 defines and integrates a user defined type "counter64" to handle this
2610 situation. This type allows you to create and return&nbsp; varbinds
2611 containing true 64 bit values.<br />
2612 </p>
2613 <p>COUNTER64 is a userdata from the Lua perspective and a metatable
2614 defining methods for conversions and some arithmetic operations is set
2615 automatically.<br />
2616 </p>
2617 <p>The counter64 data type is managed via a submodule snmp.counter64 which provides the following services:<br />
2618 </p>
2619 <p><span style="font-weight: bold;">Creation</span><br />
2620 </p>
2621
2622 <ul>
2623   <li>Creation of a counter64 instance using <span style="font-weight: bold;">counter64.number(val). </span>The instance is a value of type "userdata". <br />
2624     <span style="font-weight: bold;">val </span>can be <br />
2625   </li>
2626   <ul>
2627     <li>a Lua number, which is not sufficient to achieve true 64 bit precision</li>
2628     <li>an expresssion, that has a counter64 data type as result, e.g.
2629 counter64.pow(2, 64) - 1 delivers the maximum value
2630 18446744073709551615.</li>
2631     <li>a Lua table providing the fields <span style="font-weight: bold; font-style: italic;">high</span> and <span style="font-weight: bold; font-style: italic;">low </span>as 32 bit numbers<span style="font-weight: bold;" /></li>
2632   </ul>
2633 </ul>
2634 <span style="font-weight: bold;">
2635 </span>
2636 <h3><span style="font-weight: bold;"><p><span style="font-weight: bold;">Conversion Operations</span><br />
2637 </p></span></h3>
2638 <ul>
2639   <li><span style="font-weight: bold;">Counter64 =&gt; Lua number<br />
2640     </span><span style="font-style: italic;">n = counter64.tonumber(val) ==&gt; Lua number type (default: double), e.g. 1.844674407371e+19<br />
2641     </span>only 53 bits are maintained.<br />
2642     <span style="font-weight: bold;" /></li>
2643 </ul>
2644 <span style="font-weight: bold;" />
2645 <ul>
2646   <li><span style="font-weight: bold;">Counter64 =&gt; decimal string<br />
2647     </span><span style="font-style: italic;">s = counter64.tostring(val) ==&gt; e.g. "</span>18446744073709551615" (64 bit)<br />
2648   </li>
2649 </ul>
2650 <span style="font-weight: bold;" />
2651 <ul>
2652   <li><span style="font-weight: bold;">Counter64 =&gt; hexadecimal string<br />
2653     </span><span style="font-style: italic;">s = counter64.tohex(val) ==&gt; e.g. 0xffffffffffffffff (64 bit)</span><span style="font-weight: bold;"><br />
2654     </span></li>
2655 </ul>
2656 <span style="font-weight: bold;" />
2657 <ul>
2658   <li><span style="font-weight: bold;">Counter64 =&gt; table<br />
2659     </span><span style="font-style: italic;">t = counter64.totable(val)&nbsp; ==&gt; {high = &lt;num32&gt;, low=&lt;num32&gt;}</span><span style="font-weight: bold;"><br />
2660     </span></li>
2661 </ul>
2662 <span style="font-weight: bold;">
2663 <p><span style="font-weight: bold;">Arithmetic and boolean Operations</span><br />
2664 </p>
2665 <p>The following arithmetic operations are available. The result is
2666 automatically converted to counter64. Operands can be either counter64
2667 userdata or numbers.<br />
2668 </p>
2669
2670 <ul style="font-weight: bold; font-style: italic;">
2671   <li><span style="font-weight: bold;">Addition: </span><br />
2672     <span style="font-style: italic;">result = val1 + val2 or counter64.add(val1, val2)</span></li>
2673 </ul>
2674 <ul style="font-weight: bold; font-style: italic;">
2675   <li><span style="font-weight: bold;">Substraction: </span><br />
2676     <span style="font-style: italic;">result = val1 - val2 or counter64.sub(val1, val2)</span>; the result is always an unsigned 64 bit value</li>
2677 </ul>
2678 <ul style="font-weight: bold; font-style: italic;">
2679   <li><span style="font-weight: bold;">Multiplication: </span><br />
2680     <span style="font-style: italic;">result = val1 * val2 or counter64.mul(val1, val2)</span></li>
2681 </ul>
2682 <ul style="font-weight: bold; font-style: italic;">
2683   <li><span style="font-weight: bold;">Division:</span><br />
2684     <span style="font-style: italic;">result = val1 / val2 or counter64.div(val1, val2)</span></li>
2685 </ul>
2686 <ul style="font-weight: bold; font-style: italic;">
2687   <li><span style="font-weight: bold;">Modulo:</span><br />
2688     <span style="font-style: italic;">result = counter64.mod(val1, val2)</span></li>
2689 </ul>
2690 <ul>
2691   <li><span style="font-weight: bold;">Div and Modulo:</span><br style="font-weight: bold; font-style: italic;" />
2692     <span style="font-style: italic;">div, mod = counter64.divmod(val1, val2)</span></li>
2693   </ul><span style="font-weight: bold;" />
2694 <ul>
2695   <li><span style="font-weight: bold;">Comparision:<br />
2696     </span>All standard Lua compare operators &lt;, &gt;, ==, ~=, &gt;=, &lt;= deliver boolean results.<span style="font-weight: bold;"><br />
2697     </span>Additionally, the function <br />
2698     <span style="font-style: italic;">result = counter64.compare(val1, val2)</span><br />
2699 delivers numbers:<span style="font-weight: bold;"><br />
2700     </span><span style="font-style: italic;">-</span><span style="font-style: italic;">1, if val1 &lt; val2</span><br style="font-style: italic;" />
2701     <span style="font-style: italic;">&nbsp;0, if val1 == val2</span><br style="font-style: italic;" />
2702     <span style="font-style: italic;">&nbsp;1, if val1 &gt; val2</span></li>
2703 </ul>
2704 <span style="font-weight: bold;" />
2705 <ul>
2706   <li><span style="font-weight: bold;">Negation<br />
2707     </span><span style="font-style: italic;">result = - val or<br />
2708 result = counter64.neg(val)<br />
2709     </span>NOTE: The resulting bit pattern is correct, but since
2710 Counter64 is an unsigned type, you will never see negative counter64
2711 values.<span style="font-style: italic;"><br />
2712     </span></li>
2713 </ul>
2714 <span style="font-weight: bold;" />
2715 <ul>
2716   <li><span style="font-weight: bold;">Zero Test:<br />
2717     </span>result = counter64.iszero(val) delivers true if <span style="font-style: italic;">val</span> is 0.<span style="font-style: italic;"><span style="font-weight: bold;"><br />
2718     </span></span></li>
2719
2720 </ul>
2721
2722 <h1><a name="varbinds">Varbinds</a></h1>
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734 <h3><a name="varbinds_general">General</a></h3>
2735 <p>
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746 <a name="varbinds_general">SNMP operations are defined on a list of MIB variable instances called a <i>varbind list</i>. Each element of a varbind list - a <span style="font-weight: bold;">varbind element</span>
2747 - describes a specific MIB variable instance. A varbind element
2748 specifies three MIB instance attributes: its <span style="font-weight: bold;">object identifier</span>, its
2749 <span style="font-weight: bold;">data type</span> and its <span style="font-weight: bold;">value</span>.
2750 </a></p>
2751 <p><a name="varbinds_general">LuaSNMP represents a <span style="font-weight: bold;">varbind list</span> as a table containing <span style="font-weight: bold;">varbind elements</span>
2752 indexed by consecutive numerical values, starting with 1. A varbind
2753 element is represented as a table containing the values of the three
2754 MIB instance attributes. The strings <b>"oid"</b>,<b> "type"</b> and <b>"value" </b>index the three attributes of a varbind table. LuaSNMP represents the values of the varbind attributes as follows:</a></p>
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765 <dir>
2766
2767 <p><a name="varbinds_general"><b>oid</b> - a string containing the <i>object identifier</i> that identifies the MIB instance.</a></p>
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779 <p><a name="varbinds_general"><b>type</b> - the numerical code associated by LuaMan to the SNMP data type of the MIB instance, as specified in the table above (</a><a href="#data_types">Data Types</a>).</p>
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791 <p><b>value</b>- the value of the MIB instance, represented as specified in the table above (<a href="#data_types">Data Types</a>).</p>
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802 </dir>
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815 <p>The following example illustrates a LuaSNMP representation of a varbind list:</p>
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827 <pre>vlist = {<br /> {oid = "1.3.6.1.2.1.1.4.0", type = TYPE_DISPLAY, value = "Lua"},<br /> {oid = "1.3.6.1.2.1.1.6.0", type = TYPE_DISPLAY, value = "Program" }<br />}<br /></pre>
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839 <p>When a previously loaded MIB module contains the description of a
2840 given MIB variable, LuaSNMP allows a management application to use this
2841 variable's <span style="font-weight: bold;">MIB label</span> instead of its object identifier, and also to omit the <span style="font-weight: bold;">type</span> attribute, as shown in the example below: </p>
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853 <pre>  vb = {oid = "sysContact.0", value = "Ana"}</pre>
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865 <p>A management application can also omit the <span style="font-weight: bold;">value</span><span style="font-weight: bold;"> </span>attribute when specifying varbind tables for retrieving - or <i style="font-weight: bold;">getting</i><span style="font-weight: bold;"> </span>- the values of MIB instances. LuaMan functions, however, will always return fully specified varbind tables. </p>
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877 <p>It is important to note that varbind tables resulting from SNMPv2 operations can signal exception, or error, conditions (<i>NO SUCH OBJECT, NO SUCH INSTANCE, END OF MIB VIEW</i>) in their <span style="font-weight: bold;">type</span><span style="font-weight: bold;">
2878 </span>attribute. LuaSNMP represents these exception conditions with the
2879 numerical codes snmp.NOSUCHOBJECT, snmp.NOSUCHINSTANCE and
2880 snmp.ENDOFMIBVIEW. </p>
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891 <h3><a name="varbind_meta">Varbind Metamethods</a></h3>
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902 <p><a name="varbind_meta">Every varbind element returned by&nbsp; LuaSNMP has a metatable
2903 assigned. This metatable allows the following special operation on
2904 varbind elements:</a></p>
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915 <h5><a name="varbind_meta">Creation of varbind elements</a></h5>
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926 <p><a name="varbind_meta">A varbind element can be created using the function <span style="font-style: italic;"><span style="font-weight: bold;">snmp</span></span><span style="font-weight: bold; font-style: italic;">.newvar(NAME, VALUE). </span>This function returns a new varbind element as Lua table with approriate metamethods set.&nbsp;</a></p>
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937 <pre><a name="varbind_meta">leuwer@goofy:luasnmp$ lua -l snmp -i<br />&gt; vb1=snmp.newvar("ifSpeed.1", 1000)<br />&gt; vb2=snmp.newvar("sysContact.0", "atHome")<br />&gt; vb3=snmp.newvar("ifName.2", "Ethernet")<br />&gt; vb4=snmp.newvar("ifSpeed.2", 2000)<br /></a></pre>
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948 <h5><a name="varbind_meta">Conversion to string:&nbsp;</a></h5>
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959 <p><a name="varbind_meta">When the function tostring(vb) is applied to a varbind element, it
2960 returns a printable string representation of the varbind element.</a></p>
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971 <pre><a name="varbind_meta">&gt; print(tostring(vb1))<br />IF-MIB::ifSpeed.1 = Gauge32: 1000<br />&gt; print(vb2)<br />SNMPv2-MIB::sysContact.0 = STRING: atHome<br />&gt; print(vb3)<br />IF-MIB::ifName.2 = STRING: Ethernet<br />&gt; print(tostring(vb4))<br />IF-MIB::ifSpeed.2 = Gauge32: 2000<br /></a></pre>
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982 <h5><a name="varbind_meta">Comparision of varbind elements</a></h5>
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993 <p><a name="varbind_meta">A compare operation on varbind elements compares their values. Note
2994 that the comparison is performed on equivalent Lua type (see Data Types
2995 above). Comparing varbind elements with values of different Lua types
2996 leads to an error.</a></p>
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007 <pre><a name="varbind_meta">&gt; =vb1&lt;vb4<br />true<br />&gt; =vb1&lt;=vb4<br />true<br />&gt; =vb1&gt;vb4<br />false<br />&gt; =vb2&lt;vb3<br />false<br />&gt; =vb2&gt;vb3<br />true<br />&gt; =vb1 &lt; vb2<br />./snmp.lua:316: attempt to compare number with string<br />stack traceback:<br />        ./snmp.lua:316: in function &lt;./snmp.lua:316&gt;<br />        stdin:1: in main chunk<br />        [C]: ?</a></pre>
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018 <h5><a name="varbind_meta">Concatenation of varbind elements</a></h5>
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029 <p><a name="varbind_meta">Applying the concatenation operator on varbind elements creates a
3030 varbind list. Any number of varbinds can be concatenated. Concatenation
3031 a varbind element and a varbind list creates a new varbind list which
3032 contains the varbind element and all elements of the varbind list.</a></p>
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043 <pre><a name="varbind_meta">&gt; vlist = vb1..vb2..vb3<br />&gt; table.foreach(vlist, print)<br />1       IF-MIB::ifSpeed.1 = Gauge32: 1000<br />2       SNMPv2-MIB::sysContact.0 = STRING: atHome<br />3       IF-MIB::ifName.2 = STRING: Ethernet<br />&gt;<br /></a></pre>
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054 <a name="varbind_meta">om<br />
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065 </a><h1><a name="sessions">SNMP Sessions</a></h1>
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076 <p><a name="sessions">Similarly to other SNMP APIs, LuaSNMP implements the concept of SNMP
3077 sessions. Before invoking SNMP operations on an SNMP peer, a management
3078 application must create, or open, an SNMP session. An SNMP session is a
3079 special object that stores the configuration parameters that control
3080 the protocol interactions with an SNMP peer. These configuration
3081 parameters include the IP address of the SNMP peer, the protocol
3082 version to be used and authentication information. All invocations of
3083 SNMP operations must specify an SNMP session.</a></p>
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094 <p><a name="sessions">When creating an SNMP session, an application can also define
3095 default callback functions for receiving responses to asynchronous SNMP
3096 operations and for handling notifications (trap and inform messages)
3097 sent by the associated peer.</a></p>
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108 <p><a name="sessions">The configuration parameters stored in a LuaSNMP&nbsp;session are described below.</a></p>
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119 <h5><a name="sessions">peer = STRING</a></h5>
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131 <p><a name="sessions">Defines the network (IP) address of the associated SNMP peer, and
3132 can be provided either as an IP address in dotted notation (e.g.
3133 "139.82.95.11") or as a host name that can be translated to an IP
3134 address.</a></p>
3135
3136
3137
3138
3139
3140 <p>
3141
3142
3143
3144 <a name="sessions">The default value for this parameter is "0.0.0.0", and indicates an
3145 SNMP session that is not associated to a specific peer. This kind of
3146 "unassociated" SNMP sessions can be used for receiving all
3147 notifications (traps and informs) sent by the SNMP agents and managers
3148 on the network (see configuration parameters trap and inform). Note,
3149 however, that SNMP operations can only be invoked for SNMP sessions
3150 associated to specific peers.</a></p>
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161 <h5><a name="sessions">version = NUMBER</a></h5>
3162
3163
3164
3165
3166
3167 <p><a name="sessions">Defines the SNMP protocol version to be used when interacting with
3168 the SNMP peer associated to the session. LuaSNMP supports
3169 SNMPv1,&nbsp;SNMPv2C and SNMPv3. A <span style="font-weight: bold;">default value </span>can be defined with the <span style="font-weight: bold;">defCommunity</span> configuration directive in snmp.conf. The <span style="font-weight: bold;">default</span> <span style="font-weight: bold;">value</span> for this parameter
3170 is <span style="font-weight: bold;">snmp.SNMPv2C</span>. LuaSNMP provides the following constants to define the session's version:&nbsp;</a></p>
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193 <ul>
3194
3195
3196
3197
3198
3199 <a name="sessions">  </a><li><span style="font-weight: bold;"><a name="sessions">snmp.SNMPv1 = 1</a></span></li>
3200
3201
3202
3203
3204
3205 <a name="sessions">  </a><li><span style="font-weight: bold;"><span style="font-weight: bold;"><a name="sessions">snmp.SNMPv2C = snmp.SNMPv2c = 2</a></span></span></li>
3206
3207
3208
3209
3210
3211 <a name="sessions">  </a><li><span style="font-weight: bold;"><a name="sessions">snmp.SNMPv3 = 3</a></span></li>
3212
3213
3214
3215
3216
3217 </ul>
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228 <h5><a name="sessions">community = STRING</a></h5>
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239 <p><a name="sessions">Defines the community string to be used for authenticating the SNMP
3240 messages sent to the associated peer. A <span style="font-weight: bold;">default value </span>can be defined with the <span style="font-weight: bold;">defVersion</span> configuration directive in snmp.conf. The <span style="font-weight: bold;">default</span> <span style="font-weight: bold;">value</span> for this
3241 parameter is <span style="font-weight: bold;">"public"</span>. The community is only used for SNMPv1 and SNMPv2C</a></p>
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252 <h5><a name="sessions">port = NUMBER</a></h5>
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263 <p><a name="sessions">Defines the UDP port used by the associated peer for receiving SNMP requests. A default value can be defined via the <span style="font-weight: bold;">defaultPort</span> configuration directive in <span style="font-weight: bold;">snmp.conf</span>. See the Net-SNMP manual page snmp.conf (5) for details.&nbsp;The <span style="font-weight: bold;">default</span> <span style="font-weight: bold;">value</span> for this parameter is <span style="font-weight: bold;">161</span>.</a></p>
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274 <h5><a name="sessions">retries = NUMBER</a></h5>
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285 <p><a name="sessions">Defines the maximum number of retransmissions of an SNMP message. The <span style="font-weight: bold;">default</span> <span style="font-weight: bold;">value</span>&nbsp;is <span style="font-weight: bold;">5.</span></a></p>
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296 <h5><a name="sessions">timeout = NUMBER</a></h5>
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307 <p><a name="sessions">Defines the time (in seconds) to wait for a response to an SNMP
3308 request. In order to avoid congestion problems, every retransmission of
3309 a given SNMP request will double the previous timeout value.&nbsp;The
3310 <span style="font-weight: bold;">default</span> <span style="font-weight: bold;">value</span> for this parameter is<span style="font-weight: bold;"> 1.</span></a></p>
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321 <h5><a name="sessions">callback =FUNCTION</a></h5>
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334 <p><a name="sessions">This parameter defines a default user function to be invoked when a
3335 response to an asynchronous SNMP operation is received, or when an
3336 asynchronous request times out.<br />
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346 Note, however, that an application can define a specific function
3347 for processing the response to a given asynchronous request. In this
3348 case, this specific function overrides the default callback function
3349 configured for the session.<br />
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359 The <span style="font-weight: bold;">default</span> <span style="font-weight: bold;">value</span> for this parameter is <span style="font-weight: bold;">nil</span>, indicating that no
3360 default function for handling asynchronous responses is defined for the
3361 session.</a></p>
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372 <h5><a name="sessions">trap = FUNCTION</a></h5>
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384 <p><a name="sessions">This parameter defines a user function to be invoked when a trap
3385 message is received. Note that when a trap message is received, LuaSNMP
3386 invokes the trap handling functions specified for all SNMP sessions
3387 associated to the originating agent, and also the trap handling
3388 functions specified for "unassociated" sessions (peer = "0.0.0.0").&nbsp;<br />
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398 The <span style="font-weight: bold;">default</span> <span style="font-weight: bold;">value</span> for this parameter is <span style="font-weight: bold;">nil</span>, indicating that no trap handling function is defined for the session.</a></p>
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408 <p><a name="sessions">Note, that the trap callback function is also invoked for solicited traps = informs.<br />
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418 See Trap Handling for more details on trap handling in LuaSNMP.</a></p>
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428 <h5><a name="sessions">user = STRING</a></h5>
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438 <p><a name="sessions">This parameter defines the user name to be used during SNMP version 3 USM based&nbsp; authentication. A <span style="font-weight: bold;">default</span> <span style="font-weight: bold;">value</span> can be specified using the&nbsp;<span style="font-weight: bold;">defSecurityName </span>configuration directive in snmp.conf. See the Net-SNMP manual page snmp.conf (5) for details.&nbsp;</a></p>
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448 <h5><a name="sessions">password = STRING&nbsp;<br />
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458 autPassphrase = STRING</a></h5>
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468 <p><a name="sessions">This parameter defines the&nbsp;pass phrase to be used during SNMP
3469 version 3 USM based authentication. A default value can be specified
3470 using the <span style="font-weight: bold;">defAuthPassphrase</span> or <span style="font-weight: bold;">defPassphrase</span> configuration directives in <span style="font-weight: bold;">snmp.conf</span>. See the Net-SNMP manual page snmp.conf (5) for details.&nbsp;</a></p>
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480 <p><a name="sessions">Note, that password is used as the pass phrase for both
3481 authentication and encryption if no dedicated pass phrase is specified
3482 for encryption.</a></p>
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492 <h5><a name="sessions">authType = STRING</a></h5>
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502 <p><a name="sessions">This parameter defines the <span style="font-weight: bold;">authentication method</span> to be used for SNMP version 3 authentication. Possible values are <span style="font-weight: bold;">"MD5"</span> or <span style="font-weight: bold;">"SHA"</span>. A default value can be specified using the <span style="font-weight: bold;">defAuthType</span> configuration directive in <span style="font-weight: bold;">snmp.conf</span>. If no authentication method is defined LuaSNMP assumes <span style="font-weight: bold;">"MD5"</span> as <span style="font-weight: bold;">default value.</span></a></p>
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512 <h5><a name="sessions">privType = STRING</a></h5>
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522 <p><a name="sessions">This parameter defines the <span style="font-weight: bold;">encryption method</span> to be used for SNMP version 3 PDU encryption. Possible values are <span style="font-weight: bold;">"DES"</span> or <span style="font-weight: bold;">"AES"</span>. A default value can be specified using the <span style="font-weight: bold;">defPrivType</span><span style="font-weight: bold;"> </span>in<span style="font-weight: bold;"> snmp.conf</span>. If no authentication method is defined LuaSNMP assumes <span style="font-weight: bold;">"DES"</span><span style="font-weight: bold;"> </span>as <span style="font-weight: bold;">default value.</span></a></p>
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532 <h5><a name="sessions">privPassphrase = STRING</a></h5>
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542 <p><a name="sessions">This parameter defines the&nbsp;pass phrase to be used during SNMP version
3543 3 PDU encryption. &nbsp;A default value can be specified using the
3544 <span style="font-weight: bold;">defPrivPassphrase</span> or <span style="font-weight: bold;">defPassphrase</span> configuration directives in
3545 <span style="font-weight: bold;">snmp.conf</span>. See the Net-SNMP manual page snmp.conf (5) for details.&nbsp;</a></p>
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555 <p><a name="sessions">Note, that <span style="font-weight: bold;">password</span> is used as the pass phrase for both authentication
3556 and encryption if no dedicated pass phrase is specified for encryption.</a></p>
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566 <h5><a name="sessions">securityLevel = STRING</a></h5>
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576 <p><a name="sessions">Defines the security level to be used in SNMP version 3. The parameter can take the following values:</a></p>
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586 <p style="margin-left: 40px;"><span style="font-weight: bold;"><a name="sessions">"noAuthNoPriv"</a></span><a name="sessions"> <span style="font-weight: bold;">-</span> LuaSNMP does not require authentication nor does it perform encryption</a></p>
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596 <p style="margin-left: 40px;"><span style="font-weight: bold;"><a name="sessions">"authNoPriv" - </a></span><a name="sessions">LuaSNMP requires authentication but does NOT perform encryption.<br />
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606 </a></p>
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616 <div style="margin-left: 40px;"><span style="font-weight: bold;"><a name="sessions">"authPriv" - </a></span><a name="sessions">LuaSNMP requires authentication AND performs encryption</a></div>
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626 <p><a name="sessions">A <span style="font-weight: bold;">default value</span> can be defined using the <span style="font-weight: bold;">defSecurityLevel</span> configuration directive in snmp.conf. See the Net-SNMP manual page snmp.conf (5) for details.&nbsp;<br />
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636 If no security level is defined during session creation and there is no configuration available via snmp.conf, LuaSNMP defines <span style="font-weight: bold;">"authNoPriv"</span> as default value.<br />
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646 </a></p>
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656 <h5><a name="sessions">includeroot = BOOLEAN</a></h5>
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666 <p><a name="sessions">This parameter defines whether the SNMP access function <span style="font-weight: bold; font-style: italic;">walk(NODE) </span>shall include the given NODE. Normally, the walk starts with the successor of the given NODE. The default value is <span style="font-weight: bold;">false</span>.</a></p>
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676 <h5><a name="sessions">sprintvar = FUNCTION</a></h5>
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686 <p><a name="sessions">This parameter instructs LuaSNMP to use the given FUNCTION to convert varbind elements to readable strings.&nbsp; </a></p>
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696 <h5><a name="sessions">sprintval = FUNCTION</a></h5>
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706 <p><a name="sessions">This parameter instructs LuaSNMP to use the given FUNCTION to convert varbind values to readable strings.&nbsp;</a></p>
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716 <h5><a name="sessions">context = STRING</a></h5>
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726 <p><a name="sessions">This parameter defines the context to which this session shall have access. <span style="font-weight: bold;">Defaults</span> to an empty context <span style="font-weight: bold;">""</span>.</a></p>
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736 <h5><a name="sessions">contextID = STRING</a></h5>
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746 <p><a name="sessions">This parameter sets the context engineID used for SNMPv3 REQUEST
3747 messages scopedPdu.&nbsp;&nbsp; If not specified, this will default to
3748 the authoritative <span style="font-weight: bold;">engineID.</span></a></p>
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758 <h5><a name="sessions">engineID = STRING</a></h5>
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768 <p><a name="sessions">This parameter sets&nbsp; the&nbsp; authoritative&nbsp;
3769 (security)&nbsp; engineID&nbsp; used&nbsp; for&nbsp; SNMPv3
3770 REQUEST&nbsp; messages.&nbsp;&nbsp; It&nbsp; is&nbsp; typically&nbsp;
3771 not necessary to specify this, as it will usually be discovered
3772 automatically.</a></p>
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782 <h5><a name="sessions">engineBoots = STRING</a></h5>
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792 <p><a name="sessions">This parameter is not (yet) supported. It's typically not required because this value is automatically discovered.</a></p>
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802 <h5><a name="sessions">engineTime = STRING</a></h5>
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812 <p><a name="sessions">This parameter is not (yet) supported. It's typically not required because this value is automatically discovered.</a></p>
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823 <h1><a name="trap_handling">Trap Handling</a></h1>
3824
3825
3826
3827
3828
3829
3830
3831 <p><a name="trap_handling">LuaSNMP handles traps via the&nbsp;<span style="font-weight: bold;">snmptrapd</span> from the NetSNMP library using the <span style="font-weight: bold;">traphandle</span> directive in <span style="font-weight: bold;">snmptrapd.conf(5)</span>.&nbsp;&nbsp;</a></p>
3832
3833
3834
3835
3836
3837
3838
3839 <p><a name="trap_handling">In order to capture traps in this way&nbsp;you have to configure the
3840 script trapd.lua provided with LuaSNMP to handle &nbsp;traps via the <span style="font-weight: bold;">traphandle</span> directive. Insert the following line into snmptrapd.conf:</a></p>
3841
3842
3843
3844
3845
3846
3847 <pre><a name="trap_handling">traphandle default PATH_TO_LUA/lua50 PATH_TO_TRAPD/trapd.lua [FWDPORT]</a></pre>
3848
3849
3850
3851
3852
3853
3854 <p><a name="trap_handling">The script trapd.lua simply forwards all information received by snmptrapd to LuaSNMP using a UDP socket with localhost on&nbsp;<span style="font-weight: bold;">port&nbsp;6000</span>. In order to change the port, set the environment variable&nbsp; <span style="font-weight: bold;">LUASNMP_TRAPDPORT </span>to the desired port number and provide the same number in the traphandle directive in <span style="font-weight: bold;">snmptrapd.conf</span>.</a></p>
3855
3856
3857
3858
3859
3860
3861 <p><a name="trap_handling">Note, that for informs the response to the inform message is sent AFTER trapd.lua has finished.</a></p>
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875 </span></div>
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895 <div style="font-weight: normal;" id="footer"><small>(c) 2006-2010 Herbert Leuwer, March 2006&nbsp;&nbsp; &nbsp;<a href="mailto:herbert.leuwer@t-online.de">Contact</a></small></div>
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915 <small><small>
3916 </small></small>
3917 </h1></body></html>