1 a.dunfey 1.1 // ===================================================================
  2              // Title: Network_SNMP
  3              // $State: Exp $
  4              // $Date: 2004/12/16 05:14:25 $
  5              // $RCSfile: Network_SNMP.mof,v $
  6              // $Revision: 1.4.2.4 $
  7              // ===================================================================
  8              //#pragma inLine ("Includes/copyright.inc")
  9              // Copyright 1998-2005 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 a.dunfey 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 a.dunfey 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.0
 61              // CR1465 - Added missing value map to TypeOfAccess
 62              //          ValueMap { "0", "1", "2"},  
 63              // ===================================================================
 64 a.dunfey 1.1 
 65              #pragma Locale ("en_US")
 66              
 67              
 68              // ==================================================================
 69              // SNMPService
 70              // ==================================================================
 71                 [Version ( "2.7.0" ), Description (
 72                     "SNMPService represents an SNMP agent running on a hosting "
 73                     "system. The UDP port to use to contact the agent is an "
 74                     "instance of UDPProtocolEndpoint. The endpoint is associated "
 75                     "with the SNMPService via a Dependency relationship. The "
 76                     "community string(s) to use when contacting the SNMP agent "
 77                     "reside in instances of SNMPCommunityString, that are "
 78                     "associated with the SNMPService via the ServiceAccessBySAP "
 79                     "relationship.")]
 80              class CIM_SNMPService : CIM_Service {
 81              };
 82              
 83              
 84              // ==================================================================
 85 a.dunfey 1.1 // SNMPCommunityString
 86              // ==================================================================
 87                 [Version ( "2.7.0" ), Description (
 88                     "SNMPCommunityString is an access point for an SNMPService. "
 89                     "Each instance stores a community string that can be used for "
 90                     "making SNMP requests.")]
 91              class CIM_SNMPCommunityString : CIM_ServiceAccessPoint {
 92              
 93                    [Description (
 94                        "The SNMP community string/password used for read or "
 95                        "read/write access to the agent's data."), 
 96                     MappingStrings { "MIB.IETF|ENTITY-MIB.entLogicalCommunity" }]
 97                 string CommunityString;
 98              
 99                    [Description (
100                        "An enumerated integer describing whether read or read/ "
101                        "write access is granted, or whether this information is "
102                        "unknown."), 
103                     ValueMap { "0", "1", "2"},  
104                     Values { "Unknown", "Read Only", "Read/Write" }]
105                 uint16 TypeOfAccess;
106 a.dunfey 1.1 
107                    [Description (
108                        "This array contains one or more object identifiers "
109                        "indicating the MIB modules/object subtrees that are "
110                        "accessed using the CommunityString. Either text strings of "
111                        "numbers (such as 1.2.3.4.5), or words (such as 'system') "
112                        "are specified. When using text strings of numbers, an "
113                        "asterisk (*) can replace any subidentifier to specify a "
114                        "subtree family - for example, 1.2.*.5. Descriptions related "
115                        "to each entry in the array are found at the corresponding "
116                        "index of the LogicalEntitiesDescriptions property."), 
117                     MappingStrings { "MIB.IETF|ENTITY-MIB.entLogicalType" },
118                     ArrayType ( "Indexed" ), 
119                     ModelCorrespondence { 
120                        "CIM_SNMPCommunityString.LogicalEntitiesDescriptions" }]
121                 string LogicalEntitiesAccessed[];
122              
123                    [Description (
124                        "Free-form textual descriptions of the logical entities "
125                        "indicated in the LogicalEntitiesAccessed array. There is a "
126                        "correspondence between the entity identifier in the "
127 a.dunfey 1.1           "LogicalEntitiesAccessed array, and the description in this "
128                        "array at the corresponding index."), 
129                     MappingStrings { "MIB.IETF|ENTITY-MIB.entLogicalDescr" },
130                     ArrayType ( "Indexed" ), 
131                     ModelCorrespondence { 
132                        "CIM_SNMPCommunityString.LogicalEntitiesAccessed" }]
133                 string LogicalEntitiesDescriptions[];
134              };
135              
136              
137              // ==================================================================
138              // SNMPTrapTarget
139              // ==================================================================
140                 [Version ( "2.7.0" ), Description (
141                     "SNMPTrapTarget contains information describing a remote "
142                     "system, to which Informs and Traps are sent. An SNMPService is "
143                     "related via a ServiceSAPDependency association to one or more "
144                     "instances of this class.")]
145              class CIM_SNMPTrapTarget : CIM_RemotePort {
146              
147                    [Override ( "AccessInfo" ), Description (
148 a.dunfey 1.1           "The host address.")]
149                 string AccessInfo;
150              
151                    [Override ( "PortProtocol" ), Description (
152                        "A UDP port to which the traps/informs are sent.")]
153                 uint16 PortProtocol = 3;
154              
155                    [Override ( "PortInfo" ), Description (
156                        "The UDP port number to which the traps/informs are sent. "
157                        "The default is port 162.")]
158                 string PortInfo = "162";
159              
160                    [Description (
161                        "Allows the selection of the notification message - Traps or "
162                        "Informs. By default, Traps are selected."), 
163                     ValueMap { "1", "2" }, 
164                     Values { "Traps", "Informs" }]
165                 uint16 NotificationMessage = 1;
166              
167                    [Description (
168                        "The SNMP version used to send the traps or informs. Note "
169 a.dunfey 1.1           "that v1 does not support informs."), 
170                     ValueMap { "1", "2", "3" }, 
171                     Values { "v1", "v2C", "v3" }]
172                 uint16 SNMPVersion;
173              
174                    [Description (
175                        "A community string/password to send with the trap "
176                        "operation.")]
177                 string CommunityString;
178              };
179              
180              
181              // ==================================================================
182              // TrapSourceForSNMPService
183              // ==================================================================
184                 [Association, Version ( "2.7.0" ), Description (
185                     "TrapSourceForSNMPService specifies the protocol "
186                     "endpoint/interface (and hence its IP address) from which traps "
187                     "originate.")]
188              class CIM_TrapSourceForSNMPService : CIM_ServiceSAPDependency {
189              
190 a.dunfey 1.1       [Override ( "Antecedent" ), Max ( 1 ), Description (
191                        "The endpoint that acts as the trap source.")]
192                 CIM_ProtocolEndpoint REF Antecedent;
193              
194                    [Override ( "Dependent" ), Description (
195                        "The SNMP service that sends the notifications.")]
196                 CIM_SNMPService REF Dependent;
197              };
198              
199              
200              // ===================================================================
201              // end of file
202              // ===================================================================