userapps/opensource/net-snmp/mibs/NETWORK-SERVICES-MIB.txt

   1 NETWORK-SERVICES-MIB DEFINITIONS ::= BEGIN
   2
   3 IMPORTS
   4     OBJECT-TYPE, Counter32, Gauge32, MODULE-IDENTITY, mib-2
   5       FROM SNMPv2-SMI
   6     TimeStamp, TEXTUAL-CONVENTION
   7       FROM SNMPv2-TC
   8     MODULE-COMPLIANCE, OBJECT-GROUP
   9       FROM SNMPv2-CONF
  10     SnmpAdminString
  11         FROM SNMP-FRAMEWORK-MIB;
  12
  13 application MODULE-IDENTITY
  14     LAST-UPDATED "200003030000Z"
  15     ORGANIZATION "IETF Mail and Directory Management Working Group"
  16
  17     CONTACT-INFO
  18       "        Ned Freed
  19
  20        Postal: Innosoft International, Inc.
  21                1050 Lakes Drive
  22                West Covina, CA 91790
  23                US
  24
  25           Tel: +1 626 919 3600
  26           Fax: +1 626 919 3614
  27
  28        E-Mail: ned.freed@innosoft.com"
  29     DESCRIPTION
  30       "The MIB module describing network service applications"
  31     REVISION "200003030000Z"
  32     DESCRIPTION
  33       "This revision, published in RFC 2788, changes a number of
  34        DisplayStrings to SnmpAdminStrings. Note that this change
  35        is not strictly supported by SMIv2.  However, the alternative
  36        of deprecating the old objects and defining new objects
  37        would have a more adverse impact on backward compatibility
  38        and interoperability, given the particular semantics of
  39        these objects. The defining reference for distinguished
  40        names has also been updated from RFC 1779 to RFC 2253."
  41     REVISION "199905120000Z"
  42     DESCRIPTION
  43       "This revision fixes a few small technical problems found
  44        in previous versions, mostly in regards to the conformance
  45        groups for different versions of this MIB.  No changes have
  46        been made to the objects this MIB defines since RFC 2248."
  47     REVISION "199708170000Z"
  48     DESCRIPTION
  49       "This revision, published in RFC 2248, adds the
  50        applDescription and applURL objects, adds the quiescing
  51        state to the applOperStatus object and renames the MIB
  52        from the APPLICATION-MIB to the NETWORK-SERVICE-MIB."
  53     REVISION "199311280000Z"
  54     DESCRIPTION
  55       "The original version of this MIB was published in RFC 1565"
  56     ::= {mib-2 27}
  57
  58 -- Textual conventions
  59
  60 -- DistinguishedName is used to refer to objects in the
  61 -- directory.
  62
  63 DistinguishedName ::= TEXTUAL-CONVENTION
  64     DISPLAY-HINT "255a"
  65     STATUS current
  66     DESCRIPTION
  67         "A Distinguished Name represented in accordance with
  68          RFC 2253, presented in the UTF-8 charset defined in
  69          RFC 2279."
  70     SYNTAX OCTET STRING (SIZE (0..255))
  71
  72 -- Uniform Resource Locators are stored in URLStrings.
  73
  74 URLString ::= TEXTUAL-CONVENTION
  75     DISPLAY-HINT "255a"
  76     STATUS current
  77     DESCRIPTION
  78         "A Uniform Resource Locator represented in accordance
  79          with RFCs 1738 and 2368, presented in the NVT ASCII
  80          charset defined in RFC 854."
  81     SYNTAX OCTET STRING (SIZE (0..255))
  82
  83 -- The basic applTable contains a list of the application
  84 -- entities.
  85
  86 applTable OBJECT-TYPE
  87     SYNTAX SEQUENCE OF ApplEntry
  88     MAX-ACCESS not-accessible
  89     STATUS current
  90     DESCRIPTION
  91         "The table holding objects which apply to all different
  92          kinds of applications providing network services.
  93          Each network service application capable of being
  94          monitored should have a single entry in this table."
  95     ::= {application 1}
  96
  97 applEntry OBJECT-TYPE
  98     SYNTAX ApplEntry
  99     MAX-ACCESS not-accessible
 100     STATUS current
 101     DESCRIPTION
 102       "An entry associated with a single network service
 103        application."
 104     INDEX {applIndex}
 105     ::= {applTable 1}
 106
 107 ApplEntry ::= SEQUENCE {
 108     applIndex
 109         INTEGER,
 110     applName
 111         SnmpAdminString,
 112     applDirectoryName
 113
 114         DistinguishedName,
 115     applVersion
 116         SnmpAdminString,
 117     applUptime
 118         TimeStamp,
 119     applOperStatus
 120         INTEGER,
 121     applLastChange
 122         TimeStamp,
 123     applInboundAssociations
 124         Gauge32,
 125     applOutboundAssociations
 126         Gauge32,
 127     applAccumulatedInboundAssociations
 128         Counter32,
 129     applAccumulatedOutboundAssociations
 130         Counter32,
 131     applLastInboundActivity
 132         TimeStamp,
 133     applLastOutboundActivity
 134         TimeStamp,
 135     applRejectedInboundAssociations
 136         Counter32,
 137     applFailedOutboundAssociations
 138         Counter32,
 139     applDescription
 140         SnmpAdminString,
 141     applURL
 142         URLString
 143 }
 144
 145 applIndex OBJECT-TYPE
 146     SYNTAX INTEGER (1..2147483647)
 147     MAX-ACCESS not-accessible
 148     STATUS current
 149     DESCRIPTION
 150       "An index to uniquely identify the network service
 151        application. This attribute is the index used for
 152        lexicographic ordering of the table."
 153     ::= {applEntry 1}
 154
 155 applName OBJECT-TYPE
 156     SYNTAX SnmpAdminString
 157     MAX-ACCESS read-only
 158     STATUS current
 159     DESCRIPTION
 160       "The name the network service application chooses to be
 161        known by."
 162     ::= {applEntry 2}
 163
 164 applDirectoryName OBJECT-TYPE
 165     SYNTAX DistinguishedName
 166     MAX-ACCESS read-only
 167     STATUS current
 168     DESCRIPTION
 169       "The Distinguished Name of the directory entry where
 170        static information about this application is stored.
 171        An empty string indicates that no information about
 172        the application is available in the directory."
 173     ::= {applEntry 3}
 174
 175 applVersion OBJECT-TYPE
 176     SYNTAX SnmpAdminString
 177     MAX-ACCESS read-only
 178     STATUS current
 179     DESCRIPTION
 180       "The version of network service application software.
 181        This field is usually defined by the vendor of the
 182        network service application software."
 183     ::= {applEntry 4}
 184 applUptime OBJECT-TYPE
 185     SYNTAX TimeStamp
 186     MAX-ACCESS read-only
 187     STATUS current
 188     DESCRIPTION
 189       "The value of sysUpTime at the time the network service
 190        application was last initialized.  If the application was
 191        last initialized prior to the last initialization of the
 192        network management subsystem, then this object contains
 193        a zero value."
 194     ::= {applEntry 5}
 195
 196 applOperStatus OBJECT-TYPE
 197     SYNTAX INTEGER {
 198       up(1),
 199       down(2),
 200       halted(3),
 201       congested(4),
 202       restarting(5),
 203       quiescing(6)
 204     }
 205     MAX-ACCESS read-only
 206     STATUS current
 207     DESCRIPTION
 208       "Indicates the operational status of the network service
 209        application. 'down' indicates that the network service is
 210
 211        not available. 'up' indicates that the network service
 212        is operational and available.  'halted' indicates that the
 213        service is operational but not available.  'congested'
 214        indicates that the service is operational but no additional
 215        inbound associations can be accommodated.  'restarting'
 216        indicates that the service is currently unavailable but is
 217        in the process of restarting and will be available soon.
 218        'quiescing' indicates that service is currently operational
 219        but is in the process of shutting down. Additional inbound
 220        associations may be rejected by applications in the
 221        'quiescing' state."
 222     ::= {applEntry 6}
 223
 224 applLastChange OBJECT-TYPE
 225     SYNTAX TimeStamp
 226     MAX-ACCESS read-only
 227     STATUS current
 228     DESCRIPTION
 229       "The value of sysUpTime at the time the network service
 230        application entered its current operational state.  If
 231        the current state was entered prior to the last
 232        initialization of the local network management subsystem,
 233        then this object contains a zero value."
 234     ::= {applEntry 7}
 235
 236 applInboundAssociations OBJECT-TYPE
 237     SYNTAX Gauge32
 238     MAX-ACCESS read-only
 239     STATUS current
 240     DESCRIPTION
 241       "The number of current associations to the network service
 242        application, where it is the responder.  An inbound
 243        association occurs when another application successfully
 244        connects to this one."
 245     ::= {applEntry 8}
 246
 247 applOutboundAssociations OBJECT-TYPE
 248     SYNTAX Gauge32
 249     MAX-ACCESS read-only
 250     STATUS current
 251     DESCRIPTION
 252       "The number of current associations to the network service
 253        application, where it is the initiator.  An outbound
 254        association occurs when this application successfully
 255        connects to another one."
 256     ::= {applEntry 9}
 257
 258 applAccumulatedInboundAssociations OBJECT-TYPE
 259     SYNTAX Counter32
 260     MAX-ACCESS read-only
 261     STATUS current
 262     DESCRIPTION
 263       "The total number of associations to the application entity
 264        since application initialization, where it was the responder."
 265     ::= {applEntry 10}
 266
 267 applAccumulatedOutboundAssociations OBJECT-TYPE
 268     SYNTAX Counter32
 269     MAX-ACCESS read-only
 270     STATUS current
 271     DESCRIPTION
 272       "The total number of associations to the application entity
 273        since application initialization, where it was the initiator."
 274     ::= {applEntry 11}
 275
 276 applLastInboundActivity OBJECT-TYPE
 277     SYNTAX TimeStamp
 278     MAX-ACCESS read-only
 279     STATUS current
 280     DESCRIPTION
 281       "The value of sysUpTime at the time this application last
 282        had an inbound association.  If the last association
 283        occurred prior to the last initialization of the network
 284        subsystem, then this object contains a zero value."
 285     ::= {applEntry 12}
 286
 287 applLastOutboundActivity OBJECT-TYPE
 288     SYNTAX TimeStamp
 289     MAX-ACCESS read-only
 290     STATUS current
 291     DESCRIPTION
 292       "The value of sysUpTime at the time this application last
 293        had an outbound association.  If the last association
 294        occurred prior to the last initialization of the network
 295        subsystem, then this object contains a zero value."
 296     ::= {applEntry 13}
 297
 298 applRejectedInboundAssociations OBJECT-TYPE
 299     SYNTAX Counter32
 300     MAX-ACCESS read-only
 301     STATUS current
 302     DESCRIPTION
 303       "The total number of inbound associations the application
 304        entity has rejected, since application initialization.
 305        Rejected associations are not counted in the accumulated
 306        association totals.  Note that this only counts
 307
 308        associations the application entity has rejected itself;
 309        it does not count rejections that occur at lower layers
 310        of the network.  Thus, this counter may not reflect the
 311        true number of failed inbound associations."
 312     ::= {applEntry 14}
 313
 314 applFailedOutboundAssociations OBJECT-TYPE
 315     SYNTAX Counter32
 316     MAX-ACCESS read-only
 317     STATUS current
 318     DESCRIPTION
 319       "The total number associations where the application entity
 320        is initiator and association establishment has failed,
 321        since application initialization.  Failed associations are
 322        not counted in the accumulated association totals."
 323     ::= {applEntry 15}
 324
 325 applDescription OBJECT-TYPE
 326     SYNTAX SnmpAdminString
 327     MAX-ACCESS read-only
 328     STATUS current
 329     DESCRIPTION
 330       "A text description of the application.  This information
 331        is intended to identify and briefly describe the
 332        application in a status display."
 333     ::= {applEntry 16}
 334
 335 applURL OBJECT-TYPE
 336     SYNTAX URLString
 337     MAX-ACCESS read-only
 338     STATUS current
 339     DESCRIPTION
 340       "A URL pointing to a description of the application.
 341        This information is intended to identify and describe
 342        the application in a status display."
 343     ::= {applEntry 17}
 344
 345 -- The assocTable augments the information in the applTable
 346 -- with information about associations.  Note that two levels
 347 -- of compliance are specified below, depending on whether
 348 -- association monitoring is mandated.
 349
 350 assocTable OBJECT-TYPE
 351     SYNTAX SEQUENCE OF AssocEntry
 352     MAX-ACCESS not-accessible
 353     STATUS current
 354     DESCRIPTION
 355         "The table holding a set of all active application
 356
 357          associations."
 358     ::= {application 2}
 359
 360 assocEntry OBJECT-TYPE
 361     SYNTAX AssocEntry
 362     MAX-ACCESS not-accessible
 363     STATUS current
 364     DESCRIPTION
 365       "An entry associated with an association for a network
 366        service application."
 367     INDEX {applIndex, assocIndex}
 368     ::= {assocTable 1}
 369
 370 AssocEntry ::= SEQUENCE {
 371     assocIndex
 372         INTEGER,
 373     assocRemoteApplication
 374         SnmpAdminString,
 375     assocApplicationProtocol
 376         OBJECT IDENTIFIER,
 377     assocApplicationType
 378         INTEGER,
 379     assocDuration
 380         TimeStamp
 381 }
 382
 383 assocIndex OBJECT-TYPE
 384     SYNTAX INTEGER (1..2147483647)
 385     MAX-ACCESS not-accessible
 386     STATUS current
 387     DESCRIPTION
 388       "An index to uniquely identify each association for a network
 389        service application.  This attribute is the index that is
 390        used for lexicographic ordering of the table.  Note that the
 391        table is also indexed by the applIndex."
 392     ::= {assocEntry 1}
 393
 394 assocRemoteApplication OBJECT-TYPE
 395     SYNTAX SnmpAdminString
 396     MAX-ACCESS read-only
 397     STATUS current
 398     DESCRIPTION
 399       "The name of the system running remote network service
 400        application.  For an IP-based application this should be
 401        either a domain name or IP address.  For an OSI application
 402        it should be the string encoded distinguished name of the
 403        managed object.  For X.400(1984) MTAs which do not have a
 404        Distinguished Name, the RFC 2156 syntax 'mta in
 405
 406        globalid' used in X400-Received: fields can be used. Note,
 407        however, that not all connections an MTA makes are
 408        necessarily to another MTA."
 409     ::= {assocEntry 2}
 410
 411 assocApplicationProtocol OBJECT-TYPE
 412     SYNTAX OBJECT IDENTIFIER
 413     MAX-ACCESS read-only
 414     STATUS current
 415     DESCRIPTION
 416       "An identification of the protocol being used for the
 417        application.  For an OSI Application, this will be the
 418        Application Context.  For Internet applications, OID
 419        values of the form {applTCPProtoID port} or {applUDPProtoID
 420        port} are used for TCP-based and UDP-based protocols,
 421        respectively. In either case 'port' corresponds to the
 422        primary port number being used by the protocol. The
 423        usual IANA procedures may be used to register ports for
 424        new protocols."
 425     ::= {assocEntry 3}
 426
 427 assocApplicationType OBJECT-TYPE
 428     SYNTAX INTEGER {
 429         uainitiator(1),
 430         uaresponder(2),
 431         peerinitiator(3),
 432         peerresponder(4)}
 433     MAX-ACCESS read-only
 434     STATUS current
 435     DESCRIPTION
 436       "This indicates whether the remote application is some type of
 437        client making use of this network service (e.g., a Mail User
 438        Agent) or a server acting as a peer. Also indicated is whether
 439        the remote end initiated an incoming connection to the network
 440        service or responded to an outgoing connection made by the
 441        local application.  MTAs and messaging gateways are
 442        considered to be peers for the purposes of this variable."
 443     ::= {assocEntry 4}
 444
 445 assocDuration OBJECT-TYPE
 446     SYNTAX TimeStamp
 447     MAX-ACCESS read-only
 448     STATUS current
 449     DESCRIPTION
 450       "The value of sysUpTime at the time this association was
 451        started.  If this association started prior to the last
 452        initialization of the network subsystem, then this
 453        object contains a zero value."
 454     ::= {assocEntry 5}
 455
 456 -- Conformance information
 457
 458 applConformance OBJECT IDENTIFIER ::= {application 3}
 459
 460 applGroups      OBJECT IDENTIFIER ::= {applConformance 1}
 461 applCompliances OBJECT IDENTIFIER ::= {applConformance 2}
 462
 463 -- Compliance statements
 464
 465 applCompliance MODULE-COMPLIANCE
 466     STATUS obsolete
 467     DESCRIPTION
 468       "The compliance statement for RFC 1565 implementations
 469        which support the Network Services Monitoring MIB
 470        for basic monitoring of network service applications.
 471        This is the basic compliance statement for RFC 1565."
 472     MODULE
 473       MANDATORY-GROUPS {applRFC1565Group}
 474     ::= {applCompliances 1}
 475
 476 assocCompliance MODULE-COMPLIANCE
 477     STATUS obsolete
 478     DESCRIPTION
 479       "The compliance statement for RFC 1565 implementations
 480        which support the Network Services Monitoring MIB
 481        for basic monitoring of network service applications
 482        and their associations."
 483     MODULE
 484       MANDATORY-GROUPS {applRFC1565Group, assocRFC1565Group}
 485     ::= {applCompliances 2}
 486
 487 applRFC2248Compliance MODULE-COMPLIANCE
 488     STATUS deprecated
 489     DESCRIPTION
 490       "The compliance statement for RFC 2248 implementations
 491        which support the Network Services Monitoring MIB
 492        for basic monitoring of network service applications."
 493     MODULE
 494       MANDATORY-GROUPS {applRFC2248Group}
 495     ::= {applCompliances 3}
 496
 497 assocRFC2248Compliance MODULE-COMPLIANCE
 498     STATUS deprecated
 499     DESCRIPTION
 500       "The compliance statement for RFC 2248 implementations
 501
 502        which support the Network Services Monitoring MIB for
 503        basic monitoring of network service applications and
 504        their associations."
 505     MODULE
 506       MANDATORY-GROUPS {applRFC2248Group, assocRFC2248Group}
 507     ::= {applCompliances 4}
 508
 509 applRFC2788Compliance MODULE-COMPLIANCE
 510     STATUS current
 511     DESCRIPTION
 512       "The compliance statement for RFC 2788 implementations
 513        which support the Network Services Monitoring MIB
 514        for basic monitoring of network service applications."
 515     MODULE
 516       MANDATORY-GROUPS {applRFC2788Group}
 517     ::= {applCompliances 5}
 518
 519 assocRFC2788Compliance MODULE-COMPLIANCE
 520     STATUS current
 521     DESCRIPTION
 522       "The compliance statement for RFC 2788 implementations
 523        which support the Network Services Monitoring MIB for
 524        basic monitoring of network service applications and
 525        their associations."
 526     MODULE
 527       MANDATORY-GROUPS {applRFC2788Group, assocRFC2788Group}
 528     ::= {applCompliances 6}
 529
 530 -- Units of conformance
 531
 532 applRFC1565Group OBJECT-GROUP
 533     OBJECTS {
 534       applName, applVersion, applUptime, applOperStatus,
 535       applLastChange, applInboundAssociations,
 536       applOutboundAssociations, applAccumulatedInboundAssociations,
 537       applAccumulatedOutboundAssociations, applLastInboundActivity,
 538       applLastOutboundActivity, applRejectedInboundAssociations,
 539       applFailedOutboundAssociations}
 540     STATUS obsolete
 541     DESCRIPTION
 542       "A collection of objects providing basic monitoring of
 543        network service applications.  This is the original set
 544        of such objects defined in RFC 1565."
 545     ::= {applGroups 7}
 546
 547 assocRFC1565Group OBJECT-GROUP
 548     OBJECTS {
 549
 550       assocRemoteApplication, assocApplicationProtocol,
 551       assocApplicationType, assocDuration}
 552     STATUS obsolete
 553     DESCRIPTION
 554       "A collection of objects providing basic monitoring of
 555        network service applications' associations.  This is the
 556        original set of such objects defined in RFC 1565."
 557     ::= {applGroups 2}
 558
 559 applRFC2248Group OBJECT-GROUP
 560     OBJECTS {
 561       applName, applVersion, applUptime, applOperStatus,
 562       applLastChange, applInboundAssociations,
 563       applOutboundAssociations, applAccumulatedInboundAssociations,
 564       applAccumulatedOutboundAssociations, applLastInboundActivity,
 565       applLastOutboundActivity, applRejectedInboundAssociations,
 566       applFailedOutboundAssociations, applDescription, applURL}
 567     STATUS deprecated
 568     DESCRIPTION
 569       "A collection of objects providing basic monitoring of
 570        network service applications.  This group was originally
 571        defined in RFC 2248; note that applDirectoryName is
 572        missing."
 573     ::= {applGroups 3}
 574
 575 assocRFC2248Group OBJECT-GROUP
 576     OBJECTS {
 577       assocRemoteApplication, assocApplicationProtocol,
 578       assocApplicationType, assocDuration}
 579     STATUS deprecated
 580     DESCRIPTION
 581       "A collection of objects providing basic monitoring of
 582        network service applications' associations.  This group
 583        was originally defined by RFC 2248."
 584     ::= {applGroups 4}
 585
 586 applRFC2788Group OBJECT-GROUP
 587     OBJECTS {
 588       applName, applDirectoryName, applVersion, applUptime,
 589       applOperStatus, applLastChange, applInboundAssociations,
 590       applOutboundAssociations, applAccumulatedInboundAssociations,
 591       applAccumulatedOutboundAssociations, applLastInboundActivity,
 592       applLastOutboundActivity, applRejectedInboundAssociations,
 593       applFailedOutboundAssociations, applDescription, applURL}
 594     STATUS current
 595     DESCRIPTION
 596       "A collection of objects providing basic monitoring of
 597        network service applications.  This is the appropriate
 598
 599        group for RFC 2788 -- it adds the applDirectoryName object
 600        missing in RFC 2248."
 601     ::= {applGroups 5}
 602
 603 assocRFC2788Group OBJECT-GROUP
 604     OBJECTS {
 605       assocRemoteApplication, assocApplicationProtocol,
 606       assocApplicationType, assocDuration}
 607     STATUS current
 608     DESCRIPTION
 609       "A collection of objects providing basic monitoring of
 610        network service applications' associations.  This is
 611        the appropriate group for RFC 2788."
 612     ::= {applGroups 6}
 613
 614 -- OIDs of the form {applTCPProtoID port} are intended to be used
 615 -- for TCP-based protocols that don't have OIDs assigned by other
 616 -- means. {applUDPProtoID port} serves the same purpose for
 617 -- UDP-based protocols. In either case 'port' corresponds to
 618 -- the primary port number being used by the protocol. For example,
 619 -- assuming no other OID is assigned for SMTP, an OID of
 620 -- {applTCPProtoID 25} could be used, since SMTP is a TCP-based
 621 -- protocol that uses port 25 as its primary port.
 622
 623 applTCPProtoID OBJECT IDENTIFIER ::= {application 4}
 624 applUDPProtoID OBJECT IDENTIFIER ::= {application 5}
 625
 626 END