1-- ********************************************************************
2-- CISCO-PSD-CLIENT-MIB.my: MIB file for PSD
3--
4-- August 2005, Suma Marutirao Sutar
5--
6-- Copyright (c), 2005 by Cisco Systems, Inc.
7-- All rights reserved.
8-- ********************************************************************
9-- $Endlog$
10
11
12CISCO-PSD-CLIENT-MIB DEFINITIONS ::= BEGIN
13
14IMPORTS
15        MODULE-IDENTITY,
16        OBJECT-TYPE,
17        NOTIFICATION-TYPE,
18        Counter32,
19        Integer32
20                FROM SNMPv2-SMI
21        SnmpAdminString
22            FROM SNMP-FRAMEWORK-MIB
23        RowStatus,
24        TruthValue
25            FROM SNMPv2-TC
26        InetAddressType,
27        InetAddress
28                FROM INET-ADDRESS-MIB
29        MODULE-COMPLIANCE,
30        OBJECT-GROUP,
31        NOTIFICATION-GROUP
32                FROM SNMPv2-CONF
33        ciscoMgmt
34                FROM CISCO-SMI;
35
36ciscoPsdClientMIB   MODULE-IDENTITY
37        LAST-UPDATED    "200508241800Z"
38        ORGANIZATION    "Cisco Systems, Inc."
39        CONTACT-INFO
40                "       Cisco Systems
41                        Customer Service
42
43                Postal: 170 W Tasman Drive
44                        San Jose, CA  95134
45                        USA
46
47                   Tel: +1 800 553-NETS
48
49                E-mail: cs-gprs@cisco.com"
50        DESCRIPTION
51               "This MIB module manages the client side
52               functionality of the Persistent Storage Device(PSD).
53
54               This MIB instrumentation is for configuring
55               data-store(PSD client) feature on GGSN and monitoring
56               the state of the PSD server(up/down/full).
57
58               The Cisco Persistent Storage Device(PSD) is an
59               extension to existing storage on the Cisco Content
60               Services Gateway(CSG).
61
62               The GGSN currently allows sending of the CDRs to an
63               active CG, while allowing up to two standby CG's to
64               be configured. When all the configured CG's become
65               unavailable, the CDRs get stored at the GGSN and
66               start using up GGSN resources such as memory. As the
67               amount of memory is limited on GGSN and failure of
68               GGSN shall lead to losing these stored CDRs.
69               Using PSD as temporary storage, shall avoid losses
70               due to these problems. When all the configured CG's
71               are unavailable, GGSN needs to backup the live closed
72               CDR's to a PSD. When any of the CG's shall become
73               available, GGSN shall retrieve the stored CDR's
74               automatically from the PSD and forwards them to the
75               active CG.
76
77               PSD supports the charging protocol(GTP'), version 0
78               with a few private extensions, which is used to
79               facilitate the required functionality via UDP.
80
81               Acronyms and terms:
82
83                 CDR    Call Detail Record
84                 CID    Charging Identification
85                 CG     Charging Gateway
86                 CGF    Charging Gateway Functionality
87                 DS     Data-Store
88                 ETSI   European Telecommunications Standards
89                        Institute
90                 Ga     Name of the interface between SGSN/GGSN and
91                        CG
92                 Gi     Name of the interface between GGSN and PDN
93                 Gn     Name of the interface between GGSN and SGSN
94                 G-CDR  Gateway GPRS Support Node-Call Detail Record
95                 GGSN   Gateway GPRS Support Node
96                 GPRS   General Packet Radio Service
97                 GSM    Global System for Mobile communication
98                 GTP    GPRS Tunneling Protocol
99                 GTP'   GTP enhanced for charging
100                 IE     Information Element
101                 MS     Mobile Station
102                 PDN    Packet Data Network
103                 PDP    Packet Data Protocol
104                 SGSN   Serving GPRS support Node
105                 TOS    Type of Service.
106                 PSD    Persistence Storage Device."
107
108
109--     REFERENCE
110--               "[1] GSM 09.60: Digital cellular telecommunication
111--                   system (Phase 2+); General Packet Radio Service
112--                   (GPRS); GPRS Tunneling Protocol (GTP) across
113--                   Gn and Gp Interface, ETSI, (V7.3.0)
114--               [2] GSM 12.15: 'Digital Cellular telecommunications
115--                   system (Phase 2+); General Packet Radio Service
116--                   (GPRS); Charging in GPRS', ETSI, (V7.2.1)
117--               [3] 3GPP; Universal Mobile Telecommunications System
118--                   (UMTS);Telecommunication Management;Charging and
119--                   billing;3G call and event data for Packet
120--                   Switched(PS) domain.TS 32.015 version 3.8.0
121--                   (Release 1999)."
122       REVISION         "200508241800Z"
123       DESCRIPTION
124               "Initial version of this MIB module."
125       ::= {ciscoMgmt 495 }
126
127-- Notification Definitions
128
129ciscoPsdClientMIBNotifs        OBJECT IDENTIFIER
130       ::= { ciscoPsdClientMIB 0 }
131
132-- Object definitions
133
134ciscoPsdClientMIBObjects      OBJECT IDENTIFIER
135       ::= { ciscoPsdClientMIB 1 }
136
137ciscoPsdClientStatistics      OBJECT IDENTIFIER
138       ::= { ciscoPsdClientMIBObjects 1 }
139
140ciscoPsdClientNotifMgmt       OBJECT IDENTIFIER
141       ::= { ciscoPsdClientMIBObjects 2 }
142
143ciscoPsdClientConfigurations  OBJECT IDENTIFIER
144       ::= { ciscoPsdClientMIBObjects 3 }
145
146ciscoPsdClientNotifInfo        OBJECT IDENTIFIER
147       ::= { ciscoPsdClientMIBObjects 4 }
148
149-- Conformances definitions
150
151ciscoPsdClientMIBConform      OBJECT IDENTIFIER
152       ::= { ciscoPsdClientMIB 2 }
153--
154-- Statistics
155--
156
157cPsdClientDSWriteReq     OBJECT-TYPE
158       SYNTAX            Counter32
159       MAX-ACCESS        read-only
160       STATUS            current
161       DESCRIPTION
162             "The number of Data Record Transfer request (for write)
163             messages sent to the PSD server.
164
165             This counter is incremented when the FIFO write request
166             is sent to the PSD server from the client."
167       ::= { ciscoPsdClientStatistics 1 }
168
169cPsdClientDSReadReq      OBJECT-TYPE
170       SYNTAX            Counter32
171       MAX-ACCESS        read-only
172       STATUS            current
173       DESCRIPTION
174             "The number of Data Record Transfer request (for read)
175             messages sent to PSD server.
176
177             This counter is incremented when the FIFO read request
178             message is sent to PSD server."
179       ::= { ciscoPsdClientStatistics 2 }
180
181cPsdClientDSRdWrRetrans  OBJECT-TYPE
182       SYNTAX            Counter32
183       MAX-ACCESS        read-only
184       STATUS            current
185       DESCRIPTION
186             "The number of Data Record Transfer Request
187             (retransmission) messages sent to the PSD server.
188
189             The PSD does not differentiate between a retransmission
190             and original request. So, this counter together with
191             the above two counters cPsdClientDSReadReq/
192             cPsdClientDSWriteReq can be used to tally the number of
193             messages received by the PSD client.
194
195             This counter is incremented when the FIFO read/write
196             retransmission messages are sent to PSD server."
197       ::= { ciscoPsdClientStatistics 3 }
198
199cPsdClientDSDiskFullTrans OBJECT-TYPE
200       SYNTAX            Counter32
201       MAX-ACCESS        read-only
202       STATUS            current
203       DESCRIPTION
204             "The number of state transitions made by the PSD from
205             state 'disk available' to 'disk full'.
206
207             This counter is incremented when client receives the
208             disk full indication from PSD server."
209       ::= { ciscoPsdClientStatistics 4 }
210
211-- Notification related objects
212
213cPsdClientNotifEnable    OBJECT-TYPE
214       SYNTAX            TruthValue
215       MAX-ACCESS        read-write
216       STATUS            current
217       DESCRIPTION
218             "This object specifies whether the agent should
219             generate the notifications defined in this MIB module.
220
221             If the value of this object is 'true' it enables the
222             device to generate the notifications.
223             If the value of this object is 'false' it disables the
224             device from generating the notifications."
225       DEFVAL { false }
226       ::= { ciscoPsdClientNotifMgmt 1 }
227
228--
229--Configurations
230--
231
232cPsdClientDSTable        OBJECT-TYPE
233       SYNTAX            SEQUENCE OF CPsdClientDSEntry
234       MAX-ACCESS        not-accessible
235       STATUS            current
236       DESCRIPTION
237             "A table consisting of entries for data-store(DS) and
238             auto-retrieval configurations.
239
240             In order to minimize the performance/memory impact on
241             the PSD client, as well as not to overwhelm the CG
242             with both live CDRs and retrieved CDRs, the maximum
243             retrieval rate from PSD server to GGSN is limited and
244             can be configured by the user."
245       ::= { ciscoPsdClientConfigurations 1 }
246
247cPsdClientDSEntry        OBJECT-TYPE
248       SYNTAX            CPsdClientDSEntry
249       MAX-ACCESS        not-accessible
250       STATUS            current
251       DESCRIPTION
252             "Each entry contains the configuration for
253             auto-retrieval and also maximum retrieval value if
254             auto-retrieval is enabled."
255       INDEX    { cPsdClientDSName }
256       ::= { cPsdClientDSTable 1 }
257
258CPsdClientDSEntry ::= SEQUENCE {
259       cPsdClientDSName            SnmpAdminString,
260       cPsdClientDSAutoRetrieve    TruthValue,
261       cPsdClientDSMaxRetrieve     Integer32,
262       cPsdClientDSRowStatus       RowStatus
263       }
264
265cPsdClientDSName OBJECT-TYPE
266       SYNTAX            SnmpAdminString (SIZE(1..32))
267       MAX-ACCESS        not-accessible
268       STATUS            current
269       DESCRIPTION
270             "This object contains the name of the configured
271             data-store"
272       ::= { cPsdClientDSEntry 1 }
273
274cPsdClientDSAutoRetrieve OBJECT-TYPE
275       SYNTAX            TruthValue
276       MAX-ACCESS        read-create
277       STATUS            current
278       DESCRIPTION
279             "This object is used to enable/disable the CDR
280             auto-retrieval functionality.
281
282             If value of this object is set to 'true',
283             auto-retrieval is enabled.
284
285             If value of this object is set to 'false',
286             auto-retrieval is disabled."
287       DEFVAL { false }
288       ::= { cPsdClientDSEntry 2 }
289
290cPsdClientDSMaxRetrieve OBJECT-TYPE
291       SYNTAX            Integer32(1..6000)
292       UNITS             "messages/minute"
293       MAX-ACCESS        read-create
294       STATUS            current
295       DESCRIPTION
296             "This object used to specify the maximum retrieval
297             value, when auto retrieve is enabled, i.e when the
298             value of the corresponding instance of
299             cPsdClientDSAutoRetrieve is set to 'true'."
300       DEFVAL { 60 }
301       ::= { cPsdClientDSEntry 3 }
302
303cPsdClientDSRowStatus OBJECT-TYPE
304       SYNTAX            RowStatus
305       MAX-ACCESS        read-create
306       STATUS            current
307       DESCRIPTION
308             "The status of this conceptual row. This object is
309             used to create a row or delete a existing row in a
310             table."
311       ::= { cPsdClientDSEntry 4 }
312
313cPsdClientDSServerTable OBJECT-TYPE
314       SYNTAX            SEQUENCE OF CPsdClientDSServerEntry
315       MAX-ACCESS        not-accessible
316       STATUS            current
317       DESCRIPTION
318             "The table contains the list of the PSD servers used to
319             write/retrieve the CDRs."
320       ::= { ciscoPsdClientConfigurations 2 }
321
322cPsdClientDSServerEntry OBJECT-TYPE
323       SYNTAX            CPsdClientDSServerEntry
324       MAX-ACCESS        not-accessible
325       STATUS            current
326       DESCRIPTION
327             "This entry contains a description of the PSD server."
328       INDEX    { cPsdClientDSName,
329                  cPsdClientDSServerAddressType,
330                  cPsdClientDSServerAddress }
331       ::= { cPsdClientDSServerTable 1 }
332
333CPsdClientDSServerEntry ::= SEQUENCE {
334       cPsdClientDSServerAddressType       InetAddressType,
335       cPsdClientDSServerAddress           InetAddress,
336       cPsdClientDSRetrieveOnly            TruthValue,
337       cPsdClientDSServerRowStatus         RowStatus
338       }
339
340cPsdClientDSServerAddressType OBJECT-TYPE
341       SYNTAX            InetAddressType
342       MAX-ACCESS        not-accessible
343       STATUS            current
344       DESCRIPTION
345             "This object indicates the type of Internet address of
346             the PSD server."
347       ::= { cPsdClientDSServerEntry 1 }
348
349cPsdClientDSServerAddress OBJECT-TYPE
350       SYNTAX            InetAddress (SIZE (4..20))
351       MAX-ACCESS        not-accessible
352       STATUS            current
353       DESCRIPTION
354             "The object specifies the Internet address of the PSD
355             server. The type of address of an instance of this object
356             is determined by the value of the corresponding instance
357             of cPsdClientDSServerAddressType."
358       ::= { cPsdClientDSServerEntry 2 }
359
360cPsdClientDSRetrieveOnly OBJECT-TYPE
361       SYNTAX            TruthValue
362       MAX-ACCESS        read-create
363       STATUS            current
364       DESCRIPTION
365             "The object represents that, the PSD server can be
366             configured either as write/retrievable or as
367             retrievable only.
368
369             If the value of this object is set to 'true', the PSD
370             server (the value of the corresponding instance of
371             cPsdClientDSServerAddress) shall not be used for
372             writing the CDRs.
373
374             If the value of this object is set to 'false', the PSD
375             server (the value of the corresponding instance of
376             cPsdClientDSServerAddress) shall be used for writing
377             the CDRs as well as retrieving the CDRs."
378       ::= { cPsdClientDSServerEntry 3 }
379
380cPsdClientDSServerRowStatus OBJECT-TYPE
381       SYNTAX            RowStatus
382       MAX-ACCESS        read-create
383       STATUS            current
384       DESCRIPTION
385             "The status of this conceptual row. This object will
386             create a row or delete a existing row in a table."
387       ::= { cPsdClientDSServerEntry 4 }
388
389--Notif info
390
391cPsdClientNotifDSServerAddrType OBJECT-TYPE
392       SYNTAX            InetAddressType
393       MAX-ACCESS        accessible-for-notify
394       STATUS            current
395       DESCRIPTION
396             "This object indicates the type of Internet address of
397             the Data-Store server."
398       ::= { ciscoPsdClientNotifInfo 1 }
399
400cPsdClientNotifDSServerAddress OBJECT-TYPE
401       SYNTAX            InetAddress
402       MAX-ACCESS        accessible-for-notify
403       STATUS            current
404       DESCRIPTION
405             "This object specifies the Internet address of the
406             Data-Store server . The type of address of an instance
407             of this object is determined by the value of
408             cPsdClientNotifDSServerAddrType."
409       ::= { ciscoPsdClientNotifInfo 2 }
410
411--
412--  Notification Definitions
413--
414
415cPsdClientDownNotif NOTIFICATION-TYPE
416       OBJECTS {
417                 cPsdClientNotifDSServerAddrType,
418                 cPsdClientNotifDSServerAddress
419       }
420       STATUS            current
421       DESCRIPTION
422             "A notification of this type is generated when the
423             PSD server goes DOWN.
424
425             If the PSD client was in write/retrieving state, then
426             that operation shall be be stopped."
427       ::= { ciscoPsdClientMIBNotifs 1 }
428
429cPsdClientUpNotif NOTIFICATION-TYPE
430       OBJECTS {
431                 cPsdClientNotifDSServerAddrType,
432                 cPsdClientNotifDSServerAddress
433       }
434       STATUS            current
435       DESCRIPTION
436             "A notification of this type is generated when the
437             PSD server comes UP.
438
439             A GTP' path will be created fulfilling all the specific
440             requirements of the PSD interface."
441       ::= { ciscoPsdClientMIBNotifs 2 }
442
443cPsdClientDiskFullNotif NOTIFICATION-TYPE
444       OBJECTS {
445                 cPsdClientNotifDSServerAddrType,
446                 cPsdClientNotifDSServerAddress
447               }
448       STATUS            current
449       DESCRIPTION
450             "A notification of this type is generated when the
451             PSD server's disk become full.
452
453             If the disk of writable PSD server becomes full, the
454             client shall not be able to write any CDR into the
455             server. It shall then  behave as a retrieve only PSD
456             server."
457       ::= { ciscoPsdClientMIBNotifs 3 }
458
459--
460-- Conformances definitions
461--
462cPsdClientMIBCompliances OBJECT IDENTIFIER
463       ::= { ciscoPsdClientMIBConform 1}
464
465cPsdClientMIBGroups OBJECT IDENTIFIER
466       ::= { ciscoPsdClientMIBConform 2}
467
468-- compliance statements
469
470cPsdClientMIBCompliance MODULE-COMPLIANCE
471        STATUS           current
472        DESCRIPTION
473            "The compliance statement for entities which implement
474            the CISCO PSD CLIENT MIB."
475        MODULE  --this module
476        MANDATORY-GROUPS { cPsdClientMIBStatisticsGroup,
477                           cPsdClientMIBConfigurationsGroup,
478                           cPsdClientMIBNotifGroup,
479                           cPsdClientMIBNotifInfoGroup,
480                           cPsdClientMIBNotifMgmtGroup
481                         }
482        OBJECT           cPsdClientDSRowStatus
483        SYNTAX           INTEGER {
484                            active(1),
485                            createAndGo(4),
486                            destroy(6)
487                         }
488        DESCRIPTION
489              "The states notInService(2), notReady(3) and
490              createAndWait(5) need not be supported."
491
492        OBJECT           cPsdClientDSServerRowStatus
493        SYNTAX           INTEGER {
494                            active(1),
495                            createAndGo(4),
496                            destroy(6)
497                         }
498        DESCRIPTION
499              "The states notInService(2), notReady(3) and
500              createAndWait(5) need not be supported."
501        ::= { cPsdClientMIBCompliances 1 }
502
503-- units of conformance
504
505cPsdClientMIBStatisticsGroup OBJECT-GROUP
506        OBJECTS          {
507                           cPsdClientDSWriteReq,
508                           cPsdClientDSReadReq,
509                           cPsdClientDSRdWrRetrans,
510                           cPsdClientDSDiskFullTrans
511                         }
512        STATUS           current
513        DESCRIPTION
514              "A collection of objects providing Data Store
515               related statistics."
516        ::= { cPsdClientMIBGroups 1 }
517
518cPsdClientMIBConfigurationsGroup OBJECT-GROUP
519        OBJECTS           {
520                            cPsdClientDSRowStatus,
521                            cPsdClientDSAutoRetrieve,
522                            cPsdClientDSMaxRetrieve,
523                            cPsdClientDSServerRowStatus,
524                            cPsdClientDSRetrieveOnly
525                          }
526        STATUS            current
527        DESCRIPTION
528              "A collection of objects providing Data Store related
529               configurations."
530        ::= { cPsdClientMIBGroups 2 }
531
532cPsdClientMIBNotifGroup NOTIFICATION-GROUP
533        NOTIFICATIONS      {
534                             cPsdClientDownNotif,
535                             cPsdClientUpNotif,
536                             cPsdClientDiskFullNotif
537                           }
538        STATUS             current
539        DESCRIPTION
540              "A collection of Notifications."
541        ::= { cPsdClientMIBGroups 3 }
542
543cPsdClientMIBNotifInfoGroup OBJECT-GROUP
544        OBJECTS            {
545                             cPsdClientNotifDSServerAddrType,
546                             cPsdClientNotifDSServerAddress
547                           }
548        STATUS             current
549        DESCRIPTION
550              "A collection of notification info objects on PSD."
551        ::= { cPsdClientMIBGroups 4 }
552
553cPsdClientMIBNotifMgmtGroup OBJECT-GROUP
554       OBJECTS              {
555                              cPsdClientNotifEnable
556                            }
557       STATUS               current
558       DESCRIPTION
559             "A collection of objects related with notification
560             management on PSD."
561       ::= { cPsdClientMIBGroups 5 }
562
563END
564