summaryrefslogtreecommitdiff
path: root/MIBS/calix/OCCAM-ENTITY-MIB
blob: 4e376547fb777b77292ba7a3e090ee00db324a28 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386

--This MIB has been extracted from RFC 2737
OCCAM-ENTITY-MIB	DEFINITIONS ::= BEGIN
	IMPORTS
		MODULE-IDENTITY, OBJECT-TYPE, mib-2, NOTIFICATION-TYPE, 
		enterprises, OBJECT-IDENTITY, Integer32
			FROM SNMPv2-SMI
		TDomain, TAddress, TEXTUAL-CONVENTION, AutonomousType, 
		RowPointer, TimeStamp, TruthValue, MacAddress, DateAndTime, 
		PhysAddress
			FROM SNMPv2-TC
		SnmpAdminString
			FROM SNMP-FRAMEWORK-MIB
		MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP
			FROM SNMPv2-CONF
		occamGenericHardwareModules
			FROM OCCAM-REG-MODULE;

	entityMIB	MODULE-IDENTITY
		LAST-UPDATED	"200710020000Z"
		ORGANIZATION	"Occam Networks"
		CONTACT-INFO	"email support@occamnetworks.com"
		
		DESCRIPTION		
				"The MIB module for representing multiple 
                                logical entities supported by a single 
                                SNMP agent."
		
		REVISION	"200909100000Z"
		DESCRIPTION	"Realigned objects and indices ordering"
		
		REVISION	"200710020000Z"
		DESCRIPTION	"modified entitySoftwareRevExt object OID"
				
		REVISION	"200709200000Z"
		DESCRIPTION	"added entitySoftwareRevExt object"

		REVISION	"9912070000Z"
		DESCRIPTION	"Initial Version of Entity MIB (Version 2).
				This revision obsoletes RFC 2037."
		
		::=  {  occamGenericHardwareModules  1  }

-- TEXTUAL-CONVENTIONS --
	PhysicalIndex ::= TEXTUAL-CONVENTION 
		DISPLAY-HINT	"d"
		STATUS		current
		DESCRIPTION	"An arbitrary value which uniquely 
                                identifies the physical entity.  The 
                                value should be a small non-negative 
                                integer; index values for different 
                                physical entities are not necessarily
                                contiguous."
		SYNTAX 		Integer32  ( 0 .. 2147483647  ) 

	org	OBJECT IDENTIFIER
		::=  {  iso  3  }

	dod	OBJECT IDENTIFIER
		::=  {  org  6  }


-- MIB variables

	internet	OBJECT IDENTIFIER
		::=  {  dod  1  }

	mgmt	OBJECT IDENTIFIER
		::=  {  internet  2  }



--identifiers

	entityMIBObjects	OBJECT IDENTIFIER
		::=  {  entityMIB  1  }


-- Entity MIB Trap Definitions

	entityMIBTraps	OBJECT IDENTIFIER
		::=  {  entityMIB  2  }

--scalar Objects

	entityCompanyName	OBJECT-TYPE	
		SYNTAX		SnmpAdminString
		MAX-ACCESS	read-only
		STATUS		current
		DESCRIPTION		
				"The name of the Company which built the
                                product. In our case it is Occam 
                                Networks Inc."
		::=  {  entityMIBObjects 1 }

	entityMacAddress	OBJECT-TYPE	
		SYNTAX          MacAddress 
		MAX-ACCESS	read-only
		STATUS		current
		DESCRIPTION		
				"This object contains the MAC Address of
				an ethernet interface. For other physical
				entities it is an octet string of length 0"
		::=  {  entityMIBObjects 2  }

	entityBoardName		OBJECT-TYPE	
		SYNTAX		SnmpAdminString
		MAX-ACCESS	read-only
		STATUS		current
		DESCRIPTION		
				"The textual name of the Board."
		::=  {  entityMIBObjects 3 }

	entityBoardAssembly	OBJECT-TYPE	
		SYNTAX		SnmpAdminString
		MAX-ACCESS	read-only
		STATUS		current
		DESCRIPTION		
				"An in-house classification of the board."
		::=  {  entityMIBObjects 4 }

	entityBoardType		OBJECT-TYPE	
		SYNTAX		SnmpAdminString
		MAX-ACCESS	read-only
		STATUS		current
		DESCRIPTION		
				"The type of board that is present."
		::=  {  entityMIBObjects 5 }

	entitySerialNum		OBJECT-TYPE	
		SYNTAX		SnmpAdminString (SIZE(0 .. 32)) 
		MAX-ACCESS	read-only
		STATUS		current
		DESCRIPTION		
				"The vendor-specific serial number 
                                 string for the physical entity."
				
		::=  {  entityMIBObjects  6  }

	entityHardwareRev	OBJECT-TYPE	
		SYNTAX		SnmpAdminString
		MAX-ACCESS	read-only
		STATUS		current
		DESCRIPTION		
				"The vendor-specific hardware revision 
                                string for the physical entity.  The 
                                preferred value is the hardware revision 
                                identifier actually printed on the 
                                component itself (if present).
				
				Note that if revision information is 
                                stored internally in a non-printable 
                                (e.g., binary) format, then the agent 
                                must convert such information to a 
                                printable format, in an implementation-
                                specific manner.
				
				If no specific hardware revision string 
                                is associated with the physical component,
                                or this information is unknown to the 
                                agent, then this object will contain a 
                                zero-length string."
		::=  {  entityMIBObjects  7  }


	entityFirmwareRev	OBJECT-TYPE	
		SYNTAX		SnmpAdminString
		MAX-ACCESS	read-only
		STATUS		current
		DESCRIPTION		
				"The vendor-specific firmware revision 
                                string for the
				physical entity.
				
				Note that if revision information is 
                                stored internally in a non-printable 
                                (e.g., binary) format, then the agent 
                                must convert such information to a 
                                printable format, in an implementation-
                                specific manner.
				
				If no specific firmware programs are 
                                associated with the physical component, 
                                or this information is unknown to the
				agent, then this object will contain a 
                                zero-length string."
		::=  {  entityMIBObjects 8  }


	entitySoftwareRev	OBJECT-TYPE	
		SYNTAX		SnmpAdminString
		MAX-ACCESS	read-only
		STATUS		current
		DESCRIPTION		
				"The vendor-specific software revision 
                                string for the physical entity.
				
				Note that if revision information is 
                                stored internally in a non-printable 
                                (e.g., binary) format, then the agent 
                                must convert such information to a 
                                printable format, in an implementation-
                                specific manner.
				
				If no specific software programs are 
                                associated with the physical component, 
                                or this information is unknown to the
				agent, then this object will contain a 
                                zero-length string."
		::=  {  entityMIBObjects 9 }

	entityMfgDate		OBJECT-TYPE	
		SYNTAX		SnmpAdminString	
		MAX-ACCESS	read-only
		STATUS		current
		DESCRIPTION		
				"The date when this physical component 
                                was manufactured. The preferred value is
                                the manufacturer date printed on the 
                                component itself(if present). If the 
                                manufacturer date  associated with the 
                                physical component is unknown to the 
                                agent, then this object will contain a
				zero-length string."
		::=  {  entityMIBObjects  10 }
		
	entitySoftwareRevExt	OBJECT-TYPE	
		SYNTAX		SnmpAdminString
		MAX-ACCESS	read-only
		STATUS		current
		DESCRIPTION		
				"The Occam software revision extension in
                                'TagTagrev_SuffixSuffixrev' format 
                                (i.e. R3_P1). In this example the Tag is 
                                R, the Tagrev is 3, the Suffix is P, and 
                                the Suffixrev is 1."
		::=  {  entityMIBObjects 13 }	

	entityOntSlotId		OBJECT-TYPE
                SYNTAX		SnmpAdminString
                MAX-ACCESS	read-only
                STATUS		current
                DESCRIPTION
			        "The slot identifier configured on this 
                                entity, intended for within a daisy 
                                chained application.  This object is 
                                applicable to active ONTs."
                ::=  {  entityMIBObjects  14 }


	
--           The Port Table
	entityPortTable		OBJECT-TYPE
		SYNTAX		SEQUENCE  OF  EntityPortEntry
		MAX-ACCESS	not-accessible
		STATUS		current
		DESCRIPTION	
			        "This table contains one row per port 
                                entity."
		::=  { entityMIBObjects 11 }

	entityPortEntry		OBJECT-TYPE
		SYNTAX		EntityPortEntry
		MAX-ACCESS	not-accessible
		STATUS		current
		DESCRIPTION	
			        "Information about a particular port."
		INDEX		{  entityPortShelfIndex, 
                                entityPortSlotIndex, entityPortIndex }
		::=  { entityPortTable 1 }

	EntityPortEntry  ::=  SEQUENCE {
	        entityPortShelfIndex PhysicalIndex,
		entityPortSlotIndex PhysicalIndex,
		entityPortIndex  PhysicalIndex,
		entityPortName SnmpAdminString
		}

	entityPortShelfIndex	OBJECT-TYPE	
		SYNTAX		PhysicalIndex
		MAX-ACCESS	read-only	
		STATUS		current
		DESCRIPTION		
				"The shelf number which contains the slot
                                 that contains this port."
		::=  {  entityPortEntry  1  }

	entityPortSlotIndex	OBJECT-TYPE	
		SYNTAX		PhysicalIndex
		MAX-ACCESS      read-only	
		STATUS		current
		DESCRIPTION		
				"The slot number associated with this 
                                port." 
		::=  {  entityPortEntry  2  }

	entityPortIndex		OBJECT-TYPE	
		SYNTAX		PhysicalIndex
		MAX-ACCESS      read-only	
		STATUS		current
		DESCRIPTION		
				"The number of the port in the slot 
                                specified by entitySlotIndex, and the 
                                shelf specified by entityShelfIndex."
		::=  {  entityPortEntry  3  }

	entityPortName		OBJECT-TYPE	
		SYNTAX		SnmpAdminString
		MAX-ACCESS	read-only
		STATUS		current
		DESCRIPTION		
				"The textual name of the port. The value
                                of this object should be the name as 
                                assigned by the local device and should
                                be suitable for usein commands entered at
                                the device's console."
		::=  {  entityPortEntry  4  }

--conformance statements

	entityMIBConformance	OBJECT IDENTIFIER
		::=  { entityMIB 3  }

	entityMIBGroups	OBJECT IDENTIFIER
		::=  { entityMIBConformance 1	}

	entityMIBCompliances	OBJECT IDENTIFIER
		::=  {  entityMIBConformance  2  }

	entityMIBObjGroups	OBJECT IDENTIFIER
		::=  {  entityMIBGroups  1  }

	entityMIBEventGroups	OBJECT IDENTIFIER
		::=  {  entityMIBGroups  2  }




	entityCompliance	MODULE-COMPLIANCE
		STATUS		current
		DESCRIPTION		
				"The compliance statement for SNMP 
                                entities which implement the Entity MIB."

		MODULE 	
		MANDATORY-GROUPS	{ entityPhysicalGroup}
		OBJECT          	entitySerialNum
		MIN-ACCESS		not-accessible
		DESCRIPTION
                		"Read and write access is not required 
                                for agents which cannot identify serial 
                                number information for physical entities,
                                and/or cannot provide non-volatile 
                                storage for NMS-assigned serial numbers.
						
				Write access is not required for agents
                                which can identify serial number 
                                information,but can provide non-volatile 
                                storage for NMS-assigned serial numbers."
						
		::=  {  entityMIBCompliances  1  }


-- MIB groupings

	entityPhysicalGroup	OBJECT-GROUP
           	OBJECTS	        {  entityCompanyName,
                                   entityMacAddress, 
                                   entityBoardName,
                                   entityBoardAssembly,
                                   entityBoardType ,
                                   entitySerialNum,
                                   entityHardwareRev,
                                   entityFirmwareRev,
                                   entitySoftwareRev,
                                   entityMfgDate 
				}                 
		STATUS		current
		DESCRIPTION		
				"The collection of objects which are used
                                to represent the physical system for which
                                a single agent provides management 
                                information."
		::=  {  entityMIBObjGroups  1  }

END