Leaked source code of windows server 2003
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

4057 lines
166 KiB

  1. RMON-MIB DEFINITIONS ::= BEGIN
  2. IMPORTS
  3. Counter FROM RFC1155-SMI
  4. DisplayString FROM RFC1158-MIB
  5. mib-2 FROM RFC1213-MIB
  6. OBJECT-TYPE FROM RFC-1212
  7. TRAP-TYPE FROM RFC-1215;
  8. -- Remote Network Monitoring MIB
  9. rmon OBJECT IDENTIFIER ::= { mib-2 16 }
  10. -- textual conventions
  11. OwnerString ::= DisplayString
  12. -- This data type is used to model an administratively
  13. -- assigned name of the owner of a resource. This
  14. -- information is taken from the NVT ASCII character
  15. -- set. It is suggested that this name contain one or
  16. -- more of the following: IP address, management station
  17. -- name, network manager's name, location, or phone
  18. -- number.
  19. -- In some cases the agent itself will be the owner of
  20. -- an entry. In these cases, this string shall be set
  21. -- to a string starting with 'monitor'.
  22. --
  23. -- SNMP access control is articulated entirely in terms
  24. -- of the contents of MIB views; access to a particular
  25. -- SNMP object instance depends only upon its presence
  26. -- or absence in a particular MIB view and never upon
  27. -- its value or the value of related object instances.
  28. -- Thus, objects of this type afford resolution of
  29. -- resource contention only among cooperating managers;
  30. -- they realize no access control function with respect
  31. -- to uncooperative parties.
  32. --
  33. -- By convention, objects with this syntax are declared as
  34. -- having
  35. --
  36. -- SIZE (0..127)
  37. EntryStatus ::= INTEGER
  38. { valid(1),
  39. createRequest(2),
  40. underCreation(3),
  41. invalid(4)
  42. }
  43. -- The status of a table entry.
  44. --
  45. -- Setting this object to the value invalid(4) has the
  46. -- effect of invalidating the corresponding entry.
  47. -- That is, it effectively disassociates the mapping
  48. -- identified with said entry.
  49. -- It is an implementation-specific matter as to whether
  50. -- the agent removes an invalidated entry from the table.
  51. -- Accordingly, management stations must be prepared to
  52. -- receive tabular information from agents that
  53. -- corresponds to entries currently not in use. Proper
  54. -- interpretation of such entries requires examination
  55. -- of the relevant EntryStatus object.
  56. --
  57. -- An existing instance of this object cannot be set to
  58. -- createRequest(2). This object may only be set to
  59. -- createRequest(2) when this instance is created. When
  60. -- this object is created, the agent may wish to create
  61. -- supplemental object instances with default values
  62. -- to complete a conceptual row in this table. Because
  63. -- the creation of these default objects is entirely at
  64. -- the option of the agent, the manager must not assume
  65. -- that any will be created, but may make use of any that
  66. -- are created. Immediately after completing the create
  67. -- operation, the agent must set this object to
  68. -- underCreation(3).
  69. --
  70. -- When in the underCreation(3) state, an entry is
  71. -- allowed to exist in a possibly incomplete, possibly
  72. -- inconsistent state, usually to allow it to be
  73. -- modified in mutiple PDUs. When in this state, an
  74. -- entry is not fully active. Entries shall exist in
  75. -- the underCreation(3) state until the management
  76. -- station is finished configuring the entry and sets
  77. -- this object to valid(1) or aborts, setting this
  78. -- object to invalid(4). If the agent determines that
  79. -- an entry has been in the underCreation(3) state for
  80. -- an abnormally long time, it may decide that the
  81. -- management station has crashed. If the agent makes
  82. -- this decision, it may set this object to invalid(4)
  83. -- to reclaim the entry. A prudent agent will
  84. -- understand that the management station may need to
  85. -- wait for human input and will allow for that
  86. -- possibility in its determination of this abnormally
  87. -- long period.
  88. --
  89. -- An entry in the valid(1) state is fully configured and
  90. -- consistent and fully represents the configuration or
  91. -- operation such a row is intended to represent. For
  92. -- example, it could be a statistical function that is
  93. -- configured and active, or a filter that is available
  94. -- in the list of filters processed by the packet capture
  95. -- process.
  96. --
  97. -- A manager is restricted to changing the state of an
  98. -- entry in the following ways:
  99. --
  100. -- create under
  101. -- To: valid Request Creation invalid
  102. -- From:
  103. -- valid OK NO OK OK
  104. -- createRequest N/A N/A N/A N/A
  105. -- underCreation OK NO OK OK
  106. -- invalid NO NO NO OK
  107. -- nonExistent NO OK NO OK
  108. --
  109. -- In the table above, it is not applicable to move the
  110. -- state from the createRequest state to any other
  111. -- state because the manager will never find the
  112. -- variable in that state. The nonExistent state is
  113. -- not a value of the enumeration, rather it means that
  114. -- the entryStatus variable does not exist at all.
  115. --
  116. -- An agent may allow an entryStatus variable to change
  117. -- state in additional ways, so long as the semantics
  118. -- of the states are followed. This allowance is made
  119. -- to ease the implementation of the agent and is made
  120. -- despite the fact that managers should never
  121. -- excercise these additional state transitions.
  122. statistics OBJECT IDENTIFIER ::= { rmon 1 }
  123. history OBJECT IDENTIFIER ::= { rmon 2 }
  124. alarm OBJECT IDENTIFIER ::= { rmon 3 }
  125. hosts OBJECT IDENTIFIER ::= { rmon 4 }
  126. hostTopN OBJECT IDENTIFIER ::= { rmon 5 }
  127. matrix OBJECT IDENTIFIER ::= { rmon 6 }
  128. filter OBJECT IDENTIFIER ::= { rmon 7 }
  129. capture OBJECT IDENTIFIER ::= { rmon 8 }
  130. event OBJECT IDENTIFIER ::= { rmon 9 }
  131. -- The Ethernet Statistics Group
  132. --
  133. -- Implementation of the Ethernet Statistics group is
  134. -- optional.
  135. --
  136. -- The ethernet statistics group contains statistics
  137. -- measured by the probe for each monitored interface on
  138. -- this device. These statistics take the form of free
  139. -- running counters that start from zero when a valid entry
  140. -- is created.
  141. --
  142. -- This group currently has statistics defined only for
  143. -- Ethernet interfaces. Each etherStatsEntry contains
  144. -- statistics for one Ethernet interface. The probe must
  145. -- create one etherStats entry for each monitored Ethernet
  146. -- interface on the device.
  147. etherStatsTable OBJECT-TYPE
  148. SYNTAX SEQUENCE OF EtherStatsEntry
  149. ACCESS not-accessible
  150. STATUS mandatory
  151. DESCRIPTION
  152. "A list of Ethernet statistics entries."
  153. ::= { statistics 1 }
  154. etherStatsEntry OBJECT-TYPE
  155. SYNTAX EtherStatsEntry
  156. ACCESS not-accessible
  157. STATUS mandatory
  158. DESCRIPTION
  159. "A collection of statistics kept for a particular
  160. Ethernet interface. As an example, an instance of the
  161. etherStatsPkts object might be named etherStatsPkts.1"
  162. INDEX { etherStatsIndex }
  163. ::= { etherStatsTable 1 }
  164. EtherStatsEntry ::= SEQUENCE {
  165. etherStatsIndex INTEGER (1..65535),
  166. etherStatsDataSource OBJECT IDENTIFIER,
  167. etherStatsDropEvents Counter,
  168. etherStatsOctets Counter,
  169. etherStatsPkts Counter,
  170. etherStatsBroadcastPkts Counter,
  171. etherStatsMulticastPkts Counter,
  172. etherStatsCRCAlignErrors Counter,
  173. etherStatsUndersizePkts Counter,
  174. etherStatsOversizePkts Counter,
  175. etherStatsFragments Counter,
  176. etherStatsJabbers Counter,
  177. etherStatsCollisions Counter,
  178. etherStatsPkts64Octets Counter,
  179. etherStatsPkts65to127Octets Counter,
  180. etherStatsPkts128to255Octets Counter,
  181. etherStatsPkts256to511Octets Counter,
  182. etherStatsPkts512to1023Octets Counter,
  183. etherStatsPkts1024to1518Octets Counter,
  184. etherStatsOwner OwnerString,
  185. etherStatsStatus EntryStatus
  186. }
  187. etherStatsIndex OBJECT-TYPE
  188. SYNTAX INTEGER (1..65535)
  189. ACCESS read-only
  190. STATUS mandatory
  191. DESCRIPTION
  192. "The value of this object uniquely identifies this
  193. etherStats entry."
  194. ::= { etherStatsEntry 1 }
  195. etherStatsDataSource OBJECT-TYPE
  196. SYNTAX OBJECT IDENTIFIER
  197. ACCESS read-write
  198. STATUS mandatory
  199. DESCRIPTION
  200. "This object identifies the source of the data that
  201. this etherStats entry is configured to analyze. This
  202. source can be any ethernet interface on this device.
  203. In order to identify a particular interface, this
  204. object shall identify the instance of the ifIndex
  205. object, defined in RFC 1213 and RFC 1573 [4,6], for
  206. the desired interface. For example, if an entry
  207. were to receive data from interface #1, this object
  208. would be set to ifIndex.1.
  209. The statistics in this group reflect all packets
  210. on the local network segment attached to the
  211. identified interface.
  212. An agent may or may not be able to tell if
  213. fundamental changes to the media of the interface
  214. have occurred and necessitate an invalidation of
  215. this entry. For example, a hot-pluggable ethernet
  216. card could be pulled out and replaced by a
  217. token-ring card. In such a case, if the agent has
  218. such knowledge of the change, it is recommended that
  219. it invalidate this entry.
  220. This object may not be modified if the associated
  221. etherStatsStatus object is equal to valid(1)."
  222. ::= { etherStatsEntry 2 }
  223. etherStatsDropEvents OBJECT-TYPE
  224. SYNTAX Counter
  225. ACCESS read-only
  226. STATUS mandatory
  227. DESCRIPTION
  228. "The total number of events in which packets
  229. were dropped by the probe due to lack of resources.
  230. Note that this number is not necessarily the number of
  231. packets dropped; it is just the number of times this
  232. condition has been detected."
  233. ::= { etherStatsEntry 3 }
  234. etherStatsOctets OBJECT-TYPE
  235. SYNTAX Counter
  236. ACCESS read-only
  237. STATUS mandatory
  238. DESCRIPTION
  239. "The total number of octets of data (including
  240. those in bad packets) received on the
  241. network (excluding framing bits but including
  242. FCS octets).
  243. This object can be used as a reasonable estimate of
  244. ethernet utilization. If greater precision is
  245. desired, the etherStatsPkts and etherStatsOctets
  246. objects should be sampled before and after a common
  247. interval. The differences in the sampled values are
  248. Pkts and Octets, respectively, and the number of
  249. seconds in the interval is Interval. These values
  250. are used to calculate the Utilization as follows:
  251. Pkts * (9.6 + 6.4) + (Octets * .8)
  252. Utilization = -------------------------------------
  253. Interval * 10,000
  254. The result of this equation is the value Utilization
  255. which is the percent utilization of the ethernet
  256. segment on a scale of 0 to 100 percent."
  257. ::= { etherStatsEntry 4 }
  258. etherStatsPkts OBJECT-TYPE
  259. SYNTAX Counter
  260. ACCESS read-only
  261. STATUS mandatory
  262. DESCRIPTION
  263. "The total number of packets (including bad packets,
  264. broadcast packets, and multicast packets) received."
  265. ::= { etherStatsEntry 5 }
  266. etherStatsBroadcastPkts OBJECT-TYPE
  267. SYNTAX Counter
  268. ACCESS read-only
  269. STATUS mandatory
  270. DESCRIPTION
  271. "The total number of good packets received that were
  272. directed to the broadcast address. Note that this
  273. does not include multicast packets."
  274. ::= { etherStatsEntry 6 }
  275. etherStatsMulticastPkts OBJECT-TYPE
  276. SYNTAX Counter
  277. ACCESS read-only
  278. STATUS mandatory
  279. DESCRIPTION
  280. "The total number of good packets received that were
  281. directed to a multicast address. Note that this
  282. number does not include packets directed to the
  283. broadcast address."
  284. ::= { etherStatsEntry 7 }
  285. etherStatsCRCAlignErrors OBJECT-TYPE
  286. SYNTAX Counter
  287. ACCESS read-only
  288. STATUS mandatory
  289. DESCRIPTION
  290. "The total number of packets received that
  291. had a length (excluding framing bits, but
  292. including FCS octets) of between 64 and 1518
  293. octets, inclusive, but but had either a bad
  294. Frame Check Sequence (FCS) with an integral
  295. number of octets (FCS Error) or a bad FCS with
  296. a non-integral number of octets (Alignment Error)."
  297. ::= { etherStatsEntry 8 }
  298. etherStatsUndersizePkts OBJECT-TYPE
  299. SYNTAX Counter
  300. ACCESS read-only
  301. STATUS mandatory
  302. DESCRIPTION
  303. "The total number of packets received that were
  304. less than 64 octets long (excluding framing bits,
  305. but including FCS octets) and were otherwise well
  306. formed."
  307. ::= { etherStatsEntry 9 }
  308. etherStatsOversizePkts OBJECT-TYPE
  309. SYNTAX Counter
  310. ACCESS read-only
  311. STATUS mandatory
  312. DESCRIPTION
  313. "The total number of packets received that were
  314. longer than 1518 octets (excluding framing bits,
  315. but including FCS octets) and were otherwise
  316. well formed."
  317. ::= { etherStatsEntry 10 }
  318. etherStatsFragments OBJECT-TYPE
  319. SYNTAX Counter
  320. ACCESS read-only
  321. STATUS mandatory
  322. DESCRIPTION
  323. "The total number of packets received that were less
  324. than 64 octets in length (excluding framing bits but
  325. including FCS octets) and had either a bad Frame
  326. Check Sequence (FCS) with an integral number of
  327. octets (FCS Error) or a bad FCS with a non-integral
  328. number of octets (Alignment Error).
  329. Note that it is entirely normal for
  330. etherStatsFragments to increment. This is because
  331. it counts both runts (which are normal occurrences
  332. due to collisions) and noise hits."
  333. ::= { etherStatsEntry 11 }
  334. etherStatsJabbers OBJECT-TYPE
  335. SYNTAX Counter
  336. ACCESS read-only
  337. STATUS mandatory
  338. DESCRIPTION
  339. "The total number of packets received that were
  340. longer than 1518 octets (excluding framing bits,
  341. but including FCS octets), and had either a bad
  342. Frame Check Sequence (FCS) with an integral number
  343. of octets (FCS Error) or a bad FCS with a
  344. non-integral number of octets (Alignment Error).
  345. Note that this definition of jabber is different
  346. than the definition in IEEE-802.3 section 8.2.1.5
  347. (10BASE5) and section 10.3.1.4 (10BASE2). These
  348. documents define jabber as the condition where any
  349. packet exceeds 20 ms. The allowed range to detect
  350. jabber is between 20 ms and 150 ms."
  351. ::= { etherStatsEntry 12 }
  352. etherStatsCollisions OBJECT-TYPE
  353. SYNTAX Counter
  354. ACCESS read-only
  355. STATUS mandatory
  356. DESCRIPTION
  357. "The best estimate of the total number of collisions
  358. on this Ethernet segment.
  359. The value returned will depend on the location of
  360. the RMON probe. Section 8.2.1.3 (10BASE-5) and
  361. section 10.3.1.3 (10BASE-2) of IEEE standard 802.3
  362. states that a station must detect a collision, in
  363. the receive mode, if three or more stations are
  364. transmitting simultaneously. A repeater port must
  365. detect a collision when two or more stations are
  366. transmitting simultaneously. Thus a probe placed on
  367. a repeater port could record more collisions than a
  368. probe connected to a station on the same segment
  369. would.
  370. Probe location plays a much smaller role when
  371. considering 10BASE-T. 14.2.1.4 (10BASE-T) of IEEE
  372. standard 802.3 defines a collision as the
  373. simultaneous presence of signals on the DO and RD
  374. circuits (transmitting and receiving at the same
  375. time). A 10BASE-T station can only detect
  376. collisions when it is transmitting. Thus probes
  377. placed on a station and a repeater, should report
  378. the same number of collisions.
  379. Note also that an RMON probe inside a repeater
  380. should ideally report collisions between the
  381. repeater and one or more other hosts (transmit
  382. collisions as defined by IEEE 802.3k) plus receiver
  383. collisions observed on any coax segments to which
  384. the repeater is connected."
  385. ::= { etherStatsEntry 13 }
  386. etherStatsPkts64Octets OBJECT-TYPE
  387. SYNTAX Counter
  388. ACCESS read-only
  389. STATUS mandatory
  390. DESCRIPTION
  391. "The total number of packets (including bad
  392. packets) received that were 64 octets in length
  393. (excluding framing bits but including FCS octets)."
  394. ::= { etherStatsEntry 14 }
  395. etherStatsPkts65to127Octets OBJECT-TYPE
  396. SYNTAX Counter
  397. ACCESS read-only
  398. STATUS mandatory
  399. DESCRIPTION
  400. "The total number of packets (including bad
  401. packets) received that were between
  402. 65 and 127 octets in length inclusive
  403. (excluding framing bits but including FCS octets)."
  404. ::= { etherStatsEntry 15 }
  405. etherStatsPkts128to255Octets OBJECT-TYPE
  406. SYNTAX Counter
  407. ACCESS read-only
  408. STATUS mandatory
  409. DESCRIPTION
  410. "The total number of packets (including bad
  411. packets) received that were between
  412. 128 and 255 octets in length inclusive
  413. (excluding framing bits but including FCS octets)."
  414. ::= { etherStatsEntry 16 }
  415. etherStatsPkts256to511Octets OBJECT-TYPE
  416. SYNTAX Counter
  417. ACCESS read-only
  418. STATUS mandatory
  419. DESCRIPTION
  420. "The total number of packets (including bad
  421. packets) received that were between
  422. 256 and 511 octets in length inclusive
  423. (excluding framing bits but including FCS octets)."
  424. ::= { etherStatsEntry 17 }
  425. etherStatsPkts512to1023Octets OBJECT-TYPE
  426. SYNTAX Counter
  427. ACCESS read-only
  428. STATUS mandatory
  429. DESCRIPTION
  430. "The total number of packets (including bad
  431. packets) received that were between
  432. 512 and 1023 octets in length inclusive
  433. (excluding framing bits but including FCS octets)."
  434. ::= { etherStatsEntry 18 }
  435. etherStatsPkts1024to1518Octets OBJECT-TYPE
  436. SYNTAX Counter
  437. ACCESS read-only
  438. STATUS mandatory
  439. DESCRIPTION
  440. "The total number of packets (including bad
  441. packets) received that were between
  442. 1024 and 1518 octets in length inclusive
  443. (excluding framing bits but including FCS octets)."
  444. ::= { etherStatsEntry 19 }
  445. etherStatsOwner OBJECT-TYPE
  446. SYNTAX OwnerString
  447. ACCESS read-write
  448. STATUS mandatory
  449. DESCRIPTION
  450. "The entity that configured this entry and is
  451. therefore using the resources assigned to it."
  452. ::= { etherStatsEntry 20 }
  453. etherStatsStatus OBJECT-TYPE
  454. SYNTAX EntryStatus
  455. ACCESS read-write
  456. STATUS mandatory
  457. DESCRIPTION
  458. "The status of this etherStats entry."
  459. ::= { etherStatsEntry 21 }
  460. -- The History Control Group
  461. -- Implementation of the History Control group is optional.
  462. --
  463. -- The history control group controls the periodic statistical
  464. -- sampling of data from various types of networks. The
  465. -- historyControlTable stores configuration entries that each
  466. -- define an interface, polling period, and other parameters.
  467. -- Once samples are taken, their data is stored in an entry
  468. -- in a media-specific table. Each such entry defines one
  469. -- sample, and is associated with the historyControlEntry that
  470. -- caused the sample to be taken. Each counter in the
  471. -- etherHistoryEntry counts the same event as its
  472. -- similarly-named counterpart in the etherStatsEntry,
  473. -- except that each value here is a cumulative sum during a
  474. -- sampling period.
  475. --
  476. -- If the probe keeps track of the time of day, it should
  477. -- start the first sample of the history at a time such that
  478. -- when the next hour of the day begins, a sample is
  479. -- started at that instant. This tends to make more
  480. -- user-friendly reports, and enables comparison of reports
  481. -- from different probes that have relatively accurate time
  482. -- of day.
  483. --
  484. -- The probe is encouraged to add two history control entries
  485. -- per monitored interface upon initialization that describe
  486. -- a short term and a long term polling period. Suggested
  487. -- parameters are 30 seconds for the short term polling period
  488. -- and 30 minutes for the long term period.
  489. historyControlTable OBJECT-TYPE
  490. SYNTAX SEQUENCE OF HistoryControlEntry
  491. ACCESS not-accessible
  492. STATUS mandatory
  493. DESCRIPTION
  494. "A list of history control entries."
  495. ::= { history 1 }
  496. historyControlEntry OBJECT-TYPE
  497. SYNTAX HistoryControlEntry
  498. ACCESS not-accessible
  499. STATUS mandatory
  500. DESCRIPTION
  501. "A list of parameters that set up a periodic sampling
  502. of statistics. As an example, an instance of the
  503. historyControlInterval object might be named
  504. historyControlInterval.2"
  505. INDEX { historyControlIndex }
  506. ::= { historyControlTable 1 }
  507. HistoryControlEntry ::= SEQUENCE {
  508. historyControlIndex INTEGER (1..65535),
  509. historyControlDataSource OBJECT IDENTIFIER,
  510. historyControlBucketsRequested INTEGER (1..65535),
  511. historyControlBucketsGranted INTEGER (1..65535),
  512. historyControlInterval INTEGER (1..3600),
  513. historyControlOwner OwnerString,
  514. historyControlStatus EntryStatus
  515. }
  516. historyControlIndex OBJECT-TYPE
  517. SYNTAX INTEGER (1..65535)
  518. ACCESS read-only
  519. STATUS mandatory
  520. DESCRIPTION
  521. "An index that uniquely identifies an entry in the
  522. historyControl table. Each such entry defines a
  523. set of samples at a particular interval for an
  524. interface on the device."
  525. ::= { historyControlEntry 1 }
  526. historyControlDataSource OBJECT-TYPE
  527. SYNTAX OBJECT IDENTIFIER
  528. ACCESS read-write
  529. STATUS mandatory
  530. DESCRIPTION
  531. "This object identifies the source of the data for
  532. which historical data was collected and
  533. placed in a media-specific table on behalf of this
  534. historyControlEntry. This source can be any
  535. interface on this device. In order to identify
  536. a particular interface, this object shall identify
  537. the instance of the ifIndex object, defined
  538. in RFC 1213 and RFC 1573 [4,6], for the desired
  539. interface. For example, if an entry were to receive
  540. data from interface #1, this object would be set
  541. to ifIndex.1.
  542. The statistics in this group reflect all packets
  543. on the local network segment attached to the
  544. identified interface.
  545. An agent may or may not be able to tell if fundamental
  546. changes to the media of the interface have occurred
  547. and necessitate an invalidation of this entry. For
  548. example, a hot-pluggable ethernet card could be
  549. pulled out and replaced by a token-ring card. In
  550. such a case, if the agent has such knowledge of the
  551. change, it is recommended that it invalidate this
  552. entry.
  553. This object may not be modified if the associated
  554. historyControlStatus object is equal to valid(1)."
  555. ::= { historyControlEntry 2 }
  556. historyControlBucketsRequested OBJECT-TYPE
  557. SYNTAX INTEGER (1..65535)
  558. ACCESS read-write
  559. STATUS mandatory
  560. DESCRIPTION
  561. "The requested number of discrete time intervals
  562. over which data is to be saved in the part of the
  563. media-specific table associated with this
  564. historyControlEntry.
  565. When this object is created or modified, the probe
  566. should set historyControlBucketsGranted as closely to
  567. this object as is possible for the particular probe
  568. implementation and available resources."
  569. DEFVAL { 50 }
  570. ::= { historyControlEntry 3 }
  571. historyControlBucketsGranted OBJECT-TYPE
  572. SYNTAX INTEGER (1..65535)
  573. ACCESS read-only
  574. STATUS mandatory
  575. DESCRIPTION
  576. "The number of discrete sampling intervals
  577. over which data shall be saved in the part of
  578. the media-specific table associated with this
  579. historyControlEntry.
  580. When the associated historyControlBucketsRequested
  581. object is created or modified, the probe
  582. should set this object as closely to the requested
  583. value as is possible for the particular
  584. probe implementation and available resources. The
  585. probe must not lower this value except as a result
  586. of a modification to the associated
  587. historyControlBucketsRequested object.
  588. There will be times when the actual number of
  589. buckets associated with this entry is less than
  590. the value of this object. In this case, at the
  591. end of each sampling interval, a new bucket will
  592. be added to the media-specific table.
  593. When the number of buckets reaches the value of
  594. this object and a new bucket is to be added to the
  595. media-specific table, the oldest bucket associated
  596. with this historyControlEntry shall be deleted by
  597. the agent so that the new bucket can be added.
  598. When the value of this object changes to a value less
  599. than the current value, entries are deleted
  600. from the media-specific table associated with this
  601. historyControlEntry. Enough of the oldest of these
  602. entries shall be deleted by the agent so that their
  603. number remains less than or equal to the new value of
  604. this object.
  605. When the value of this object changes to a value
  606. greater than the current value, the number of
  607. associated media- specific entries may be allowed to
  608. grow."
  609. ::= { historyControlEntry 4 }
  610. historyControlInterval OBJECT-TYPE
  611. SYNTAX INTEGER (1..3600)
  612. ACCESS read-write
  613. STATUS mandatory
  614. DESCRIPTION
  615. "The interval in seconds over which the data is
  616. sampled for each bucket in the part of the
  617. media-specific table associated with this
  618. historyControlEntry. This interval can
  619. be set to any number of seconds between 1 and
  620. 3600 (1 hour).
  621. Because the counters in a bucket may overflow at their
  622. maximum value with no indication, a prudent manager
  623. will take into account the possibility of overflow
  624. in any of the associated counters. It is important
  625. to consider the minimum time in which any counter
  626. could overflow on a particular media type and set
  627. the historyControlInterval object to a value less
  628. than this interval. This is typically most
  629. important for the 'octets' counter in any
  630. media-specific table. For example, on an Ethernet
  631. network, the etherHistoryOctets counter could
  632. overflow in about one hour at the Ethernet's maximum
  633. utilization.
  634. This object may not be modified if the associated
  635. historyControlStatus object is equal to valid(1)."
  636. DEFVAL { 1800 }
  637. ::= { historyControlEntry 5 }
  638. historyControlOwner OBJECT-TYPE
  639. SYNTAX OwnerString
  640. ACCESS read-write
  641. STATUS mandatory
  642. DESCRIPTION
  643. "The entity that configured this entry and is
  644. therefore using the resources assigned to it."
  645. ::= { historyControlEntry 6 }
  646. historyControlStatus OBJECT-TYPE
  647. SYNTAX EntryStatus
  648. ACCESS read-write
  649. STATUS mandatory
  650. DESCRIPTION
  651. "The status of this historyControl entry.
  652. Each instance of the media-specific table associated
  653. with this historyControlEntry will be deleted by the
  654. agent if this historyControlEntry is not equal to
  655. valid(1)."
  656. ::= { historyControlEntry 7 }
  657. -- The Ethernet History Group
  658. -- Implementation of the Ethernet History group is optional.
  659. --
  660. -- The Ethernet History group records periodic
  661. -- statistical samples from a network and stores them
  662. -- for later retrieval. Once samples are taken, their
  663. -- data is stored in an entry in a media-specific
  664. -- table. Each such entry defines one sample, and is
  665. -- associated with the historyControlEntry that caused
  666. -- the sample to be taken. This group defines the
  667. -- etherHistoryTable, for Ethernet networks.
  668. --
  669. etherHistoryTable OBJECT-TYPE
  670. SYNTAX SEQUENCE OF EtherHistoryEntry
  671. ACCESS not-accessible
  672. STATUS mandatory
  673. DESCRIPTION
  674. "A list of Ethernet history entries."
  675. ::= { history 2 }
  676. etherHistoryEntry OBJECT-TYPE
  677. SYNTAX EtherHistoryEntry
  678. ACCESS not-accessible
  679. STATUS mandatory
  680. DESCRIPTION
  681. "An historical sample of Ethernet statistics on a
  682. particular Ethernet interface. This sample is
  683. associated with the historyControlEntry which set up
  684. the parameters for a regular collection of these
  685. samples. As an example, an instance of the
  686. etherHistoryPkts object might be named
  687. etherHistoryPkts.2.89"
  688. INDEX { etherHistoryIndex , etherHistorySampleIndex }
  689. ::= { etherHistoryTable 1 }
  690. EtherHistoryEntry ::= SEQUENCE {
  691. etherHistoryIndex INTEGER (1..65535),
  692. etherHistorySampleIndex INTEGER (1..2147483647),
  693. etherHistoryIntervalStart TimeTicks,
  694. etherHistoryDropEvents Counter,
  695. etherHistoryOctets Counter,
  696. etherHistoryPkts Counter,
  697. etherHistoryBroadcastPkts Counter,
  698. etherHistoryMulticastPkts Counter,
  699. etherHistoryCRCAlignErrors Counter,
  700. etherHistoryUndersizePkts Counter,
  701. etherHistoryOversizePkts Counter,
  702. etherHistoryFragments Counter,
  703. etherHistoryJabbers Counter,
  704. etherHistoryCollisions Counter,
  705. etherHistoryUtilization INTEGER (0..10000)
  706. }
  707. etherHistoryIndex OBJECT-TYPE
  708. SYNTAX INTEGER (1..65535)
  709. ACCESS read-only
  710. STATUS mandatory
  711. DESCRIPTION
  712. "The history of which this entry is a part. The
  713. history identified by a particular value of this
  714. index is the same history as identified
  715. by the same value of historyControlIndex."
  716. ::= { etherHistoryEntry 1 }
  717. etherHistorySampleIndex OBJECT-TYPE
  718. SYNTAX INTEGER (1..2147483647)
  719. ACCESS read-only
  720. STATUS mandatory
  721. DESCRIPTION
  722. "An index that uniquely identifies the particular
  723. sample this entry represents among all samples
  724. associated with the same historyControlEntry.
  725. This index starts at 1 and increases by one
  726. as each new sample is taken."
  727. ::= { etherHistoryEntry 2 }
  728. etherHistoryIntervalStart OBJECT-TYPE
  729. SYNTAX TimeTicks
  730. ACCESS read-only
  731. STATUS mandatory
  732. DESCRIPTION
  733. "The value of sysUpTime at the start of the interval
  734. over which this sample was measured. If the probe
  735. keeps track of the time of day, it should start
  736. the first sample of the history at a time such that
  737. when the next hour of the day begins, a sample is
  738. started at that instant. Note that following this
  739. rule may require the probe to delay collecting the
  740. first sample of the history, as each sample must be
  741. of the same interval. Also note that the sample which
  742. is currently being collected is not accessible in this
  743. table until the end of its interval."
  744. ::= { etherHistoryEntry 3 }
  745. etherHistoryDropEvents OBJECT-TYPE
  746. SYNTAX Counter
  747. ACCESS read-only
  748. STATUS mandatory
  749. DESCRIPTION
  750. "The total number of events in which packets
  751. were dropped by the probe due to lack of resources
  752. during this sampling interval. Note that this number
  753. is not necessarily the number of packets dropped, it
  754. is just the number of times this condition has been
  755. detected."
  756. ::= { etherHistoryEntry 4 }
  757. etherHistoryOctets OBJECT-TYPE
  758. SYNTAX Counter
  759. ACCESS read-only
  760. STATUS mandatory
  761. DESCRIPTION
  762. "The total number of octets of data (including
  763. those in bad packets) received on the
  764. network (excluding framing bits but including
  765. FCS octets)."
  766. ::= { etherHistoryEntry 5 }
  767. etherHistoryPkts OBJECT-TYPE
  768. SYNTAX Counter
  769. ACCESS read-only
  770. STATUS mandatory
  771. DESCRIPTION
  772. "The number of packets (including bad packets)
  773. received during this sampling interval."
  774. ::= { etherHistoryEntry 6 }
  775. etherHistoryBroadcastPkts OBJECT-TYPE
  776. SYNTAX Counter
  777. ACCESS read-only
  778. STATUS mandatory
  779. DESCRIPTION
  780. "The number of good packets received during this
  781. sampling interval that were directed to the
  782. broadcast address."
  783. ::= { etherHistoryEntry 7 }
  784. etherHistoryMulticastPkts OBJECT-TYPE
  785. SYNTAX Counter
  786. ACCESS read-only
  787. STATUS mandatory
  788. DESCRIPTION
  789. "The number of good packets received during this
  790. sampling interval that were directed to a
  791. multicast address. Note that this number does not
  792. include packets addressed to the broadcast address."
  793. ::= { etherHistoryEntry 8 }
  794. etherHistoryCRCAlignErrors OBJECT-TYPE
  795. SYNTAX Counter
  796. ACCESS read-only
  797. STATUS mandatory
  798. DESCRIPTION
  799. "The number of packets received during this sampling
  800. interval that had a length (excluding framing bits
  801. but including FCS octets) between 64 and 1518
  802. octets, inclusive, but had either a bad Frame Check
  803. Sequence (FCS) with an integral number of octets
  804. (FCS Error) or a bad FCS with a non-integral number
  805. of octets (Alignment Error)."
  806. ::= { etherHistoryEntry 9 }
  807. etherHistoryUndersizePkts OBJECT-TYPE
  808. SYNTAX Counter
  809. ACCESS read-only
  810. STATUS mandatory
  811. DESCRIPTION
  812. "The number of packets received during this
  813. sampling interval that were less than 64 octets
  814. long (excluding framing bits but including FCS
  815. octets) and were otherwise well formed."
  816. ::= { etherHistoryEntry 10 }
  817. etherHistoryOversizePkts OBJECT-TYPE
  818. SYNTAX Counter
  819. ACCESS read-only
  820. STATUS mandatory
  821. DESCRIPTION
  822. "The number of packets received during this
  823. sampling interval that were longer than 1518
  824. octets (excluding framing bits but including
  825. FCS octets) but were otherwise well formed."
  826. ::= { etherHistoryEntry 11 }
  827. etherHistoryFragments OBJECT-TYPE
  828. SYNTAX Counter
  829. ACCESS read-only
  830. STATUS mandatory
  831. DESCRIPTION
  832. "The total number of packets received during this
  833. sampling interval that were less than 64 octets in
  834. length (excluding framing bits but including FCS
  835. octets) had either a bad Frame Check Sequence (FCS)
  836. with an integral number of octets (FCS Error) or a bad
  837. FCS with a non-integral number of octets (Alignment
  838. Error).
  839. Note that it is entirely normal for
  840. etherHistoryFragments to increment. This is because
  841. it counts both runts (which are normal occurrences
  842. due to collisions) and noise hits."
  843. ::= { etherHistoryEntry 12 }
  844. etherHistoryJabbers OBJECT-TYPE
  845. SYNTAX Counter
  846. ACCESS read-only
  847. STATUS mandatory
  848. DESCRIPTION
  849. "The number of packets received during this
  850. sampling interval that were longer than 1518 octets
  851. (excluding framing bits but including FCS octets),
  852. and had either a bad Frame Check Sequence (FCS)
  853. with an integral number of octets (FCS Error) or
  854. a bad FCS with a non-integral number of octets
  855. (Alignment Error).
  856. Note that this definition of jabber is different
  857. than the definition in IEEE-802.3 section 8.2.1.5
  858. (10BASE5) and section 10.3.1.4 (10BASE2). These
  859. documents define jabber as the condition where any
  860. packet exceeds 20 ms. The allowed range to detect
  861. jabber is between 20 ms and 150 ms."
  862. ::= { etherHistoryEntry 13 }
  863. etherHistoryCollisions OBJECT-TYPE
  864. SYNTAX Counter
  865. ACCESS read-only
  866. STATUS mandatory
  867. DESCRIPTION
  868. "The best estimate of the total number of collisions
  869. on this Ethernet segment during this sampling
  870. interval.
  871. The value returned will depend on the location of
  872. the RMON probe. Section 8.2.1.3 (10BASE-5) and
  873. section 10.3.1.3 (10BASE-2) of IEEE standard 802.3
  874. states that a station must detect a collision, in
  875. the receive mode, if three or more stations are
  876. transmitting simultaneously. A repeater port must
  877. detect a collision when two or more stations are
  878. transmitting simultaneously. Thus a probe placed on
  879. a repeater port could record more collisions than a
  880. probe connected to a station on the same segment
  881. would.
  882. Probe location plays a much smaller role when
  883. considering 10BASE-T. 14.2.1.4 (10BASE-T) of IEEE
  884. standard 802.3 defines a collision as the
  885. simultaneous presence of signals on the DO and RD
  886. circuits (transmitting and receiving at the same
  887. time). A 10BASE-T station can only detect
  888. collisions when it is transmitting. Thus probes
  889. placed on a station and a repeater, should report
  890. the same number of collisions.
  891. Note also that an RMON probe inside a repeater
  892. should ideally report collisions between the
  893. repeater and one or more other hosts (transmit
  894. collisions as defined by IEEE 802.3k) plus receiver
  895. collisions observed on any coax segments to which
  896. the repeater is connected."
  897. ::= { etherHistoryEntry 14 }
  898. etherHistoryUtilization OBJECT-TYPE
  899. SYNTAX INTEGER (0..10000)
  900. ACCESS read-only
  901. STATUS mandatory
  902. DESCRIPTION
  903. "The best estimate of the mean physical layer
  904. network utilization on this interface during this
  905. sampling interval, in hundredths of a percent."
  906. ::= { etherHistoryEntry 15 }
  907. -- The Alarm Group
  908. -- Implementation of the Alarm group is optional.
  909. --
  910. -- The Alarm Group requires the implementation of the Event
  911. -- group.
  912. --
  913. -- The Alarm group periodically takes
  914. -- statistical samples from variables in the probe and
  915. -- compares them to thresholds that have been
  916. -- configured. The alarm table stores configuration
  917. -- entries that each define a variable, polling period,
  918. -- and threshold parameters. If a sample is found to
  919. -- cross the threshold values, an event is generated.
  920. -- Only variables that resolve to an ASN.1 primitive
  921. -- type of INTEGER (INTEGER, Counter, Gauge, or
  922. -- TimeTicks) may be monitored in this way.
  923. --
  924. -- This function has a hysteresis mechanism to limit
  925. -- the generation of events. This mechanism generates
  926. -- one event as a threshold is crossed in the
  927. -- appropriate direction. No more events are generated
  928. -- for that threshold until the opposite threshold is
  929. -- crossed.
  930. --
  931. -- In the case of a sampling a deltaValue, a probe may
  932. -- implement this mechanism with more precision if it
  933. -- takes a delta sample twice per period, each time
  934. -- comparing the sum of the latest two samples to the
  935. -- threshold. This allows the detection of threshold
  936. -- crossings that span the sampling boundary. Note
  937. -- that this does not require any special configuration
  938. -- of the threshold value. It is suggested that probes
  939. -- implement this more precise algorithm.
  940. alarmTable OBJECT-TYPE
  941. SYNTAX SEQUENCE OF AlarmEntry
  942. ACCESS not-accessible
  943. STATUS mandatory
  944. DESCRIPTION
  945. "A list of alarm entries."
  946. ::= { alarm 1 }
  947. alarmEntry OBJECT-TYPE
  948. SYNTAX AlarmEntry
  949. ACCESS not-accessible
  950. STATUS mandatory
  951. DESCRIPTION
  952. "A list of parameters that set up a periodic checking
  953. for alarm conditions. For example, an instance of the
  954. alarmValue object might be named alarmValue.8"
  955. INDEX { alarmIndex }
  956. ::= { alarmTable 1 }
  957. AlarmEntry ::= SEQUENCE {
  958. alarmIndex INTEGER (1..65535),
  959. alarmInterval INTEGER,
  960. alarmVariable OBJECT IDENTIFIER,
  961. alarmSampleType INTEGER,
  962. alarmValue INTEGER,
  963. alarmStartupAlarm INTEGER,
  964. alarmRisingThreshold INTEGER,
  965. alarmFallingThreshold INTEGER,
  966. alarmRisingEventIndex INTEGER (0..65535),
  967. alarmFallingEventIndex INTEGER (0..65535),
  968. alarmOwner OwnerString,
  969. alarmStatus EntryStatus
  970. }
  971. alarmIndex OBJECT-TYPE
  972. SYNTAX INTEGER (1..65535)
  973. ACCESS read-only
  974. STATUS mandatory
  975. DESCRIPTION
  976. "An index that uniquely identifies an entry in the
  977. alarm table. Each such entry defines a
  978. diagnostic sample at a particular interval
  979. for an object on the device."
  980. ::= { alarmEntry 1 }
  981. alarmInterval OBJECT-TYPE
  982. SYNTAX INTEGER
  983. ACCESS read-write
  984. STATUS mandatory
  985. DESCRIPTION
  986. "The interval in seconds over which the data is
  987. sampled and compared with the rising and falling
  988. thresholds. When setting this variable, care
  989. should be taken in the case of deltaValue
  990. sampling - the interval should be set short enough
  991. that the sampled variable is very unlikely to
  992. increase or decrease by more than 2^31 - 1 during
  993. a single sampling interval.
  994. This object may not be modified if the associated
  995. alarmStatus object is equal to valid(1)."
  996. ::= { alarmEntry 2 }
  997. alarmVariable OBJECT-TYPE
  998. SYNTAX OBJECT IDENTIFIER
  999. ACCESS read-write
  1000. STATUS mandatory
  1001. DESCRIPTION
  1002. "The object identifier of the particular variable to
  1003. be sampled. Only variables that resolve to an ASN.1
  1004. primitive type of INTEGER (INTEGER, Counter, Gauge,
  1005. or TimeTicks) may be sampled.
  1006. Because SNMP access control is articulated entirely
  1007. in terms of the contents of MIB views, no access
  1008. control mechanism exists that can restrict the value
  1009. of this object to identify only those objects that
  1010. exist in a particular MIB view. Because there is
  1011. thus no acceptable means of restricting the read
  1012. access that could be obtained through the alarm
  1013. mechanism, the probe must only grant write access to
  1014. this object in those views that have read access to
  1015. all objects on the probe.
  1016. During a set operation, if the supplied variable
  1017. name is not available in the selected MIB view, a
  1018. badValue error must be returned. If at any time the
  1019. variable name of an established alarmEntry is no
  1020. longer available in the selected MIB view, the probe
  1021. must change the status of this alarmEntry to
  1022. invalid(4).
  1023. This object may not be modified if the associated
  1024. alarmStatus object is equal to valid(1)."
  1025. ::= { alarmEntry 3 }
  1026. alarmSampleType OBJECT-TYPE
  1027. SYNTAX INTEGER {
  1028. absoluteValue(1),
  1029. deltaValue(2)
  1030. }
  1031. ACCESS read-write
  1032. STATUS mandatory
  1033. DESCRIPTION
  1034. "The method of sampling the selected variable and
  1035. calculating the value to be compared against the
  1036. thresholds. If the value of this object is
  1037. absoluteValue(1), the value of the selected variable
  1038. will be compared directly with the thresholds at the
  1039. end of the sampling interval. If the value of this
  1040. object is deltaValue(2), the value of the selected
  1041. variable at the last sample will be subtracted from
  1042. the current value, and the difference compared with
  1043. the thresholds.
  1044. This object may not be modified if the associated
  1045. alarmStatus object is equal to valid(1)."
  1046. ::= { alarmEntry 4 }
  1047. alarmValue OBJECT-TYPE
  1048. SYNTAX INTEGER
  1049. ACCESS read-only
  1050. STATUS mandatory
  1051. DESCRIPTION
  1052. "The value of the statistic during the last sampling
  1053. period. For example, if the sample type is
  1054. deltaValue, this value will be the difference
  1055. between the samples at the beginning and end of the
  1056. period. If the sample type is absoluteValue, this
  1057. value will be the sampled value at the end of the
  1058. period.
  1059. This is the value that is compared with the rising and
  1060. falling thresholds.
  1061. The value during the current sampling period is not
  1062. made available until the period is completed and will
  1063. remain available until the next period completes."
  1064. ::= { alarmEntry 5 }
  1065. alarmStartupAlarm OBJECT-TYPE
  1066. SYNTAX INTEGER {
  1067. risingAlarm(1),
  1068. fallingAlarm(2),
  1069. risingOrFallingAlarm(3)
  1070. }
  1071. ACCESS read-write
  1072. STATUS mandatory
  1073. DESCRIPTION
  1074. "The alarm that may be sent when this entry is first
  1075. set to valid. If the first sample after this entry
  1076. becomes valid is greater than or equal to the
  1077. risingThreshold and alarmStartupAlarm is equal to
  1078. risingAlarm(1) or risingOrFallingAlarm(3), then a
  1079. single rising alarm will be generated. If the first
  1080. sample after this entry becomes valid is less than
  1081. or equal to the fallingThreshold and
  1082. alarmStartupAlarm is equal to fallingAlarm(2) or
  1083. risingOrFallingAlarm(3), then a single falling alarm
  1084. will be generated.
  1085. This object may not be modified if the associated
  1086. alarmStatus object is equal to valid(1)."
  1087. ::= { alarmEntry 6 }
  1088. alarmRisingThreshold OBJECT-TYPE
  1089. SYNTAX INTEGER
  1090. ACCESS read-write
  1091. STATUS mandatory
  1092. DESCRIPTION
  1093. "A threshold for the sampled statistic. When the
  1094. current sampled value is greater than or equal to
  1095. this threshold, and the value at the last sampling
  1096. interval was less than this threshold, a single
  1097. event will be generated. A single event will also
  1098. be generated if the first sample after this entry
  1099. becomes valid is greater than or equal to this
  1100. threshold and the associated alarmStartupAlarm is
  1101. equal to risingAlarm(1) or risingOrFallingAlarm(3).
  1102. After a rising event is generated, another such event
  1103. will not be generated until the sampled value
  1104. falls below this threshold and reaches the
  1105. alarmFallingThreshold.
  1106. This object may not be modified if the associated
  1107. alarmStatus object is equal to valid(1)."
  1108. ::= { alarmEntry 7 }
  1109. alarmFallingThreshold OBJECT-TYPE
  1110. SYNTAX INTEGER
  1111. ACCESS read-write
  1112. STATUS mandatory
  1113. DESCRIPTION
  1114. "A threshold for the sampled statistic. When the
  1115. current sampled value is less than or equal to this
  1116. threshold, and the value at the last sampling
  1117. interval was greater than this threshold, a single
  1118. event will be generated. A single event will also
  1119. be generated if the first sample after this entry
  1120. becomes valid is less than or equal to this
  1121. threshold and the associated alarmStartupAlarm is
  1122. equal to fallingAlarm(2) or risingOrFallingAlarm(3).
  1123. After a falling event is generated, another such event
  1124. will not be generated until the sampled value
  1125. rises above this threshold and reaches the
  1126. alarmRisingThreshold.
  1127. This object may not be modified if the associated
  1128. alarmStatus object is equal to valid(1)."
  1129. ::= { alarmEntry 8 }
  1130. alarmRisingEventIndex OBJECT-TYPE
  1131. SYNTAX INTEGER (0..65535)
  1132. ACCESS read-write
  1133. STATUS mandatory
  1134. DESCRIPTION
  1135. "The index of the eventEntry that is
  1136. used when a rising threshold is crossed. The
  1137. eventEntry identified by a particular value of
  1138. this index is the same as identified by the same value
  1139. of the eventIndex object. If there is no
  1140. corresponding entry in the eventTable, then
  1141. no association exists. In particular, if this value
  1142. is zero, no associated event will be generated, as
  1143. zero is not a valid event index.
  1144. This object may not be modified if the associated
  1145. alarmStatus object is equal to valid(1)."
  1146. ::= { alarmEntry 9 }
  1147. alarmFallingEventIndex OBJECT-TYPE
  1148. SYNTAX INTEGER (0..65535)
  1149. ACCESS read-write
  1150. STATUS mandatory
  1151. DESCRIPTION
  1152. "The index of the eventEntry that is
  1153. used when a falling threshold is crossed. The
  1154. eventEntry identified by a particular value of
  1155. this index is the same as identified by the same value
  1156. of the eventIndex object. If there is no
  1157. corresponding entry in the eventTable, then
  1158. no association exists. In particular, if this value
  1159. is zero, no associated event will be generated, as
  1160. zero is not a valid event index.
  1161. This object may not be modified if the associated
  1162. alarmStatus object is equal to valid(1)."
  1163. ::= { alarmEntry 10 }
  1164. alarmOwner OBJECT-TYPE
  1165. SYNTAX OwnerString
  1166. ACCESS read-write
  1167. STATUS mandatory
  1168. DESCRIPTION
  1169. "The entity that configured this entry and is
  1170. therefore using the resources assigned to it."
  1171. ::= { alarmEntry 11 }
  1172. alarmStatus OBJECT-TYPE
  1173. SYNTAX EntryStatus
  1174. ACCESS read-write
  1175. STATUS mandatory
  1176. DESCRIPTION
  1177. "The status of this alarm entry."
  1178. ::= { alarmEntry 12 }
  1179. -- The Host Group
  1180. -- Implementation of the Host group is optional.
  1181. --
  1182. -- The host group discovers new hosts on the network by
  1183. -- keeping a list of source and destination MAC Addresses seen
  1184. -- in good packets. For each of these addresses, the host
  1185. -- group keeps a set of statistics. The hostControlTable
  1186. -- controls which interfaces this function is performed on,
  1187. -- and contains some information about the process. On
  1188. -- behalf of each hostControlEntry, data is collected on an
  1189. -- interface and placed in both the hostTable and the
  1190. -- hostTimeTable. If the monitoring device finds itself
  1191. -- short of resources, it may delete entries as needed. It
  1192. -- is suggested that the device delete the least recently
  1193. -- used entries first.
  1194. -- The hostTable contains entries for each address
  1195. -- discovered on a particular interface. Each entry
  1196. -- contains statistical data about that host. This table is
  1197. -- indexed by the MAC address of the host, through which a
  1198. -- random access may be achieved.
  1199. -- The hostTimeTable contains data in the same format as the
  1200. -- hostTable, and must contain the same set of hosts, but is
  1201. -- indexed using hostTimeCreationOrder rather than
  1202. -- hostAddress.
  1203. -- The hostTimeCreationOrder is an integer which reflects
  1204. -- the relative order in which a particular entry was
  1205. -- discovered and thus inserted into the table. As this
  1206. -- order, and thus the index, is among those entries
  1207. -- currently in the table, the index for a particular entry
  1208. -- may change if an (earlier) entry is deleted. Thus the
  1209. -- association between hostTimeCreationOrder and
  1210. -- hostTimeEntry may be broken at any time.
  1211. -- The hostTimeTable has two important uses. The first is the
  1212. -- fast download of this potentially large table. Because the
  1213. -- index of this table runs from 1 to the size of the table,
  1214. -- inclusive, its values are predictable. This allows very
  1215. -- efficient packing of variables into SNMP PDU's and allows
  1216. -- a table transfer to have multiple packets outstanding.
  1217. -- These benefits increase transfer rates tremendously.
  1218. -- The second use of the hostTimeTable is the efficient
  1219. -- discovery by the management station of new entries added
  1220. -- to the table. After the management station has downloaded
  1221. -- the entire table, it knows that new entries will be added
  1222. -- immediately after the end of the current table. It can
  1223. -- thus detect new entries there and retrieve them easily.
  1224. -- Because the association between hostTimeCreationOrder and
  1225. -- hostTimeEntry may be broken at any time, the management
  1226. -- station must monitor the related hostControlLastDeleteTime
  1227. -- object. When the management station thus detects a
  1228. -- deletion, it must assume that any such associations have
  1229. --- been broken, and invalidate any it has stored locally.
  1230. -- This includes restarting any download of the
  1231. -- hostTimeTable that may have been in progress, as well as
  1232. -- rediscovering the end of the hostTimeTable so that it may
  1233. -- detect new entries. If the management station does not
  1234. -- detect the broken association, it may continue to refer
  1235. -- to a particular host by its creationOrder while
  1236. -- unwittingly retrieving the data associated with another
  1237. -- host entirely. If this happens while downloading the
  1238. -- host table, the management station may fail to download
  1239. -- all of the entries in the table.
  1240. hostControlTable OBJECT-TYPE
  1241. SYNTAX SEQUENCE OF HostControlEntry
  1242. ACCESS not-accessible
  1243. STATUS mandatory
  1244. DESCRIPTION
  1245. "A list of host table control entries."
  1246. ::= { hosts 1 }
  1247. hostControlEntry OBJECT-TYPE
  1248. SYNTAX HostControlEntry
  1249. ACCESS not-accessible
  1250. STATUS mandatory
  1251. DESCRIPTION
  1252. "A list of parameters that set up the discovery of
  1253. hosts on a particular interface and the collection
  1254. of statistics about these hosts. For example, an
  1255. instance of the hostControlTableSize object might be
  1256. named hostControlTableSize.1"
  1257. INDEX { hostControlIndex }
  1258. ::= { hostControlTable 1 }
  1259. HostControlEntry ::= SEQUENCE {
  1260. hostControlIndex INTEGER (1..65535),
  1261. hostControlDataSource OBJECT IDENTIFIER,
  1262. hostControlTableSize INTEGER,
  1263. hostControlLastDeleteTime TimeTicks,
  1264. hostControlOwner OwnerString,
  1265. hostControlStatus EntryStatus
  1266. }
  1267. hostControlIndex OBJECT-TYPE
  1268. SYNTAX INTEGER (1..65535)
  1269. ACCESS read-only
  1270. STATUS mandatory
  1271. DESCRIPTION
  1272. "An index that uniquely identifies an entry in the
  1273. hostControl table. Each such entry defines
  1274. a function that discovers hosts on a particular
  1275. interface and places statistics about them in the
  1276. hostTable and the hostTimeTable on behalf of this
  1277. hostControlEntry."
  1278. ::= { hostControlEntry 1 }
  1279. hostControlDataSource OBJECT-TYPE
  1280. SYNTAX OBJECT IDENTIFIER
  1281. ACCESS read-write
  1282. STATUS mandatory
  1283. DESCRIPTION
  1284. "This object identifies the source of the data for
  1285. this instance of the host function. This source
  1286. can be any interface on this device. In order
  1287. to identify a particular interface, this object shall
  1288. identify the instance of the ifIndex object, defined
  1289. in RFC 1213 and RFC 1573 [4,6], for the desired
  1290. interface. For example, if an entry were to receive
  1291. data from interface #1, this object would be set to
  1292. ifIndex.1.
  1293. The statistics in this group reflect all packets
  1294. on the local network segment attached to the
  1295. identified interface.
  1296. An agent may or may not be able to tell if
  1297. fundamental changes to the media of the interface
  1298. have occurred and necessitate an invalidation of
  1299. this entry. For example, a hot-pluggable ethernet
  1300. card could be pulled out and replaced by a
  1301. token-ring card. In such a case, if the agent has
  1302. such knowledge of the change, it is recommended that
  1303. it invalidate this entry.
  1304. This object may not be modified if the associated
  1305. hostControlStatus object is equal to valid(1)."
  1306. ::= { hostControlEntry 2 }
  1307. hostControlTableSize OBJECT-TYPE
  1308. SYNTAX INTEGER
  1309. ACCESS read-only
  1310. STATUS mandatory
  1311. DESCRIPTION
  1312. "The number of hostEntries in the hostTable and the
  1313. hostTimeTable associated with this hostControlEntry."
  1314. ::= { hostControlEntry 3 }
  1315. hostControlLastDeleteTime OBJECT-TYPE
  1316. SYNTAX TimeTicks
  1317. ACCESS read-only
  1318. STATUS mandatory
  1319. DESCRIPTION
  1320. "The value of sysUpTime when the last entry
  1321. was deleted from the portion of the hostTable
  1322. associated with this hostControlEntry. If no
  1323. deletions have occurred, this value shall be zero."
  1324. ::= { hostControlEntry 4 }
  1325. hostControlOwner OBJECT-TYPE
  1326. SYNTAX OwnerString
  1327. ACCESS read-write
  1328. STATUS mandatory
  1329. DESCRIPTION
  1330. "The entity that configured this entry and is
  1331. therefore using the resources assigned to it."
  1332. ::= { hostControlEntry 5 }
  1333. hostControlStatus OBJECT-TYPE
  1334. SYNTAX EntryStatus
  1335. ACCESS read-write
  1336. STATUS mandatory
  1337. DESCRIPTION
  1338. "The status of this hostControl entry.
  1339. If this object is not equal to valid(1), all
  1340. associated entries in the hostTable, hostTimeTable,
  1341. and the hostTopNTable shall be deleted by the
  1342. agent."
  1343. ::= { hostControlEntry 6 }
  1344. hostTable OBJECT-TYPE
  1345. SYNTAX SEQUENCE OF HostEntry
  1346. ACCESS not-accessible
  1347. STATUS mandatory
  1348. DESCRIPTION
  1349. "A list of host entries."
  1350. ::= { hosts 2 }
  1351. hostEntry OBJECT-TYPE
  1352. SYNTAX HostEntry
  1353. ACCESS not-accessible
  1354. STATUS mandatory
  1355. DESCRIPTION
  1356. "A collection of statistics for a particular host
  1357. that has been discovered on an interface of this
  1358. device. For example, an instance of the
  1359. hostOutBroadcastPkts object might be named
  1360. hostOutBroadcastPkts.1.6.8.0.32.27.3.176"
  1361. INDEX { hostIndex, hostAddress }
  1362. ::= { hostTable 1 }
  1363. HostEntry ::= SEQUENCE {
  1364. hostAddress OCTET STRING,
  1365. hostCreationOrder INTEGER (1..65535),
  1366. hostIndex INTEGER (1..65535),
  1367. hostInPkts Counter,
  1368. hostOutPkts Counter,
  1369. hostInOctets Counter,
  1370. hostOutOctets Counter,
  1371. hostOutErrors Counter,
  1372. hostOutBroadcastPkts Counter,
  1373. hostOutMulticastPkts Counter
  1374. }
  1375. hostAddress OBJECT-TYPE
  1376. SYNTAX OCTET STRING
  1377. ACCESS read-only
  1378. STATUS mandatory
  1379. DESCRIPTION
  1380. "The physical address of this host."
  1381. ::= { hostEntry 1 }
  1382. hostCreationOrder OBJECT-TYPE
  1383. SYNTAX INTEGER (1..65535)
  1384. ACCESS read-only
  1385. STATUS mandatory
  1386. DESCRIPTION
  1387. "An index that defines the relative ordering of
  1388. the creation time of hosts captured for a
  1389. particular hostControlEntry. This index shall
  1390. be between 1 and N, where N is the value of
  1391. the associated hostControlTableSize. The ordering
  1392. of the indexes is based on the order of each entry's
  1393. insertion into the table, in which entries added
  1394. earlier have a lower index value than entries added
  1395. later.
  1396. It is important to note that the order for a
  1397. particular entry may change as an (earlier) entry
  1398. is deleted from the table. Because this order may
  1399. change, management stations should make use of the
  1400. hostControlLastDeleteTime variable in the
  1401. hostControlEntry associated with the relevant
  1402. portion of the hostTable. By observing
  1403. this variable, the management station may detect
  1404. the circumstances where a previous association
  1405. between a value of hostCreationOrder
  1406. and a hostEntry may no longer hold."
  1407. ::= { hostEntry 2 }
  1408. hostIndex OBJECT-TYPE
  1409. SYNTAX INTEGER (1..65535)
  1410. ACCESS read-only
  1411. STATUS mandatory
  1412. DESCRIPTION
  1413. "The set of collected host statistics of which
  1414. this entry is a part. The set of hosts
  1415. identified by a particular value of this
  1416. index is associated with the hostControlEntry
  1417. as identified by the same value of hostControlIndex."
  1418. ::= { hostEntry 3 }
  1419. hostInPkts OBJECT-TYPE
  1420. SYNTAX Counter
  1421. ACCESS read-only
  1422. STATUS mandatory
  1423. DESCRIPTION
  1424. "The number of good packets transmitted to this
  1425. address since it was added to the hostTable."
  1426. ::= { hostEntry 4 }
  1427. hostOutPkts OBJECT-TYPE
  1428. SYNTAX Counter
  1429. ACCESS read-only
  1430. STATUS mandatory
  1431. DESCRIPTION
  1432. "The number of packets, including bad packets,
  1433. transmitted by this address since it was added
  1434. to the hostTable."
  1435. ::= { hostEntry 5 }
  1436. hostInOctets OBJECT-TYPE
  1437. SYNTAX Counter
  1438. ACCESS read-only
  1439. STATUS mandatory
  1440. DESCRIPTION
  1441. "The number of octets transmitted to this address
  1442. since it was added to the hostTable (excluding
  1443. framing bits but including FCS octets), except for
  1444. those octets in bad packets."
  1445. ::= { hostEntry 6 }
  1446. hostOutOctets OBJECT-TYPE
  1447. SYNTAX Counter
  1448. ACCESS read-only
  1449. STATUS mandatory
  1450. DESCRIPTION
  1451. "The number of octets transmitted by this address
  1452. since it was added to the hostTable (excluding
  1453. framing bits but including FCS octets), including
  1454. those octets in bad packets."
  1455. ::= { hostEntry 7 }
  1456. hostOutErrors OBJECT-TYPE
  1457. SYNTAX Counter
  1458. ACCESS read-only
  1459. STATUS mandatory
  1460. DESCRIPTION
  1461. "The number of bad packets transmitted by this address
  1462. since this host was added to the hostTable."
  1463. ::= { hostEntry 8 }
  1464. hostOutBroadcastPkts OBJECT-TYPE
  1465. SYNTAX Counter
  1466. ACCESS read-only
  1467. STATUS mandatory
  1468. DESCRIPTION
  1469. "The number of good packets transmitted by this
  1470. address that were directed to the broadcast address
  1471. since this host was added to the hostTable."
  1472. ::= { hostEntry 9 }
  1473. hostOutMulticastPkts OBJECT-TYPE
  1474. SYNTAX Counter
  1475. ACCESS read-only
  1476. STATUS mandatory
  1477. DESCRIPTION
  1478. "The number of good packets transmitted by this
  1479. address that were directed to a multicast address
  1480. since this host was added to the hostTable.
  1481. Note that this number does not include packets
  1482. directed to the broadcast address."
  1483. ::= { hostEntry 10 }
  1484. -- host Time Table
  1485. hostTimeTable OBJECT-TYPE
  1486. SYNTAX SEQUENCE OF HostTimeEntry
  1487. ACCESS not-accessible
  1488. STATUS mandatory
  1489. DESCRIPTION
  1490. "A list of time-ordered host table entries."
  1491. ::= { hosts 3 }
  1492. hostTimeEntry OBJECT-TYPE
  1493. SYNTAX HostTimeEntry
  1494. ACCESS not-accessible
  1495. STATUS mandatory
  1496. DESCRIPTION
  1497. "A collection of statistics for a particular host
  1498. that has been discovered on an interface of this
  1499. device. This collection includes the relative
  1500. ordering of the creation time of this object. For
  1501. example, an instance of the hostTimeOutBroadcastPkts
  1502. object might be named
  1503. hostTimeOutBroadcastPkts.1.687"
  1504. INDEX { hostTimeIndex, hostTimeCreationOrder }
  1505. ::= { hostTimeTable 1 }
  1506. HostTimeEntry ::= SEQUENCE {
  1507. hostTimeAddress OCTET STRING,
  1508. hostTimeCreationOrder INTEGER (1..65535),
  1509. hostTimeIndex INTEGER (1..65535),
  1510. hostTimeInPkts Counter,
  1511. hostTimeOutPkts Counter,
  1512. hostTimeInOctets Counter,
  1513. hostTimeOutOctets Counter,
  1514. hostTimeOutErrors Counter,
  1515. hostTimeOutBroadcastPkts Counter,
  1516. hostTimeOutMulticastPkts Counter
  1517. }
  1518. hostTimeAddress OBJECT-TYPE
  1519. SYNTAX OCTET STRING
  1520. ACCESS read-only
  1521. STATUS mandatory
  1522. DESCRIPTION
  1523. "The physical address of this host."
  1524. ::= { hostTimeEntry 1 }
  1525. hostTimeCreationOrder OBJECT-TYPE
  1526. SYNTAX INTEGER (1..65535)
  1527. ACCESS read-only
  1528. STATUS mandatory
  1529. DESCRIPTION
  1530. "An index that uniquely identifies an entry in
  1531. the hostTime table among those entries associated
  1532. with the same hostControlEntry. This index shall
  1533. be between 1 and N, where N is the value of
  1534. the associated hostControlTableSize. The ordering
  1535. of the indexes is based on the order of each entry's
  1536. insertion into the table, in which entries added
  1537. earlier have a lower index value than entries added
  1538. later. Thus the management station has the ability to
  1539. learn of new entries added to this table without
  1540. downloading the entire table.
  1541. It is important to note that the index for a
  1542. particular entry may change as an (earlier) entry
  1543. is deleted from the table. Because this order may
  1544. change, management stations should make use of the
  1545. hostControlLastDeleteTime variable in the
  1546. hostControlEntry associated with the relevant
  1547. portion of the hostTimeTable. By observing
  1548. this variable, the management station may detect
  1549. the circumstances where a download of the table
  1550. may have missed entries, and where a previous
  1551. association between a value of hostTimeCreationOrder
  1552. and a hostTimeEntry may no longer hold."
  1553. ::= { hostTimeEntry 2 }
  1554. hostTimeIndex OBJECT-TYPE
  1555. SYNTAX INTEGER (1..65535)
  1556. ACCESS read-only
  1557. STATUS mandatory
  1558. DESCRIPTION
  1559. "The set of collected host statistics of which
  1560. this entry is a part. The set of hosts
  1561. identified by a particular value of this
  1562. index is associated with the hostControlEntry
  1563. as identified by the same value of hostControlIndex."
  1564. ::= { hostTimeEntry 3 }
  1565. hostTimeInPkts OBJECT-TYPE
  1566. SYNTAX Counter
  1567. ACCESS read-only
  1568. STATUS mandatory
  1569. DESCRIPTION
  1570. "The number of good packets transmitted to this
  1571. address since it was added to the hostTimeTable."
  1572. ::= { hostTimeEntry 4 }
  1573. hostTimeOutPkts OBJECT-TYPE
  1574. SYNTAX Counter
  1575. ACCESS read-only
  1576. STATUS mandatory
  1577. DESCRIPTION
  1578. "The number of god packets transmitted by this
  1579. address since it was added to the hostTimeTable."
  1580. ::= { hostTimeEntry 5 }
  1581. hostTimeInOctets OBJECT-TYPE
  1582. SYNTAX Counter
  1583. ACCESS read-only
  1584. STATUS mandatory
  1585. DESCRIPTION
  1586. "The number of octets transmitted to this address
  1587. since it was added to the hostTimeTable (excluding
  1588. framing bits but including FCS octets), except for
  1589. those octets in bad packets."
  1590. ::= { hostTimeEntry 6 }
  1591. hostTimeOutOctets OBJECT-TYPE
  1592. SYNTAX Counter
  1593. ACCESS read-only
  1594. STATUS mandatory
  1595. DESCRIPTION
  1596. "The number of octets transmitted by this address
  1597. since it was added to the hostTimeTable (excluding
  1598. framing bits but including FCS octets), including
  1599. those octets in bad packets."
  1600. ::= { hostTimeEntry 7 }
  1601. hostTimeOutErrors OBJECT-TYPE
  1602. SYNTAX Counter
  1603. ACCESS read-only
  1604. STATUS mandatory
  1605. DESCRIPTION
  1606. "The number of bad packets transmitted by this address
  1607. since this host was added to the hostTimeTable."
  1608. ::= { hostTimeEntry 8 }
  1609. hostTimeOutBroadcastPkts OBJECT-TYPE
  1610. SYNTAX Counter
  1611. ACCESS read-only
  1612. STATUS mandatory
  1613. DESCRIPTION
  1614. "The number of good packets transmitted by this
  1615. address that were directed to the broadcast address
  1616. since this host was added to the hostTimeTable."
  1617. ::= { hostTimeEntry 9 }
  1618. hostTimeOutMulticastPkts OBJECT-TYPE
  1619. SYNTAX Counter
  1620. ACCESS read-only
  1621. STATUS mandatory
  1622. DESCRIPTION
  1623. "The number of good packets transmitted by this
  1624. address that were directed to a multicast address
  1625. since this host was added to the hostTimeTable.
  1626. Note that this number does not include packets
  1627. directed to the broadcast address."
  1628. ::= { hostTimeEntry 10 }
  1629. -- The Host Top "N" Group
  1630. -- Implementation of the Host Top N group is optional.
  1631. --
  1632. -- The Host Top N group requires the implementation of the
  1633. -- host group.
  1634. --
  1635. -- The Host Top N group is used to prepare reports that
  1636. -- describe the hosts that top a list ordered by one of
  1637. -- their statistics.
  1638. -- The available statistics are samples of one of their
  1639. -- base statistics, over an interval specified by the
  1640. -- management station. Thus, these statistics are rate
  1641. -- based. The management station also selects how many such
  1642. -- hosts are reported.
  1643. -- The hostTopNControlTable is used to initiate the
  1644. -- generation of such a report. The management station
  1645. -- may select the parameters of such a report, such as
  1646. -- which interface, which statistic, how many hosts,
  1647. -- and the start and stop times of the sampling. When
  1648. -- the report is prepared, entries are created in the
  1649. -- hostTopNTable associated with the relevant
  1650. -- hostTopNControlEntry. These entries are static for
  1651. -- each report after it has been prepared.
  1652. hostTopNControlTable OBJECT-TYPE
  1653. SYNTAX SEQUENCE OF HostTopNControlEntry
  1654. ACCESS not-accessible
  1655. STATUS mandatory
  1656. DESCRIPTION
  1657. "A list of top N host control entries."
  1658. ::= { hostTopN 1 }
  1659. hostTopNControlEntry OBJECT-TYPE
  1660. SYNTAX HostTopNControlEntry
  1661. ACCESS not-accessible
  1662. STATUS mandatory
  1663. DESCRIPTION
  1664. "A set of parameters that control the creation of a
  1665. report of the top N hosts according to several
  1666. metrics. For example, an instance of the
  1667. hostTopNDuration object might be named
  1668. hostTopNDuration.3"
  1669. INDEX { hostTopNControlIndex }
  1670. ::= { hostTopNControlTable 1 }
  1671. HostTopNControlEntry ::= SEQUENCE {
  1672. hostTopNControlIndex INTEGER (1..65535),
  1673. hostTopNHostIndex INTEGER (1..65535),
  1674. hostTopNRateBase INTEGER,
  1675. hostTopNTimeRemaining INTEGER,
  1676. hostTopNDuration INTEGER,
  1677. hostTopNRequestedSize INTEGER,
  1678. hostTopNGrantedSize INTEGER,
  1679. hostTopNStartTime TimeTicks,
  1680. hostTopNOwner OwnerString,
  1681. hostTopNStatus EntryStatus
  1682. }
  1683. hostTopNControlIndex OBJECT-TYPE
  1684. SYNTAX INTEGER (1..65535)
  1685. ACCESS read-only
  1686. STATUS mandatory
  1687. DESCRIPTION
  1688. "An index that uniquely identifies an entry
  1689. in the hostTopNControl table. Each such
  1690. entry defines one top N report prepared for
  1691. one interface."
  1692. ::= { hostTopNControlEntry 1 }
  1693. hostTopNHostIndex OBJECT-TYPE
  1694. SYNTAX INTEGER (1..65535)
  1695. ACCESS read-write
  1696. STATUS mandatory
  1697. DESCRIPTION
  1698. "The host table for which a top N report will be
  1699. prepared on behalf of this entry. The host table
  1700. identified by a particular value of this index is
  1701. associated with the same host table as identified by
  1702. the same value of hostIndex.
  1703. This object may not be modified if the associated
  1704. hostTopNStatus object is equal to valid(1)."
  1705. ::= { hostTopNControlEntry 2 }
  1706. hostTopNRateBase OBJECT-TYPE
  1707. SYNTAX INTEGER {
  1708. hostTopNInPkts(1),
  1709. hostTopNOutPkts(2),
  1710. hostTopNInOctets(3),
  1711. hostTopNOutOctets(4),
  1712. hostTopNOutErrors(5),
  1713. hostTopNOutBroadcastPkts(6),
  1714. hostTopNOutMulticastPkts(7)
  1715. }
  1716. ACCESS read-write
  1717. STATUS mandatory
  1718. DESCRIPTION
  1719. "The variable for each host that the hostTopNRate
  1720. variable is based upon.
  1721. This object may not be modified if the associated
  1722. hostTopNStatus object is equal to valid(1)."
  1723. ::= { hostTopNControlEntry 3 }
  1724. hostTopNTimeRemaining OBJECT-TYPE
  1725. SYNTAX INTEGER
  1726. ACCESS read-write
  1727. STATUS mandatory
  1728. DESCRIPTION
  1729. "The number of seconds left in the report currently
  1730. being collected. When this object is modified by
  1731. the management station, a new collection is started,
  1732. possibly aborting a currently running report. The
  1733. new value is used as the requested duration of this
  1734. report, which is loaded into the associated
  1735. hostTopNDuration object.
  1736. When this object is set to a non-zero value, any
  1737. associated hostTopNEntries shall be made
  1738. inaccessible by the monitor. While the value of
  1739. this object is non-zero, it decrements by one per
  1740. second until it reaches zero. During this time, all
  1741. associated hostTopNEntries shall remain
  1742. inaccessible. At the time that this object
  1743. decrements to zero, the report is made accessible in
  1744. the hostTopNTable. Thus, the hostTopN table needs
  1745. to be created only at the end of the collection
  1746. interval."
  1747. DEFVAL { 0 }
  1748. ::= { hostTopNControlEntry 4 }
  1749. hostTopNDuration OBJECT-TYPE
  1750. SYNTAX INTEGER
  1751. ACCESS read-only
  1752. STATUS mandatory
  1753. DESCRIPTION
  1754. "The number of seconds that this report has collected
  1755. during the last sampling interval, or if this
  1756. report is currently being collected, the number
  1757. of seconds that this report is being collected
  1758. during this sampling interval.
  1759. When the associated hostTopNTimeRemaining object is
  1760. set, this object shall be set by the probe to the
  1761. same value and shall not be modified until the next
  1762. time the hostTopNTimeRemaining is set.
  1763. This value shall be zero if no reports have been
  1764. requested for this hostTopNControlEntry."
  1765. DEFVAL { 0 }
  1766. ::= { hostTopNControlEntry 5 }
  1767. hostTopNRequestedSize OBJECT-TYPE
  1768. SYNTAX INTEGER
  1769. ACCESS read-write
  1770. STATUS mandatory
  1771. DESCRIPTION
  1772. "The maximum number of hosts requested for the top N
  1773. table.
  1774. When this object is created or modified, the probe
  1775. should set hostTopNGrantedSize as closely to this
  1776. object as is possible for the particular probe
  1777. implementation and available resources."
  1778. DEFVAL { 10 }
  1779. ::= { hostTopNControlEntry 6 }
  1780. hostTopNGrantedSize OBJECT-TYPE
  1781. SYNTAX INTEGER
  1782. ACCESS read-only
  1783. STATUS mandatory
  1784. DESCRIPTION
  1785. "The maximum number of hosts in the top N table.
  1786. When the associated hostTopNRequestedSize object is
  1787. created or modified, the probe should set this
  1788. object as closely to the requested value as is
  1789. possible for the particular implementation and
  1790. available resources. The probe must not lower this
  1791. value except as a result of a set to the associated
  1792. hostTopNRequestedSize object.
  1793. Hosts with the highest value of hostTopNRate shall be
  1794. placed in this table in decreasing order of this rate
  1795. until there is no more room or until there are no more
  1796. hosts."
  1797. ::= { hostTopNControlEntry 7 }
  1798. hostTopNStartTime OBJECT-TYPE
  1799. SYNTAX TimeTicks
  1800. ACCESS read-only
  1801. STATUS mandatory
  1802. DESCRIPTION
  1803. "The value of sysUpTime when this top N report was
  1804. last started. In other words, this is the time that
  1805. the associated hostTopNTimeRemaining object was
  1806. modified to start the requested report."
  1807. ::= { hostTopNControlEntry 8 }
  1808. hostTopNOwner OBJECT-TYPE
  1809. SYNTAX OwnerString
  1810. ACCESS read-write
  1811. STATUS mandatory
  1812. DESCRIPTION
  1813. "The entity that configured this entry and is
  1814. therefore using the resources assigned to it."
  1815. ::= { hostTopNControlEntry 9 }
  1816. hostTopNStatus OBJECT-TYPE
  1817. SYNTAX EntryStatus
  1818. ACCESS read-write
  1819. STATUS mandatory
  1820. DESCRIPTION
  1821. "The status of this hostTopNControl entry.
  1822. If this object is not equal to valid(1), all
  1823. associated hostTopNEntries shall be deleted by the
  1824. agent."
  1825. ::= { hostTopNControlEntry 10 }
  1826. hostTopNTable OBJECT-TYPE
  1827. SYNTAX SEQUENCE OF HostTopNEntry
  1828. ACCESS not-accessible
  1829. STATUS mandatory
  1830. DESCRIPTION
  1831. "A list of top N host entries."
  1832. ::= { hostTopN 2 }
  1833. hostTopNEntry OBJECT-TYPE
  1834. SYNTAX HostTopNEntry
  1835. ACCESS not-accessible
  1836. STATUS mandatory
  1837. DESCRIPTION
  1838. "A set of statistics for a host that is part of a
  1839. top N report. For example, an instance of the
  1840. hostTopNRate object might be named
  1841. hostTopNRate.3.10"
  1842. INDEX { hostTopNReport, hostTopNIndex }
  1843. ::= { hostTopNTable 1 }
  1844. HostTopNEntry ::= SEQUENCE {
  1845. hostTopNReport INTEGER (1..65535),
  1846. hostTopNIndex INTEGER (1..65535),
  1847. hostTopNAddress OCTET STRING,
  1848. hostTopNRate INTEGER
  1849. }
  1850. hostTopNReport OBJECT-TYPE
  1851. SYNTAX INTEGER (1..65535)
  1852. ACCESS read-only
  1853. STATUS mandatory
  1854. DESCRIPTION
  1855. "This object identifies the top N report of which
  1856. this entry is a part. The set of hosts
  1857. identified by a particular value of this
  1858. object is part of the same report as identified
  1859. by the same value of the hostTopNControlIndex object."
  1860. ::= { hostTopNEntry 1 }
  1861. hostTopNIndex OBJECT-TYPE
  1862. SYNTAX INTEGER (1..65535)
  1863. ACCESS read-only
  1864. STATUS mandatory
  1865. DESCRIPTION
  1866. "An index that uniquely identifies an entry in
  1867. the hostTopN table among those in the same report.
  1868. This index is between 1 and N, where N is the
  1869. number of entries in this table. Increasing values
  1870. of hostTopNIndex shall be assigned to entries with
  1871. decreasing values of hostTopNRate until index N
  1872. is assigned to the entry with the lowest value of
  1873. hostTopNRate or there are no more hostTopNEntries."
  1874. ::= { hostTopNEntry 2 }
  1875. hostTopNAddress OBJECT-TYPE
  1876. SYNTAX OCTET STRING
  1877. ACCESS read-only
  1878. STATUS mandatory
  1879. DESCRIPTION
  1880. "The physical address of this host."
  1881. ::= { hostTopNEntry 3 }
  1882. hostTopNRate OBJECT-TYPE
  1883. SYNTAX INTEGER
  1884. ACCESS read-only
  1885. STATUS mandatory
  1886. DESCRIPTION
  1887. "The amount of change in the selected variable
  1888. during this sampling interval. The selected
  1889. variable is this host's instance of the object
  1890. selected by hostTopNRateBase."
  1891. ::= { hostTopNEntry 4 }
  1892. -- The Matrix Group
  1893. -- Implementation of the Matrix group is optional.
  1894. --
  1895. -- The Matrix group consists of the matrixControlTable,
  1896. -- matrixSDTable and the matrixDSTable. These tables
  1897. -- store statistics for a particular conversation
  1898. -- between two addresses. As the device detects a new
  1899. -- conversation, including those to a non-unicast
  1900. -- address, it creates a new entry in both of the
  1901. -- matrix tables. It must only create new entries
  1902. -- based on information received in good packets. If
  1903. -- the monitoring device finds itself short of
  1904. -- resources, it may delete entries as needed. It is
  1905. -- suggested that the device delete the least recently
  1906. -- used entries first.
  1907. matrixControlTable OBJECT-TYPE
  1908. SYNTAX SEQUENCE OF MatrixControlEntry
  1909. ACCESS not-accessible
  1910. STATUS mandatory
  1911. DESCRIPTION
  1912. "A list of information entries for the
  1913. traffic matrix on each interface."
  1914. ::= { matrix 1 }
  1915. matrixControlEntry OBJECT-TYPE
  1916. SYNTAX MatrixControlEntry
  1917. ACCESS not-accessible
  1918. STATUS mandatory
  1919. DESCRIPTION
  1920. "Information about a traffic matrix on a particular
  1921. interface. For example, an instance of the
  1922. matrixControlLastDeleteTime object might be named
  1923. matrixControlLastDeleteTime.1"
  1924. INDEX { matrixControlIndex }
  1925. ::= { matrixControlTable 1 }
  1926. MatrixControlEntry ::= SEQUENCE {
  1927. matrixControlIndex INTEGER (1..65535),
  1928. matrixControlDataSource OBJECT IDENTIFIER,
  1929. matrixControlTableSize INTEGER,
  1930. matrixControlLastDeleteTime TimeTicks,
  1931. matrixControlOwner OwnerString,
  1932. matrixControlStatus EntryStatus
  1933. }
  1934. matrixControlIndex OBJECT-TYPE
  1935. SYNTAX INTEGER (1..65535)
  1936. ACCESS read-only
  1937. STATUS mandatory
  1938. DESCRIPTION
  1939. "An index that uniquely identifies an entry in the
  1940. matrixControl table. Each such entry defines
  1941. a function that discovers conversations on a
  1942. particular interface and places statistics about
  1943. them in the matrixSDTable and the matrixDSTable on
  1944. behalf of this matrixControlEntry."
  1945. ::= { matrixControlEntry 1 }
  1946. matrixControlDataSource OBJECT-TYPE
  1947. SYNTAX OBJECT IDENTIFIER
  1948. ACCESS read-write
  1949. STATUS mandatory
  1950. DESCRIPTION
  1951. "This object identifies the source of
  1952. the data from which this entry creates a traffic
  1953. matrix. This source can be any interface on this
  1954. device. In order to identify a particular
  1955. interface, this object shall identify the instance
  1956. of the ifIndex object, defined in RFC 1213 and RFC
  1957. 1573 [4,6], for the desired interface. For example,
  1958. if an entry were to receive data from interface #1,
  1959. this object would be set to ifIndex.1.
  1960. The statistics in this group reflect all packets
  1961. on the local network segment attached to the
  1962. identified interface.
  1963. An agent may or may not be able to tell if
  1964. fundamental changes to the media of the interface
  1965. have occurred and necessitate an invalidation of
  1966. this entry. For example, a hot-pluggable ethernet
  1967. card could be pulled out and replaced by a
  1968. token-ring card. In such a case, if the agent has
  1969. such knowledge of the change, it is recommended that
  1970. it invalidate this entry.
  1971. This object may not be modified if the associated
  1972. matrixControlStatus object is equal to valid(1)."
  1973. ::= { matrixControlEntry 2 }
  1974. matrixControlTableSize OBJECT-TYPE
  1975. SYNTAX INTEGER
  1976. ACCESS read-only
  1977. STATUS mandatory
  1978. DESCRIPTION
  1979. "The number of matrixSDEntries in the matrixSDTable
  1980. for this interface. This must also be the value of
  1981. the number of entries in the matrixDSTable for this
  1982. interface."
  1983. ::= { matrixControlEntry 3 }
  1984. matrixControlLastDeleteTime OBJECT-TYPE
  1985. SYNTAX TimeTicks
  1986. ACCESS read-only
  1987. STATUS mandatory
  1988. DESCRIPTION
  1989. "The value of sysUpTime when the last entry
  1990. was deleted from the portion of the matrixSDTable
  1991. or matrixDSTable associated with this
  1992. matrixControlEntry. If no deletions have occurred,
  1993. this value shall be zero."
  1994. ::= { matrixControlEntry 4 }
  1995. matrixControlOwner OBJECT-TYPE
  1996. SYNTAX OwnerString
  1997. ACCESS read-write
  1998. STATUS mandatory
  1999. DESCRIPTION
  2000. "The entity that configured this entry and is
  2001. therefore using the resources assigned to it."
  2002. ::= { matrixControlEntry 5 }
  2003. matrixControlStatus OBJECT-TYPE
  2004. SYNTAX EntryStatus
  2005. ACCESS read-write
  2006. STATUS mandatory
  2007. DESCRIPTION
  2008. "The status of this matrixControl entry.
  2009. If this object is not equal to valid(1), all
  2010. associated entries in the matrixSDTable and the
  2011. matrixDSTable shall be deleted by the agent."
  2012. ::= { matrixControlEntry 6 }
  2013. matrixSDTable OBJECT-TYPE
  2014. SYNTAX SEQUENCE OF MatrixSDEntry
  2015. ACCESS not-accessible
  2016. STATUS mandatory
  2017. DESCRIPTION
  2018. "A list of traffic matrix entries indexed by
  2019. source and destination MAC address."
  2020. ::= { matrix 2 }
  2021. matrixSDEntry OBJECT-TYPE
  2022. SYNTAX MatrixSDEntry
  2023. ACCESS not-accessible
  2024. STATUS mandatory
  2025. DESCRIPTION
  2026. "A collection of statistics for communications between
  2027. two addresses on a particular interface. For example,
  2028. an instance of the matrixSDPkts object might be named
  2029. matrixSDPkts.1.6.8.0.32.27.3.176.6.8.0.32.10.8.113"
  2030. INDEX { matrixSDIndex,
  2031. matrixSDSourceAddress, matrixSDDestAddress }
  2032. ::= { matrixSDTable 1 }
  2033. MatrixSDEntry ::= SEQUENCE {
  2034. matrixSDSourceAddress OCTET STRING,
  2035. matrixSDDestAddress OCTET STRING,
  2036. matrixSDIndex INTEGER (1..65535),
  2037. matrixSDPkts Counter,
  2038. matrixSDOctets Counter,
  2039. matrixSDErrors Counter
  2040. }
  2041. matrixSDSourceAddress OBJECT-TYPE
  2042. SYNTAX OCTET STRING
  2043. ACCESS read-only
  2044. STATUS mandatory
  2045. DESCRIPTION
  2046. "The source physical address."
  2047. ::= { matrixSDEntry 1 }
  2048. matrixSDDestAddress OBJECT-TYPE
  2049. SYNTAX OCTET STRING
  2050. ACCESS read-only
  2051. STATUS mandatory
  2052. DESCRIPTION
  2053. "The destination physical address."
  2054. ::= { matrixSDEntry 2 }
  2055. matrixSDIndex OBJECT-TYPE
  2056. SYNTAX INTEGER (1..65535)
  2057. ACCESS read-only
  2058. STATUS mandatory
  2059. DESCRIPTION
  2060. "The set of collected matrix statistics of which
  2061. this entry is a part. The set of matrix statistics
  2062. identified by a particular value of this index
  2063. is associated with the same matrixControlEntry
  2064. as identified by the same value of
  2065. matrixControlIndex."
  2066. ::= { matrixSDEntry 3 }
  2067. matrixSDPkts OBJECT-TYPE
  2068. SYNTAX Counter
  2069. ACCESS read-only
  2070. STATUS mandatory
  2071. DESCRIPTION
  2072. "The number of packets transmitted from the source
  2073. address to the destination address (this number
  2074. includes bad packets)."
  2075. ::= { matrixSDEntry 4 }
  2076. matrixSDOctets OBJECT-TYPE
  2077. SYNTAX Counter
  2078. ACCESS read-only
  2079. STATUS mandatory
  2080. DESCRIPTION
  2081. "The number of octets (excluding framing bits but
  2082. including FCS octets) contained in all packets
  2083. transmitted from the source address to the
  2084. destination address."
  2085. ::= { matrixSDEntry 5 }
  2086. matrixSDErrors OBJECT-TYPE
  2087. SYNTAX Counter
  2088. ACCESS read-only
  2089. STATUS mandatory
  2090. DESCRIPTION
  2091. "The number of bad packets transmitted from
  2092. the source address to the destination address."
  2093. ::= { matrixSDEntry 6 }
  2094. -- Traffic matrix tables from destination to source
  2095. matrixDSTable OBJECT-TYPE
  2096. SYNTAX SEQUENCE OF MatrixDSEntry
  2097. ACCESS not-accessible
  2098. STATUS mandatory
  2099. DESCRIPTION
  2100. "A list of traffic matrix entries indexed by
  2101. destination and source MAC address."
  2102. ::= { matrix 3 }
  2103. matrixDSEntry OBJECT-TYPE
  2104. SYNTAX MatrixDSEntry
  2105. ACCESS not-accessible
  2106. STATUS mandatory
  2107. DESCRIPTION
  2108. "A collection of statistics for communications between
  2109. two addresses on a particular interface. For example,
  2110. an instance of the matrixSDPkts object might be named
  2111. matrixSDPkts.1.6.8.0.32.10.8.113.6.8.0.32.27.3.176"
  2112. INDEX { matrixDSIndex,
  2113. matrixDSDestAddress, matrixDSSourceAddress }
  2114. ::= { matrixDSTable 1 }
  2115. MatrixDSEntry ::= SEQUENCE {
  2116. matrixDSSourceAddress OCTET STRING,
  2117. matrixDSDestAddress OCTET STRING,
  2118. matrixDSIndex INTEGER (1..65535),
  2119. matrixDSPkts Counter,
  2120. matrixDSOctets Counter,
  2121. matrixDSErrors Counter
  2122. }
  2123. matrixDSSourceAddress OBJECT-TYPE
  2124. SYNTAX OCTET STRING
  2125. ACCESS read-only
  2126. STATUS mandatory
  2127. DESCRIPTION
  2128. "The source physical address."
  2129. ::= { matrixDSEntry 1 }
  2130. matrixDSDestAddress OBJECT-TYPE
  2131. SYNTAX OCTET STRING
  2132. ACCESS read-only
  2133. STATUS mandatory
  2134. DESCRIPTION
  2135. "The destination physical address."
  2136. ::= { matrixDSEntry 2 }
  2137. matrixDSIndex OBJECT-TYPE
  2138. SYNTAX INTEGER (1..65535)
  2139. ACCESS read-only
  2140. STATUS mandatory
  2141. DESCRIPTION
  2142. "The set of collected matrix statistics of which
  2143. this entry is a part. The set of matrix statistics
  2144. identified by a particular value of this index
  2145. is associated with the same matrixControlEntry
  2146. as identified by the same value of
  2147. matrixControlIndex."
  2148. ::= { matrixDSEntry 3 }
  2149. matrixDSPkts OBJECT-TYPE
  2150. SYNTAX Counter
  2151. ACCESS read-only
  2152. STATUS mandatory
  2153. DESCRIPTION
  2154. "The number of packets transmitted from the source
  2155. address to the destination address (this number
  2156. includes bad packets)."
  2157. ::= { matrixDSEntry 4 }
  2158. matrixDSOctets OBJECT-TYPE
  2159. SYNTAX Counter
  2160. ACCESS read-only
  2161. STATUS mandatory
  2162. DESCRIPTION
  2163. "The number of octets (excluding framing bits
  2164. but including FCS octets) contained in all packets
  2165. transmitted from the source address to the
  2166. destination address."
  2167. ::= { matrixDSEntry 5 }
  2168. matrixDSErrors OBJECT-TYPE
  2169. SYNTAX Counter
  2170. ACCESS read-only
  2171. STATUS mandatory
  2172. DESCRIPTION
  2173. "The number of bad packets transmitted from
  2174. the source address to the destination address."
  2175. ::= { matrixDSEntry 6 }
  2176. -- The Filter Group
  2177. -- Implementation of the Filter group is optional.
  2178. --
  2179. -- The Filter group allows packets to be captured with an
  2180. -- arbitrary filter expression. A logical data and
  2181. -- event stream or "channel" is formed by the packets
  2182. -- that match the filter expression.
  2183. --
  2184. -- This filter mechanism allows the creation of an arbitrary
  2185. -- logical expression with which to filter packets. Each
  2186. -- filter associated with a channel is OR'ed with the others.
  2187. -- Within a filter, any bits checked in the data and status
  2188. -- are AND'ed with respect to other bits in the same filter.
  2189. -- The NotMask also allows for checking for inequality.
  2190. -- Finally, the channelAcceptType object allows for
  2191. -- inversion of the whole equation.
  2192. --
  2193. -- If a management station wishes to receive a trap to alert
  2194. -- it that new packets have been captured and are available
  2195. -- for download, it is recommended that it set up an alarm
  2196. -- entry that monitors the value of the relevant
  2197. -- channelMatches instance.
  2198. --
  2199. -- The channel can be turned on or off, and can also
  2200. -- generate events when packets pass through it.
  2201. filterTable OBJECT-TYPE
  2202. SYNTAX SEQUENCE OF FilterEntry
  2203. ACCESS not-accessible
  2204. STATUS mandatory
  2205. DESCRIPTION
  2206. "A list of packet filter entries."
  2207. ::= { filter 1 }
  2208. filterEntry OBJECT-TYPE
  2209. SYNTAX FilterEntry
  2210. ACCESS not-accessible
  2211. STATUS mandatory
  2212. DESCRIPTION
  2213. "A set of parameters for a packet filter applied on a
  2214. particular interface. As an example, an instance of
  2215. the filterPktData object might be named
  2216. filterPktData.12"
  2217. INDEX { filterIndex }
  2218. ::= { filterTable 1 }
  2219. FilterEntry ::= SEQUENCE {
  2220. filterIndex INTEGER (1..65535),
  2221. filterChannelIndex INTEGER (1..65535),
  2222. filterPktDataOffset INTEGER,
  2223. filterPktData OCTET STRING,
  2224. filterPktDataMask OCTET STRING,
  2225. filterPktDataNotMask OCTET STRING,
  2226. filterPktStatus INTEGER,
  2227. filterPktStatusMask INTEGER,
  2228. filterPktStatusNotMask INTEGER,
  2229. filterOwner OwnerString,
  2230. filterStatus EntryStatus
  2231. }
  2232. filterIndex OBJECT-TYPE
  2233. SYNTAX INTEGER (1..65535)
  2234. ACCESS read-only
  2235. STATUS mandatory
  2236. DESCRIPTION
  2237. "An index that uniquely identifies an entry
  2238. in the filter table. Each such entry defines
  2239. one filter that is to be applied to every packet
  2240. received on an interface."
  2241. ::= { filterEntry 1 }
  2242. filterChannelIndex OBJECT-TYPE
  2243. SYNTAX INTEGER (1..65535)
  2244. ACCESS read-write
  2245. STATUS mandatory
  2246. DESCRIPTION
  2247. "This object identifies the channel of which this
  2248. filter is a part. The filters identified by a
  2249. particular value of this object are associated with
  2250. the same channel as identified by the same value of
  2251. the channelIndex object."
  2252. ::= { filterEntry 2 }
  2253. filterPktDataOffset OBJECT-TYPE
  2254. SYNTAX INTEGER
  2255. ACCESS read-write
  2256. STATUS mandatory
  2257. DESCRIPTION
  2258. "The offset from the beginning of each packet where
  2259. a match of packet data will be attempted. This offset
  2260. is measured from the point in the physical layer
  2261. packet after the framing bits, if any. For example,
  2262. in an Ethernet frame, this point is at the beginning
  2263. of the destination MAC address.
  2264. This object may not be modified if the associated
  2265. filterStatus object is equal to valid(1)."
  2266. DEFVAL { 0 }
  2267. ::= { filterEntry 3 }
  2268. filterPktData OBJECT-TYPE
  2269. SYNTAX OCTET STRING
  2270. ACCESS read-write
  2271. STATUS mandatory
  2272. DESCRIPTION
  2273. "The data that is to be matched with the input
  2274. packet. For each packet received, this filter and
  2275. the accompanying filterPktDataMask and
  2276. filterPktDataNotMask will be adjusted for the
  2277. offset. The only bits relevant to this match
  2278. algorithm are those that have the corresponding
  2279. filterPktDataMask bit equal to one. The following
  2280. three rules are then applied to every packet:
  2281. (1) If the packet is too short and does not have data
  2282. corresponding to part of the filterPktData, the
  2283. packet will fail this data match.
  2284. (2) For each relevant bit from the packet with the
  2285. corresponding filterPktDataNotMask bit set to
  2286. zero, if the bit from the packet is not equal to
  2287. the corresponding bit from the filterPktData,
  2288. then the packet will fail this data match.
  2289. (3) If for every relevant bit from the packet with the
  2290. corresponding filterPktDataNotMask bit set to one,
  2291. the bit from the packet is equal to the
  2292. corresponding bit from the filterPktData, then
  2293. the packet will fail this data match.
  2294. Any packets that have not failed any of the three
  2295. matches above have passed this data match. In
  2296. particular, a zero length filter will match any
  2297. packet.
  2298. This object may not be modified if the associated
  2299. filterStatus object is equal to valid(1)."
  2300. ::= { filterEntry 4 }
  2301. filterPktDataMask OBJECT-TYPE
  2302. SYNTAX OCTET STRING
  2303. ACCESS read-write
  2304. STATUS mandatory
  2305. DESCRIPTION
  2306. "The mask that is applied to the match process.
  2307. After adjusting this mask for the offset, only those
  2308. bits in the received packet that correspond to bits
  2309. set in this mask are relevant for further processing
  2310. by the match algorithm. The offset is applied to
  2311. filterPktDataMask in the same way it is applied to the
  2312. filter. For the purposes of the matching algorithm,
  2313. if the associated filterPktData object is longer
  2314. than this mask, this mask is conceptually extended
  2315. with '1' bits until it reaches the length of the
  2316. filterPktData object.
  2317. This object may not be modified if the associated
  2318. filterStatus object is equal to valid(1)."
  2319. ::= { filterEntry 5 }
  2320. filterPktDataNotMask OBJECT-TYPE
  2321. SYNTAX OCTET STRING
  2322. ACCESS read-write
  2323. STATUS mandatory
  2324. DESCRIPTION
  2325. "The inversion mask that is applied to the match
  2326. process. After adjusting this mask for the offset,
  2327. those relevant bits in the received packet that
  2328. correspond to bits cleared in this mask must all be
  2329. equal to their corresponding bits in the
  2330. filterPktData object for the packet to be accepted.
  2331. In addition, at least one of those relevant bits in
  2332. the received packet that correspond to bits set in
  2333. this mask must be different to its corresponding bit
  2334. in the filterPktData object.
  2335. For the purposes of the matching algorithm, if the
  2336. associated filterPktData object is longer than this
  2337. mask, this mask is conceptually extended with '0'
  2338. bits until it reaches the length of the
  2339. filterPktData object.
  2340. This object may not be modified if the associated
  2341. filterStatus object is equal to valid(1)."
  2342. ::= { filterEntry 6 }
  2343. filterPktStatus OBJECT-TYPE
  2344. SYNTAX INTEGER
  2345. ACCESS read-write
  2346. STATUS mandatory
  2347. DESCRIPTION
  2348. "The status that is to be matched with the input
  2349. packet. The only bits relevant to this match
  2350. algorithm are those that have the corresponding
  2351. filterPktStatusMask bit equal to one. The following
  2352. two rules are then applied to every packet:
  2353. (1) For each relevant bit from the packet status
  2354. with the corresponding filterPktStatusNotMask bit
  2355. set to zero, if the bit from the packet status is
  2356. not equal to the corresponding bit from the
  2357. filterPktStatus, then the packet will fail this
  2358. status match.
  2359. (2) If for every relevant bit from the packet status
  2360. with the corresponding filterPktStatusNotMask bit
  2361. set to one, the bit from the packet status is
  2362. equal to the corresponding bit from the
  2363. filterPktStatus, then the packet will fail this
  2364. status match.
  2365. Any packets that have not failed either of the two
  2366. matches above have passed this status match. In
  2367. particular, a zero length status filter will match any
  2368. packet's status.
  2369. The value of the packet status is a sum. This sum
  2370. initially takes the value zero. Then, for each
  2371. error, E, that has been discovered in this packet,
  2372. 2 raised to a value representing E is added to the
  2373. sum. The errors and the bits that represent them are
  2374. dependent on the media type of the interface that
  2375. this channel is receiving packets from.
  2376. The errors defined for a packet captured off of an
  2377. Ethernet interface are as follows:
  2378. bit # Error
  2379. 0 Packet is longer than 1518 octets
  2380. 1 Packet is shorter than 64 octets
  2381. 2 Packet experienced a CRC or Alignment
  2382. error
  2383. For example, an Ethernet fragment would have a
  2384. value of 6 (2^1 + 2^2).
  2385. As this MIB is expanded to new media types, this
  2386. object will have other media-specific errors
  2387. defined.
  2388. For the purposes of this status matching algorithm,
  2389. if the packet status is longer than this
  2390. filterPktStatus object, this object is conceptually
  2391. extended with '0' bits until it reaches the size of
  2392. the packet status.
  2393. This object may not be modified if the associated
  2394. filterStatus object is equal to valid(1)."
  2395. ::= { filterEntry 7 }
  2396. filterPktStatusMask OBJECT-TYPE
  2397. SYNTAX INTEGER
  2398. ACCESS read-write
  2399. STATUS mandatory
  2400. DESCRIPTION
  2401. "The mask that is applied to the status match
  2402. process. Only those bits in the received packet
  2403. that correspond to bits set in this mask are
  2404. relevant for further processing by the status match
  2405. algorithm. For the purposes of the matching
  2406. algorithm, if the associated filterPktStatus object
  2407. is longer than this mask, this mask is conceptually
  2408. extended with '1' bits until it reaches the size of
  2409. the filterPktStatus. In addition, if a packet
  2410. status is longer than this mask, this mask is
  2411. conceptually extended with '0' bits until it reaches
  2412. the size of the packet status.
  2413. This object may not be modified if the associated
  2414. filterStatus object is equal to valid(1)."
  2415. ::= { filterEntry 8 }
  2416. filterPktStatusNotMask OBJECT-TYPE
  2417. SYNTAX INTEGER
  2418. ACCESS read-write
  2419. STATUS mandatory
  2420. DESCRIPTION
  2421. "The inversion mask that is applied to the status
  2422. match process. Those relevant bits in the received
  2423. packet status that correspond to bits cleared in
  2424. this mask must all be equal to their corresponding
  2425. bits in the filterPktStatus object for the packet to
  2426. be accepted. In addition, at least one of those
  2427. relevant bits in the received packet status that
  2428. correspond to bits set in this mask must be
  2429. different to its corresponding bit in the
  2430. filterPktStatus object for the packet to be
  2431. accepted.
  2432. For the purposes of the matching algorithm, if the
  2433. associated filterPktStatus object or a packet status
  2434. is longer than this mask, this mask is conceptually
  2435. extended with '0' bits until it reaches the longer
  2436. of the lengths of the filterPktStatus object and the
  2437. packet status.
  2438. This object may not be modified if the associated
  2439. filterStatus object is equal to valid(1)."
  2440. ::= { filterEntry 9 }
  2441. filterOwner OBJECT-TYPE
  2442. SYNTAX OwnerString
  2443. ACCESS read-write
  2444. STATUS mandatory
  2445. DESCRIPTION
  2446. "The entity that configured this entry and is
  2447. therefore using the resources assigned to it."
  2448. ::= { filterEntry 10 }
  2449. filterStatus OBJECT-TYPE
  2450. SYNTAX EntryStatus
  2451. ACCESS read-write
  2452. STATUS mandatory
  2453. DESCRIPTION
  2454. "The status of this filter entry."
  2455. ::= { filterEntry 11 }
  2456. channelTable OBJECT-TYPE
  2457. SYNTAX SEQUENCE OF ChannelEntry
  2458. ACCESS not-accessible
  2459. STATUS mandatory
  2460. DESCRIPTION
  2461. "A list of packet channel entries."
  2462. ::= { filter 2 }
  2463. channelEntry OBJECT-TYPE
  2464. SYNTAX ChannelEntry
  2465. ACCESS not-accessible
  2466. STATUS mandatory
  2467. DESCRIPTION
  2468. "A set of parameters for a packet channel applied on a
  2469. particular interface. As an example, an instance of
  2470. the channelMatches object might be named
  2471. channelMatches.3"
  2472. INDEX { channelIndex }
  2473. ::= { channelTable 1 }
  2474. ChannelEntry ::= SEQUENCE {
  2475. channelIndex INTEGER (1..65535),
  2476. channelIfIndex INTEGER (1..65535),
  2477. channelAcceptType INTEGER,
  2478. channelDataControl INTEGER,
  2479. channelTurnOnEventIndex INTEGER (0..65535),
  2480. channelTurnOffEventIndex INTEGER (0..65535),
  2481. channelEventIndex INTEGER (0..65535),
  2482. channelEventStatus INTEGER,
  2483. channelMatches Counter,
  2484. channelDescription DisplayString (SIZE (0..127)),
  2485. channelOwner OwnerString,
  2486. channelStatus EntryStatus
  2487. }
  2488. channelIndex OBJECT-TYPE
  2489. SYNTAX INTEGER (1..65535)
  2490. ACCESS read-only
  2491. STATUS mandatory
  2492. DESCRIPTION
  2493. "An index that uniquely identifies an entry in the
  2494. channel table. Each such entry defines one channel,
  2495. a logical data and event stream.
  2496. It is suggested that before creating a channel, an
  2497. application should scan all instances of the
  2498. filterChannelIndex object to make sure that there
  2499. are no pre-existing filters that would be
  2500. inadvertently be linked to the channel."
  2501. ::= { channelEntry 1 }
  2502. channelIfIndex OBJECT-TYPE
  2503. SYNTAX INTEGER (1..65535)
  2504. ACCESS read-write
  2505. STATUS mandatory
  2506. DESCRIPTION
  2507. "The value of this object uniquely identifies the
  2508. interface on this remote network monitoring device
  2509. to which the associated filters are applied to allow
  2510. data into this channel. The interface identified by
  2511. a particular value of this object is the same
  2512. interface as identified by the same value of the
  2513. ifIndex object, defined in RFC 1213 and RFC 1573
  2514. [4,6].
  2515. The filters in this group are applied to all packets
  2516. on the local network segment attached to the
  2517. identified interface.
  2518. An agent may or may not be able to tell if
  2519. fundamental changes to the media of the interface
  2520. have occurred and necessitate an invalidation of
  2521. this entry. For example, a hot-pluggable ethernet
  2522. card could be pulled out and replaced by a
  2523. token-ring card. In such a case, if the agent has
  2524. such knowledge of the change, it is recommended that
  2525. it invalidate this entry.
  2526. This object may not be modified if the associated
  2527. channelStatus object is equal to valid(1)."
  2528. ::= { channelEntry 2 }
  2529. channelAcceptType OBJECT-TYPE
  2530. SYNTAX INTEGER {
  2531. acceptMatched(1),
  2532. acceptFailed(2)
  2533. }
  2534. ACCESS read-write
  2535. STATUS mandatory
  2536. DESCRIPTION
  2537. "This object controls the action of the filters
  2538. associated with this channel. If this object is equal
  2539. to acceptMatched(1), packets will be accepted to this
  2540. channel if they are accepted by both the packet data
  2541. and packet status matches of an associated filter. If
  2542. this object is equal to acceptFailed(2), packets will
  2543. be accepted to this channel only if they fail either
  2544. the packet data match or the packet status match of
  2545. each of the associated filters.
  2546. In particular, a channel with no associated filters
  2547. will match no packets if set to acceptMatched(1)
  2548. case and will match all packets in the
  2549. acceptFailed(2) case.
  2550. This object may not be modified if the associated
  2551. channelStatus object is equal to valid(1)."
  2552. ::= { channelEntry 3 }
  2553. channelDataControl OBJECT-TYPE
  2554. SYNTAX INTEGER {
  2555. on(1),
  2556. off(2)
  2557. }
  2558. ACCESS read-write
  2559. STATUS mandatory
  2560. DESCRIPTION
  2561. "This object controls the flow of data through this
  2562. channel. If this object is on(1), data, status and
  2563. events flow through this channel. If this object is
  2564. off(2), data, status and events will not flow
  2565. through this channel."
  2566. DEFVAL { off }
  2567. ::= { channelEntry 4 }
  2568. channelTurnOnEventIndex OBJECT-TYPE
  2569. SYNTAX INTEGER (0..65535)
  2570. ACCESS read-write
  2571. STATUS mandatory
  2572. DESCRIPTION
  2573. "The value of this object identifies the event
  2574. that is configured to turn the associated
  2575. channelDataControl from off to on when the event is
  2576. generated. The event identified by a particular value
  2577. of this object is the same event as identified by the
  2578. same value of the eventIndex object. If there is no
  2579. corresponding entry in the eventTable, then no
  2580. association exists. In fact, if no event is intended
  2581. for this channel, channelTurnOnEventIndex must be
  2582. set to zero, a non-existent event index.
  2583. This object may not be modified if the associated
  2584. channelStatus object is equal to valid(1)."
  2585. ::= { channelEntry 5 }
  2586. channelTurnOffEventIndex OBJECT-TYPE
  2587. SYNTAX INTEGER (0..65535)
  2588. ACCESS read-write
  2589. STATUS mandatory
  2590. DESCRIPTION
  2591. "The value of this object identifies the event
  2592. that is configured to turn the associated
  2593. channelDataControl from on to off when the event is
  2594. generated. The event identified by a particular value
  2595. of this object is the same event as identified by the
  2596. same value of the eventIndex object. If there is no
  2597. corresponding entry in the eventTable, then no
  2598. association exists. In fact, if no event is intended
  2599. for this channel, channelTurnOffEventIndex must be
  2600. set to zero, a non-existent event index.
  2601. This object may not be modified if the associated
  2602. channelStatus object is equal to valid(1)."
  2603. ::= { channelEntry 6 }
  2604. channelEventIndex OBJECT-TYPE
  2605. SYNTAX INTEGER (0..65535)
  2606. ACCESS read-write
  2607. STATUS mandatory
  2608. DESCRIPTION
  2609. "The value of this object identifies the event
  2610. that is configured to be generated when the
  2611. associated channelDataControl is on and a packet
  2612. is matched. The event identified by a particular
  2613. value of this object is the same event as identified
  2614. by the same value of the eventIndex object. If
  2615. there is no corresponding entry in the eventTable,
  2616. then no association exists. In fact, if no event is
  2617. intended for this channel, channelEventIndex must be
  2618. set to zero, a non-existent event index.
  2619. This object may not be modified if the associated
  2620. channelStatus object is equal to valid(1)."
  2621. ::= { channelEntry 7 }
  2622. channelEventStatus OBJECT-TYPE
  2623. SYNTAX INTEGER {
  2624. eventReady(1),
  2625. eventFired(2),
  2626. eventAlwaysReady(3)
  2627. }
  2628. ACCESS read-write
  2629. STATUS mandatory
  2630. DESCRIPTION
  2631. "The event status of this channel.
  2632. If this channel is configured to generate events
  2633. when packets are matched, a means of controlling
  2634. the flow of those events is often needed. When
  2635. this object is equal to eventReady(1), a single
  2636. event may be generated, after which this object
  2637. will be set by the probe to eventFired(2). While
  2638. in the eventFired(2) state, no events will be
  2639. generated until the object is modified to
  2640. eventReady(1) (or eventAlwaysReady(3)). The
  2641. management station can thus easily respond to a
  2642. notification of an event by re-enabling this object.
  2643. If the management station wishes to disable this
  2644. flow control and allow events to be generated
  2645. at will, this object may be set to
  2646. eventAlwaysReady(3). Disabling the flow control
  2647. is discouraged as it can result in high network
  2648. traffic or other performance problems."
  2649. DEFVAL { eventReady }
  2650. ::= { channelEntry 8 }
  2651. channelMatches OBJECT-TYPE
  2652. SYNTAX Counter
  2653. ACCESS read-only
  2654. STATUS mandatory
  2655. DESCRIPTION
  2656. "The number of times this channel has matched a
  2657. packet. Note that this object is updated even when
  2658. channelDataControl is set to off."
  2659. ::= { channelEntry 9 }
  2660. channelDescription OBJECT-TYPE
  2661. SYNTAX DisplayString (SIZE (0..127))
  2662. ACCESS read-write
  2663. STATUS mandatory
  2664. DESCRIPTION
  2665. "A comment describing this channel."
  2666. ::= { channelEntry 10 }
  2667. channelOwner OBJECT-TYPE
  2668. SYNTAX OwnerString
  2669. ACCESS read-write
  2670. STATUS mandatory
  2671. DESCRIPTION
  2672. "The entity that configured this entry and is
  2673. therefore using the resources assigned to it."
  2674. ::= { channelEntry 11 }
  2675. channelStatus OBJECT-TYPE
  2676. SYNTAX EntryStatus
  2677. ACCESS read-write
  2678. STATUS mandatory
  2679. DESCRIPTION
  2680. "The status of this channel entry."
  2681. ::= { channelEntry 12 }
  2682. -- The Packet Capture Group
  2683. -- Implementation of the Packet Capture group is optional.
  2684. --
  2685. -- The Packet Capture Group requires implementation of the
  2686. -- Filter Group.
  2687. --
  2688. -- The Packet Capture group allows packets to be captured
  2689. -- upon a filter match. The bufferControlTable controls
  2690. -- the captured packets output from a channel that is
  2691. -- associated with it. The captured packets are placed
  2692. -- in entries in the captureBufferTable. These entries are
  2693. -- associated with the bufferControlEntry on whose behalf they
  2694. -- were stored.
  2695. bufferControlTable OBJECT-TYPE
  2696. SYNTAX SEQUENCE OF BufferControlEntry
  2697. ACCESS not-accessible
  2698. STATUS mandatory
  2699. DESCRIPTION
  2700. "A list of buffers control entries."
  2701. ::= { capture 1 }
  2702. bufferControlEntry OBJECT-TYPE
  2703. SYNTAX BufferControlEntry
  2704. ACCESS not-accessible
  2705. STATUS mandatory
  2706. DESCRIPTION
  2707. "A set of parameters that control the collection of
  2708. a stream of packets that have matched filters. As
  2709. an example, an instance of the
  2710. bufferControlCaptureSliceSize object might be named
  2711. bufferControlCaptureSliceSize.3"
  2712. INDEX { bufferControlIndex }
  2713. ::= { bufferControlTable 1 }
  2714. BufferControlEntry ::= SEQUENCE {
  2715. bufferControlIndex INTEGER (1..65535),
  2716. bufferControlChannelIndex INTEGER (1..65535),
  2717. bufferControlFullStatus INTEGER,
  2718. bufferControlFullAction INTEGER,
  2719. bufferControlCaptureSliceSize INTEGER,
  2720. bufferControlDownloadSliceSize INTEGER,
  2721. bufferControlDownloadOffset INTEGER,
  2722. bufferControlMaxOctetsRequested INTEGER,
  2723. bufferControlMaxOctetsGranted INTEGER,
  2724. bufferControlCapturedPackets INTEGER,
  2725. bufferControlTurnOnTime TimeTicks,
  2726. bufferControlOwner OwnerString,
  2727. bufferControlStatus EntryStatus
  2728. }
  2729. bufferControlIndex OBJECT-TYPE
  2730. SYNTAX INTEGER (1..65535)
  2731. ACCESS read-only
  2732. STATUS mandatory
  2733. DESCRIPTION
  2734. "An index that uniquely identifies an entry
  2735. in the bufferControl table. The value of this
  2736. index shall never be zero. Each such
  2737. entry defines one set of packets that is
  2738. captured and controlled by one or more filters."
  2739. ::= { bufferControlEntry 1 }
  2740. bufferControlChannelIndex OBJECT-TYPE
  2741. SYNTAX INTEGER (1..65535)
  2742. ACCESS read-write
  2743. STATUS mandatory
  2744. DESCRIPTION
  2745. "An index that identifies the channel that is the
  2746. source of packets for this bufferControl table.
  2747. The channel identified by a particular value of this
  2748. index is the same as identified by the same value of
  2749. the channelIndex object.
  2750. This object may not be modified if the associated
  2751. bufferControlStatus object is equal to valid(1)."
  2752. ::= { bufferControlEntry 2 }
  2753. bufferControlFullStatus OBJECT-TYPE
  2754. SYNTAX INTEGER {
  2755. spaceAvailable(1),
  2756. full(2)
  2757. }
  2758. ACCESS read-only
  2759. STATUS mandatory
  2760. DESCRIPTION
  2761. "This object shows whether the buffer has room to
  2762. accept new packets or if it is full.
  2763. If the status is spaceAvailable(1), the buffer is
  2764. accepting new packets normally. If the status is
  2765. full(2) and the associated bufferControlFullAction
  2766. object is wrapWhenFull, the buffer is accepting new
  2767. packets by deleting enough of the oldest packets
  2768. to make room for new ones as they arrive. Otherwise,
  2769. if the status is full(2) and the
  2770. bufferControlFullAction object is lockWhenFull,
  2771. then the buffer has stopped collecting packets.
  2772. When this object is set to full(2) the probe must
  2773. not later set it to spaceAvailable(1) except in the
  2774. case of a significant gain in resources such as
  2775. an increase of bufferControlOctetsGranted. In
  2776. particular, the wrap-mode action of deleting old
  2777. packets to make room for newly arrived packets
  2778. must not affect the value of this object."
  2779. ::= { bufferControlEntry 3 }
  2780. bufferControlFullAction OBJECT-TYPE
  2781. SYNTAX INTEGER {
  2782. lockWhenFull(1),
  2783. wrapWhenFull(2) -- FIFO
  2784. }
  2785. ACCESS read-write
  2786. STATUS mandatory
  2787. DESCRIPTION
  2788. "Controls the action of the buffer when it
  2789. reaches the full status. When in the lockWhenFull(1)
  2790. state and a packet is added to the buffer that
  2791. fills the buffer, the bufferControlFullStatus will
  2792. be set to full(2) and this buffer will stop capturing
  2793. packets."
  2794. ::= { bufferControlEntry 4 }
  2795. bufferControlCaptureSliceSize OBJECT-TYPE
  2796. SYNTAX INTEGER
  2797. ACCESS read-write
  2798. STATUS mandatory
  2799. DESCRIPTION
  2800. "The maximum number of octets of each packet
  2801. that will be saved in this capture buffer.
  2802. For example, if a 1500 octet packet is received by
  2803. the probe and this object is set to 500, then only
  2804. 500 octets of the packet will be stored in the
  2805. associated capture buffer. If this variable is set
  2806. to 0, the capture buffer will save as many octets
  2807. as is possible.
  2808. This object may not be modified if the associated
  2809. bufferControlStatus object is equal to valid(1)."
  2810. DEFVAL { 100 }
  2811. ::= { bufferControlEntry 5 }
  2812. bufferControlDownloadSliceSize OBJECT-TYPE
  2813. SYNTAX INTEGER
  2814. ACCESS read-write
  2815. STATUS mandatory
  2816. DESCRIPTION
  2817. "The maximum number of octets of each packet
  2818. in this capture buffer that will be returned in
  2819. an SNMP retrieval of that packet. For example,
  2820. if 500 octets of a packet have been stored in the
  2821. associated capture buffer, the associated
  2822. bufferControlDownloadOffset is 0, and this
  2823. object is set to 100, then the captureBufferPacket
  2824. object that contains the packet will contain only
  2825. the first 100 octets of the packet.
  2826. A prudent manager will take into account possible
  2827. interoperability or fragmentation problems that may
  2828. occur if the download slice size is set too large.
  2829. In particular, conformant SNMP implementations are not
  2830. required to accept messages whose length exceeds 484
  2831. octets, although they are encouraged to support larger
  2832. datagrams whenever feasible."
  2833. DEFVAL { 100 }
  2834. ::= { bufferControlEntry 6 }
  2835. bufferControlDownloadOffset OBJECT-TYPE
  2836. SYNTAX INTEGER
  2837. ACCESS read-write
  2838. STATUS mandatory
  2839. DESCRIPTION
  2840. "The offset of the first octet of each packet
  2841. in this capture buffer that will be returned in
  2842. an SNMP retrieval of that packet. For example,
  2843. if 500 octets of a packet have been stored in the
  2844. associated capture buffer and this object is set to
  2845. 100, then the captureBufferPacket object that
  2846. contains the packet will contain bytes starting
  2847. 100 octets into the packet."
  2848. DEFVAL { 0 }
  2849. ::= { bufferControlEntry 7 }
  2850. bufferControlMaxOctetsRequested OBJECT-TYPE
  2851. SYNTAX INTEGER
  2852. ACCESS read-write
  2853. STATUS mandatory
  2854. DESCRIPTION
  2855. "The requested maximum number of octets to be
  2856. saved in this captureBuffer, including any
  2857. implementation-specific overhead. If this variable
  2858. is set to -1, the capture buffer will save as many
  2859. octets as is possible.
  2860. When this object is created or modified, the probe
  2861. should set bufferControlMaxOctetsGranted as closely
  2862. to this object as is possible for the particular probe
  2863. implementation and available resources. However, if
  2864. the object has the special value of -1, the probe
  2865. must set bufferControlMaxOctetsGranted to -1."
  2866. DEFVAL { -1 }
  2867. ::= { bufferControlEntry 8 }
  2868. bufferControlMaxOctetsGranted OBJECT-TYPE
  2869. SYNTAX INTEGER
  2870. ACCESS read-only
  2871. STATUS mandatory
  2872. DESCRIPTION
  2873. "The maximum number of octets that can be
  2874. saved in this captureBuffer, including overhead.
  2875. If this variable is -1, the capture buffer will save
  2876. as many octets as possible.
  2877. When the bufferControlMaxOctetsRequested object is
  2878. created or modified, the probe should set this object
  2879. as closely to the requested value as is possible for
  2880. the particular probe implementation and available
  2881. resources.
  2882. However, if the request object has the special value
  2883. of -1, the probe must set this object to -1.
  2884. The probe must not lower this value except as a result
  2885. of a modification to the associated
  2886. bufferControlMaxOctetsRequested object.
  2887. When this maximum number of octets is reached
  2888. and a new packet is to be added to this
  2889. capture buffer and the corresponding
  2890. bufferControlFullAction is set to wrapWhenFull(2),
  2891. enough of the oldest packets associated with this
  2892. capture buffer shall be deleted by the agent so
  2893. that the new packet can be added. If the
  2894. corresponding bufferControlFullAction is set to
  2895. lockWhenFull(1), the new packet shall be discarded.
  2896. In either case, the probe must set
  2897. bufferControlFullStatus to full(2).
  2898. When the value of this object changes to a value less
  2899. than the current value, entries are deleted from
  2900. the captureBufferTable associated with this
  2901. bufferControlEntry. Enough of the
  2902. oldest of these captureBufferEntries shall be
  2903. deleted by the agent so that the number of octets
  2904. used remains less than or equal to the new value of
  2905. this object.
  2906. When the value of this object changes to a value
  2907. greater than the current value, the number of
  2908. associated captureBufferEntries may be allowed to
  2909. grow."
  2910. ::= { bufferControlEntry 9 }
  2911. bufferControlCapturedPackets OBJECT-TYPE
  2912. SYNTAX INTEGER
  2913. ACCESS read-only
  2914. STATUS mandatory
  2915. DESCRIPTION
  2916. "The number of packets currently in this
  2917. captureBuffer."
  2918. ::= { bufferControlEntry 10 }
  2919. bufferControlTurnOnTime OBJECT-TYPE
  2920. SYNTAX TimeTicks
  2921. ACCESS read-only
  2922. STATUS mandatory
  2923. DESCRIPTION
  2924. "The value of sysUpTime when this capture buffer was
  2925. first turned on."
  2926. ::= { bufferControlEntry 11 }
  2927. bufferControlOwner OBJECT-TYPE
  2928. SYNTAX OwnerString
  2929. ACCESS read-write
  2930. STATUS mandatory
  2931. DESCRIPTION
  2932. "The entity that configured this entry and is
  2933. therefore using the resources assigned to it."
  2934. ::= { bufferControlEntry 12 }
  2935. bufferControlStatus OBJECT-TYPE
  2936. SYNTAX EntryStatus
  2937. ACCESS read-write
  2938. STATUS mandatory
  2939. DESCRIPTION
  2940. "The status of this buffer Control Entry."
  2941. ::= { bufferControlEntry 13 }
  2942. captureBufferTable OBJECT-TYPE
  2943. SYNTAX SEQUENCE OF CaptureBufferEntry
  2944. ACCESS not-accessible
  2945. STATUS mandatory
  2946. DESCRIPTION
  2947. "A list of packets captured off of a channel."
  2948. ::= { capture 2 }
  2949. captureBufferEntry OBJECT-TYPE
  2950. SYNTAX CaptureBufferEntry
  2951. ACCESS not-accessible
  2952. STATUS mandatory
  2953. DESCRIPTION
  2954. "A packet captured off of an attached network. As an
  2955. example, an instance of the captureBufferPacketData
  2956. object might be named captureBufferPacketData.3.1783"
  2957. INDEX { captureBufferControlIndex, captureBufferIndex }
  2958. ::= { captureBufferTable 1 }
  2959. CaptureBufferEntry ::= SEQUENCE {
  2960. captureBufferControlIndex INTEGER (1..65535),
  2961. captureBufferIndex INTEGER (1..2147483647),
  2962. captureBufferPacketID INTEGER,
  2963. captureBufferPacketData OCTET STRING,
  2964. captureBufferPacketLength INTEGER,
  2965. captureBufferPacketTime INTEGER,
  2966. captureBufferPacketStatus INTEGER
  2967. }
  2968. captureBufferControlIndex OBJECT-TYPE
  2969. SYNTAX INTEGER (1..65535)
  2970. ACCESS read-only
  2971. STATUS mandatory
  2972. DESCRIPTION
  2973. "The index of the bufferControlEntry with which
  2974. this packet is associated."
  2975. ::= { captureBufferEntry 1 }
  2976. captureBufferIndex OBJECT-TYPE
  2977. SYNTAX INTEGER (1..2147483647)
  2978. ACCESS read-only
  2979. STATUS mandatory
  2980. DESCRIPTION
  2981. "An index that uniquely identifies an entry
  2982. in the captureBuffer table associated with a
  2983. particular bufferControlEntry. This index will
  2984. start at 1 and increase by one for each new packet
  2985. added with the same captureBufferControlIndex.
  2986. Should this value reach 2147483647, the next packet
  2987. added with the same captureBufferControlIndex shall
  2988. cause this value to wrap around to 1."
  2989. ::= { captureBufferEntry 2 }
  2990. captureBufferPacketID OBJECT-TYPE
  2991. SYNTAX INTEGER
  2992. ACCESS read-only
  2993. STATUS mandatory
  2994. DESCRIPTION
  2995. "An index that describes the order of packets
  2996. that are received on a particular interface.
  2997. The packetID of a packet captured on an
  2998. interface is defined to be greater than the
  2999. packetID's of all packets captured previously on
  3000. the same interface. As the captureBufferPacketID
  3001. object has a maximum positive value of 2^31 - 1,
  3002. any captureBufferPacketID object shall have the
  3003. value of the associated packet's packetID mod 2^31."
  3004. ::= { captureBufferEntry 3 }
  3005. captureBufferPacketData OBJECT-TYPE
  3006. SYNTAX OCTET STRING
  3007. ACCESS read-only
  3008. STATUS mandatory
  3009. DESCRIPTION
  3010. "The data inside the packet, starting at the
  3011. beginning of the packet plus any offset specified in
  3012. the associated bufferControlDownloadOffset,
  3013. including any link level headers. The length of the
  3014. data in this object is the minimum of the length of
  3015. the captured packet minus the offset, the length of
  3016. the associated bufferControlCaptureSliceSize minus
  3017. the offset, and the associated
  3018. bufferControlDownloadSliceSize. If this minimum is
  3019. less than zero, this object shall have a length of
  3020. zero."
  3021. ::= { captureBufferEntry 4 }
  3022. captureBufferPacketLength OBJECT-TYPE
  3023. SYNTAX INTEGER
  3024. ACCESS read-only
  3025. STATUS mandatory
  3026. DESCRIPTION
  3027. "The actual length (off the wire) of the packet stored
  3028. in this entry, including FCS octets."
  3029. ::= { captureBufferEntry 5 }
  3030. captureBufferPacketTime OBJECT-TYPE
  3031. SYNTAX INTEGER
  3032. ACCESS read-only
  3033. STATUS mandatory
  3034. DESCRIPTION
  3035. "The number of milliseconds that had passed since
  3036. this capture buffer was first turned on when this
  3037. packet was captured."
  3038. ::= { captureBufferEntry 6 }
  3039. captureBufferPacketStatus OBJECT-TYPE
  3040. SYNTAX INTEGER
  3041. ACCESS read-only
  3042. STATUS mandatory
  3043. DESCRIPTION
  3044. "A value which indicates the error status of this
  3045. packet.
  3046. The value of this object is defined in the same way as
  3047. filterPktStatus. The value is a sum. This sum
  3048. initially takes the value zero. Then, for each
  3049. error, E, that has been discovered in this packet,
  3050. 2 raised to a value representing E is added to the
  3051. sum.
  3052. The errors defined for a packet captured off of an
  3053. Ethernet interface are as follows:
  3054. bit # Error
  3055. 0 Packet is longer than 1518 octets
  3056. 1 Packet is shorter than 64 octets
  3057. 2 Packet experienced a CRC or Alignment
  3058. error
  3059. 3 First packet in this capture buffer after
  3060. it was detected that some packets were
  3061. not processed correctly.
  3062. 4 Packet's order in buffer is only
  3063. approximate (May only be set for packets
  3064. sent from the probe)
  3065. For example, an Ethernet fragment would have a
  3066. value of 6 (2^1 + 2^2).
  3067. As this MIB is expanded to new media types, this
  3068. object will have other media-specific errors defined."
  3069. ::= { captureBufferEntry 7 }
  3070. -- The Event Group
  3071. -- Implementation of the Event group is optional.
  3072. --
  3073. -- The Event group controls the generation and notification
  3074. -- of events from this device. Each entry in the eventTable
  3075. -- describes the parameters of the event that can be
  3076. -- triggered. Each event entry is fired by an associated
  3077. -- condition located elsewhere in the MIB. An event entry
  3078. -- may also be associated- with a function elsewhere in the
  3079. -- MIB that will be executed when the event is generated. For
  3080. -- example, a channel may be turned on or off by the firing
  3081. -- of an event.
  3082. --
  3083. -- Each eventEntry may optionally specify that a log entry
  3084. -- be created on its behalf whenever the event occurs.
  3085. -- Each entry may also specify that notification should
  3086. -- occur by way of SNMP trap messages. In this case, the
  3087. -- community for the trap message is given in the associated
  3088. -- eventCommunity object. The enterprise and specific trap
  3089. -- fields of the trap are determined by the condition that
  3090. -- triggered the event. Two traps are defined: risingAlarm
  3091. -- and fallingAlarm. If the eventTable is triggered by a
  3092. -- condition specified elsewhere, the enterprise and
  3093. -- specific trap fields must be specified for traps
  3094. -- generated for that condition.
  3095. eventTable OBJECT-TYPE
  3096. SYNTAX SEQUENCE OF EventEntry
  3097. ACCESS not-accessible
  3098. STATUS mandatory
  3099. DESCRIPTION
  3100. "A list of events to be generated."
  3101. ::= { event 1 }
  3102. eventEntry OBJECT-TYPE
  3103. SYNTAX EventEntry
  3104. ACCESS not-accessible
  3105. STATUS mandatory
  3106. DESCRIPTION
  3107. "A set of parameters that describe an event to be
  3108. generated when certain conditions are met. As an
  3109. example, an instance of the eventLastTimeSent object
  3110. might be named eventLastTimeSent.6"
  3111. INDEX { eventIndex }
  3112. ::= { eventTable 1 }
  3113. EventEntry ::= SEQUENCE {
  3114. eventIndex INTEGER (1..65535),
  3115. eventDescription DisplayString (SIZE (0..127)),
  3116. eventType INTEGER,
  3117. eventCommunity OCTET STRING (SIZE (0..127)),
  3118. eventLastTimeSent TimeTicks,
  3119. eventOwner OwnerString,
  3120. eventStatus EntryStatus
  3121. }
  3122. eventIndex OBJECT-TYPE
  3123. SYNTAX INTEGER (1..65535)
  3124. ACCESS read-only
  3125. STATUS mandatory
  3126. DESCRIPTION
  3127. "An index that uniquely identifies an entry in the
  3128. event table. Each such entry defines one event that
  3129. is to be generated when the appropriate conditions
  3130. occur."
  3131. ::= { eventEntry 1 }
  3132. eventDescription OBJECT-TYPE
  3133. SYNTAX DisplayString (SIZE (0..127))
  3134. ACCESS read-write
  3135. STATUS mandatory
  3136. DESCRIPTION
  3137. "A comment describing this event entry."
  3138. ::= { eventEntry 2 }
  3139. eventType OBJECT-TYPE
  3140. SYNTAX INTEGER {
  3141. none(1),
  3142. log(2),
  3143. snmp-trap(3), -- send an SNMP trap
  3144. log-and-trap(4)
  3145. }
  3146. ACCESS read-write
  3147. STATUS mandatory
  3148. DESCRIPTION
  3149. "The type of notification that the probe will make
  3150. about this event. In the case of log, an entry is
  3151. made in the log table for each event. In the case of
  3152. snmp-trap, an SNMP trap is sent to one or more
  3153. management stations."
  3154. ::= { eventEntry 3 }
  3155. eventCommunity OBJECT-TYPE
  3156. SYNTAX OCTET STRING (SIZE (0..127))
  3157. ACCESS read-write
  3158. STATUS mandatory
  3159. DESCRIPTION
  3160. "If an SNMP trap is to be sent, it will be sent to
  3161. the SNMP community specified by this octet string.
  3162. In the future this table will be extended to include
  3163. the party security mechanism. This object shall be
  3164. set to a string of length zero if it is intended that
  3165. that mechanism be used to specify the destination of
  3166. the trap."
  3167. ::= { eventEntry 4 }
  3168. eventLastTimeSent OBJECT-TYPE
  3169. SYNTAX TimeTicks
  3170. ACCESS read-only
  3171. STATUS mandatory
  3172. DESCRIPTION
  3173. "The value of sysUpTime at the time this event
  3174. entry last generated an event. If this entry has
  3175. not generated any events, this value will be
  3176. zero."
  3177. ::= { eventEntry 5 }
  3178. eventOwner OBJECT-TYPE
  3179. SYNTAX OwnerString
  3180. ACCESS read-write
  3181. STATUS mandatory
  3182. DESCRIPTION
  3183. "The entity that configured this entry and is
  3184. therefore using the resources assigned to it.
  3185. If this object contains a string starting with
  3186. 'monitor' and has associated entries in the log
  3187. table, all connected management stations should
  3188. retrieve those log entries, as they may have
  3189. significance to all management stations connected to
  3190. this device"
  3191. ::= { eventEntry 6 }
  3192. eventStatus OBJECT-TYPE
  3193. SYNTAX EntryStatus
  3194. ACCESS read-write
  3195. STATUS mandatory
  3196. DESCRIPTION
  3197. "The status of this event entry.
  3198. If this object is not equal to valid(1), all
  3199. associated log entries shall be deleted by the
  3200. agent."
  3201. ::= { eventEntry 7 }
  3202. --
  3203. logTable OBJECT-TYPE
  3204. SYNTAX SEQUENCE OF LogEntry
  3205. ACCESS not-accessible
  3206. STATUS mandatory
  3207. DESCRIPTION
  3208. "A list of events that have been logged."
  3209. ::= { event 2 }
  3210. logEntry OBJECT-TYPE
  3211. SYNTAX LogEntry
  3212. ACCESS not-accessible
  3213. STATUS mandatory
  3214. DESCRIPTION
  3215. "A set of data describing an event that has been
  3216. logged. For example, an instance of the
  3217. logDescription object might be named
  3218. logDescription.6.47"
  3219. INDEX { logEventIndex, logIndex }
  3220. ::= { logTable 1 }
  3221. LogEntry ::= SEQUENCE {
  3222. logEventIndex INTEGER (1..65535),
  3223. logIndex INTEGER (1..2147483647),
  3224. logTime TimeTicks,
  3225. logDescription DisplayString (SIZE (0..255))
  3226. }
  3227. logEventIndex OBJECT-TYPE
  3228. SYNTAX INTEGER (1..65535)
  3229. ACCESS read-only
  3230. STATUS mandatory
  3231. DESCRIPTION
  3232. "The event entry that generated this log
  3233. entry. The log identified by a particular
  3234. value of this index is associated with the same
  3235. eventEntry as identified by the same value
  3236. of eventIndex."
  3237. ::= { logEntry 1 }
  3238. logIndex OBJECT-TYPE
  3239. SYNTAX INTEGER (1..2147483647)
  3240. ACCESS read-only
  3241. STATUS mandatory
  3242. DESCRIPTION
  3243. "An index that uniquely identifies an entry
  3244. in the log table amongst those generated by the
  3245. same eventEntries. These indexes are
  3246. assigned beginning with 1 and increase by one
  3247. with each new log entry. The association
  3248. between values of logIndex and logEntries
  3249. is fixed for the lifetime of each logEntry.
  3250. The agent may choose to delete the oldest
  3251. instances of logEntry as required because of
  3252. lack of memory. It is an implementation-specific
  3253. matter as to when this deletion may occur."
  3254. ::= { logEntry 2 }
  3255. logTime OBJECT-TYPE
  3256. SYNTAX TimeTicks
  3257. ACCESS read-only
  3258. STATUS mandatory
  3259. DESCRIPTION
  3260. "The value of sysUpTime when this log entry was
  3261. created."
  3262. ::= { logEntry 3 }
  3263. logDescription OBJECT-TYPE
  3264. SYNTAX DisplayString (SIZE (0..255))
  3265. ACCESS read-only
  3266. STATUS mandatory
  3267. DESCRIPTION
  3268. "An implementation dependent description of the
  3269. event that activated this log entry."
  3270. ::= { logEntry 4 }
  3271. -- These definitions use the TRAP-TYPE macro as
  3272. -- defined in RFC 1215 [10]
  3273. -- Remote Network Monitoring Traps
  3274. risingAlarm TRAP-TYPE
  3275. ENTERPRISE rmon
  3276. VARIABLES { alarmIndex, alarmVariable, alarmSampleType,
  3277. alarmValue, alarmRisingThreshold }
  3278. DESCRIPTION
  3279. "The SNMP trap that is generated when an alarm
  3280. entry crosses its rising threshold and generates
  3281. an event that is configured for sending SNMP
  3282. traps."
  3283. ::= 1
  3284. fallingAlarm TRAP-TYPE
  3285. ENTERPRISE rmon
  3286. VARIABLES { alarmIndex, alarmVariable, alarmSampleType,
  3287. alarmValue, alarmFallingThreshold }
  3288. DESCRIPTION
  3289. "The SNMP trap that is generated when an alarm
  3290. entry crosses its falling threshold and generates
  3291. an event that is configured for sending SNMP
  3292. traps."
  3293. ::= 2
  3294. END