1-- *****************************************************************
2-- UBQS-TC:  Ubiquoss MIB Textual Conventions
3--
4-- June 2009, Hyung Eun Park
5--
6-- Copyright (c) 2009 by Ubiquoss, Corp.
7-- All rights reserved.
8-- ****************************************************************
9
10UBQS-TC DEFINITIONS ::= BEGIN
11
12IMPORTS
13    MODULE-IDENTITY,
14    Gauge32,
15    Integer32,
16    Unsigned32,
17    Counter64
18        FROM SNMPv2-SMI
19    TEXTUAL-CONVENTION
20        FROM SNMPv2-TC;
21
22
23-- 2010.11.26, defined bridge id (IEEE 8021)
24--UbiBridgeId ::= TEXTUAL-CONVENTION
25--    STATUS          current
26--    DESCRIPTION
27--		"Represents the bridge id.
28--			bridge id : 1 ~ 32
29--			backbone
30--			beb
31--		"
32--	SYNTAX	 OCTET STRING (SIZE (0..64))
33
34UbiBridgeId ::= TEXTUAL-CONVENTION
35    STATUS          current
36    DESCRIPTION
37		"Represents the bridge id.
38			bridge id : 1 ~ 32
39			default bridge (1000)
40			backbone(1001)
41		"
42	SYNTAX	 INTEGER {
43		-- looking for better mechanism to represent the bridge id
44		default(1000),
45		backbone(1001)
46	}
47
48
49Layer2Cos ::= TEXTUAL-CONVENTION
50    STATUS          current
51    DESCRIPTION
52        "An integer that is in the range of the layer 2 CoS values. It
53        corresponds to the IEEE 802.1P CoS value which defines eight
54        (2^3) user priority levels.
55        Note: the IEEE 802.1P has been merged into IEEE 802.1D."
56
57    REFERENCE
58        "IEEE 802.1D, 2004 Edition, Annex G User priorities and traffic
59            classes."
60    SYNTAX          Integer32 (0..7 )
61
62UbiNetworkProtocol ::= TEXTUAL-CONVENTION
63    STATUS          current
64    DESCRIPTION
65        "Represents the different types of network layer protocols."
66    SYNTAX          INTEGER  {
67                        ip(1),
68                        decnet(2),
69                        pup(3),
70                        chaos(4),
71                        xns(5),
72                        x121(6),
73                        appletalk(7),
74                        clns(8),
75                        lat(9),
76                        vines(10),
77                        cons(11),
78                        apollo(12),
79                        stun(13),
80                        novell(14),
81                        qllc(15),
82                        snapshot(16),
83                        atmIlmi(17),
84                        bstun(18),
85                        x25pvc(19),
86                        ipv6(20),
87                        cdm(21),
88                        nbf(22),
89                        bpxIgx(23),
90                        clnsPfx(24),
91                        http(25),
92                        unknown(65535)
93                    }
94
95UbiNetworkAddress ::= TEXTUAL-CONVENTION
96    STATUS          current
97    DESCRIPTION
98        "Represents a network layer address.  The length and format of
99        the address is protocol dependent as follows:
100        ip        4 octets
101        decnet    2 octets
102        pup       obsolete
103        chaos     2 octets
104        xns       10 octets
105                  first 4 octets are the net number
106                  last 6 octets are the host number
107        x121
108        appletalk 3 octets
109                  first 2 octets are the net number
110                  last octet is the host number
111        clns
112        lat
113        vines     6 octets
114                  first 4 octets are the net number
115                  last 2 octets are the host number
116        cons
117        apollo    10 octets
118                  first 4 octets are the net number
119                  last 6 octets are the host number
120        stun      8 octets
121        novell    10 octets
122                  first 4 octets are the net number
123                  last 6 octets are the host number
124        qllc      6 octets
125        bstun     1 octet - bi-sync serial tunnel
126        snapshot  1 octet
127        atmIlmi   4 octets
128        x25 pvc   2 octets (12 bits)
129        ipv6      16 octets
130        cdm
131        nbf
132        bgpIgx
133        clnsPfx  upto 20 octets
134        http     upto 70 octets
135                 first 4 octets are the IPv4 host
136                 address
137                 next 2 octets are the TCP port
138                 number
139                 remaining(1 upto 64) octets are
140                 the URI"
141    SYNTAX          OCTET STRING
142
143Unsigned64 ::= TEXTUAL-CONVENTION
144    STATUS          current
145    DESCRIPTION
146        "An unsigned 64 bit integer. We use SYNTAX Counter64 for the
147        encoding rules."
148    SYNTAX          Counter64
149
150InterfaceIndexOrZero ::= TEXTUAL-CONVENTION
151    STATUS          current
152    DESCRIPTION
153        "Either the value 0, or the ifIndex value of an
154        interface in the ifTable."
155    SYNTAX          Integer32 (0..2147483647 )
156
157SAPType ::= TEXTUAL-CONVENTION
158    STATUS          current
159    DESCRIPTION
160        "Service Access Point - is a term that denotes the means
161        by which a user entity in layer n+1 accesses a service
162        of a provider entity in layer n."
163    SYNTAX          Integer32 (0..254 )
164
165CountryCode ::= TEXTUAL-CONVENTION
166    STATUS          current
167    DESCRIPTION
168        "Represents a case-insensitive 2-letter country code taken
169        from ISO-3166. Unrecognized countries are represented as
170        empty string."
171    SYNTAX          OCTET STRING (SIZE (0  |  2))
172
173CountryCodeITU ::= TEXTUAL-CONVENTION
174    STATUS          current
175    DESCRIPTION
176        "This textual convention represents a country or area code for
177        non-standard facilities in telematic services."
178
179    REFERENCE       "ITU-T T.35 - Section 3.1 Country Code"
180    SYNTAX          Unsigned32 (0..255 )
181
182EntPhysicalIndexOrZero ::= TEXTUAL-CONVENTION
183    STATUS          current
184    DESCRIPTION
185        "This textual convention is an extension of entPhysicalIndex.
186        If non-zero, the object is an entPhysicalIndex. If zero, no
187        appropriate entPhysicalIndex exists. Any additional semantics
188        are object specific."
189    SYNTAX          Integer32 (0..2147483647 )
190
191UbiRowOperStatus ::= TEXTUAL-CONVENTION
192    STATUS          current
193    DESCRIPTION
194        "Represents the operational status of an table entry.
195        This textual convention allows explicitly representing
196        the states of rows dependent on rows in other tables.
197
198        active(1) -
199            Indicates this entry's RowStatus is active
200            and the RowStatus for each dependency is active.
201
202        activeDependencies(2) -
203            Indicates that the RowStatus for each dependency
204            is active, but the entry's RowStatus is not active.
205
206        inactiveDependency(3) -
207            Indicates that the RowStatus for at least one
208            dependency is not active.
209
210        missingDependency(4) -
211            Indicates that at least one dependency does
212            not exist in it's table."
213    SYNTAX          INTEGER  {
214                        active(1),
215                        activeDependencies(2),
216                        inactiveDependency(3),
217                        missingDependency(4)
218                    }
219
220UbiPort ::= TEXTUAL-CONVENTION
221    STATUS          current
222    DESCRIPTION
223        "The TCP or UDP port number range."
224
225    REFERENCE
226        "Transmission Control Protocol. J. Postel. RFC793,
227            User Datagram Protocol. J. Postel. RFC768"
228    SYNTAX          Integer32 (0..65535 )
229
230UbiIpProtocol ::= TEXTUAL-CONVENTION
231    STATUS          current
232    DESCRIPTION
233        "IP protocol number range."
234
235    REFERENCE       "Internet Protocol. J. Postel. RFC791"
236    SYNTAX          Integer32 (0..255 )
237
238UbiLocationClass ::= TEXTUAL-CONVENTION
239    STATUS          current
240    DESCRIPTION
241        "An enumerated value which provides an indication of
242        the general location type of a particular physical and/or
243        logical interface.
244        chassis - a system framework for mounting one or more
245                  shelves/slots/cards.
246        shelf - a cabinet that holds one or more slots.
247        slot -  card or subSlot holder.
248        subSlot - daughter-card holder.
249        port - a physical port (e.g., a DS1 or DS3 physical port).
250        subPort - a logical port on a physical port (e.g., a DS1
251                  subPort on a DS3 physical port).
252        channel - a logical interface (e.g., a DS0 channel, signaling
253                  channel, ATM port, other virtual interfaces).
254        subChannel - a sub-channel on a logical interface."
255    SYNTAX          INTEGER  {
256                        chassis(1),
257                        shelf(2),
258                        slot(3),
259                        subSlot(4),
260                        port(5),
261                        subPort(6),
262                        channel(7),
263                        subChannel(8)
264                    }
265
266UbiLocationSpecifier ::= TEXTUAL-CONVENTION
267    STATUS          current
268    DESCRIPTION
269        "Use this TC to define objects that indicate the
270        physical entity and/or logical interface location
271        of a managed entity on a managed device. In SNMP, a
272        standard mechanism for indicating the physical location
273        of entities is via the ENTITY-MIB. However, that approach
274        is not satisfactory in some cases because:
275
276        1. The entity requiring a location-based naming may be
277           associated with an entity which can not be represented
278           as a physical entity in the ENTITY-MIB,
279        2. NMS applications may desire a more direct
280           name/representation of a physical entity than is
281           available via the ENTITY-MIB, e.g., a physical entity
282           which is named via a hierarchy of levels in the ENTITY-MIB.
283
284        The value of an object defined using this TC is an ASCII
285        string consisting of zero or more elements separated by
286        commas. Each element is of the form  = .
287
288        An example of this syntax is 'slot=5,port=3'.
289
290        The syntax of the string is formally specified using
291        ABNF notation (with one exception, noted below), as
292        follows:
293
294        location-specifier =  elem *(',' elem)
295                       ; subject to
296                       ; size restriction specified in the SYNTAX
297                       ; clause below
298
299        elem    =   loctype '=' number
300
301        number  = %x00-FFFFFFFF / %d0-4294967295
302
303        loctype = 1*32VCHAR
304
305        It is recommended that loctype use one of the enumerated
306        labels defined for UbiLocationClass.
307
308        (NOTE: To conform to ABNF notation as defined in RFC2234,
309         substitute the single-quote symbol with a double-quote
310         symbol in the above rules.)
311
312        A zero length of UbiLocationSpecifier is object-specific
313        and must be defined as part of the description of any object
314        which uses this syntax."
315
316    REFERENCE
317        "RFC2234, Augmented BNF for syntax specifications: ABNF"
318    SYNTAX          OCTET STRING (SIZE (0..255))
319
320UbiInetAddressMask ::= TEXTUAL-CONVENTION
321    STATUS          current
322    DESCRIPTION
323        "Denotes a generic Internet subnet address mask.
324        The Internet subnet address mask is represented as the
325        number of contiguous 1-bit from MSB (most significant bit)
326        of the Internet subnet address mask.
327        A UbiInetAddressMask value is always interpreted within
328        the context of an InetAddressType value. The
329        InetAddressType only object or InetAddressType with
330        InetAddress objects which define the context must be
331        registered immediately before the object which uses the
332        UbiInetAddressMask textual convention.  In other words,
333        the object identifiers for the InetAddressType object and
334        the UbiInetAddressMask object MUST have the same length
335        and the last sub-identifier of the InetAddressType object
336        MUST be 1 less than the last sub-identifier of the
337        UbiInetAddressMask object and MUST be 2 less than the
338        last sub-identifier of the UbiInetAddressMask object if
339        an InetAddress object is defined between InetAddressType
340        and UbiInetAddressMask objects.
341        The maximum value of the UbiInetAddressMask TC is 32 for
342        the value 'ipv4(1)' in InetAddressType object and 128 for
343        the value 'ipv6(2)' in InetAddressType object.
344        The value zero is object-specific and must therefore be
345        defined as part of the description of any object which
346        uses this syntax.  Examples of the usage of zero might
347        include situations where Internet subnet mask was unknown,
348        or when none subnet masks need to be referenced."
349
350    REFERENCE
351        "RFC2851, Textual Conventions for Internet Network Addresses."
352    SYNTAX          Unsigned32 (0..128 )
353
354UbiAbsZeroBasedCounter32 ::= TEXTUAL-CONVENTION
355    STATUS          current
356    DESCRIPTION
357        "This TC describes an object which counts events with the
358        following semantics: objects of this type will be set to
359        zero(0) on creation and will thereafter count appropriate
360        events, it locks at the maximum value of 4,294,967,295 if
361        the counter overflows.
362        This TC may be used only in situations where wrapping is
363        not possible or extremely unlikely situation."
364    SYNTAX          Gauge32
365
366UbiSnapShotAbsCounter32 ::= TEXTUAL-CONVENTION
367    STATUS          current
368    DESCRIPTION
369        "This TC describes an object which stores a snap-shot value
370        with the following semantics: objects of this type will
371        take a snap-shot value from their associated
372        UbiAbsZeroBasedCounter32 type objects on creation."
373    SYNTAX          Unsigned32
374
375UbiAlarmSeverity ::= TEXTUAL-CONVENTION
376    STATUS          current
377    DESCRIPTION
378        "Represents the perceived alarm severity associated
379        with a service or safety affecting condition and/or
380        event.  These are based on ITU severities, except
381        that info(7) is added.
382
383            cleared(1) -
384                Indicates a previous alarm condition has been
385                cleared.  It is not required (unless specifically
386                stated elsewhere on a case by case basis) that an
387                alarm condition that has been cleared will produce
388                a notification or other event containing an
389                alarm severity with this value.
390
391            indeterminate(2) -
392                Indicates that the severity level cannot be
393                determined.
394
395            critical(3) -
396                Indicates that a service or safety affecting
397                condition has occurred and an immediate
398                corrective action is required.
399
400            major(4) -
401                Indicates that a service affecting condition has
402                occurred and an urgent corrective action is
403                required.
404
405            minor(5) -
406                Indicates the existence of a non-service affecting
407                condition and that corrective action should be
408                taken in order to prevent a more serious (for
409                example, service or safety affecting) condition.
410
411            warning(6) -
412                Indicates the detection of a potential or impending
413                service or safety affecting condition, before any
414                significant effects have been felt.
415
416            info(7) -
417                Indicates an alarm condition that does not
418                meet any other severity definition.  This can
419                include important, but non-urgent, notices or
420                informational events."
421
422    REFERENCE       "ITU-X.733"
423    SYNTAX          INTEGER  {
424                        cleared(1),
425                        indeterminate(2),
426                        critical(3),
427                        major(4),
428                        minor(5),
429                        warning(6),
430                        info(7)
431                    }
432
433PerfHighIntervalCount ::= TEXTUAL-CONVENTION
434    STATUS          current
435    DESCRIPTION
436        "A 64 bit counter associated with a
437        performance measurement in a previous
438        15 minute measurement interval. In the
439        case where the agent has no valid data
440        available for a particular interval the
441        corresponding object instance is not
442        available and upon a retrieval request
443        a corresponding error message shall be
444        returned to indicate that this instance
445        does not exist (for example, a noSuchName
446        error for SNMPv1 and a noSuchInstance for
447        SNMPv2 GET operation).
448        In a system supporting
449        a history of n intervals with
450        IntervalCount(1) and IntervalCount(n) the
451        most and least recent intervals
452        respectively, the following applies at
453        the end of a 15 minute interval:
454            - discard the value of IntervalCount(n)
455            - the value of IntervalCount(i) becomes that
456              of IntervalCount(i-1) for n >= i > 1
457            - the value of IntervalCount(1) becomes that
458              of CurrentCount
459            - the TotalCount, if supported, is adjusted.
460
461        This definition is based on CounterBasedGauge64 TEXTUAL
462        CONVENTION  defined in RFC2856. The PerfHighIntervalCount
463        type represents a non-negative
464        integer, which may increase or decrease, but shall never
465        exceed a maximum value, nor fall below a minimum value. The
466        maximum value can not be greater than 2^64-1
467        (18446744073709551615 decimal), and the minimum value can
468        not be smaller than 0.  The value of a PerfHighIntervalCount,
469        has its maximum value whenever the information being modeled
470        is greater than or equal to its maximum value, and has its
471        minimum value whenever the information being modeled is
472        smaller than or equal to its minimum value.  If the
473        information being modeled subsequently decreases below
474        (increases above) the maximum (minimum) value, the
475        PerfHighIntervalCount also decreases (increases).
476
477        Note that this TC is not strictly supported in SMIv2,
478        because the 'always increasing' and 'counter wrap' semantics
479        associated with the Counter64 base type are not preserved.
480        It is possible that management applications which rely
481        solely upon the (Counter64) ASN.1 tag to determine object
482        semantics will mistakenly operate upon objects of this type
483        as they would for Counter64 objects.
484
485        This textual convention represents a limited and short-term
486        solution, and may be deprecated as a long term solution is
487        defined and deployed to replace it."
488
489    REFERENCE
490        "RFC 2856(HCNUM-TC MIB).
491            RFC 2493(PerfHist-TC-MIB)."
492    SYNTAX          Counter64
493
494ConfigIterator ::= TEXTUAL-CONVENTION
495    STATUS          current
496    DESCRIPTION
497        "This object type is a control object type which applies to
498        writable objects in the same SNMP PDU related to the
499        same table containing those objects. It controls an
500        operation which repeatedly applies the specified
501        configuration data to more than one rows in a table.
502        The operation starts from the row specified by the index
503        of the instance and repeats for the number of rows as
504        the value of the object.
505
506        ConfigIterator object needs to be accompanied by one set of
507        writable objects which are of the same instance to apply to.
508
509        For example, a SNMP PDU contains
510           { objectA.10 = 1,
511             objectB.10 = 'E1',
512             objectC.10 = 44,
513             objectRepetition.10 = 100 }
514
515        The SYNTAX of objectRepetition is ConfigIterator.
516        This will apply value 1 to objectA, value 'E1' to objectB,
517        value 44 to objectC in the table starting from row 10
518        repeatedly for 100 rows.
519
520        The iteration is based on the number of rows, not based on
521        the value of the index. For sparse tables, the index 10,
522        20, 30, 110, and 120 counts for 5 rows, the operation will
523        go beyond index 100 in the previous SNMP PDU example.
524
525        The iteration will stop prematurely when it comes to the
526        following situations:
527        (1) When the number of the rows in the table is less than
528            the designated row indicated by the ConfigIterator
529            object.
530        (2) When it encounters the first error in any row, the
531            operation won't continue to next row.
532
533        The operation of ConfigIterator object applies only to
534        the writable objects having the same index as the
535        ConfigIterator object in one SNMP PDU.
536
537        For example, a SNMP PDU contains
538           { objectD.5 = 38,
539             objectE.6 = 'T1',
540             objectF.5 = 'false',
541             objectIterator.5 = 10 }
542
543        The SYNTAX of objectIterator is ConfigIterator.
544        This will apply value 38 to objectD, value 'false' to
545        objectF in the table starting from row 5 repeatedly
546        for 10 rows. Since the object objectE.6 has different
547        index (6) from the index of objectIterator, the
548        repetition won't be applied to it. However the value
549        of objectE in the row 6 will be set to 'T1' according
550        to regular SNMP SET orperation.
551
552        If there is row overlapping of the iteration in a SNMP PDU,
553        it will be operated as they are in two different SNMP PDUs.
554
555        For example, a SNMP PDU contains
556           { objectD.5 = 38,
557             objectD.6 = 40,
558             objectE.6 = 'T1',
559             objectF.5 = 'false',
560             objectIterator.5 = 10
561             objectIterator.6 = 10 }
562
563        This will apply value 38 to objectD, value 'false' to
564        objectF starting from row 5 repeatedly for 10 rows, and
565        apply value 40 to objectD, value 'T1' to objectE starting
566        from row 6 repeatedly for 10 rows. The final value of
567        objectD.6 can be 38 or 40, it depends on the SNMP stack of
568        the system starts SNMP SET for the row 5 before the row 6
569        or the other way around.
570
571        The object defined as ConfigIterator will be set to value 1
572        after the iteration operation is kick-off regardless the
573        system has completed the operation to the designated rows
574        or not. Therefore retrieving the value of this object
575        is meaningless. It acts as the one time operation for
576        bulk configuration.
577
578        The object defined as ConfigIterator has no meaning by itself,
579        it has to be combined with one or more than one writable
580        objects from the same table and within the same SNMP PDU
581        for the repetition operation.
582
583        For example, a SNMP PDU contains
584           { objectG.2 = 49,
585             objectH.2 = 'AE'h
586             objectIterator.4 = 20 }
587
588        The SYNTAX of objectIterator is ConfigIterator. Since
589        there are no objects having the same index as the index
590        of objectIterator in the PDU, the result of this SNMP
591        operation will set value 49 to objectG and value 0xAE
592        to objectH of the row 2 only as regular SNMP SET operation.
593
594        The index of the instance indicates the starting row for the
595        iteration.
596        The order of the iteration depends, for instance, on:
597        (1) physical hardware position, or
598        (2) logical index.
599
600        It depends on the characters of the table which contains
601        the ConfigIterator object.
602
603        Iteration can be done through some or all the components
604        of the index for a table. The description of the iterator
605        object in that table should describe which part of the
606        index the iteration is applied to.
607
608        The operation for this object type is based on the best
609        effort. When the agent receives a SNMP PDU containing this
610        data type, the return status of the SNMP request reflects
611        only the result of the SET operation has applied to the
612        starting row. It may return a SNMP response with SUCCESS
613        status regardless the number of rows for the data actually
614        been deployed later on. Therefore it is possible the data
615        might not be completely deployed to the number of rows
616        designated by the ConfigIterator and the operation stops
617        prematurely due to an error it first encounters after
618        n rows (n < the value of ConfigIterator object).
619
620        Usually the error report mechanism for this type of operation
621        is accomplished by combining this type of object with the
622        other two objects in the same table:
623
624        (1) An OwnerString object
625        (2) An object indicates the result of the operation.
626
627        When issuing this bulk configuration request, the SNMP
628        manager should provide its identifier in (1) object.
629        After issuing the request, it should check the value of (1)
630        object if it is the same with it own name.
631        If they are the same, then the value of the object presents
632        in (2) is the result from the previous operation from this
633        manager. Otherwise, another SNMP manager might issue
634        the bulk configuration to the same table before the previous
635        bulk operation has been completed. These two objects will
636        represent the last bulk operation in the table."
637    SYNTAX          Unsigned32 (1..4294967295 )
638
639BulkConfigResult ::= TEXTUAL-CONVENTION
640    STATUS          current
641    DESCRIPTION
642        "This textual convention defines the format of the
643        displayable textual result from the bulk configuration
644        operation specified as ConfigIterator type.
645
646        The format should be:
647        'COMPLETION=          error occured>/,
648         ERROR=/:
649         '
650
651        For example:
652        'COMPLETION=22/100,ERROR=38/44:Invalid Ds1 line coding
653         for the line type'"
654    SYNTAX          OCTET STRING (SIZE (0..255))
655
656ListIndex ::= TEXTUAL-CONVENTION
657    STATUS          current
658    DESCRIPTION
659        "A unique value greater than zero, for each of the
660        list that is defined. The object using this
661        convention should give all the object specific
662        details including the list type."
663    SYNTAX          Integer32 (1..2147483647 )
664
665ListIndexOrZero ::= TEXTUAL-CONVENTION
666    STATUS          current
667    DESCRIPTION
668        "This textual convention is an extension of the
669        ListIndex. In addition to the ListIndex range,
670        this also includes 0 in its range of values.
671        This value could be object specific and
672        should be given the description of that object.
673        In most cases, a value 0 means that the it does
674        not represent any lists."
675    SYNTAX          Integer32 (0..2147483647 )
676
677TimeIntervalSec ::= TEXTUAL-CONVENTION
678    STATUS          current
679    DESCRIPTION
680        "A period of time, measured in units of 1 second."
681    SYNTAX          Unsigned32
682
683TimeIntervalMin ::= TEXTUAL-CONVENTION
684    STATUS          current
685    DESCRIPTION
686        "A period of time, measured in units of 1 minute."
687    SYNTAX          Unsigned32
688
689UbiMilliSeconds ::= TEXTUAL-CONVENTION
690    STATUS          current
691    DESCRIPTION
692        "Represents time unit value in milliseconds."
693    SYNTAX          Unsigned32
694
695MicroSeconds ::= TEXTUAL-CONVENTION
696    STATUS          current
697    DESCRIPTION
698        "Represents time unit value in microseconds."
699    SYNTAX          Unsigned32
700
701UbiPortList ::= TEXTUAL-CONVENTION
702    STATUS          current
703    DESCRIPTION
704        "Each octet within this value specifies a set of eight
705        ports. The object defined by this textual convention
706        can specify a port range of 2k ports in its description.
707        Example: 1 - 2048, 2049 - 4096, etc. The first octet
708        represents the first 8 ports of the range of ports
709        specified by the object, the second octet represents
710        the next 8 ports, etc. When a port range is not
711        specified, a default port range of '1 - 2048' is assumed.
712
713        Within each octet, the most significant bit represents
714        the lowest numbered port, and the least significant bit
715        represents the highest numbered port. Thus, each port
716        of the bridge is represented by a single bit within the
717        value of this object.  If that bit has a value of '1'
718        then that port is included in the set of ports; the port
719        is not included if its bit has a value of '0'.
720
721        Note that if the length of this string is less than
722        256 octets, any 'missing' octets are assumed to contain
723        the value zero. An NMS may omit any zero-valued octets
724        from the end of this string in order to reduce SetPDU size,
725        and the agent may also omit zero-valued trailing octets,
726        to reduce the size of GetResponse PDUs."
727    SYNTAX          OCTET STRING (SIZE (0..256))
728
729UbiPortListRange ::= TEXTUAL-CONVENTION
730    STATUS          current
731    DESCRIPTION
732        "Indicates the port range.
733
734        oneto2K(1) indicates that the port number range is
735        from 1 to 2048.
736
737        twoKto4K(2) indicates that the port number range is
738        from 2049 to 4096.
739
740        fourKto6K(3) indicates that the port number range is
741        from 4097 to 6144.
742
743        sixKto8K(4) indicates that the port number range is
744        from 6145 to 8192.
745
746        eightKto10K(5) indicates that the port number range is
747        from 8193 to 10240.
748
749        tenKto12K(6) indicates that the port number range is
750        from 10241 to 12288.
751
752        twelveKto14K(7) indicates that the port number range is
753        from 12289 to 14336.
754
755        fourteenKto16K(8) indicates that the port number range is
756        from 14337 to 16384.
757
758        When an object is defined with this textual convention,
759        it must be accompanied by an object of UbiPortList
760        syntax."
761    SYNTAX          INTEGER  {
762                        oneto2k(1),
763                        twoKto4K(2),
764                        fourKto6K(3),
765                        sixKto8K(4),
766                        eightKto10K(5),
767                        tenKto12K(6),
768                        twelveKto14K(7),
769                        fourteenKto16K(8)
770                    }
771
772IfOperStatusReason ::= TEXTUAL-CONVENTION
773    STATUS          current
774    DESCRIPTION
775        "The cause of current operational state of the
776        interface.
777
778        GLOSSARY:
779
780        BB        - Buffer-to-Buffer.
781
782        BB_Credit - Buffer-to-Buffer credit, a link level flow
783                    control mechanism.
784
785        B_Port    - A Fibre Channel, Bridging port.
786
787        Class F   - A connectionless service with notification on
788                    non-delivery between E_Ports, used for control,
789                    coordination, and configuration of the Fabric.
790
791        Class N   - Refers to any class of service (different types
792                    of frame delivery services) other than Class F.
793
794        E_D_TOV   - Error Detect Timeout Value.
795
796        ELP       - Exchange Link Parameter.
797
798        E-mode    - A fibre channel port providing E_Port
799                    functionality.
800
801        E_Port    - A Fabric Expansion Port.
802
803        EPP       - Exchange Peer Parameters.
804
805        ESC       - Exchange Switch Capabilities.
806
807        Fabric    - The set of physically connected fibre channel
808                    switches.
809
810        FC-FS     - Fibre Channel Framing and Signaling.
811
812        FCIP      - Fibre Channel over IP protocol.
813
814        FCOT      - Fibre channel optical transmitter.
815
816        FC-PH     - The Fibre Channel Physical and Signaling
817                    standard.
818
819        FCSP      - Fibre Channel Security Protocol.
820
821        Fibre Channel - The primary protocol for building SANs.
822
823        FICON     - An I\O protocol used between IBM (and compatible)
824                    mainframes and storage.
825
826        FLOGI     - Fabric Login, used by a node port to establish a
827                    session with the fabric.
828
829        GBIC      - Gigabit Interface Converter; a removable
830                    transceiver module permitting Fibre Channel and
831                    Gigabit Ethernet physical-layer transport.
832
833        Interconnect_Ports - Switch Ports that assume either the
834                    E_Port or B_Port mode are generally referred to
835                    as Interconnect_Ports.
836
837        LIP       - Loop Initialization Primitive sequence.
838
839        LR        - Link Reset, the FC-PH defined primitive sequence
840                    used to initiate a link reset.
841
842        NOS       - Not Operational Sequence, the FC-PH defined
843                    primitive sequence to indicate that the
844                    transmitting port has detected a link failure (or)
845                    offline condition.
846
847        Nx_Port   - A Fiber Channel Node Port.
848
849        OLS       - Offline Sequence, the FC-PH defined primitive
850                    sequence to indicate that the port is entering
851                    into offline state.
852
853        OHMS      - Online Health Management System.
854
855        R_A_TOV   - Resource Allocation Timeout Value.
856
857        RCF       - Reconfigure Fabric.
858
859        Rxbbcredit - Receive BB credit value configured for
860                     a FC interface.
861
862        SAN       - Storage Area Network; a network linking computing
863                    devices to disk or tape arrays and other devices
864                    over Fibre Channel.
865
866        TE_Port   - Trunking E_Port.
867
868        TOV       - Time out value.
869
870        VSAN      - Virtual Storage Area Network.
871
872        WWN       - World Wide Name.
873
874        xE_Port   - A Fiber channel port that can assume either
875                    E_Port or TE_Port mode.
876
877        The enumerated values which provides the cause of the current
878        operational state of the interface are,
879
880           'other(1)' - reasons other than defined here.
881
882           'none(2)' - no failure.
883
884           'hwFailure(3)' - hardware failure.
885
886           'loopbackDiagFailure(4)' - loopback diagnostics failure.
887
888           'errorDisabled(5)' - the port is not operational due to
889               some error conditions that require administrative
890               attention.
891
892           'swFailure(6)' - software failure.
893
894           'linkFailure(7)' - physical link failure.
895
896           'offline(8)' -  physical link is in offline state as
897               defined in the FC-FS standards.
898
899           'nonParticipating(9)' - during loop initialization, the
900               port is not allowed to participate in loop operations.
901
902           'initializing(10)' - port is being initialized.
903
904           'vsanInactive(11)'- port VSAN is inactive. The port becomes
905               operational again when the port VSAN is active.
906
907           'adminDown(12)' - ifAdminStatus is 'down'.
908
909           'channelAdminDown(13)' - this port is a member of a port
910               channel and that port channel's ifAdminStatus is
911               'down'.
912
913           'channelOperSuspended(14)' - this port is a member of a
914               port channel and its operational parameters are
915               incompatible with the port channel parameters.
916
917           'channelConfigurationInProgress(15)' - this port is
918               undergoing a port channel configuration.
919
920           'rcfInProgress(16)' - an isolated xE_port is transmitting
921               an reconfigure fabric, requesting a disruptive
922               reconfiguration in an attempt to build a single,
923               non-isolated fabric. Only the Interconnect_Ports can
924               become isolated.
925
926           'elpFailureIsolation(17)' - during a port initialization
927               the prospective Interconnect_Ports find incompatible
928               link parameters.
929
930           'escFailureIsolation(18) - during a port initialization the
931               prospective Interconnect_Ports are unable to proceed
932               with initialization as a result of ESC.
933
934           'domainOverlapIsolation(19)' - there is a overlap in
935               domains while attempting to connect two existing
936               fabrics.
937
938           'domainAddrAssignFailureIsolation(20)' - the elected
939               principal switch is not capable of performing domain
940               address manager functions so no Nx_port traffic can be
941               forwarded across switches, hence all Interconnect_Ports
942               in the switch are isolated.
943
944           'domainOtherSideEportIsolation(21)' - the peer E_port is
945               isolated.
946
947           'domainInvalidRcfReceived(22)' - invalid RCF received.
948
949           'domainManagerDisabled(23) - domain manager is disabled.
950
951           'zoneMergeFailureIsolation(24)' - the two Interconnect_Ports
952               cannot merge zoning configuration after having exchanged
953               merging request for zoning.
954
955           'vsanMismatchIsolation(25)' - this VSAN is not configured
956               on both sides of a trunk port.
957
958           'parentDown(26)' - the physical port to which this interface
959               is bound is down.
960
961           'srcPortNotBound(27)'- no source port is specified for this
962               interface.
963
964           'interfaceRemoved(28)' - interface is being removed.
965
966           'fcotNotPresent(29)' - FCOT (GBIC) not present.
967
968           'fcotVendorNotSupported(30)' - FCOT (GBIC) vendor is not
969               supported.
970
971           'incompatibleAdminMode(31)' - port administrative mode is
972               incompatible with port capabilities.
973
974           'incompatibleAdminSpeed(32)' - port speed is incompatible
975               with port capabilities.
976
977           'suspendedByMode(33)' - port that belongs to a port channel
978               is suspended due to incompatible operational mode.
979
980           'suspendedBySpeed(34)' - port that belongs to a port channel
981               is suspended due to incompatible operational speed.
982
983           'suspendedByWwn(35)' - port that belongs to a port channel
984               is suspended due to incompatible remote switch WWN.
985
986           'domainMaxReTxFailure(36)' - domain manager failure after
987               maximum retries.
988
989           'eppFailure(37)' - trunk negotiation protocol failure after
990               maximum retries.
991
992           'portVsanMismatchIsolation(38)' - an attempt is made to
993               connect two switches using non-trunking ports having
994               different port VSANs.
995
996           'loopbackIsolation(39)' - port is connected to another port
997               in the same switch.
998
999           'upgradeInProgress(40)' - linecard upgrade in progress.
1000
1001           'incompatibleAdminRxBbCredit(41)' - receive BB credit is
1002               incompatible. "
1003     SYNTAX          OCTET STRING (SIZE (0..256))
1004
1005
1006------------------------------------------------------------------
1007-- The fllowing was defined in UBQS_QOS_PIB_MIB
1008------------------------------------------------------------------
1009-- Percentage for thresholds, etc.
1010--
1011Percent ::= TEXTUAL-CONVENTION
1012    STATUS current
1013    DESCRIPTION
1014        "An integer that is in the range of a percent value."
1015    SYNTAX INTEGER (0..100)
1016
1017-- DiffServ Codepoint
1018--
1019Dscp ::= TEXTUAL-CONVENTION
1020    STATUS current
1021    DESCRIPTION
1022        "An integer that is in the range of the DiffServ codepoint
1023        values."
1024    SYNTAX INTEGER (0..63)
1025
1026------------------------------------------------------------------
1027-- The fllowing was defined in UBQS_ST_TC_MIB
1028------------------------------------------------------------------
1029FcNameIdOrZero ::= TEXTUAL-CONVENTION
1030        STATUS current
1031        DESCRIPTION
1032           "The World Wide Name (WWN) associated with a Fibre Channel
1033           (FC) entity.  WWNs were initially defined as 64-bits in
1034           length.  The latest definition (for future use) is 128-bits
1035           long.  The zero-length string value is used in circumstances
1036           where the WWN is unassigned/unknown."
1037        SYNTAX  OCTET STRING (SIZE(0 | 8 | 16))
1038
1039------------------------------------------------------------------
1040-- The fllowing was defined in UBQS-FRAME-RELAY-MIB
1041------------------------------------------------------------------
1042DlciNumber ::= TEXTUAL-CONVENTION
1043        STATUS  current
1044        DESCRIPTION
1045                "Numerical format of Data Link Connection Identifier
1046                (DLCI) in decimal, identical to the 'DLCI' as INTEGER
1047                of 0..DLCINumber in RFC1315. The maximum value depends
1048                on Frame Relay implementation, which is currently set
1049                to be 1023 for 2-octet address format per UNI
1050                Implementation Agreement FRF.1."
1051        SYNTAX        INTEGER (0..1023)
1052
1053
1054 END
1055