1-- *****************************************************************
2-- CISCO-LOCAL-AUTH-USER-MIB.my
3--
4-- June 2012, Prakash Vijayaragavan
5--
6-- Copyright (c) 2005-2006-2013 by cisco Systems Inc.
7-- All rights reserved.
8--
9-- *****************************************************************
10
11CISCO-LOCAL-AUTH-USER-MIB DEFINITIONS ::= BEGIN
12
13IMPORTS
14    MODULE-IDENTITY,
15    OBJECT-TYPE,
16    NOTIFICATION-TYPE,
17    Unsigned32
18        FROM SNMPv2-SMI
19    MODULE-COMPLIANCE,
20    NOTIFICATION-GROUP,
21    OBJECT-GROUP
22        FROM SNMPv2-CONF
23    TruthValue,
24    DateAndTime,
25    RowStatus,
26    StorageType
27        FROM SNMPv2-TC
28    SnmpAdminString
29        FROM SNMP-FRAMEWORK-MIB
30    ciscoMgmt
31        FROM CISCO-SMI;
32
33
34ciscoLocalAuthUserMIB MODULE-IDENTITY
35    LAST-UPDATED    "201311080000Z"
36    ORGANIZATION    "Cisco Systems, Inc."
37    CONTACT-INFO
38            "Cisco Systems
39            Customer Service
40
41
42            Postal: 170 W Tasman Drive
43
44            San Jose, CA  95134
45
46            USA
47
48
49            Tel: +1 800 553-NETSS
50
51
52            E-mail: cs-aaa@cisco.com"
53    DESCRIPTION
54        "This MIB module defines objects describing users
55        authenticated locally by a Network Access Server (NAS).
56
57            +--------+      +--------+        +---------+
58            |        |      |        |        |         |
59            | Client |<---->| Server |<------>| Network |
60            |        |      |  (NAS) |        |         |
61            +--------+      +--------+        +---------+
62
63
64        A client is a telnet or SSH user needing access to the NAS
65        box directly. Network user like PPP or dot1x will request
66        NAS box for authentication to access the network.
67
68        NAS box authenticates user present in the local user
69        database.
70
71        GLOSSARY
72
73        Network Access Server ( NAS )
74        A single point of access to a remote resource and is
75        exclusively used with Authentication, Authorization
76        and Accounting.
77
78        Point-to-Point Protocol (PPP)
79        A data link protocol commonly used in establishing a
80        direct connection between two networking nodes."
81
82    REVISION        "201311080000Z"
83    DESCRIPTION
84    	"Deprecated clauUserTable and the following
85    	notifications: clauUserAdded, clauUserDeleted,
86    	clauUserLoggedIn and clauUserLoggedOut;
87
88    	Added the new objects and notifications defined in
89    	the following new mib groups:
90   		 clauMIBUserInfoGroup;
91   		 clauNotifControlGroup;
92   		 clauMIBNotificationGroup2;"
93    REVISION        "201305090000Z"
94    DESCRIPTION
95        "Added clauUserLoggedIn and clauUserLoggedOut notification"
96    REVISION        "201207130000Z"
97    DESCRIPTION
98        "Initial version of MIB"
99    ::= { ciscoMgmt 798 }
100
101
102-- Default Notification Type
103
104ciscoLocalAuthUserMIBNotifs  OBJECT IDENTIFIER
105    ::= { ciscoLocalAuthUserMIB 0 }
106
107-- Local authenticated user MIB object definition
108
109ciscoLocalAuthUserMIBObjects  OBJECT IDENTIFIER
110    ::= { ciscoLocalAuthUserMIB 1 }
111
112ciscoLocalAuthUserMIBConform  OBJECT IDENTIFIER
113    ::= { ciscoLocalAuthUserMIB 2 }
114
115
116-- Notification Configuration
117
118clauNotifEnable OBJECT-TYPE
119    SYNTAX          TruthValue
120    MAX-ACCESS      read-write
121    STATUS          current
122    DESCRIPTION
123        "This object specifies whether the system generates
124        clauUserAdded1, clauUserDeleted1, clauUserLoggedIn1
125        and clauUserLoggedOut1 notifications."
126    DEFVAL          { false }
127    ::= { ciscoLocalAuthUserMIBObjects 1 }
128-- Currently only Network- Guest users profiles are updated in the
129-- table.
130
131clauUserTable OBJECT-TYPE
132    SYNTAX          SEQUENCE OF ClauEntry
133    MAX-ACCESS      not-accessible
134    STATUS          deprecated
135    DESCRIPTION
136        "This table lists the currently configured local users.
137
138        This table is deprecated and replaced by
139        clauUserConfigTable."
140    ::= { ciscoLocalAuthUserMIBObjects 2 }
141
142clauUserEntry OBJECT-TYPE
143    SYNTAX          ClauEntry
144    MAX-ACCESS      not-accessible
145    STATUS          deprecated
146    DESCRIPTION
147        "An entry describes a local user identified by its index.
148
149        An entry is created or modified when a user is defined with
150        IOS configuration commands via CLI. An entry is removed when
151        a user is undefined with IOS configuration commands via CLI
152        or by automatic expiry of users when lifetime of the user is
153        expired."
154    INDEX           { clauUserIndex }
155    ::= { clauUserTable 1 }
156
157ClauEntry ::= SEQUENCE {
158        clauUserIndex        Unsigned32,
159        clauUserName         SnmpAdminString,
160        clauUserType         INTEGER,
161        clauUserCreationTime DateAndTime,
162        clauUserLifetime     Unsigned32
163}
164
165clauUserIndex OBJECT-TYPE
166    SYNTAX          Unsigned32 (1..4294967295)
167    MAX-ACCESS      not-accessible
168    STATUS          deprecated
169    DESCRIPTION
170        "This object indicates an integer-value that uniquely identifies
171        a local user."
172    ::= { clauUserEntry 1 }
173
174clauUserName OBJECT-TYPE
175    SYNTAX          SnmpAdminString
176    MAX-ACCESS      read-only
177    STATUS          deprecated
178    DESCRIPTION
179        "A textual string containing the name of the locally
180        authenticated user."
181    ::= { clauUserEntry 2 }
182
183clauUserType OBJECT-TYPE
184    SYNTAX          INTEGER  {
185                        defaultUser(1),
186                        lobbyUser(2),
187                        managementUser(3),
188                        networkUser(4),
189                        guestUser(5)
190                    }
191    MAX-ACCESS      read-only
192    STATUS          deprecated
193    DESCRIPTION
194        "This object indicates the type of local user:
195
196        defaultUser    - Default user account type.
197        lobbyUser      - Management user with lobby admin privileges,
198                     can create and manage guest user account type.
199        managementUser - Management user account type.
200        networkUser    - User requires accessing the network.
201        guestUser      - Type of networkUser with lifetime configured
202                         such that they can stay alive for a given time
203                                  period and will expire
204        therafter."
205    ::= { clauUserEntry 3 }
206
207clauUserCreationTime OBJECT-TYPE
208    SYNTAX          DateAndTime
209    MAX-ACCESS      read-only
210    STATUS          deprecated
211    DESCRIPTION
212        "This object indicates the time the local user was created."
213    ::= { clauUserEntry 4 }
214
215clauUserLifetime OBJECT-TYPE
216    SYNTAX          Unsigned32
217    UNITS           "seconds"
218    MAX-ACCESS      read-only
219    STATUS          deprecated
220    DESCRIPTION
221        "This object indicates the expiry duration of the local user;
222        that is, the duration the local user is valid from the
223        creation time."
224    ::= { clauUserEntry 5 }
225
226
227clauUserConfigTable OBJECT-TYPE
228    SYNTAX          SEQUENCE OF ClauConfigEntry
229    MAX-ACCESS      not-accessible
230    STATUS          current
231    DESCRIPTION
232        "This table lists the currently configured local users."
233    ::= { ciscoLocalAuthUserMIBObjects 3 }
234
235clauUserConfigEntry OBJECT-TYPE
236    SYNTAX          ClauConfigEntry
237    MAX-ACCESS      not-accessible
238    STATUS          current
239    DESCRIPTION
240        "An entry describes the configured local user."
241    INDEX           { clauUserConfigName }
242    ::= { clauUserConfigTable 1 }
243
244ClauConfigEntry ::= SEQUENCE {
245        clauUserConfigName            OCTET STRING,
246        clauUserConfigType            INTEGER,
247        clauUserConfigCreationTime    DateAndTime,
248        clauUserConfigLifetime        Unsigned32,
249        clauUserConfigPassword	      SnmpAdminString,
250        clauUserConfigDescription     SnmpAdminString,
251        clauUserConfigStorageType	  StorageType,
252        clauUserConfigRowStatus		  RowStatus
253}
254
255clauUserConfigName OBJECT-TYPE
256    SYNTAX          OCTET STRING (SIZE  (1..64))
257    MAX-ACCESS      not-accessible
258    STATUS          current
259    DESCRIPTION
260        "A textual string containing the name of the locally
261        authenticated user."
262    ::= { clauUserConfigEntry 1 }
263
264clauUserConfigType OBJECT-TYPE
265    SYNTAX          INTEGER  {
266                        defaultUser(1),
267                        lobbyUser(2),
268                        managementUser(3),
269                        networkUser(4),
270                        guestUser(5)
271                    }
272    MAX-ACCESS      read-only
273    STATUS          current
274    DESCRIPTION
275        "This object indicates the type of local user:
276
277        defaultUser    - Default user account type.
278        lobbyUser      - Management user with lobby admin privileges,
279                     can create and manage guest user account type.
280        managementUser - Management user account type.
281        networkUser    - User requires accessing the network.
282        guestUser      - Type of networkUser with lifetime configured
283                         such that they can stay alive for a given time
284                                  period and will expire
285        therafter."
286    ::= { clauUserConfigEntry 2 }
287
288clauUserConfigCreationTime OBJECT-TYPE
289    SYNTAX          DateAndTime
290    MAX-ACCESS      read-only
291    STATUS          current
292    DESCRIPTION
293        "This object indicates the time the local user was created."
294    ::= { clauUserConfigEntry 3 }
295
296clauUserConfigLifetime OBJECT-TYPE
297    SYNTAX          Unsigned32
298    UNITS           "seconds"
299    MAX-ACCESS      read-create
300    STATUS          current
301    DESCRIPTION
302        "This object specifies the expiry duration of the local user;
303        that is, the duration the local user is valid from thes
304        creation time."
305    ::= { clauUserConfigEntry 4 }
306
307clauUserConfigPassword OBJECT-TYPE
308    SYNTAX          SnmpAdminString
309    MAX-ACCESS      read-create
310    STATUS          current
311    DESCRIPTION
312		"This object specifies the password of the locally
313		authenticated user.
314
315        When read, this object always returns the value of a
316        non zero-length octet string with asterick value."
317    ::= { clauUserConfigEntry 5 }
318
319
320clauUserConfigDescription OBJECT-TYPE
321    SYNTAX          SnmpAdminString
322    MAX-ACCESS      read-create
323    STATUS          current
324    DESCRIPTION
325	   "This object specifies the description of the local user."
326    ::= { clauUserConfigEntry 6 }
327
328clauUserConfigStorageType OBJECT-TYPE
329    SYNTAX          StorageType
330    MAX-ACCESS      read-create
331    STATUS          current
332    DESCRIPTION
333        "The storage type for this conceptual row in the
334        clauUserConfigTable."
335    ::= { clauUserConfigEntry 7 }
336
337clauUserConfigRowStatus OBJECT-TYPE
338    SYNTAX          RowStatus
339    MAX-ACCESS      read-create
340    STATUS          current
341    DESCRIPTION
342        "This object reflects the status of the row in this table.
343		It can be used for creating, deleting and modifying the
344		entries in this table."
345    ::= { clauUserConfigEntry 8 }
346
347
348clauMIBCompliances  OBJECT IDENTIFIER
349    ::= { ciscoLocalAuthUserMIBConform 1 }
350
351
352clauUserAdded NOTIFICATION-TYPE
353    OBJECTS         {
354    					clauUserName,
355                        clauUserType,
356                        clauUserLifetime
357                    }
358    STATUS          deprecated
359    DESCRIPTION
360        "This notification indicates when the system has added a
361        user.
362
363        This notification is deprecated and replaced by
364        clauUserAdded1"
365   ::= { ciscoLocalAuthUserMIBNotifs 1 }
366
367clauUserDeleted NOTIFICATION-TYPE
368    OBJECTS         {
369    					clauUserName,
370                        clauUserType
371                    }
372    STATUS          deprecated
373    DESCRIPTION
374        "This notification indicates when the system has deleted a
375        user.
376
377        This notification is deprecated and replaced by
378        clauUserDeleted1"
379   ::= { ciscoLocalAuthUserMIBNotifs 2 }
380
381clauUserLoggedIn NOTIFICATION-TYPE
382    OBJECTS         {
383    					clauUserName,
384                        clauUserType
385                    }
386    STATUS          deprecated
387    DESCRIPTION
388        "This notification indicates when the user has logged
389        into the system.
390
391        This notification is deprecated and replaced by
392        clauUserLoggedIn1"
393   ::= { ciscoLocalAuthUserMIBNotifs 3 }
394
395clauUserLoggedOut NOTIFICATION-TYPE
396    OBJECTS         {
397    					clauUserName,
398                        clauUserType
399                    }
400    STATUS          deprecated
401    DESCRIPTION
402        "This notification indicates when the user has logged
403        out of the system.
404
405        This notification is deprecated and replaced by
406        clauUserLoggedOut1"
407   ::= { ciscoLocalAuthUserMIBNotifs 4 }
408
409clauUserAdded1 NOTIFICATION-TYPE
410    OBJECTS         {
411                        clauUserType,
412                        clauUserLifetime
413                    }
414    STATUS          current
415    DESCRIPTION
416        "This notification indicates when the system has added a
417        user."
418   ::= { ciscoLocalAuthUserMIBNotifs 5 }
419
420clauUserDeleted1 NOTIFICATION-TYPE
421    OBJECTS         {
422                        clauUserType
423                    }
424    STATUS          current
425    DESCRIPTION
426        "This notification indicates when the system has deleted a
427        user or when user lifetime got expired."
428   ::= { ciscoLocalAuthUserMIBNotifs 6 }
429
430clauUserLoggedIn1 NOTIFICATION-TYPE
431    OBJECTS         {
432                        clauUserType
433                    }
434    STATUS          current
435    DESCRIPTION
436        "This notification indicates when the user has logged
437        into the system."
438   ::= { ciscoLocalAuthUserMIBNotifs 7 }
439
440clauUserLoggedOut1 NOTIFICATION-TYPE
441    OBJECTS         {
442                        clauUserType
443                    }
444    STATUS          current
445    DESCRIPTION
446        "This notification indicates when the user has logged
447        out of the system"
448   ::= { ciscoLocalAuthUserMIBNotifs 8 }
449
450clauMIBGroups  OBJECT IDENTIFIER
451    ::= { ciscoLocalAuthUserMIBConform 2 }
452
453
454clauMIBCompliance MODULE-COMPLIANCE
455    STATUS          deprecated
456    DESCRIPTION
457        "This is a default module-compliance
458        containing default object groups."
459    MODULE          -- this module
460    MANDATORY-GROUPS {
461                        clauMIBMainObjectGroup,
462                        clauMIBNotificationGroup
463                    }
464    ::= { clauMIBCompliances 1 }
465
466clauMIBCompliance1 MODULE-COMPLIANCE
467    STATUS          deprecated
468    DESCRIPTION
469        "This is a default module-compliance
470        containing object and notification groups."
471    MODULE          -- this module
472    MANDATORY-GROUPS {
473                        clauMIBMainObjectGroup,
474                        clauMIBNotificationGroup,
475                        clauMIBNotificationGroup1
476                    }
477    ::= { clauMIBCompliances 2 }
478
479clauMIBCompliance2 MODULE-COMPLIANCE
480    STATUS          current
481    DESCRIPTION
482        "This is a default module-compliance
483        containing object and notification groups."
484    MODULE          -- this module
485    MANDATORY-GROUPS {
486    					clauNotifControlGroup,
487                        clauUserInfoGroup,
488                        clauMIBNotificationGroup2
489                    }
490    OBJECT           clauNotifEnable
491    MIN-ACCESS       read-only
492    DESCRIPTION     "Write access is not required."
493
494    OBJECT           clauUserConfigPassword
495    MIN-ACCESS       read-only
496    DESCRIPTION     "Write access is not required."
497
498    OBJECT           clauUserConfigLifetime
499    MIN-ACCESS       read-only
500    DESCRIPTION     "Write access is not required."
501
502    OBJECT           clauUserConfigDescription
503    MIN-ACCESS       read-only
504    DESCRIPTION     "Write access is not required."
505
506    OBJECT           clauUserConfigRowStatus
507    MIN-ACCESS       read-only
508    DESCRIPTION     "Write access is not required."
509
510    ::= { clauMIBCompliances 3 }
511
512
513-- Units of Conformance
514
515clauMIBMainObjectGroup OBJECT-GROUP
516    OBJECTS         {
517                        clauNotifEnable,
518                        clauUserType,
519                        clauUserCreationTime,
520                        clauUserLifetime,
521                        clauUserName
522                    }
523    STATUS          deprecated
524    DESCRIPTION
525        "This is a cisco Local Authenticated User MIB Main Object
526        group."
527    ::= { clauMIBGroups 1 }
528
529
530clauMIBNotificationGroup NOTIFICATION-GROUP
531   NOTIFICATIONS    {
532                        clauUserAdded,
533                        clauUserDeleted
534                    }
535    STATUS          deprecated
536    DESCRIPTION
537        "This is a cisco Local Authenticated User MIB
538        Notification group."
539    ::= { clauMIBGroups 2 }
540
541clauMIBNotificationGroup1 NOTIFICATION-GROUP
542   NOTIFICATIONS    {
543                        clauUserLoggedIn,
544                        clauUserLoggedOut
545                    }
546    STATUS          deprecated
547    DESCRIPTION
548        "A collection of notifications about local user
549        login and logout"
550    ::= { clauMIBGroups 3 }
551
552clauNotifControlGroup OBJECT-GROUP
553    OBJECTS         {
554    					clauNotifEnable
555                    }
556    STATUS          current
557    DESCRIPTION
558        "A collection of objects providing for configuration of
559   		notification control."
560    ::= { clauMIBGroups 4 }
561
562clauUserInfoGroup OBJECT-GROUP
563    OBJECTS         {
564                        clauUserConfigType,
565        				clauUserConfigCreationTime,
566                        clauUserConfigLifetime,
567                        clauUserConfigPassword,
568                        clauUserConfigDescription,
569                        clauUserConfigStorageType,
570                        clauUserConfigRowStatus
571                    }
572    STATUS          current
573    DESCRIPTION
574        "A collection of objects providing the local user
575		information."
576    ::= { clauMIBGroups 5 }
577
578clauMIBNotificationGroup2 NOTIFICATION-GROUP
579   NOTIFICATIONS    {
580   						clauUserAdded1,
581                        clauUserDeleted1,
582                        clauUserLoggedIn1,
583                        clauUserLoggedOut1
584                    }
585    STATUS          current
586    DESCRIPTION
587        "A collection of notifications about local user addition,
588   		deletion, login and logout."
589    ::= { clauMIBGroups 6 }
590
591END
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614