BEGEMOT-NETGRAPH.txt revision 122405
1122405Sharti-- 2122405Sharti-- Copyright (c) 2001-2003 3122405Sharti-- Fraunhofer Institute for Open Communication Systems (FhG Fokus). 4122405Sharti-- All rights reserved. 5122405Sharti-- 6122405Sharti-- Author: Harti Brandt <harti@freebsd.org> 7122405Sharti-- 8122405Sharti-- Redistribution of this software and documentation and use in source and 9122405Sharti-- binary forms, with or without modification, are permitted provided that 10122405Sharti-- the following conditions are met: 11122405Sharti-- 12122405Sharti-- 1. Redistributions of source code or documentation must retain the above 13122405Sharti-- copyright notice, this list of conditions and the following disclaimer. 14122405Sharti-- 2. Redistributions in binary form must reproduce the above copyright 15122405Sharti-- notice, this list of conditions and the following disclaimer in the 16122405Sharti-- documentation and/or other materials provided with the distribution. 17122405Sharti-- 18122405Sharti-- THIS SOFTWARE AND DOCUMENTATION IS PROVIDED BY FRAUNHOFER FOKUS 19122405Sharti-- AND ITS CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, 20122405Sharti-- INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 21122405Sharti-- FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL 22122405Sharti-- FRAUNHOFER FOKUS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 23122405Sharti-- INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24122405Sharti-- LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, 25122405Sharti-- OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 26122405Sharti-- LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 27122405Sharti-- NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 28122405Sharti-- EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29122405Sharti-- 30122405Sharti-- $FreeBSD: head/usr.sbin/bsnmpd/modules/snmp_netgraph/BEGEMOT-NETGRAPH.txt 122405 2003-11-10 09:17:34Z harti $ 31122405Sharti-- 32122405Sharti-- Private MIB for netgraph part of Begemot SNMP daemon. 33122405Sharti-- 34122405ShartiBEGEMOT-NETGRAPH-MIB DEFINITIONS ::= BEGIN 35122405Sharti 36122405ShartiIMPORTS 37122405Sharti MODULE-IDENTITY, OBJECT-TYPE, Counter32, Unsigned32 38122405Sharti FROM SNMPv2-SMI 39122405Sharti TEXTUAL-CONVENTION, TruthValue 40122405Sharti FROM SNMPv2-TC 41122405Sharti MODULE-COMPLIANCE, OBJECT-GROUP 42122405Sharti FROM SNMPv2-CONF 43122405Sharti begemot 44122405Sharti FROM BEGEMOT-MIB; 45122405Sharti 46122405ShartibegemotNg MODULE-IDENTITY 47122405Sharti LAST-UPDATED "200201310000Z" 48122405Sharti ORGANIZATION "Fraunhofer FOKUS, CATS" 49122405Sharti CONTACT-INFO 50122405Sharti " Hartmut Brandt 51122405Sharti 52122405Sharti Postal: Fraunhofer Institute for Open Communication Systems 53122405Sharti Kaiserin-Augusta-Allee 31 54122405Sharti 10589 Berlin 55122405Sharti Germany 56122405Sharti 57122405Sharti Fax: +49 30 3463 7352 58122405Sharti 59122405Sharti E-mail: harti@freebsd.org" 60122405Sharti DESCRIPTION 61122405Sharti "The MIB for the NetGraph access module for SNMP." 62122405Sharti ::= { begemot 2 } 63122405Sharti 64122405ShartibegemotNgObjects OBJECT IDENTIFIER ::= { begemotNg 1 } 65122405Sharti 66122405Sharti-- -------------------------------------------------------------------------- 67122405Sharti 68122405ShartiNgTypeName ::= TEXTUAL-CONVENTION 69122405Sharti DISPLAY-HINT "15a" 70122405Sharti STATUS current 71122405Sharti DESCRIPTION 72122405Sharti "Name of a netgraph type." 73122405Sharti SYNTAX OCTET STRING (SIZE(1..15)) 74122405Sharti 75122405ShartiNgNodeName ::= TEXTUAL-CONVENTION 76122405Sharti DISPLAY-HINT "15a" 77122405Sharti STATUS current 78122405Sharti DESCRIPTION 79122405Sharti "Name of a netgraph node." 80122405Sharti SYNTAX OCTET STRING (SIZE(1..15)) 81122405Sharti 82122405ShartiNgNodeNameOrEmpty ::= TEXTUAL-CONVENTION 83122405Sharti DISPLAY-HINT "15a" 84122405Sharti STATUS current 85122405Sharti DESCRIPTION 86122405Sharti "Name of a netgraph node." 87122405Sharti SYNTAX OCTET STRING (SIZE(0..15)) 88122405Sharti 89122405ShartiNgHookName ::= TEXTUAL-CONVENTION 90122405Sharti DISPLAY-HINT "15a" 91122405Sharti STATUS current 92122405Sharti DESCRIPTION 93122405Sharti "Name of a netgraph hook." 94122405Sharti SYNTAX OCTET STRING (SIZE(1..15)) 95122405Sharti 96122405ShartiNgNodeId ::= TEXTUAL-CONVENTION 97122405Sharti DISPLAY-HINT "x" 98122405Sharti STATUS current 99122405Sharti DESCRIPTION 100122405Sharti "Node identifier." 101122405Sharti SYNTAX Unsigned32 (1..4294967295) 102122405Sharti 103122405ShartiNgNodeIdOrZero ::= TEXTUAL-CONVENTION 104122405Sharti DISPLAY-HINT "x" 105122405Sharti STATUS current 106122405Sharti DESCRIPTION 107122405Sharti "Node identifier or 0 for 'no-node'." 108122405Sharti SYNTAX Unsigned32 (0..4294967295) 109122405Sharti 110122405Sharti-- -------------------------------------------------------------------------- 111122405Sharti-- 112122405Sharti-- Configuration parameters 113122405Sharti-- 114122405ShartibegemotNgConfig OBJECT IDENTIFIER ::= { begemotNgObjects 1 } 115122405Sharti 116122405ShartibegemotNgControlNodeName OBJECT-TYPE 117122405Sharti SYNTAX NgNodeName 118122405Sharti MAX-ACCESS read-only 119122405Sharti STATUS current 120122405Sharti DESCRIPTION 121122405Sharti "The name of the netgraph node of this daemon. The name is 122122405Sharti writeable during initialisation. If the name is set from 123122405Sharti the empty string to the non-empty string, the netgraph socket 124122405Sharti is created. Once set it cannot be changed." 125122405Sharti ::= { begemotNgConfig 1 } 126122405Sharti 127122405ShartibegemotNgResBufSiz OBJECT-TYPE 128122405Sharti SYNTAX INTEGER (1024..65536) 129122405Sharti MAX-ACCESS read-write 130122405Sharti STATUS current 131122405Sharti DESCRIPTION 132122405Sharti "The size of the receive buffers for netgraph messages." 133122405Sharti DEFVAL { 20000 } 134122405Sharti ::= { begemotNgConfig 2 } 135122405Sharti 136122405ShartibegemotNgTimeout OBJECT-TYPE 137122405Sharti SYNTAX INTEGER (10..10000) 138122405Sharti UNITS "milliseconds" 139122405Sharti MAX-ACCESS read-write 140122405Sharti STATUS current 141122405Sharti DESCRIPTION 142122405Sharti "The maximum time to wait for a response to a netgraph message." 143122405Sharti DEFVAL { 1000 } 144122405Sharti ::= { begemotNgConfig 3 } 145122405Sharti 146122405ShartibegemotNgDebugLevel OBJECT-TYPE 147122405Sharti SYNTAX Unsigned32 148122405Sharti MAX-ACCESS read-write 149122405Sharti STATUS current 150122405Sharti DESCRIPTION 151122405Sharti "The netgraph library debug level. This should be set only 152122405Sharti if the daemon is run with a terminal attached." 153122405Sharti DEFVAL { 0 } 154122405Sharti ::= { begemotNgConfig 4 } 155122405Sharti 156122405Sharti-- -------------------------------------------------------------------------- 157122405Sharti-- 158122405Sharti-- The STATISTICS Group 159122405Sharti-- 160122405ShartibegemotNgStats OBJECT IDENTIFIER ::= { begemotNgObjects 2 } 161122405Sharti 162122405ShartibegemotNgNoMems OBJECT-TYPE 163122405Sharti SYNTAX Counter32 164122405Sharti MAX-ACCESS read-only 165122405Sharti STATUS current 166122405Sharti DESCRIPTION 167122405Sharti "Number of times a memory allocation has failed for buffers 168122405Sharti or the message queue." 169122405Sharti ::= { begemotNgStats 1 } 170122405Sharti 171122405ShartibegemotNgMsgReadErrs OBJECT-TYPE 172122405Sharti SYNTAX Counter32 173122405Sharti MAX-ACCESS read-only 174122405Sharti STATUS current 175122405Sharti DESCRIPTION 176122405Sharti "Number of times reading a netgraph message has failed." 177122405Sharti ::= { begemotNgStats 2 } 178122405Sharti 179122405ShartibegemotNgTooLargeMsgs OBJECT-TYPE 180122405Sharti SYNTAX Counter32 181122405Sharti MAX-ACCESS read-only 182122405Sharti STATUS current 183122405Sharti DESCRIPTION 184122405Sharti "Number of times a netgraph message was too large for 185122405Sharti the buffer. Try increasing begemotNgResBufSiz if 186122405Sharti this happens." 187122405Sharti ::= { begemotNgStats 3 } 188122405Sharti 189122405ShartibegemotNgDataReadErrs OBJECT-TYPE 190122405Sharti SYNTAX Counter32 191122405Sharti MAX-ACCESS read-only 192122405Sharti STATUS current 193122405Sharti DESCRIPTION 194122405Sharti "Number of times reading a netgraph data message has failed." 195122405Sharti ::= { begemotNgStats 4 } 196122405Sharti 197122405ShartibegemotNgTooLargeDatas OBJECT-TYPE 198122405Sharti SYNTAX Counter32 199122405Sharti MAX-ACCESS read-only 200122405Sharti STATUS current 201122405Sharti DESCRIPTION 202122405Sharti "Number of times a netgraph data message was too large. 203122405Sharti You need to increase begemotNgResBufSiz." 204122405Sharti ::= { begemotNgStats 5 } 205122405Sharti 206122405Sharti-- ----------------------------------------------------- 207122405Sharti-- 208122405Sharti-- The NODE table 209122405Sharti-- 210122405ShartibegemotNgTypeTable OBJECT-TYPE 211122405Sharti SYNTAX SEQUENCE OF BegemotNgTypeEntry 212122405Sharti MAX-ACCESS not-accessible 213122405Sharti STATUS current 214122405Sharti DESCRIPTION 215122405Sharti "A table containing information about all netgraph node types." 216122405Sharti ::= { begemotNgObjects 3 } 217122405Sharti 218122405ShartibegemotNgTypeEntry OBJECT-TYPE 219122405Sharti SYNTAX BegemotNgTypeEntry 220122405Sharti MAX-ACCESS not-accessible 221122405Sharti STATUS current 222122405Sharti DESCRIPTION 223122405Sharti "Table entry that describes one netgraph node." 224122405Sharti INDEX { begemotNgTypeName } 225122405Sharti ::= { begemotNgTypeTable 1 } 226122405Sharti 227122405ShartiBegemotNgTypeEntry ::= SEQUENCE { 228122405Sharti begemotNgTypeName NgTypeName, 229122405Sharti begemotNgTypeStatus INTEGER 230122405Sharti} 231122405Sharti 232122405ShartibegemotNgTypeName OBJECT-TYPE 233122405Sharti SYNTAX NgTypeName 234122405Sharti MAX-ACCESS not-accessible 235122405Sharti STATUS current 236122405Sharti DESCRIPTION 237122405Sharti "The name of the type. Used as index." 238122405Sharti ::= { begemotNgTypeEntry 1 } 239122405Sharti 240122405ShartibegemotNgTypeStatus OBJECT-TYPE 241122405Sharti SYNTAX INTEGER { loaded(1), unloaded(2) } 242122405Sharti MAX-ACCESS read-create 243122405Sharti STATUS current 244122405Sharti DESCRIPTION 245122405Sharti "If loaded then the node type is available. A type can be load 246122405Sharti by setting this field to loaded. It is unload if the field is 247122405Sharti set to unloaded. Note, that a type cannot be unloaded if it 248122405Sharti is compiled into the kernel or has nodes of this type. The name 249122405Sharti of the file containing the type implementation is constructed by 250122405Sharti prepending ng_ to the type name." 251122405Sharti ::= { begemotNgTypeEntry 2 } 252122405Sharti 253122405Sharti-- 254122405Sharti-- Node table 255122405Sharti-- 256122405ShartibegemotNgNodeTable OBJECT-TYPE 257122405Sharti SYNTAX SEQUENCE OF BegemotNgNodeEntry 258122405Sharti MAX-ACCESS not-accessible 259122405Sharti STATUS current 260122405Sharti DESCRIPTION 261122405Sharti "A table containing information about all netgraph nodes." 262122405Sharti ::= { begemotNgObjects 4 } 263122405Sharti 264122405ShartibegemotNgNodeEntry OBJECT-TYPE 265122405Sharti SYNTAX BegemotNgNodeEntry 266122405Sharti MAX-ACCESS not-accessible 267122405Sharti STATUS current 268122405Sharti DESCRIPTION 269122405Sharti "Table entry that describes one netgraph node." 270122405Sharti INDEX { begemotNgNodeId } 271122405Sharti ::= { begemotNgNodeTable 1 } 272122405Sharti 273122405ShartiBegemotNgNodeEntry ::= SEQUENCE { 274122405Sharti begemotNgNodeId NgNodeId, 275122405Sharti begemotNgNodeStatus INTEGER, 276122405Sharti begemotNgNodeName NgNodeNameOrEmpty, 277122405Sharti begemotNgNodeType NgTypeName, 278122405Sharti begemotNgNodeHooks Unsigned32 279122405Sharti} 280122405Sharti 281122405ShartibegemotNgNodeId OBJECT-TYPE 282122405Sharti SYNTAX NgNodeId 283122405Sharti MAX-ACCESS not-accessible 284122405Sharti STATUS current 285122405Sharti DESCRIPTION 286122405Sharti "The 32bit node id of this node. 0 is an illegal value." 287122405Sharti ::= { begemotNgNodeEntry 1 } 288122405Sharti 289122405ShartibegemotNgNodeStatus OBJECT-TYPE 290122405Sharti SYNTAX INTEGER { valid(1), invalid(2) } 291122405Sharti MAX-ACCESS read-only 292122405Sharti STATUS current 293122405Sharti DESCRIPTION 294122405Sharti "Indicates whether the node exists or not." 295122405Sharti ::= { begemotNgNodeEntry 2 } 296122405Sharti 297122405ShartibegemotNgNodeName OBJECT-TYPE 298122405Sharti SYNTAX NgNodeNameOrEmpty 299122405Sharti MAX-ACCESS read-only 300122405Sharti STATUS current 301122405Sharti DESCRIPTION 302122405Sharti "Name of the node (if any)." 303122405Sharti ::= { begemotNgNodeEntry 3 } 304122405Sharti 305122405ShartibegemotNgNodeType OBJECT-TYPE 306122405Sharti SYNTAX NgTypeName 307122405Sharti MAX-ACCESS read-only 308122405Sharti STATUS current 309122405Sharti DESCRIPTION 310122405Sharti "Type name of the node." 311122405Sharti ::= { begemotNgNodeEntry 4 } 312122405Sharti 313122405ShartibegemotNgNodeHooks OBJECT-TYPE 314122405Sharti SYNTAX Unsigned32 315122405Sharti MAX-ACCESS read-only 316122405Sharti STATUS current 317122405Sharti DESCRIPTION 318122405Sharti "Number of hooks on this node." 319122405Sharti ::= { begemotNgNodeEntry 5 } 320122405Sharti 321122405Sharti-- 322122405Sharti-- Hook table 323122405Sharti-- 324122405ShartibegemotNgHookTable OBJECT-TYPE 325122405Sharti SYNTAX SEQUENCE OF BegemotNgHookEntry 326122405Sharti MAX-ACCESS not-accessible 327122405Sharti STATUS current 328122405Sharti DESCRIPTION 329122405Sharti "A table containing information about all netgraph hooks." 330122405Sharti ::= { begemotNgObjects 5 } 331122405Sharti 332122405ShartibegemotNgHookEntry OBJECT-TYPE 333122405Sharti SYNTAX BegemotNgHookEntry 334122405Sharti MAX-ACCESS not-accessible 335122405Sharti STATUS current 336122405Sharti DESCRIPTION 337122405Sharti "Table entry that describes one netgraph node." 338122405Sharti INDEX { begemotNgHookNodeId, begemotNgHookHook } 339122405Sharti ::= { begemotNgHookTable 1 } 340122405Sharti 341122405ShartiBegemotNgHookEntry ::= SEQUENCE { 342122405Sharti begemotNgHookNodeId NgNodeId, 343122405Sharti begemotNgHookHook NgHookName, 344122405Sharti begemotNgHookStatus INTEGER, 345122405Sharti begemotNgHookPeerNodeId NgNodeId, 346122405Sharti begemotNgHookPeerHook NgHookName, 347122405Sharti begemotNgHookPeerType NgTypeName 348122405Sharti} 349122405Sharti 350122405ShartibegemotNgHookNodeId OBJECT-TYPE 351122405Sharti SYNTAX NgNodeId 352122405Sharti MAX-ACCESS not-accessible 353122405Sharti STATUS current 354122405Sharti DESCRIPTION 355122405Sharti "The 32bit node id of this node." 356122405Sharti ::= { begemotNgHookEntry 1 } 357122405Sharti 358122405ShartibegemotNgHookHook OBJECT-TYPE 359122405Sharti SYNTAX NgHookName 360122405Sharti MAX-ACCESS read-only 361122405Sharti STATUS current 362122405Sharti DESCRIPTION 363122405Sharti "Name of the hook." 364122405Sharti ::= { begemotNgHookEntry 2 } 365122405Sharti 366122405ShartibegemotNgHookStatus OBJECT-TYPE 367122405Sharti SYNTAX INTEGER { valid(1), invalid(2) } 368122405Sharti MAX-ACCESS read-only 369122405Sharti STATUS current 370122405Sharti DESCRIPTION 371122405Sharti "Indicates whether the hook exists or not." 372122405Sharti ::= { begemotNgHookEntry 3 } 373122405Sharti 374122405ShartibegemotNgHookPeerNodeId OBJECT-TYPE 375122405Sharti SYNTAX NgNodeId 376122405Sharti MAX-ACCESS read-only 377122405Sharti STATUS current 378122405Sharti DESCRIPTION 379122405Sharti "The 32bit node id of the peer node of this hook." 380122405Sharti ::= { begemotNgHookEntry 4 } 381122405Sharti 382122405ShartibegemotNgHookPeerHook OBJECT-TYPE 383122405Sharti SYNTAX NgHookName 384122405Sharti MAX-ACCESS read-only 385122405Sharti STATUS current 386122405Sharti DESCRIPTION 387122405Sharti "Name of the peer hook." 388122405Sharti ::= { begemotNgHookEntry 5 } 389122405Sharti 390122405ShartibegemotNgHookPeerType OBJECT-TYPE 391122405Sharti SYNTAX NgTypeName 392122405Sharti MAX-ACCESS read-only 393122405Sharti STATUS current 394122405Sharti DESCRIPTION 395122405Sharti "Name of the peer type." 396122405Sharti ::= { begemotNgHookEntry 6 } 397122405Sharti 398122405ShartiEND 399