1-- *****************************************************************
2-- CISCO-WAN-ATM-PREF-ROUTE-MIB
3--
4-- June 2002, Sheldon Chan
5--
6-- Copyright (c) 2002 by Cisco Systems, Inc.
7-- All rights reserved.
8-- *****************************************************************
9
10CISCO-WAN-ATM-PREF-ROUTE-MIB DEFINITIONS ::= BEGIN
11
12IMPORTS
13       MODULE-IDENTITY,
14       OBJECT-TYPE,
15       Unsigned32          FROM SNMPv2-SMI
16
17       TEXTUAL-CONVENTION,
18       RowStatus          FROM SNMPv2-TC
19
20       ciscoMgmt          FROM CISCO-SMI
21
22       MODULE-COMPLIANCE,
23       OBJECT-GROUP       FROM SNMPv2-CONF
24       PnniNodeId, PnniPortId
25                          FROM PNNI-MIB;
26
27
28ciscoWanATMPrefRouteMIB   MODULE-IDENTITY
29       LAST-UPDATED       "200206250000Z"
30       ORGANIZATION       "Cisco System Inc."
31       CONTACT-INFO
32               "
33                           Cisco Systems
34                           Customer Service
35
36            Postal:        170 West Tasman Drive,
37                           San Jose CA 95134-1706.
38                           USA
39
40               Tel:        +1 800 553-NETS
41
42            E-mail:        cs-wanatm@cisco.com"
43       DESCRIPTION
44           "This MIB facilitates the maintenance of preferred routes
45            configuration."
46
47       REVISION            "200206250000Z"
48       DESCRIPTION
49           "Initial version of the preferred routes MIB.
50
51           Preferred Route allows the user an improved control over
52           the Soft Permanent Virtual Circuit (SPVC) or Soft Permanent
53           Virtual Path (SPVP) connections. The use of network
54           resources by these connections can be explicitly specified
55           through the exact lowest-level nodes and the associated
56           links the connection has to traverse.
57
58           In subsequent discussion, the term SPVC implicitly applies
59           also to SPVP.
60
61           Preferred route is specified only at originating node.
62
63           When an originating node selects a connection to be
64           rerouted, the node searches for a route. If a preferred
65           route is configured for the connection, the originating
66           node uses the configured route as the basis of routing.
67
68           Terminologies used:
69           Network Element (NE):
70                  The pair of a node identifier and the egress port
71                  Identifier associated to the node.
72
73           Master node of a connection:
74                  It is the node which owns the connection and is
75                  responsible to establish a data path from its end to
76                  the remote end.
77
78           Route Identifier:
79                  It is a number uniquely identifying a preferred
80                  route within the master node.
81
82           A preferred route consists of up to 20 network elements.
83           The number of network elements valid within the route is
84           specified by the user.
85
86           Contextually, the node at the first network element is the
87           originating node; the node at the last network element (as
88           specified by the user in the number of valid network
89           elements) is the destination node."
90       ::= { ciscoMgmt 99996 }
91
92-- CISCO-WAN-ATM-PREF-ROUTE-MIB MIB groups
93
94ciscoWanATMPrefRouteMIBNotifs OBJECT IDENTIFIER
95       ::= { ciscoWanATMPrefRouteMIB 0 }
96
97ciscoWanATMPrefRouteMIBObjects OBJECT IDENTIFIER
98       ::= { ciscoWanATMPrefRouteMIB 1 }
99
100cwaPrefRouteConformance OBJECT IDENTIFIER
101       ::= { ciscoWanATMPrefRouteMIB 2 }
102
103RouteId ::= TEXTUAL-CONVENTION
104       STATUS      current
105       DESCRIPTION
106           "A value that uniquely identifies a preferred route for an
107            SPVC connection."
108       SYNTAX Unsigned32 ( 0..65535 )
109
110cwaPrefRouteConfTable OBJECT-TYPE
111       SYNTAX SEQUENCE OF CwaPrefRouteConfEntry
112       MAX-ACCESS  not-accessible
113       STATUS      current
114       DESCRIPTION
115          "This table contains a list of preferred routes configured
116           at the master node."
117       ::= { ciscoWanATMPrefRouteMIBObjects 1 }
118
119cwaPrefRouteConfEntry OBJECT-TYPE
120       SYNTAX      CwaPrefRouteConfEntry
121       MAX-ACCESS  not-accessible
122       STATUS      current
123       DESCRIPTION
124          "An entry in the preferred routes table. Each entry is keyed
125           by a route identifier. The number of leading network
126           elements to be used are specified by the object
127           cwaPrefRouteNetwElemCount."
128       INDEX { cwaPrefRouteId }
129       ::= { cwaPrefRouteConfTable 1 }
130
131CwaPrefRouteConfEntry ::=
132       SEQUENCE {
133          cwaPrefRouteId             RouteId,
134          cwaPrefRouteNwElemCount    Unsigned32,
135          cwaPrefRouteRowStatus      RowStatus
136       }
137
138cwaPrefRouteId OBJECT-TYPE
139       SYNTAX      RouteId
140       MAX-ACCESS  not-accessible
141       STATUS      current
142       DESCRIPTION
143          "A unique identifier to an entry of the preferred routes
144           table. The identifier cannot be zero."
145       ::= { cwaPrefRouteConfEntry 1 }
146
147cwaPrefRouteNwElemCount OBJECT-TYPE
148       SYNTAX      Unsigned32 ( 1..20 )
149       MAX-ACCESS  read-create
150       STATUS      current
151       DESCRIPTION
152          "A value that indicates in the preferred route entry the
153           number of leading network elements which are integral to the
154           preferred route."
155       ::= { cwaPrefRouteConfEntry 2 }
156
157cwaPrefRouteRowStatus OBJECT-TYPE
158       SYNTAX      RowStatus
159       MAX-ACCESS  read-create
160       STATUS      current
161       DESCRIPTION
162          "To create, modify and delete a preferred route entry. Only
163           the value 'active', 'createAndGo', and 'destroy' are
164           supported.
165
166           The value of this variable is set to 'active' by the
167           managed system for each valid entry. If a management
168           station wants to delete an entry from the database, this
169           value is set to 'destroy'. If a management station wants to
170           create a new entry, this value is set to 'createAndGo'. The
171           modification of an 'active' row is permitted."
172       ::= { cwaPrefRouteConfEntry 3 }
173
174cwaPrefRouteNwElemTable OBJECT-TYPE
175       SYNTAX SEQUENCE OF CwaPrefRouteNwElemEntry
176       MAX-ACCESS  not-accessible
177       STATUS      current
178       DESCRIPTION
179          "The table contains a list of network elements, each of
180           which is indexed by the route identifier and the position of
181           the network element within the preferred route. Position 1
182           refers to the first network element, while position 20
183           refers to the last network element."
184       ::= { ciscoWanATMPrefRouteMIBObjects 2 }
185
186cwaPrefRouteNwElemEntry OBJECT-TYPE
187       SYNTAX      CwaPrefRouteNwElemEntry
188       MAX-ACCESS  not-accessible
189       STATUS      current
190       DESCRIPTION
191            "An entry in the preferred route network element
192             table. The entry can be modified on the fly. The entry
193             will not be used in the preferred route if its position
194             specified by cwaPrefRouteNwElemPos is greater than
195             cwaPrefRouteNwElemCount."
196       INDEX { cwaPrefRouteId, cwaPrefRouteNwElemPos }
197       ::= { cwaPrefRouteNwElemTable 1}
198
199CwaPrefRouteNwElemEntry ::=
200       SEQUENCE {
201          cwaPrefRouteNwElemPos       Unsigned32,
202          cwaPrefRouteNwElemNodeId    PnniNodeId,
203          cwaPrefRouteNwElemPortId    PnniPortId,
204          cwaPrefRouteNwElemRowStatus RowStatus
205       }
206
207cwaPrefRouteNwElemPos OBJECT-TYPE
208       SYNTAX      Unsigned32 ( 1..20 )
209       MAX-ACCESS  not-accessible
210       STATUS      current
211       DESCRIPTION
212          "The network element position identifies the position of the
213           network element within the preferred route."
214       REFERENCE
215          "ATM Forum PNNI 1.1 Section 6.4.6.4"
216       ::= { cwaPrefRouteNwElemEntry 1 }
217
218cwaPrefRouteNwElemNodeId OBJECT-TYPE
219       SYNTAX      PnniNodeId
220       MAX-ACCESS  read-create
221       STATUS      current
222       DESCRIPTION
223          "The 22-octet logical node identifier of a PNNI node."
224       ::= { cwaPrefRouteNwElemEntry 2 }
225
226cwaPrefRouteNwElemPortId OBJECT-TYPE
227       SYNTAX      PnniPortId
228       MAX-ACCESS  read-create
229       STATUS      current
230       DESCRIPTION
231          "The 32-bit logical port identifier of an egress port on the
232           associated PNNI node for the network element."
233       ::= { cwaPrefRouteNwElemEntry 3 }
234
235cwaPrefRouteNwElemRowStatus OBJECT-TYPE
236       SYNTAX      RowStatus
237       MAX-ACCESS  read-create
238       STATUS      current
239       DESCRIPTION
240          "To create, modify and delete a network element (node
241           identifier and port identifier).
242
243           Only the value 'active', 'createAndGo', and 'destroy' are
244           supported.
245
246           The value of this variable is set to 'active' by the
247           managed system for each valid entry. If a management
248           station wants to delete an entry from the database, this
249           value is set to 'destroy'. If a management station wants to
250           create a new entry, this value is set to 'createAndGo'. The
251           modification of an 'active' row is permitted."
252       ::= { cwaPrefRouteNwElemEntry 4 }
253
254-- conformance information
255
256cwaPrefRouteCompliances OBJECT IDENTIFIER
257       ::= { cwaPrefRouteConformance 1 }
258
259cwaPrefMIBGroups OBJECT IDENTIFIER
260       ::= { cwaPrefRouteConformance 2 }
261
262-- compliance statements
263cwaPrefMIBCompliance MODULE-COMPLIANCE
264       STATUS current
265       DESCRIPTION
266          "The compliance statement for SNMPv2 entities which
267           implement the preferred route."
268       MODULE  -- this module
269       MANDATORY-GROUPS {
270          cwaPrefRouteMIBGroups
271       }
272       ::= { cwaPrefRouteCompliances 1 }
273
274-- units of conformance
275cwaPrefRouteMIBGroups OBJECT-GROUP
276       OBJECTS {
277          cwaPrefRouteNwElemCount,
278          cwaPrefRouteRowStatus,
279          cwaPrefRouteNwElemNodeId,
280          cwaPrefRouteNwElemPortId,
281          cwaPrefRouteNwElemRowStatus
282       }
283       STATUS current
284       DESCRIPTION
285          "This group contains a list of objects which identify a
286           preferred route."
287       ::= { cwaPrefMIBGroups 1 }
288
289END
290
291
292