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