1-- *****************************************************************
2-- CISCO-PTOPO-EXTN-MIB: Cisco Physical Topology Extension MIB file
3--
4-- May 2002,  Arvind Prabhudev, Mickey Spiegel
5--
6-- Copyright (c) 2002 by Cisco Systems, Inc.
7-- All rights reserved.
8-- *****************************************************************
9
10CISCO-PTOPO-EXTN-MIB DEFINITIONS ::= BEGIN
11
12IMPORTS
13    MODULE-IDENTITY,
14    OBJECT-TYPE                FROM SNMPv2-SMI
15    RowStatus                  FROM SNMPv2-TC
16    MODULE-COMPLIANCE,
17    OBJECT-GROUP               FROM SNMPv2-CONF
18    PhysicalIndex              FROM ENTITY-MIB
19    InterfaceIndexOrZero       FROM IF-MIB
20    ptopoConnEntry             FROM PTOPO-MIB
21    ciscoMgmt                  FROM CISCO-SMI
22    ;
23
24ciscoPtopoExtnMIB   MODULE-IDENTITY
25    LAST-UPDATED    "200205120000Z"
26    ORGANIZATION    "Cisco Systems, Inc."
27    CONTACT-INFO    "Cisco Systems
28                     Customer Service
29
30                     Postal: 170 W Tasman Drive
31                     San Jose, CA  95134
32                     USA
33
34                     Tel: +1 800 553-NETS
35
36                     E-mail: cs-dwdm@cisco.com"
37    DESCRIPTION
38        "This MIB module contains extensions to the PTOPO-MIB that
39        provide support to distinguish between bidirectional and
40        unidirectional physical topology connections. It also
41        introduces a table that allows configuration of dynamic
42        learning of the physical topology through the Cisco
43        Discovery Protocol (CDP)."
44
45    REVISION           "200205120000Z"
46    DESCRIPTION
47        "Initial version of this MIB."
48    ::= { ciscoMgmt 261 }
49
50
51ciscoPtopoExtnMIBObjects OBJECT IDENTIFIER ::= { ciscoPtopoExtnMIB 1 }
52
53
54-- This table augments the ptopoConnTable from PTOPO-MIB.
55
56cPtopoConnExtTable OBJECT-TYPE
57    SYNTAX        SEQUENCE OF CPtopoConnExtEntry
58    MAX-ACCESS    not-accessible
59    STATUS        current
60    DESCRIPTION
61        "This table augments the ptopoConnTable with information
62        about the direction of physical network connections."
63    ::= { ciscoPtopoExtnMIBObjects 1 }
64
65cPtopoConnExtEntry OBJECT-TYPE
66    SYNTAX        CPtopoConnExtEntry
67    MAX-ACCESS    not-accessible
68    STATUS        current
69    DESCRIPTION
70        "An entry which contains additional information about the
71        physical network connection contained in the ptopoConnEntry.
72        It helps specify whether a remote connection endpoint is
73        connected to the local port in the transmit direction, the
74        receive direction or both directions."
75    AUGMENTS { ptopoConnEntry }
76    ::= { cPtopoConnExtTable 1 }
77
78CPtopoConnExtEntry ::=
79    SEQUENCE {
80        cPtopoConnExtLinkDirection    INTEGER
81    }
82
83cPtopoConnExtLinkDirection OBJECT-TYPE
84    SYNTAX      INTEGER {
85                    transmit(1),
86                    receive(2),
87                    both(3)
88                }
89    MAX-ACCESS  read-create
90    STATUS      current
91    DESCRIPTION
92        "The remote connection endpoint (identified by
93        ptopoConnRemoteChassis and ptopoConnRemotePort of this row)
94        may be connected to the local port (identified by
95        ptopoConnLocalPort of this row) through either an
96        unidirectional or bidirectional link. This object is used
97        to indicate the directionality of the connection and in
98        the case of unidirectional links this object indicates
99        whether the remote connection endpoint is on the transmit
100        or the receive link.
101
102        For example, in case of optical interfaces where the
103        transmitted and received signals travel on 2 different
104        strands of fiber, it is possible that each fiber terminates
105        at a different device. For instance, the transmit and
106        receive fibers of the local port may be connected to
107        different optical amplifiers. This object could then be
108        used to indicate whether the remote device is on the
109        transmit or the receive fiber of the local port.
110
111        If the remote connection endpoint is connected to the
112        transmit fiber of the local port then
113        cPtopoConnExtLinkDirection is set to 'transmit'.
114        If the remote connection endpoint is connected to the
115        receive fiber of the local port then
116        cPtopoConnExtLinkDirection is set to 'receive'.
117        If both the transmit and receive fibers of the local port
118        terminate at the same remote connection endpoint then this
119        object is set to 'both'. Individual entries for 'transmit'
120        and 'receive' should not be created in this case. Note that
121        in the case of a port connected to a broadcast medium,
122        there can be multiple entries associated with the port,
123        with this object set to 'both'."
124    ::= { cPtopoConnExtEntry 1 }
125
126
127-- This table contains additional objects for configuring physical
128-- topology discovery via Cisco Discovery Protocol (CDP).
129
130cPtopoExtCdpTable OBJECT-TYPE
131    SYNTAX        SEQUENCE OF CPtopoExtCdpEntry
132    MAX-ACCESS    not-accessible
133    STATUS        current
134    DESCRIPTION
135        "This table contains a row for each local port (identified
136        by the index of this table) for which the agent populates
137        physical topology information (ptopoConnEntry) with neighbor
138        information dynamically learned from the Cisco Discovery
139        Protocol (CDP) running on this port or a proxy port."
140    ::= { ciscoPtopoExtnMIBObjects 2 }
141
142cPtopoExtCdpEntry OBJECT-TYPE
143    SYNTAX        CPtopoExtCdpEntry
144    MAX-ACCESS    not-accessible
145    STATUS        current
146    DESCRIPTION
147        "This entry contains objects for configuring discovery of
148        physical topology information for a local port (identified
149        by the index of this entry) via CDP."
150    INDEX  {
151        cPtopoExtCdpLocalChassis,
152        cPtopoExtCdpLocalPort
153    }
154    ::= { cPtopoExtCdpTable 1 }
155
156CPtopoExtCdpEntry ::=
157    SEQUENCE {
158        cPtopoExtCdpLocalChassis    PhysicalIndex,
159        cPtopoExtCdpLocalPort       PhysicalIndex,
160        cPtopoExtCdpDiscoveryState  INTEGER,
161        cPtopoExtCdpProxyIf         InterfaceIndexOrZero,
162        cPtopoExtCdpRowStatus       RowStatus
163    }
164
165cPtopoExtCdpLocalChassis   OBJECT-TYPE
166    SYNTAX      PhysicalIndex
167    MAX-ACCESS  not-accessible
168    STATUS      current
169    DESCRIPTION
170        "The entPhysicalIndex value used to identify the chassis
171        component associated with the local port for which
172        physical topology information is discovered via CDP."
173    ::= { cPtopoExtCdpEntry 1 }
174
175cPtopoExtCdpLocalPort      OBJECT-TYPE
176    SYNTAX      PhysicalIndex
177    MAX-ACCESS  not-accessible
178    STATUS      current
179    DESCRIPTION
180        "The entPhysicalIndex value used to identify the port
181        component associated with the local port for which
182        physical topology information is discovered via CDP."
183    ::= { cPtopoExtCdpEntry 2 }
184
185cPtopoExtCdpDiscoveryState OBJECT-TYPE
186    SYNTAX        INTEGER {
187                      cdpDisabled(1),
188                      interfaceDown(2),
189                      waiting(3),
190                      discovered(4)
191                  }
192    MAX-ACCESS    read-only
193    STATUS        current
194    DESCRIPTION
195        "This object indicates the state of physical topology
196        discovery via CDP for the local port for which this row
197        exists.
198
199        The agent sets this object to 'cdpDisabled' if
200        cPtopoExtCdpProxyIf is set to zero and CDP has not been
201        configured to run on the local port, or if CDP has not
202        been configured to run on the proxy interface whose
203        ifIndex is given by the non-zero value in
204        cPtopoExtCdpProxyIf.
205
206        The enumeration 'interfaceDown' indicates that this
207        interface is down, when cPtopoExtCdpProxyIf is set to
208        zero, or the proxy interface is down, when
209        cPtopoExtCdpProxyIf is set to a non-zero value.
210
211        After this row has been activated, if CDP is running (on
212        this or the proxy interface) and no neighbors have been
213        discovered yet, the agent sets this object to 'waiting'.
214
215        The 'discovered' state indicates that one or more
216        neighbors have been discovered through CDP and the agent
217        has accordingly created ptopoConnEntry(s) in the
218        PTOPO-MIB."
219    ::= { cPtopoExtCdpEntry 3 }
220
221cPtopoExtCdpProxyIf OBJECT-TYPE
222    SYNTAX        InterfaceIndexOrZero
223    MAX-ACCESS    read-create
224    STATUS        current
225    DESCRIPTION
226        "Physical topology information for the local port
227        (identified by cPtopoExtCdpLocalChassis and
228        cPtopoExtCdpLocalPort of this row) can be discovered
229        from CDP running on the local port, if it is CDP capable
230        or from CDP running on a proxy interface. In the case of
231        optical ports running wavelength division multiplexing,
232        the physical connector port on which the CDP packet is
233        transmitted is different from the logical interface
234        representing the wavelength on which CDP is running. In
235        such a case, physical topology for the 'external' optical
236        port can be learned from CDP running on one of the
237        wavelengths.
238
239        This object is set to zero if physical topology information
240        for the local port is discovered from CDP running on itself.
241        Otherwise, this object contains the ifIndex value of the CDP
242        capable interface which is being used as proxy to learn
243        physical topology information for the local port.
244
245        Usage of this object is possible only if the local port
246        is the 'External Port', as specified in the CDP protocol,
247        for the proxy interface.
248
249        This object may be modified when the associated
250        cPtopoExtCdpRowStatus object has a value of 'active'."
251    DEFVAL { 0 }
252    ::= { cPtopoExtCdpEntry 4 }
253
254cPtopoExtCdpRowStatus OBJECT-TYPE
255    SYNTAX        RowStatus
256    MAX-ACCESS    read-create
257    STATUS        current
258    DESCRIPTION
259        "This object is used to create and delete conceptual rows
260        in the cPtopoExtCdpTable.
261
262        Once this object has been set to 'active' it implies
263        that physical topology discovery via CDP has been enabled
264        for the local port for which this row exists.
265
266        This object cannot be set to 'active' when any rows that
267        were manually created for the local port exist in the
268        ptopoConnTable. After this object is set to 'active',
269        entries for this local port cannot be manually created in
270        the ptopoConnTable.
271
272        After the entry has been activated, this object cannot be
273        set to any value other than 'destroy'. The row status
274        never changes to 'notInService' after reaching the value
275        'active'."
276    ::= { cPtopoExtCdpEntry 5 }
277
278
279-- conformance information
280
281cPtopoExtnConformance OBJECT IDENTIFIER ::= { ciscoPtopoExtnMIB 3 }
282
283cPtopoExtnCompliances OBJECT IDENTIFIER ::= { cPtopoExtnConformance 1 }
284cPtopoExtnGroups      OBJECT IDENTIFIER ::= { cPtopoExtnConformance 2 }
285
286-- compliance statements
287
288cPtopoExtnCompliance  MODULE-COMPLIANCE
289    STATUS  current
290    DESCRIPTION
291        "The compliance statement for SNMP entities that implement
292        the CISCO-PTOPO-EXTN-MIB."
293    MODULE  -- this module
294        MANDATORY-GROUPS {
295            cPtopoConnExtGroup
296        }
297
298        GROUP       cPtopoExtCdpGroup
299        DESCRIPTION
300            "This group is required only for entities that support
301            physical topology discovery via CDP."
302
303        GROUP       cPtopoExtCdpProxyGroup
304        DESCRIPTION
305            "This group is required only for entities that support
306            physical topology discovery via CDP running on a proxy
307            interface."
308
309    ::= { cPtopoExtnCompliances 1 }
310
311-- MIB groupings
312
313cPtopoConnExtGroup     OBJECT-GROUP
314    OBJECTS {
315        cPtopoConnExtLinkDirection
316    }
317    STATUS  current
318    DESCRIPTION
319        "The collection of objects which augment the ptopoConnTable
320        in the PTOPO-MIB."
321    ::= { cPtopoExtnGroups 1 }
322
323cPtopoExtCdpGroup      OBJECT-GROUP
324    OBJECTS {
325        cPtopoExtCdpDiscoveryState,
326        cPtopoExtCdpRowStatus
327    }
328    STATUS  current
329    DESCRIPTION
330        "The collection of objects which are required for
331        configuration of physical topology discovery via CDP."
332    ::= { cPtopoExtnGroups 2 }
333
334cPtopoExtCdpProxyGroup OBJECT-GROUP
335    OBJECTS {
336        cPtopoExtCdpProxyIf
337    }
338    STATUS  current
339    DESCRIPTION
340        "The collection of objects which are used to configure
341        physical topology learning via CDP with support for use
342        of CDP running on a proxy interface."
343    ::= { cPtopoExtnGroups 3 }
344
345END
346