mibs/ietf/SSPM-MIB

   1 SSPM-MIB DEFINITIONS ::= BEGIN
   2
   3    IMPORTS
   4
   5        MODULE-IDENTITY, OBJECT-TYPE,
   6        Counter32, Integer32, Unsigned32
   7                                    FROM SNMPv2-SMI  --[RFC2578]
   8
   9        TEXTUAL-CONVENTION, StorageType,
  10        TruthValue, RowStatus
  11                                    FROM SNMPv2-TC  --[RFC2579]
  12
  13        MODULE-COMPLIANCE, OBJECT-GROUP
  14                                    FROM SNMPv2-CONF --[RFC2578,
  15                                                     -- RFC2579,
  16                                                     -- RFC2580]
  17        OwnerString, rmon
  18                                    FROM RMON-MIB  --[RFC2819]
  19
  20        InetAddressType, InetAddress
  21                                    FROM INET-ADDRESS-MIB  --[RFC3291]
  22
  23
  24
  25
  26        InterfaceIndexOrZero
  27                                    FROM IF-MIB  --[RFC2863]
  28
  29        AppLocalIndex
  30                                    FROM APM-MIB  --[RFC3729]
  31
  32        Utf8String
  33                                    FROM SYSAPPL-MIB;  --[RFC2287]
  34
  35    sspmMIB MODULE-IDENTITY
  36        LAST-UPDATED "200507280000Z"  -- July 28, 2005
  37        ORGANIZATION "IETF RMON MIB working group"
  38        CONTACT-INFO
  39            "        Carl W. Kalbfleisch
  40                     Consultant
  41
  42             E-mail: ietf@kalbfleisch.us
  43
  44             Working group mailing list: rmonmib@ietf.org
  45             To subscribe send email to rmonmib-request@ietf.org"
  46        DESCRIPTION
  47            "This SSPM MIB module is applicable to probes
  48             implementing Synthetic Source for Performance
  49             Monitoring functions.
  50
  51             Copyright (C) The Internet Society (2005).  This version
  52             of this MIB module is part of RFC 4149; see the RFC
  53             itself for full legal notices."
  54
  55           -- revision history
  56
  57           REVISION    "200507280000Z"   -- July 28, 2005
  58           DESCRIPTION
  59               "The original version of this MIB module,
  60               was published as RFC4149."
  61           ::= { rmon 28 }
  62
  63 --
  64 -- Object Identifier Assignments
  65 --
  66 sspmMIBObjects       OBJECT IDENTIFIER ::= { sspmMIB 1 }
  67 sspmMIBNotifications OBJECT IDENTIFIER ::= { sspmMIB 2 }
  68 sspmMIBConformance   OBJECT IDENTIFIER ::= { sspmMIB 3 }
  69
  70 --
  71 -- Textual Conventions
  72 --
  73
  74
  75
  76
  77 SspmMicroSeconds ::= TEXTUAL-CONVENTION
  78     DISPLAY-HINT "d"
  79     STATUS current
  80     DESCRIPTION
  81         "A unit of time with resolution of MicroSeconds."
  82     SYNTAX Unsigned32
  83
  84 SspmClockSource ::= TEXTUAL-CONVENTION
  85     DISPLAY-HINT "d"
  86     STATUS current
  87     DESCRIPTION
  88         "An indication of the source of the clock as defined by the
  89          NTP specification RFC1305 [RFC1305] definition of stratum:
  90
  91          Stratum (sys.stratum, peer.stratum, pkt.stratum): This is
  92          an integer indicating the stratum of the local clock,
  93          with values defined as follows:
  94
  95          0      unspecified
  96
  97          1      primary reference (e.g., calibrated atomic clock,
  98                 radio clock)
  99
 100          2-255  secondary reference (via NTP)."
 101     REFERENCE
 102         "RFC1305."
 103     SYNTAX Integer32 (0..255)
 104
 105 SspmClockMaxSkew ::= TEXTUAL-CONVENTION
 106     DISPLAY-HINT "d"
 107     STATUS current
 108     -- UNITS "Seconds"
 109     DESCRIPTION
 110         "An indication of the accuracy of the clock as defined by
 111          RFC1305.  This variable indicates the maximum offset
 112          error due to skew of the local clock over the
 113          time interval 86400 seconds, in seconds."
 114     REFERENCE
 115         "RFC1305."
 116     SYNTAX Integer32 (1..65535)
 117
 118 --
 119 -- sspmGeneral
 120 --
 121 sspmGeneral           OBJECT IDENTIFIER ::= { sspmMIBObjects 1 }
 122 sspmGeneralClockResolution OBJECT-TYPE
 123     SYNTAX      SspmMicroSeconds
 124     MAX-ACCESS  read-only
 125
 126
 127
 128     STATUS      current
 129     -- UNITS       Microseconds
 130     DESCRIPTION
 131         "A read-only variable indicating the resolution
 132       of the measurements possible by this device."
 133     ::= { sspmGeneral 1 }
 134
 135 sspmGeneralClockMaxSkew OBJECT-TYPE
 136     SYNTAX SspmClockMaxSkew
 137     MAX-ACCESS read-only
 138     STATUS current
 139     -- UNITS Seconds
 140     DESCRIPTION
 141         "A read-only variable indicating the maximum offset
 142          error due to skew of the local clock over the
 143          time interval 86400 seconds, in seconds."
 144     ::= { sspmGeneral 2 }
 145
 146
 147 sspmGeneralClockSource OBJECT-TYPE
 148     SYNTAX SspmClockSource
 149     MAX-ACCESS  read-only
 150     STATUS      current
 151     DESCRIPTION
 152         "A read-only variable indicating the source of the clock.
 153          This is provided to allow a user to determine how accurate
 154          the timing mechanism is compared with other devices.  This
 155          is needed for the coordination of time values
 156          between probes for one-way measurements."
 157     ::= { sspmGeneral 3 }
 158
 159 sspmGeneralMinFrequency OBJECT-TYPE
 160     SYNTAX     SspmMicroSeconds
 161     MAX-ACCESS read-only
 162     -- units   MicroSeconds
 163     STATUS     current
 164     DESCRIPTION
 165          "A read-only variable that indicates the devices'
 166           capability for the minimum supported
 167           sspmSourceFrequency.  If sspmSourceFrequency is
 168           set to a value lower than the value reported
 169           by this attribute, then the set of sspmSourceFrequency
 170           will fail with an inconsistent value error."
 171     ::= { sspmGeneral 4 }
 172
 173 --
 174 -- sspmCapabilities
 175 --
 176
 177
 178
 179 -- Describes the capabilities of the SSPM device.
 180 --
 181 sspmCapabilitiesTable OBJECT-TYPE
 182     SYNTAX       SEQUENCE OF SspmCapabilitiesEntry
 183     MAX-ACCESS  not-accessible
 184     STATUS      current
 185     DESCRIPTION
 186         "The table of SSPM capabilities."
 187     ::= { sspmGeneral 5 }
 188
 189 sspmCapabilitiesEntry OBJECT-TYPE
 190     SYNTAX      SspmCapabilitiesEntry
 191     MAX-ACCESS  not-accessible
 192     STATUS      current
 193     DESCRIPTION
 194         "Details about a particular SSPM capability."
 195     INDEX { sspmCapabilitiesInstance }
 196     ::= { sspmCapabilitiesTable 1 }
 197
 198 SspmCapabilitiesEntry ::= SEQUENCE {
 199     sspmCapabilitiesInstance AppLocalIndex
 200     }
 201
 202 sspmCapabilitiesInstance OBJECT-TYPE
 203     SYNTAX      AppLocalIndex
 204     MAX-ACCESS  read-only
 205     STATUS      current
 206     DESCRIPTION
 207         "Indicates whether SSPM configuration of the corresponding
 208          AppLocalIndex is supported by this device.  Generally,
 209          entries in this table are only made by the device when the
 210          configuration of the measurement is available."
 211      ::= { sspmCapabilitiesEntry 1 }
 212
 213 --
 214 -- sspmSource
 215 --
 216 -- Contains the details of the source of the
 217 -- Synthetic Sources for Performance Monitoring algorithms.
 218 -- This information is split into two tables.  The first defines
 219 -- profiles that can be applied to specific sources in the
 220 -- control table.
 221 --
 222 sspmSource           OBJECT IDENTIFIER ::= { sspmMIBObjects 2 }
 223
 224 --
 225 -- sspmSourceProfileTable
 226 -- Defines template profiles for measurements.
 227
 228
 229
 230 --
 231 sspmSourceProfileTable OBJECT-TYPE
 232     SYNTAX       SEQUENCE OF SspmSourceProfileEntry
 233     MAX-ACCESS  not-accessible
 234     STATUS      current
 235     DESCRIPTION
 236         "The table of SSPM Source Profiles configured."
 237     ::= { sspmSource 1 }
 238
 239 sspmSourceProfileEntry OBJECT-TYPE
 240     SYNTAX      SspmSourceProfileEntry
 241     MAX-ACCESS  not-accessible
 242     STATUS      current
 243     DESCRIPTION
 244         "Details about a particular SSPM Source Profile
 245          configuration.  Entries must exist in this table
 246          in order to be referenced by rows in the
 247          sspmSourceControlTable."
 248     INDEX { sspmSourceProfileInstance }
 249     ::= { sspmSourceProfileTable 1 }
 250
 251 SspmSourceProfileEntry ::= SEQUENCE {
 252     sspmSourceProfileInstance           Unsigned32,
 253     sspmSourceProfileType               AppLocalIndex,
 254     sspmSourceProfilePacketSize         Unsigned32,
 255     sspmSourceProfilePacketFillType     INTEGER,
 256     sspmSourceProfilePacketFillValue    OCTET STRING,
 257     sspmSourceProfileTOS                Integer32,
 258     sspmSourceProfileFlowLabel          Integer32,
 259     sspmSourceProfileLooseSrcRteFill    OCTET STRING,
 260     sspmSourceProfileLooseSrcRteLen     Integer32,
 261     sspmSourceProfileTTL                Integer32,
 262     sspmSourceProfileNoFrag             TruthValue,
 263     sspmSourceProfile8021Tagging        Integer32,
 264     sspmSourceProfileUsername           Utf8String,
 265     sspmSourceProfilePassword           Utf8String,
 266     sspmSourceProfileParameter          OCTET STRING,
 267     sspmSourceProfileOwner              OwnerString,
 268     sspmSourceProfileStorageType        StorageType,
 269     sspmSourceProfileStatus             RowStatus
 270 }
 271
 272 sspmSourceProfileInstance OBJECT-TYPE
 273     SYNTAX      Unsigned32 (1..65535)
 274     MAX-ACCESS  not-accessible
 275     STATUS      current
 276     DESCRIPTION
 277         "An arbitrary index."
 278
 279
 280
 281      ::= { sspmSourceProfileEntry 1 }
 282
 283 sspmSourceProfileType OBJECT-TYPE
 284     SYNTAX      AppLocalIndex
 285     MAX-ACCESS  read-create
 286     STATUS      current
 287     DESCRIPTION
 288         "The AppLocalIndex value that uniquely identifies the
 289          measurement per the APM-MIB.  In order to create a row
 290          in this table, there must be a corresponding row in the
 291          sspmCapabilitiesTable.
 292
 293          When attempting to set this object, if no
 294          corresponding row exists in the sspmCapabilitiesTable,
 295          then the agent should return a 'badValue' error."
 296     ::= { sspmSourceProfileEntry 2}
 297
 298 sspmSourceProfilePacketSize OBJECT-TYPE
 299     SYNTAX      Unsigned32
 300     MAX-ACCESS  read-create
 301     STATUS      current
 302     DESCRIPTION
 303         "The size of packet to be transmitted in bytes.  The
 304          size accounts for all data within the IPv4 or IPv6
 305          payloads, excluding the IP headers, IP header options
 306          and link-level protocol headers.
 307
 308          If the size is set smaller than the minimum allowed
 309          packet size or greater than the maximum allowed
 310          packet size, then the set should fail, and the agent
 311          should return a 'badValue' error."
 312     ::= { sspmSourceProfileEntry 3 }
 313
 314 sspmSourceProfilePacketFillType OBJECT-TYPE
 315     SYNTAX      INTEGER {
 316                         random (1),
 317                         pattern (2),
 318                         url(3)
 319                 }
 320     MAX-ACCESS  read-create
 321     STATUS      current
 322     DESCRIPTION
 323         "Indicates how the packet is filled.
 324
 325          'random' indicates that the packet contains random
 326          data patterns.  This is probe and implementation
 327          dependent.
 328
 329
 330
 331
 332          'pattern' indicates that the pattern defined in the
 333          sspmSourceProfilePacketFillValue attribute is used to
 334          fill the packet.
 335
 336          'url' indicates that the value of
 337          sspmSourceProfilePacketFillValue should
 338          contain a URL.  The contents of the document
 339          at that URL are retrieved when sspmSourceStatus becomes
 340          active and utilized in the packet.  If the attempt to
 341          access that URL fails, then the row status is set to
 342          'notReady', and the set should fail with
 343          'inconsistentValue'.  This value must contain a
 344          dereferencable URL of the type 'http:', 'https:', or
 345          'ftp:' only."
 346     ::= { sspmSourceProfileEntry 4 }
 347
 348 sspmSourceProfilePacketFillValue OBJECT-TYPE
 349     SYNTAX      OCTET STRING (SIZE(0..255))
 350     MAX-ACCESS  read-create
 351     STATUS      current
 352     DESCRIPTION
 353         "The string value with which to fill the packet.  If
 354          sspmSourceProfilePacketFillType is set to 'pattern',
 355          then this pattern is repeated until the packet is
 356          sspmSourcePacketSize in bytes.  Note that if the
 357          length of the octet string specified for this
 358          value does not divide evenly into the packet
 359          size, then an incomplete last copy of this data
 360          may be copied into the packet.  If the value of
 361          sspmSourceProfilePacketFillType is set to 'random', then
 362          this attribute is unused.  If the value of the
 363          sspmSourceProfilePacketFillType is set to 'url', then
 364          the URL specified in this attribute is retrieved
 365          and used by the probe.  In the case of a URL, this value
 366          must contain a dereferencable URL of the type
 367          'http:', 'https:', or 'ftp:' only."
 368     ::= { sspmSourceProfileEntry 5 }
 369
 370 sspmSourceProfileTOS OBJECT-TYPE
 371     SYNTAX      Integer32 (0..255)
 372     MAX-ACCESS  read-create
 373     STATUS      current
 374     DESCRIPTION
 375         "Represents the TOS field in the IP packet header.  The
 376         value of this object defaults to zero if not set."
 377     DEFVAL { 0 }
 378     ::= { sspmSourceProfileEntry 6 }
 379
 380
 381
 382
 383 sspmSourceProfileFlowLabel OBJECT-TYPE
 384     SYNTAX      Integer32 (0..1048575) -- 20-bit range (0 to 0xfffff)
 385     MAX-ACCESS  read-create
 386     STATUS      current
 387     DESCRIPTION
 388         "This object is used to specify the Flow Label in a IPv6
 389          packet (RFC 2460) to force special handling by the IPv6
 390          routers; e.g., non-default quality-of-service handling.
 391
 392          This object is meaningful only when the object
 393          sspmSourceDestAddressType is IPv6(2).
 394          The value of this object defaults to zero if not set."
 395     DEFVAL { 0 }
 396     ::= { sspmSourceProfileEntry 7 }
 397
 398 sspmSourceProfileLooseSrcRteFill OBJECT-TYPE
 399     SYNTAX      OCTET STRING (SIZE(0..240))
 400     MAX-ACCESS  read-create
 401     STATUS      current
 402     DESCRIPTION
 403         "In the event that the test should run over a
 404          specific route, the intent is to force the route using the
 405          Loose Source Route option in IPv4 [RFC791] and
 406          IPv6 [RFC2460].  This object contains a
 407          series of IP addresses along the path that would be
 408          put into the loose source route option in the IP header.
 409
 410          The IPv4 addresses are to be listed as 32-bit
 411          address values, and the IPv6 addresses are to be
 412          listed as a string of 128-bit addresses.  The
 413          maximum length allowed within the IPv4 source route
 414          option is 63 addresses.  To simply account for
 415          IPv6 addresses as well, the maximum length of the
 416          octet string is 240.  This allows up to 60
 417          IPv4 addresses or up to 15 IPv6 addresses in the
 418          string."
 419     ::= { sspmSourceProfileEntry 8 }
 420
 421 sspmSourceProfileLooseSrcRteLen OBJECT-TYPE
 422     SYNTAX      Integer32(0..240)
 423     MAX-ACCESS  read-create
 424     STATUS      current
 425     DESCRIPTION
 426         "In the event that the test should run over a
 427          specific route, the intent is to force the route.
 428          This attribute specifies the length of data to
 429          be copied from the sspmSourceProfileLooseSrcRteFill
 430          into the route data fields of the loose source route
 431
 432
 433
 434          options in the IPv4 or IPv6 headers."
 435     ::= { sspmSourceProfileEntry 9 }
 436
 437 sspmSourceProfileTTL OBJECT-TYPE
 438     SYNTAX      Integer32(1..255)
 439     MAX-ACCESS  read-create
 440     STATUS      current
 441     DESCRIPTION
 442          "If non-zero, this specifies the value to place into
 443          the TTL field on transmission."
 444     ::= { sspmSourceProfileEntry 10 }
 445
 446 sspmSourceProfileNoFrag OBJECT-TYPE
 447     SYNTAX      TruthValue
 448     MAX-ACCESS  read-create
 449     STATUS      current
 450     DESCRIPTION
 451         "When true, the 'Don't Fragment Bit' should be set
 452          on the packet header."
 453     ::= { sspmSourceProfileEntry 11 }
 454
 455 sspmSourceProfile8021Tagging OBJECT-TYPE
 456     SYNTAX      Integer32 (-1..65535)
 457     MAX-ACCESS  read-create
 458     STATUS      current
 459     DESCRIPTION
 460         "IEEE 802.1Q tagging used in IEEE 802.1D bridged
 461         environments.
 462
 463         A value of -1 indicates that the packets are untagged.
 464
 465         A value of 0 to 65535 is the value of the tag to be
 466         inserted in the tagged packets.
 467
 468         Note that according to IEEE 802.1Q, VLAN-ID tags with
 469         a value of 4095 shall not be transmitted on the wire.
 470         As the VLAN-ID is encoded in the 12 least significant
 471         bits on the tag, values that translate in a binary
 472         representation of all 1's in the last 12 bits
 473         SHALL NOT be configured.  In this case, the set should
 474         fail, and return an error-status of 'inconsistentValue'."
 475     ::= { sspmSourceProfileEntry 12 }
 476
 477 sspmSourceProfileUsername OBJECT-TYPE
 478     SYNTAX      Utf8String
 479     MAX-ACCESS  read-create
 480     STATUS      current
 481     DESCRIPTION
 482
 483
 484
 485         "An optional username used by the application protocol."
 486     ::= { sspmSourceProfileEntry 13 }
 487
 488 sspmSourceProfilePassword OBJECT-TYPE
 489     SYNTAX      Utf8String
 490     MAX-ACCESS  read-create
 491     STATUS      current
 492     DESCRIPTION
 493         "An optional password used by the application protocol."
 494     ::= { sspmSourceProfileEntry 14 }
 495
 496 sspmSourceProfileParameter OBJECT-TYPE
 497     SYNTAX      OCTET STRING (SIZE(0..65535))
 498     MAX-ACCESS  read-create
 499     STATUS      current
 500     DESCRIPTION
 501          "An optional parameter used by the application protocol.
 502          For DNS, this would be the hostname or IP.  For HTTP,
 503          this would be the URL.  For nntp, this would be the
 504          news group.  For TCP, this would be the port number.
 505          For SMTP, this would be the recipient (and could
 506          assume the message is predefined)."
 507     ::= { sspmSourceProfileEntry 15 }
 508
 509 sspmSourceProfileOwner OBJECT-TYPE
 510     SYNTAX      OwnerString
 511     MAX-ACCESS  read-create
 512     STATUS      current
 513     DESCRIPTION
 514         "Name of the management station/application that
 515         set up the profile."
 516     ::= { sspmSourceProfileEntry 16 }
 517
 518 sspmSourceProfileStorageType OBJECT-TYPE
 519     SYNTAX      StorageType
 520     MAX-ACCESS  read-create
 521     STATUS      current
 522     DESCRIPTION
 523         "The storage type of this sspmSourceProfileEntry.  If the
 524         value of this object is 'permanent', no objects in this row
 525         need to be writable."
 526     ::= { sspmSourceProfileEntry 17 }
 527
 528 sspmSourceProfileStatus OBJECT-TYPE
 529     SYNTAX      RowStatus
 530     MAX-ACCESS  read-create
 531     STATUS      current
 532     DESCRIPTION
 533
 534
 535
 536         "Status of this profile.
 537
 538         An entry may not exist in the active state unless all
 539         objects in the entry have an appropriate value.
 540
 541         Once this object is set to active(1), no objects in the
 542         sspmSourceProfileTable can be changed."
 543     ::= { sspmSourceProfileEntry 18 }
 544
 545 --
 546 -- sspmSourceControlTable
 547 -- Defines specific measurement instances based on template
 548 -- profiles in the sspmSourceProfileTable which must be
 549 -- pre-configured.
 550 --
 551
 552 sspmSourceControlTable OBJECT-TYPE
 553     SYNTAX       SEQUENCE OF SspmSourceControlEntry
 554     MAX-ACCESS  not-accessible
 555     STATUS      current
 556     DESCRIPTION
 557         "The table of SSPM measurements configured."
 558     ::= { sspmSource 2 }
 559
 560 sspmSourceControlEntry OBJECT-TYPE
 561     SYNTAX      SspmSourceControlEntry
 562     MAX-ACCESS  not-accessible
 563     STATUS      current
 564     DESCRIPTION
 565         "Details about a particular SSPM configuration."
 566     INDEX { sspmSourceControlInstance }
 567     ::= { sspmSourceControlTable 1 }
 568
 569 SspmSourceControlEntry ::= SEQUENCE {
 570     sspmSourceControlInstance          Unsigned32,
 571     sspmSourceControlProfile           Integer32,
 572     sspmSourceControlSrc               InterfaceIndexOrZero,
 573     sspmSourceControlDestAddrType      InetAddressType,
 574     sspmSourceControlDestAddr          InetAddress,
 575     sspmSourceControlEnabled           TruthValue,
 576     sspmSourceControlTimeOut           SspmMicroSeconds,
 577     sspmSourceControlSamplingDist      INTEGER,
 578     sspmSourceControlFrequency         SspmMicroSeconds,
 579     sspmSourceControlFirstSeqNum       Unsigned32,
 580     sspmSourceControlLastSeqNum        Unsigned32,
 581     sspmSourceControlOwner             OwnerString,
 582     sspmSourceControlStorageType       StorageType,
 583     sspmSourceControlStatus            RowStatus
 584
 585
 586
 587 }
 588
 589 sspmSourceControlInstance OBJECT-TYPE
 590     SYNTAX      Unsigned32 (1..65535)
 591     MAX-ACCESS  not-accessible
 592     STATUS      current
 593     DESCRIPTION
 594         "An arbitrary index."
 595      ::= { sspmSourceControlEntry 1 }
 596
 597 sspmSourceControlProfile OBJECT-TYPE
 598     SYNTAX      Integer32 (1..65535)
 599     MAX-ACCESS  read-create
 600     STATUS      current
 601     DESCRIPTION
 602         "A pointer to the profile (sspmSourceProfileEntry) that
 603          this control entry uses to define the test being
 604          performed."
 605      ::= { sspmSourceControlEntry 2 }
 606
 607 sspmSourceControlSrc OBJECT-TYPE
 608     SYNTAX      InterfaceIndexOrZero
 609     MAX-ACCESS  read-create
 610     STATUS      current
 611     DESCRIPTION
 612         "The ifIndex where the packet should originate from the
 613          probe (if it matters).  A value of zero indicates that
 614          it does not matter and that the device decides."
 615     ::= { sspmSourceControlEntry 3 }
 616
 617 sspmSourceControlDestAddrType OBJECT-TYPE
 618     SYNTAX      InetAddressType
 619     MAX-ACCESS  read-create
 620     STATUS      current
 621     DESCRIPTION
 622         "The type of Internet address by which the destination
 623          is accessed."
 624     ::= { sspmSourceControlEntry 4 }
 625
 626 sspmSourceControlDestAddr OBJECT-TYPE
 627     SYNTAX      InetAddress
 628     MAX-ACCESS  read-create
 629     STATUS      current
 630     DESCRIPTION
 631         "The Internet address for the destination.  The formatting
 632         of this object is controlled by the
 633         sspmSourceControlDestAddrType object above.
 634
 635
 636
 637
 638         When this object contains a DNS name, then the name is
 639         resolved to an address each time measurement is to be made.
 640         Further, the agent should not cache this address,
 641         but instead should perform the resolution prior to each
 642         measurement."
 643     ::= { sspmSourceControlEntry 5 }
 644
 645 sspmSourceControlEnabled OBJECT-TYPE
 646     SYNTAX      TruthValue
 647     MAX-ACCESS  read-create
 648     STATUS      current
 649     DESCRIPTION
 650         "When set to 'true', this test is enabled.  When set to
 651          'false', it is disabled."
 652     ::= { sspmSourceControlEntry 6 }
 653
 654 sspmSourceControlTimeOut OBJECT-TYPE
 655     SYNTAX      SspmMicroSeconds
 656     MAX-ACCESS  read-create
 657     STATUS      current
 658     DESCRIPTION
 659         "Timeout value for the measurement response.  If no
 660          response is received in the time specified, then
 661          the test fails."
 662     ::= { sspmSourceControlEntry 7 }
 663
 664 sspmSourceControlSamplingDist OBJECT-TYPE
 665     SYNTAX      INTEGER {
 666                          deterministic(1),
 667                          poisson(2)
 668                 }
 669     MAX-ACCESS  read-create
 670     STATUS      current
 671     DESCRIPTION
 672         "When this attribute is set to 'deterministic', then
 673          packets are generated at with a fixed inter-packet
 674          injection time specified by sspmSourceFrequency.
 675
 676          When this attribute is set to 'Poisson', then packets
 677          are generated with inter-packet injection times sampled
 678          from an exponential distribution with the single
 679          distributional parameter determined by the inverse
 680          frequency)."
 681     ::= { sspmSourceControlEntry 8 }
 682
 683 sspmSourceControlFrequency OBJECT-TYPE
 684     SYNTAX      SspmMicroSeconds
 685     MAX-ACCESS  read-create
 686
 687
 688
 689     STATUS      current
 690     DESCRIPTION
 691         "The inverse of this value is the rate at which packets
 692          are generated.  Refer to sspmSourceSamplingDistribution.
 693          If the value set is less than the value of
 694          sspmGeneralMinFrequency, then the set will fail with an
 695          error-status of 'inconsistentValue'."
 696     ::= { sspmSourceControlEntry 9 }
 697
 698 sspmSourceControlFirstSeqNum OBJECT-TYPE
 699     SYNTAX      Unsigned32
 700     MAX-ACCESS  read-create
 701     STATUS      current
 702     DESCRIPTION
 703         "The first sequence number of packets to be transmitted."
 704     ::= { sspmSourceControlEntry 10 }
 705
 706 sspmSourceControlLastSeqNum OBJECT-TYPE
 707     SYNTAX      Unsigned32
 708     MAX-ACCESS  read-only
 709     STATUS      current
 710     DESCRIPTION
 711         "The last sequence number transmitted.  This value is updated
 712          by the agent after packet generation."
 713     ::= { sspmSourceControlEntry 11 }
 714
 715 sspmSourceControlOwner OBJECT-TYPE
 716     SYNTAX      OwnerString
 717     MAX-ACCESS  read-create
 718     STATUS      current
 719     DESCRIPTION
 720         "Name of the management station/application that set
 721         up the test."
 722     ::= { sspmSourceControlEntry 12 }
 723
 724 sspmSourceControlStorageType OBJECT-TYPE
 725     SYNTAX      StorageType
 726     MAX-ACCESS  read-create
 727     STATUS      current
 728     DESCRIPTION
 729         "The storage type of this sspmSourceControlEntry.  If the
 730         value of this object is 'permanent', no objects in this row
 731         need to be writable."
 732     ::= { sspmSourceControlEntry 13 }
 733
 734 sspmSourceControlStatus OBJECT-TYPE
 735     SYNTAX      RowStatus
 736     MAX-ACCESS  read-create
 737
 738
 739
 740     STATUS      current
 741     DESCRIPTION
 742         "Status of this source control entry.
 743
 744         An entry may not exist in the active state unless all
 745         objects in the entry have an appropriate value.
 746
 747         When this attribute has the value of
 748         'active', none of the read-write or read-create attributes
 749         in this table may be modified, with the exception of
 750         sspmSourceControlEnabled."
 751     ::= { sspmSourceControlEntry 14 }
 752
 753 --
 754 -- sspmSinkTable
 755 --
 756 -- Contains attributes for configuration of Synthetic
 757 -- Sources for Performance Monitoring sinks, i.e.,
 758 -- sinks for receipt of one-way delay measurements.
 759 --
 760 sspmSink           OBJECT IDENTIFIER ::= { sspmMIBObjects 5 }
 761
 762 sspmSinkTable OBJECT-TYPE
 763     SYNTAX       SEQUENCE OF SspmSinkEntry
 764     MAX-ACCESS  not-accessible
 765     STATUS      current
 766     DESCRIPTION
 767         "A table configuring the sink for measurements."
 768     ::= { sspmSink 1 }
 769
 770 sspmSinkEntry OBJECT-TYPE
 771     SYNTAX      SspmSinkEntry
 772     MAX-ACCESS  not-accessible
 773     STATUS      current
 774     DESCRIPTION
 775         "The details of a particular sink entry.  If the measurement
 776          is a round-trip type, then the sink entry will be on the
 777          same probe as the corresponding sspmSourceEntry.  If the
 778          measurement is a one-way, type then the sink entry will be
 779          on a different probe."
 780     INDEX { sspmSinkInstance }
 781     ::= { sspmSinkTable 1}
 782
 783 SspmSinkEntry ::= SEQUENCE {
 784     sspmSinkInstance                       Unsigned32,
 785     sspmSinkType                           AppLocalIndex,
 786     sspmSinkSourceAddressType              InetAddressType,
 787     sspmSinkSourceAddress                  InetAddress,
 788
 789
 790
 791     sspmSinkExpectedRate                   SspmMicroSeconds,
 792     sspmSinkEnable                         TruthValue,
 793     sspmSinkExpectedFirstSequenceNum       Unsigned32,
 794     sspmSinkLastSequenceNumber             Unsigned32,
 795     sspmSinkLastSequenceInvalid            Counter32,
 796     sspmSinkStorageType                    StorageType,
 797     sspmSinkStatus                         RowStatus
 798 }
 799
 800 sspmSinkInstance OBJECT-TYPE
 801     SYNTAX      Unsigned32 (1..65535)
 802     MAX-ACCESS  not-accessible
 803     STATUS      current
 804     DESCRIPTION
 805         "An index.  When the measurement is for a round-trip
 806          measurement, then this table entry is on the same probe as
 807          the corresponding sspmSourceEntry, and the value of this
 808          attribute should correspond to the value of
 809          sspmSourceInstance.  Management applications configuring
 810          sinks for one-way measurements could define some
 811          scheme whereby the sspmSinkInstance is unique across
 812          all probes.  Note that the unique key to this entry is
 813          also constructed with sspmSinkType,
 814          sspmSinkSourceAddressType, and sspmSinkSourceAddress.
 815          To make the implementation simpler, those other
 816          attributes are not included in the index but uniqueness
 817          is still needed to receive all the packets."
 818      ::= { sspmSinkEntry 1 }
 819
 820 sspmSinkType OBJECT-TYPE
 821     SYNTAX      AppLocalIndex
 822     MAX-ACCESS  read-create
 823     STATUS      current
 824     DESCRIPTION
 825         "The AppLocalIndex value that uniquely identifies the
 826          measurement per the APM-MIB.  In order to create a row
 827          in this table, there must be a corresponding row in the
 828          sspmCapabilitiesTable.  If there is no corresponding
 829          row in the sspmCapabilitiestable, then the agent will
 830          return an error-status of 'inconsistentValue'."
 831     ::= { sspmSinkEntry 2}
 832
 833 sspmSinkSourceAddressType OBJECT-TYPE
 834     SYNTAX      InetAddressType
 835     MAX-ACCESS  read-create
 836     STATUS      current
 837     DESCRIPTION
 838         "The type of Internet address of the source."
 839
 840
 841
 842     ::= { sspmSinkEntry 3 }
 843
 844 sspmSinkSourceAddress OBJECT-TYPE
 845     SYNTAX      InetAddress
 846     MAX-ACCESS  read-create
 847     STATUS      current
 848     DESCRIPTION
 849         "The Internet address of the source.  The formatting
 850         of this object is controlled by the sspmSinkSourceAddressType
 851         object above.
 852
 853         This object should be set only to a valid device address
 854         that has been administratively configured into the
 855         device.  If a set attempts to set this object to an
 856         address that does not belong (i.e., is not administratively
 857         configured into the device), the set should fail, and the
 858         agent should return a error-status of 'inconsistentValue'."
 859     ::= { sspmSinkEntry 4 }
 860
 861 sspmSinkExpectedRate OBJECT-TYPE
 862     SYNTAX      SspmMicroSeconds
 863     MAX-ACCESS  read-create
 864     STATUS      current
 865     DESCRIPTION
 866         "The expected rate at which packets will arrive."
 867     ::= { sspmSinkEntry 5 }
 868
 869 sspmSinkEnable OBJECT-TYPE
 870     SYNTAX      TruthValue
 871     MAX-ACCESS  read-create
 872     STATUS      current
 873     DESCRIPTION
 874         "Indicates if the sink is enabled or not."
 875     ::= { sspmSinkEntry 6 }
 876
 877 sspmSinkExpectedFirstSequenceNum OBJECT-TYPE
 878     SYNTAX      Unsigned32
 879     MAX-ACCESS  read-create
 880     STATUS      current
 881     DESCRIPTION
 882         "The expected first sequence number of packets.
 883          This is used by the sink to determine if packets
 884          were lost at the initiation of the test."
 885     ::= { sspmSinkEntry 7 }
 886
 887 sspmSinkLastSequenceNumber OBJECT-TYPE
 888     SYNTAX      Unsigned32
 889     MAX-ACCESS  read-only
 890
 891
 892
 893     STATUS      current
 894     DESCRIPTION
 895         "The last sequence number received."
 896     ::= { sspmSinkEntry 8 }
 897
 898 sspmSinkLastSequenceInvalid OBJECT-TYPE
 899     SYNTAX      Counter32
 900     MAX-ACCESS  read-only
 901     STATUS      current
 902     DESCRIPTION
 903         "The number of packets that arrived whose
 904          sequence number was not one plus the value of
 905          sspmSinkLastSequenceNumber."
 906     ::= { sspmSinkEntry 9 }
 907
 908 sspmSinkStorageType OBJECT-TYPE
 909     SYNTAX      StorageType
 910     MAX-ACCESS  read-create
 911     STATUS      current
 912     DESCRIPTION
 913         "The storage type of this sspmSinkEntry.  If the value
 914         of this object is 'permanent', no objects in this row
 915         need to be writable."
 916     ::= { sspmSinkEntry 10 }
 917
 918 sspmSinkStatus OBJECT-TYPE
 919     SYNTAX       RowStatus
 920     MAX-ACCESS  read-create
 921     STATUS      current
 922     DESCRIPTION
 923          "Status of this conceptual row.
 924          An entry may not exist in the active state unless all
 925          objects in the entry have an appropriate value.
 926
 927          Once this object is set to active(1), no objects with
 928          MAX-ACCESS of read-create in the sspmSinkTable can
 929          be changed."
 930     ::= { sspmSinkEntry 11 }
 931
 932 --
 933 -- Notifications
 934 --
 935
 936 --
 937 -- Conformance information
 938 --
 939 sspmCompliances OBJECT IDENTIFIER ::= { sspmMIBConformance 1 }
 940 sspmGroups      OBJECT IDENTIFIER ::= { sspmMIBConformance 2 }
 941
 942
 943
 944 -- Compliance Statements
 945 sspmGeneralCompliance MODULE-COMPLIANCE
 946   STATUS current
 947   DESCRIPTION
 948     "A general compliance that allows all things to be optional."
 949   MODULE -- this module
 950
 951   MANDATORY-GROUPS { sspmGeneralGroup }
 952
 953   GROUP sspmSourceGroup
 954   DESCRIPTION
 955     "The SSPM Source Group is optional."
 956
 957   GROUP sspmSinkGroup
 958   DESCRIPTION
 959     "The SSPM Sink Group is optional."
 960
 961   GROUP sspmUserPassGroup
 962   DESCRIPTION
 963     "The SSPM User Pass Group is optional."
 964
 965   ::= { sspmCompliances 1 }
 966
 967 --
 968 -- SSPM Source Compliance
 969 --
 970 sspmSourceFullCompliance MODULE-COMPLIANCE
 971   STATUS current
 972   DESCRIPTION
 973     "A source compliance.  Use this compliance when implementing
 974      a traffic-source-only device.  This is useful for implementing
 975      devices that probe other devices for intrusive application
 976      monitoring.  It is also useful for implementing the source
 977      of one-way tests used with a sink-only device."
 978   MODULE -- this module
 979
 980   MANDATORY-GROUPS { sspmGeneralGroup, sspmSourceGroup }
 981
 982   GROUP sspmUserPassGroup
 983   DESCRIPTION
 984     "The SSPM User Pass Group is optional."
 985   ::= { sspmCompliances 2 }
 986
 987 --
 988 -- SSPM Sink Compliance
 989 --
 990 sspmSinkFullCompliance MODULE-COMPLIANCE
 991   STATUS current
 992
 993
 994
 995   DESCRIPTION
 996     "A sink-only compliance.  Use this compliance when implementing a
 997      sink-only device.  This is useful for devices to receive one-way
 998      measurements."
 999   MODULE -- this module
1000
1001   MANDATORY-GROUPS { sspmGeneralGroup, sspmSinkGroup }
1002
1003   ::= { sspmCompliances 3 }
1004
1005 --
1006 -- Groups
1007 --
1008 sspmGeneralGroup OBJECT-GROUP
1009     OBJECTS {
1010     sspmGeneralClockResolution,
1011     sspmGeneralClockMaxSkew,
1012     sspmGeneralClockSource,
1013     sspmGeneralMinFrequency,
1014     sspmCapabilitiesInstance
1015     }
1016     STATUS      current
1017     DESCRIPTION
1018         "The objects in the SSPM General Group."
1019     ::= { sspmGroups 1 }
1020
1021 sspmSourceGroup OBJECT-GROUP
1022     OBJECTS {
1023     sspmSourceProfileType,
1024     sspmSourceProfilePacketSize,
1025     sspmSourceProfilePacketFillType,
1026     sspmSourceProfilePacketFillValue,
1027     sspmSourceProfileTOS,
1028     sspmSourceProfileFlowLabel,
1029     sspmSourceProfileLooseSrcRteFill,
1030     sspmSourceProfileLooseSrcRteLen,
1031     sspmSourceProfileTTL,
1032     sspmSourceProfileNoFrag,
1033     sspmSourceProfile8021Tagging,
1034     sspmSourceProfileUsername,
1035     sspmSourceProfilePassword,
1036     sspmSourceProfileParameter,
1037     sspmSourceProfileOwner,
1038     sspmSourceProfileStorageType,
1039     sspmSourceProfileStatus,
1040     sspmSourceControlProfile,
1041     sspmSourceControlSrc,
1042     sspmSourceControlDestAddrType,
1043
1044
1045
1046     sspmSourceControlDestAddr,
1047     sspmSourceControlEnabled,
1048     sspmSourceControlTimeOut,
1049     sspmSourceControlSamplingDist,
1050     sspmSourceControlFrequency,
1051     sspmSourceControlFirstSeqNum,
1052     sspmSourceControlLastSeqNum,
1053     sspmSourceControlOwner,
1054     sspmSourceControlStorageType,
1055     sspmSourceControlStatus
1056     }
1057     STATUS      current
1058     DESCRIPTION
1059         "The objects in the SSPM Source Group."
1060     ::= { sspmGroups 2 }
1061
1062 sspmUserPassGroup OBJECT-GROUP
1063     OBJECTS {
1064     sspmSourceProfileUsername,
1065     sspmSourceProfilePassword
1066     }
1067     STATUS      current
1068     DESCRIPTION
1069         "The objects in the SSPM Username and password group."
1070     ::= { sspmGroups 3 }
1071
1072 sspmSinkGroup OBJECT-GROUP
1073     OBJECTS {
1074     sspmSinkType,
1075     sspmSinkSourceAddressType,
1076     sspmSinkSourceAddress,
1077     sspmSinkExpectedRate,
1078     sspmSinkEnable,
1079     sspmSinkExpectedFirstSequenceNum,
1080     sspmSinkLastSequenceNumber,
1081     sspmSinkLastSequenceInvalid,
1082     sspmSinkStorageType,
1083     sspmSinkStatus
1084     }
1085     STATUS      current
1086     DESCRIPTION
1087         "The objects in the SSPM Sink Group."
1088     ::= { sspmGroups 4 }
1089
1090 END