1       HP-ICF-LINKTEST DEFINITIONS ::= BEGIN
2
3       IMPORTS
4           Integer32, OBJECT-TYPE, MODULE-IDENTITY
5               FROM SNMPv2-SMI
6           RowStatus, TimeInterval
7               FROM SNMPv2-TC
8           MODULE-COMPLIANCE, OBJECT-GROUP
9               FROM SNMPv2-CONF
10           OwnerString
11               FROM RMON-MIB
12           hpicfObjectModules, hpicfCommon
13               FROM HP-ICF-OID;
14
15       hpicfLinkTestMib MODULE-IDENTITY
16            LAST-UPDATED "200011032225Z"  -- November 3, 2000
17            ORGANIZATION "Hewlett Packard Company,
18                          Network Infrastructure Solutions"
19            CONTACT-INFO
20                    "Hewlett Packard Company
21                     8000 Foothills Blvd.
22                     Roseville, CA 95747"
23            DESCRIPTION
24                    "This MIB module describes objects for managing
25                    the link test features of devices in the HP
26                    Integrated Communication Facility product line."
27
28            REVISION     "200011032225Z"  -- November 3, 2000
29            DESCRIPTION  "Updated division name."
30
31            REVISION     "9703060338Z"  -- March 6, 1997
32            DESCRIPTION
33                    "Added 'destroyWhenDone' capability."
34            REVISION     "9609062218Z"  -- September 6, 1996
35            DESCRIPTION
36                    "Initial version of this MIB module."
37            ::= { hpicfObjectModules 7 }
38
39
40
41       -- The HP ICF Linktest Group
42
43       hpicfLinktest OBJECT IDENTIFIER ::= { hpicfCommon 6 }
44
45       hpicfLinkTestNextIndex OBJECT-TYPE
46           SYNTAX     Integer32 (0..65535)
47           MAX-ACCESS read-write
48           STATUS     current
49           DESCRIPTION
50                   "A currently unassigned value of hpicfLinkTestIndex.
51                   The value 0 indicates that no unassigned values are
52                   available.
53
54                   In order to cause a non-zero value of this object to
55                   be assigned for use as the hpicfLinkTestIndex of a
56                   future link test, it must be successfully modified by
57                   a set operation.  When modified by a set operation,
58                   the new value must precisely match the value
59                   presently held by the object.  If not, the management
60                   protocol set operation will fail.
61
62                   Immediately after the completion of a successful set
63                   operation, the agent must modify the value of this
64                   object.  The algorithm for modifying the value is
65                   implementation-dependent, and may use a subset of
66                   values within the legal range.  However, the agent
67                   must guarantee that the new value is not assigned to
68                   any in-use value of hpicfLinkTestIndex.
69
70                   A management station creates a new link test using
71                   this algorithm:
72
73                      - issue a management protocol retrieval operation
74                        to obtain the value of hpicfLinkTestNextIndex;
75                        if the retrieved value is zero, a new link test
76                        cannot be created at this time;
77
78                      - issue a management protocol set operation for
79                        hpicfLinkTestNextIndex, supplying the same value
80                        as obtained in the previous step;
81
82                      - if the set operation succeeds, use the supplied
83                        value as the hpicfLinkTestIndex of the new
84                        link test; if the set operation fails, go back
85                        to the first step and obtain a new value for
86                        hpicfLinkTestNextIndex;
87
88                      - issue a management protocol set operation to
89                        create an instance of the hpicfLinkTestStatus
90                        object setting its value to 'createAndGo' or
91                        'createAndWait' (as specified in the description
92                        of the RowStatus textual convention).
93
94                    Note that the set of hpicfLinkTestNextIndex and the
95                    instance of hpicfLinkTestStatus may occur in the
96                    same set operation if desired."
97           ::= { hpicfLinktest 1 }
98
99       hpicfLinkTestTable OBJECT-TYPE
100           SYNTAX     SEQUENCE OF HpicfLinkTestEntry
101           MAX-ACCESS not-accessible
102           STATUS     current
103           DESCRIPTION
104                   "A table of in-progress link tests."
105           ::= { hpicfLinktest 2 }
106
107       hpicfLinkTestEntry OBJECT-TYPE
108           SYNTAX     HpicfLinkTestEntry
109           MAX-ACCESS not-accessible
110           STATUS     current
111           DESCRIPTION
112                   "A row in the table, containing information about a
113                   single link test."
114           INDEX      { hpicfLinkTestIndex }
115           ::= { hpicfLinkTestTable 1 }
116
117       HpicfLinkTestEntry ::=
118           SEQUENCE {
119               hpicfLinkTestIndex              Integer32,
120               hpicfLinkTestType               INTEGER,
121               hpicfLinkTestAddress            OCTET STRING,
122               hpicfLinkTestIfIndex            Integer32,
123               hpicfLinkTestTimeout            TimeInterval,
124               hpicfLinkTestRepetitions        Integer32,
125               hpicfLinkTestAttempts           Integer32,
126               hpicfLinkTestSuccesses          Integer32,
127               hpicfLinkTestMinRespTime        Integer32,
128               hpicfLinkTestMaxRespTime        Integer32,
129               hpicfLinkTestTotalRespTime      Integer32,
130               hpicfLinkTestOwner              OwnerString,
131               hpicfLinkTestStatus             RowStatus,
132               hpicfLinkTestDeleteMode         INTEGER
133           }
134
135       hpicfLinkTestIndex OBJECT-TYPE
136           SYNTAX     Integer32 (1..65535)
137           MAX-ACCESS not-accessible
138           STATUS     current
139           DESCRIPTION
140                   "The value of this object uniquely identifies this
141                   link test."
142           ::= { hpicfLinkTestEntry 1 }
143
144       hpicfLinkTestType OBJECT-TYPE
145           SYNTAX     INTEGER {
146                          icmpEcho(1),
147                          ieee8022Test(2),
148                          ipxDiagnostic(3)
149                      }
150           MAX-ACCESS read-create
151           STATUS     current
152           DESCRIPTION
153                   "The type of test to run."
154           ::= { hpicfLinkTestEntry 2 }
155
156       hpicfLinkTestAddress OBJECT-TYPE
157           SYNTAX     OCTET STRING (SIZE(4|6|10))
158           MAX-ACCESS read-create
159           STATUS     current
160           DESCRIPTION
161                   "The destination address used for sending link test
162                   packets, formatted according to the value of the
163                   corresponding instance of hpicfLinkTestType.  When
164                   hpicfLinkTestType is equal to 'icmpEcho', this object
165                   will be four octets long, and contain an IP address
166                   in network byte order.  When hpicfLinkTestType is
167                   equal to 'ieee8022Test', this object will be six
168                   octets long, and contain an IEEE MAC address in
169                   canonical order.  When hpicfLinkTestType is equal to
170                   'ipxDiagnostic', this object will be ten octets long,
171                   and will contain the IPX network number in network
172                   byte order, followed by the IPX node number in
173                   network byte order."
174           ::= { hpicfLinkTestEntry 3 }
175
176       hpicfLinkTestIfIndex OBJECT-TYPE
177           SYNTAX     Integer32
178           MAX-ACCESS read-create
179           STATUS     current
180           DESCRIPTION
181                   "The local interface to send the link test packets
182                   on.  The value of this object must correspond to an
183                   ifIndex value for an interface capable of supporting
184                   the requested link test.  The value 0 is used to
185                   indicate that the agent should determine the
186                   interface using local routing information."
187           DEFVAL     { 0 }
188           ::= { hpicfLinkTestEntry 4 }
189
190       hpicfLinkTestTimeout OBJECT-TYPE
191           SYNTAX     TimeInterval
192           MAX-ACCESS read-create
193           STATUS     current
194           DESCRIPTION
195                   "The time interval over which a link test response
196                   must be recieved, or the test is counted as failed."
197           DEFVAL     { 100 }    -- one second
198           ::= { hpicfLinkTestEntry 5 }
199
200       hpicfLinkTestRepetitions OBJECT-TYPE
201           SYNTAX     Integer32 (1..65535)
202           MAX-ACCESS read-create
203           STATUS     current
204           DESCRIPTION
205                   "The total number of times that the agent should
206                   send link test packets to the destination host."
207           DEFVAL     { 1 }
208           ::= { hpicfLinkTestEntry 6 }
209
210       hpicfLinkTestAttempts OBJECT-TYPE
211           SYNTAX     Integer32 (0..65535)
212           MAX-ACCESS read-only
213           STATUS     current
214           DESCRIPTION
215                   "The number of times we have sent link test packets
216                   to the destination during the current test.  This
217                   object will start at zero when the corresponding
218                   instance of hpicfLinkTestStatus is set to 'active'.
219                   It will increment at the completion of each iteration
220                   of the test until either it reaches the value of
221                   hpicfLinkTestRepetitions, or the corresponding
222                   instance of hpicfLinkTestStatus is set to a value
223                   other than 'active'.  Note that it is incremented
224                   at the completion of each iteration, not when the
225                   link test packet is sent, so that the number of
226                   failures can be calculated accurately."
227           ::= { hpicfLinkTestEntry 7 }
228
229       hpicfLinkTestSuccesses OBJECT-TYPE
230           SYNTAX     Integer32 (0..65535)
231           MAX-ACCESS read-only
232           STATUS     current
233           DESCRIPTION
234                   "The number of times that we have received a response
235                   to a link test packet during the current test.  This
236                   object will start at zero when the corresponding
237                   instance of hpicfLinkTestStatus is set to 'active'.
238                   It will increment each time the agent receives a
239                   response from the destination of this test.  Note
240                   that the number of failed attempts is given by
241                   hpicfLinkTestAttempts - hpicfLinkTestSuccesses."
242           ::= { hpicfLinkTestEntry 8 }
243
244       hpicfLinkTestMinRespTime OBJECT-TYPE
245           SYNTAX     Integer32
246           MAX-ACCESS read-only
247           STATUS     current
248           DESCRIPTION
249                   "The shortest time (in milliseconds) between request
250                   and response for all of the link tests that have been
251                   attempted as part of this test."
252           ::= { hpicfLinkTestEntry 9 }
253
254       hpicfLinkTestMaxRespTime OBJECT-TYPE
255           SYNTAX     Integer32
256           MAX-ACCESS read-only
257           STATUS     current
258           DESCRIPTION
259                   "The longest time (in milliseconds) between request
260                   and response for all of the link tests that have been
261                   attempted as part of this test."
262           ::= { hpicfLinkTestEntry 10 }
263
264       hpicfLinkTestTotalRespTime OBJECT-TYPE
265           SYNTAX     Integer32
266           MAX-ACCESS read-only
267           STATUS     current
268           DESCRIPTION
269                   "The sum of all of the response times (in
270                   milliseconds) for all of the link tests that have
271                   been attempted as part of this test.  This value can
272                   be used in conjunction with hpicfLinkTestSuccesses
273                   to calculate the average response time."
274           ::= { hpicfLinkTestEntry 11 }
275
276       hpicfLinkTestOwner OBJECT-TYPE
277           SYNTAX     OwnerString
278           MAX-ACCESS read-create
279           STATUS     current
280           DESCRIPTION
281                   "The entity that configured this test and is
282                   therefore using the resources assigned to it."
283           ::= { hpicfLinkTestEntry 12 }
284
285       hpicfLinkTestStatus OBJECT-TYPE
286           SYNTAX     RowStatus
287           MAX-ACCESS read-create
288           STATUS     current
289           DESCRIPTION
290                   "The status of this entry."
291           ::= { hpicfLinkTestEntry 13 }
292
293       hpicfLinkTestDeleteMode OBJECT-TYPE
294           SYNTAX     INTEGER {
295                          keepWhenDone(1),
296                          destroyWhenDone(2)
297                      }
298           MAX-ACCESS read-create
299           STATUS     current
300           DESCRIPTION
301                   "When the value of this object is 'keepWhenDone',
302                   the associated instance of the hpicfLinkTestStatus
303                   object will be changed to 'notInService' upon
304                   completion of the test.  It will then be timed out
305                   by the agent after 5 minutes in the 'notInService'
306                   state.
307
308                   When the value of this object is 'destroyWhenDone',
309                   the assocated instance of the hpicfLinkTestStatus
310                   object will be changed to 'destroy' upon completion
311                   of the test.  This will remove the row from the
312                   table immediately after the test completes."
313           DEFVAL     { keepWhenDone }
314           ::= { hpicfLinkTestEntry 14 }
315
316       -- Conformance information
317
318       hpicfLinkTestConformance
319           OBJECT IDENTIFIER ::= { hpicfLinkTestMib 1 }
320
321       hpicfLinkTestCompliances
322           OBJECT IDENTIFIER ::= { hpicfLinkTestConformance 1 }
323       hpicfLinkTestGroups
324           OBJECT IDENTIFIER ::= { hpicfLinkTestConformance 2 }
325
326
327       -- Compliance statements
328
329       hpicfLinkTestCompliance MODULE-COMPLIANCE
330           STATUS     deprecated
331           DESCRIPTION
332                   "The compliance statement for ICF devices that
333                   provide a connectivity test facility."
334           MODULE
335               MANDATORY-GROUPS { hpicfLinkTestGroup }
336
337           ::= { hpicfLinkTestCompliances 1 }
338
339       hpicfLinkTestCompliance2 MODULE-COMPLIANCE
340           STATUS     current
341           DESCRIPTION
342                   "The compliance statement for ICF devices that
343                   provide a connectivity test facility."
344           MODULE
345               MANDATORY-GROUPS { hpicfLinkTestGroup2 }
346
347           ::= { hpicfLinkTestCompliances 2 }
348
349
350       -- Units of conformance
351
352       hpicfLinkTestGroup OBJECT-GROUP
353           OBJECTS    { hpicfLinkTestNextIndex,
354                        hpicfLinkTestType,
355                        hpicfLinkTestAddress,
356                        hpicfLinkTestIfIndex,
357                        hpicfLinkTestTimeout,
358                        hpicfLinkTestRepetitions,
359                        hpicfLinkTestAttempts,
360                        hpicfLinkTestSuccesses,
361                        hpicfLinkTestMinRespTime,
362                        hpicfLinkTestMaxRespTime,
363                        hpicfLinkTestTotalRespTime,
364                        hpicfLinkTestOwner,
365                        hpicfLinkTestStatus
366                      }
367           STATUS     deprecated
368           DESCRIPTION
369                   "A collection of objects for initiating and
370                   monitoring network connectivity tests on ICF
371                   devices."
372           ::= { hpicfLinkTestGroups 1 }
373
374       hpicfLinkTestGroup2 OBJECT-GROUP
375           OBJECTS    { hpicfLinkTestNextIndex,
376                        hpicfLinkTestType,
377                        hpicfLinkTestAddress,
378                        hpicfLinkTestIfIndex,
379                        hpicfLinkTestTimeout,
380                        hpicfLinkTestRepetitions,
381                        hpicfLinkTestAttempts,
382                        hpicfLinkTestSuccesses,
383                        hpicfLinkTestMinRespTime,
384                        hpicfLinkTestMaxRespTime,
385                        hpicfLinkTestTotalRespTime,
386                        hpicfLinkTestOwner,
387                        hpicfLinkTestStatus,
388                        hpicfLinkTestDeleteMode
389                      }
390           STATUS     current
391           DESCRIPTION
392                   "A collection of objects for initiating and
393                   monitoring network connectivity tests on ICF
394                   devices."
395           ::= { hpicfLinkTestGroups 2 }
396
397
398       END
399
400