1 karl  1.1 // ===================================================================
  2           // Title:  Network SNMP Management
  3           // $State: Preliminary $
  4           // $Date: 2004/07/14 01:07:27 $
  5           // $Source: /home/dmtf2/dotorg/var/cvs/repositories/dev/Schema/MOF/Network_SNMP.mof,v $
  6           // $Revision: 1.4 $
  7           // ===================================================================
  8           //#pragma inLine ("Includes/copyright.inc")
  9           // Copyright 1998-2004 Distributed Management Task Force, Inc. (DMTF).
 10           // All rights reserved.
 11           // DMTF is a not-for-profit association of industry members dedicated
 12           // to promoting enterprise and systems management and interoperability.
 13           // DMTF specifications and documents may be reproduced for uses
 14           // consistent with this purpose by members and non-members,
 15           // provided that correct attribution is given.
 16           // As DMTF specifications may be revised from time to time,
 17           // the particular version and release date should always be noted.
 18           // 
 19           // Implementation of certain elements of this standard or proposed
 20           // standard may be subject to third party patent rights, including
 21           // provisional patent rights (herein "patent rights"). DMTF makes
 22 karl  1.1 // no representations to users of the standard as to the existence
 23           // of such rights, and is not responsible to recognize, disclose, or
 24           // identify any or all such third party patent right, owners or
 25           // claimants, nor for any incomplete or inaccurate identification or
 26           // disclosure of such rights, owners or claimants. DMTF shall have no
 27           // liability to any party, in any manner or circumstance, under any
 28           // legal theory whatsoever, for failure to recognize, disclose, or
 29           // identify any such third party patent rights, or for such party's
 30           // reliance on the standard or incorporation thereof in its product,
 31           // protocols or testing procedures. DMTF shall have no liability to
 32           // any party implementing such standard, whether such implementation
 33           // is foreseeable or not, nor to any patent owner or claimant, and shall
 34           // have no liability or responsibility for costs or losses incurred if
 35           // a standard is withdrawn or modified after publication, and shall be
 36           // indemnified and held harmless by any party implementing the
 37           // standard from any and all claims of infringement by a patent owner
 38           // for such implementations.
 39           // 
 40           // For information about patents held by third-parties which have
 41           // notified the DMTF that, in their opinion, such patent may relate to
 42           // or impact implementations of DMTF standards, visit
 43 karl  1.1 // http://www.dmtf.org/about/policies/disclosures.php.
 44           //#pragma inLine
 45           // ===================================================================
 46           // Description: The Network Model extends the management concepts to
 47           //              represent protocol interfaces and network/protocol
 48           //              services.  This file defines classes to manage
 49           //              SNMP (Simple Network Management Protocol) services.
 50           // 
 51           //              The object classes below are listed in an order that
 52           //              avoids forward references. Required objects, defined
 53           //              by other working groups, are omitted.
 54           // ==================================================================
 55           // Change Log for v2.7
 56           // CR791 - Add classes to support the configuration and management
 57           //         of SNMP services
 58           // CR982 - Removal of Experimental for preliminary to final
 59           // Change Log for v2.8 - None
 60           // Change Log for V2.9
 61           // CR1465 - Added missing value map to TypeOfAccess
 62           //          ValueMap { "0", "1", "2"},  
 63           //            
 64 karl  1.1 // ===================================================================
 65           
 66           #pragma Locale ("en_US")
 67           
 68           
 69           // ==================================================================
 70           // SNMPService
 71           // ==================================================================
 72              [Version ( "2.7.0" ), Description (
 73                  "SNMPService represents an SNMP agent running on a hosting "
 74                  "system. The UDP port to use to contact the agent is an "
 75                  "instance of UDPProtocolEndpoint. The endpoint is associated "
 76                  "with the SNMPService via a Dependency relationship. The "
 77                  "community string(s) to use when contacting the SNMP agent "
 78                  "reside in instances of SNMPCommunityString, that are "
 79                  "associated with the SNMPService via the ServiceAccessBySAP "
 80                  "relationship.")]
 81           class CIM_SNMPService : CIM_Service {
 82           };
 83           
 84           
 85 karl  1.1 // ==================================================================
 86           // SNMPCommunityString
 87           // ==================================================================
 88              [Version ( "2.7.0" ), Description (
 89                  "SNMPCommunityString is an access point for an SNMPService. "
 90                  "Each instance stores a community string that can be used for "
 91                  "making SNMP requests.")]
 92           class CIM_SNMPCommunityString : CIM_ServiceAccessPoint {
 93           
 94                 [Description (
 95                     "The SNMP community string/password used for read or "
 96                     "read/write access to the agent's data."), 
 97                  MappingStrings { "MIB.IETF|ENTITY-MIB.entLogicalCommunity" }]
 98              string CommunityString;
 99           
100                 [Description (
101                     "An enumerated integer describing whether read or read/ "
102                     "write access is granted, or whether this information is "
103                     "unknown."),
104                  ValueMap { "0", "1", "2"},  
105                  Values { "Unknown", "Read Only", "Read/Write" }]
106 karl  1.1    uint16 TypeOfAccess;
107           
108                 [Description (
109                     "This array contains one or more object identifiers "
110                     "indicating the MIB modules/object subtrees that are "
111                     "accessed using the CommunityString. Either text strings of "
112                     "numbers (such as 1.2.3.4.5), or words (such as 'system') "
113                     "are specified. When using text strings of numbers, an "
114                     "asterisk (*) can replace any subidentifier to specify a "
115                     "subtree family - for example, 1.2.*.5. Descriptions related "
116                     "to each entry in the array are found at the corresponding "
117                     "index of the LogicalEntitiesDescriptions property."), 
118                  MappingStrings { "MIB.IETF|ENTITY-MIB.entLogicalType" },
119                  ArrayType ( "Indexed" ), 
120                  ModelCorrespondence { 
121                     "CIM_SNMPCommunityString.LogicalEntitiesDescriptions" }]
122              string LogicalEntitiesAccessed[];
123           
124                 [Description (
125                     "Free-form textual descriptions of the logical entities "
126                     "indicated in the LogicalEntitiesAccessed array. There is a "
127 karl  1.1           "correspondence between the entity identifier in the "
128                     "LogicalEntitiesAccessed array, and the description in this "
129                     "array at the corresponding index."), 
130                  MappingStrings { "MIB.IETF|ENTITY-MIB.entLogicalDescr" },
131                  ArrayType ( "Indexed" ), 
132                  ModelCorrespondence { 
133                     "CIM_SNMPCommunityString.LogicalEntitiesAccessed" }]
134              string LogicalEntitiesDescriptions[];
135           };
136           
137           
138           // ==================================================================
139           // SNMPTrapTarget
140           // ==================================================================
141              [Version ( "2.7.0" ), Description (
142                  "SNMPTrapTarget contains information describing a remote "
143                  "system, to which Informs and Traps are sent. An SNMPService is "
144                  "related via a ServiceSAPDependency association to one or more "
145                  "instances of this class.")]
146           class CIM_SNMPTrapTarget : CIM_RemotePort {
147           
148 karl  1.1       [Override ( "AccessInfo" ), Description (
149                     "The host address.")]
150              string AccessInfo;
151           
152                 [Override ( "PortProtocol" ), Description (
153                     "A UDP port to which the traps/informs are sent.")]
154              uint16 PortProtocol = 3;
155           
156                 [Override ( "PortInfo" ), Description (
157                     "The UDP port number to which the traps/informs are sent. "
158                     "The default is port 162.")]
159              string PortInfo = "162";
160           
161                 [Description (
162                     "Allows the selection of the notification message - Traps or "
163                     "Informs. By default, Traps are selected."), 
164                  ValueMap { "1", "2" }, 
165                  Values { "Traps", "Informs" }]
166              uint16 NotificationMessage = 1;
167           
168                 [Description (
169 karl  1.1           "The SNMP version used to send the traps or informs. Note "
170                     "that v1 does not support informs."), 
171                  ValueMap { "1", "2", "3" }, 
172                  Values { "v1", "v2C", "v3" }]
173              uint16 SNMPVersion;
174           
175                 [Description (
176                     "A community string/password to send with the trap "
177                     "operation.")]
178              string CommunityString;
179           };
180           
181           
182           // ==================================================================
183           // TrapSourceForSNMPService
184           // ==================================================================
185              [Association, Version ( "2.7.0" ), Description (
186                  "TrapSourceForSNMPService specifies the protocol "
187                  "endpoint/interface (and hence its IP address) from which traps "
188                  "originate.")]
189           class CIM_TrapSourceForSNMPService : CIM_ServiceSAPDependency {
190 karl  1.1 
191                 [Override ( "Antecedent" ), Max ( 1 ), Description (
192                     "The endpoint that acts as the trap source.")]
193              CIM_ProtocolEndpoint REF Antecedent;
194           
195                 [Override ( "Dependent" ), Description (
196                     "The SNMP service that sends the notifications.")]
197              CIM_SNMPService REF Dependent;
198           };
199           
200           
201           // ===================================================================
202           // end of file
203           // ===================================================================