1 karl 1.1 // ===================================================================
2 // Title: Network Pipes 2.7
3 // Filename: Network27_Pipes.mof
4 // Version: 2.7.0
5 // Status: Preliminary
6 // Date: 08/05/2002
7 // ===================================================================
8 // Copyright 1998-2002 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 karl 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 karl 1.1 // ===================================================================
44 // Description: The Network Model extends the management concepts to
45 // represent protocol interfaces and network/protocol
46 // services. This file models network pipes, based on
47 // the ITU M.3100 definitions.
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.7
54 // CR696 - Add M.3100 concepts of Pipe; Define the associations,
55 // HostedPipe, EndpointOfPipe, and PipeComposition
56 // CR850 - Change CIM_Pipe to CIM_NetworkPipe; Propagate this change
57 // through the model; Make similar name changes throughout
58 // the other classes
59 // ===================================================================
60
61 #pragma Locale ("en_US")
62
63
64 karl 1.1 // ================================================================
65 // NetworkPipe
66 // ================================================================
67 [Experimental, Version ("2.7.0"), Description (
68 "NetworkPipe is a subclass of EnabledLogicalElement, "
69 "representing the status and management of a connection or "
70 "trail between endpoints. This object is different than the "
71 "association between the endpoints (CIM_ActiveConnection) "
72 "since the emphasis is NOT on the endpoints but on the "
73 "management of the pipe itself - its status, configuration, "
74 "etc. NetworkPipes are defined in the context of a "
75 "CIM_Network and represent the 'transfer of information . . . "
76 "between . . . endpoints'. These concepts are aligned with "
77 "the definition of the Pipe object in ITU's M.3100 "
78 "specification."),
79 MappingStrings {"Recommendation.ITU|M3100.Pipe",
80 "Recommendation.ITU|M3100.TrailR1",
81 "Recommendation.ITU|M3100.ConnectionR1",
82 "Recommendation.ITU|M3100.SubNetworkConnection"} ]
83 class CIM_NetworkPipe : CIM_EnabledLogicalElement {
84
85 karl 1.1 [Key, Description (
86 "InstanceID opaquely identifies a unique instance of "
87 "NetworkPipe. The InstanceID must be unique within a "
88 "namespace. In order to ensure uniqueness, the value of "
89 "InstanceID SHOULD be constructed in the following "
90 "manner: \n"
91 "<Vendor ID><ID> \n"
92 " <Vendor ID> MUST include a copyrighted, trademarked "
93 "or otherwise unique name that is owned by the business "
94 "entity or a registered ID that is assigned to the "
95 "business entity that is defining the InstanceID. "
96 "(This is similar to the <Schema Name>_<Class Name> "
97 "structure of Schema class names.) The purpose of "
98 "<Vendor ID> is to ensure that <ID> is truly unique "
99 "across multiple vendor implementations. If such a name "
100 "is not used, the defining entity MUST assure that the <ID> "
101 "portion of the Instance ID is unique when compared with "
102 "other instance providers. For DMTF defined instances, the "
103 "<Vendor ID> is 'CIM'. \n"
104 " <ID> MUST include either a vendor specified unique "
105 "identifier, or if mapping from an ITU M.3100 environment, "
106 karl 1.1 "the trailID, connectionID or subNetworkConnectionID of "
107 "the instances of PipeR2."),
108 MappingStrings {"Recommendation.ITU|M3100.TrailR1.trailId",
109 "Recommendation.ITU|M3100.ConnectionR1.connectionID",
110 "Recommendation.ITU|M3100.SubNetworkConnection."
111 "subNetworkConnectionID"} ]
112 string InstanceID;
113
114 [Description (
115 "Indicates whether the pipe is bi-directional (value = "
116 "2), unidirectional (value = 3), or this information is "
117 "not known (value = 0). For unidirectional pipes, the "
118 "source and sink are indicated by a property (SourceOrSink) "
119 "of the association, EndpointOfNetworkPipe."),
120 ValueMap {"0", "2", "3"},
121 Values {"Unknown", "Bi-Directional", "Unidirectional"},
122 MappingStrings {
123 "Recommendation.ITU|M3100.Pipe.directionality"} ]
124 uint16 Directionality;
125
126 [Description (
127 karl 1.1 " Indicates whether the pipe is composed of lower-level "
128 "pipes, and if so, how these lower-level pipes are aggregated "
129 "(in parallel or in sequence). The specific instances of "
130 "NetworkPipe that are combined are described using the "
131 "NetworkPipeComposition association. \n"
132 "\n"
133 " In the context of M.3100, the ability to be composed of "
134 "lower-level pipes is modeled as a Trail. A Trail is made up "
135 "of one or more Connections. (Note that both Trails and "
136 "Connections are subclasses of Pipe). Because of the "
137 "flexibility of the NetworkPipeComposition association, there "
138 "is no need to subclass NetworkPipe, as was done in M.3100, "
139 "but merely to instantiate the NetworkPipeComposition "
140 "association to describe the bundling of the lower-level "
141 "pipes (i.e., the connections), or the sequencing of them."),
142 ValueMap {"0", "2", "3", "4"},
143 Values {"Unknown", "No Lower-Level Composition",
144 "Combined In Parallel", "Combined In Sequence"} ]
145 uint16 AggregationBehavior;
146
147 [Override ("EnabledStatus"), Description (
148 karl 1.1 "EnabledStatus is an integer enumeration indicating "
149 "whether the element is currently shutting down (value = 4), "
150 "or in an enabled (value = 2) or disabled (value = 3) "
151 "state. In various situations, an element that is being "
152 "tested is neither enabled or disabled - this is addressed "
153 "by the value \"In Test\" (7). If this property does not "
154 "apply to an instance of EnabledLogicalElement, the value 5 "
155 "(\"Not Applicable\"), is used."),
156 ValueMap {"0", "1", "2", "3", "4", "5", "6", "7"},
157 Values {"Unknown", "Other", "Enabled", "Disabled",
158 "Shutting Down", "Not Applicable", "Enabled but Offline",
159 "In Test"},
160 ModelCorrespondence {
161 "CIM_EnabledLogicalElement.OtherEnabledStatus"},
162 MappingStrings {
163 "Recommendation.ITU|M3100.Pipe.operationalState"} ]
164 uint16 EnabledStatus;
165
166 [Override ("RequestedStatus"), Write, Description (
167 "RequestedStatus is an integer enumeration indicating "
168 "whether the element should be shut down (value = 4), "
169 karl 1.1 "enabled (2), disabled (3), taken offline (6) or "
170 "tested (7) at the next opportunity. This "
171 "property is provided to compare Requested and "
172 "current Enabled statuses. Note that when "
173 "EnabledStatus is set to 5 (\"Not Applicable\"), "
174 "then writing this property has no effect. By default, "
175 "the element's RequestedStatus is 5 (\"No Change\")."),
176 ValueMap {"2", "3", "4", "5", "6", "7"},
177 Values {"Enabled", "Disabled", "Shut Down", "No Change",
178 "Offline", "Test"},
179 MappingStrings {
180 "Recommendation.ITU|M3100.Pipe.administrativeState"} ]
181 uint16 RequestedStatus = 5;
182 };
183
184
185 // ==================================================================
186 // HostedNetworkPipe
187 // ==================================================================
188 [Association, Experimental, Version ("2.7.0"), Description (
189 "HostedNetworkPipe is an association between a pipe and the "
190 karl 1.1 "network in whose context the pipe is defined. The "
191 "cardinality of this association is 1-to-many. A network may "
192 "host many pipes, and pipes are scoped/contained by only "
193 "one network.") ]
194 class CIM_HostedNetworkPipe : CIM_Dependency {
195
196 [Override ("Antecedent"), Min (1), Max (1),
197 Description ("The hosting network.") ]
198 CIM_Network REF Antecedent;
199
200 [Override ("Dependent"),
201 Description ("The pipe in the network.") ]
202 CIM_NetworkPipe REF Dependent;
203 };
204
205
206 // ==================================================================
207 // EndpointOfNetworkPipe
208 // ==================================================================
209 [Association, Experimental, Version ("2.7.0"), Description (
210 "EndpointOfNetworkPipe describes the endpoints between which "
211 karl 1.1 "a pipe transfers information. Whether an endpoint is a source "
212 "or sink is indicated by a property of the association, "
213 "SourceOrSink."),
214 MappingStrings {"Recommendation.ITU|M3100.Pipe.a-TPInstance",
215 "Recommendation.ITU|M3100.Pipe.z-TPInstance"} ]
216 class CIM_EndpointOfNetworkPipe : CIM_Dependency {
217
218 [Override ("Antecedent"), Min (2), Max (2),
219 Description ("One of the endpoints of the pipe.") ]
220 CIM_ProtocolEndpoint REF Antecedent;
221
222 [Override ("Dependent"), Description (
223 "The pipe which is dependent on the endpoints as the "
224 "source or sink of the transferred information.") ]
225 CIM_NetworkPipe REF Dependent;
226
227 [Description (
228 "Indicates whether the endpoint is a source (value = "
229 "2), or sink (value = 3) for the pipe. If this information "
230 "is not applicable, the property is set to 4. If the "
231 "information is not known, the property is set to 0."),
232 karl 1.1 ValueMap {"0", "2", "3", "4"},
233 Values {"Unknown", "Source", "Sink", "Not Applicable"} ]
234 uint16 SourceOrSink;
235 };
236
237
238 // ==================================================================
239 // NetworkPipeComposition
240 // ==================================================================
241 [Association, Aggregation, Composition, Experimental,
242 Version ("2.7.0"), Description (
243 "NetworkPipeComposition describes the makeup a pipe, based on "
244 "lower-level ones. If the pipe is not composed of lower-level "
245 "entities (i.e., its AggregationBehavior property is set to 2), "
246 "then no instances of this association should be defined where "
247 "the pipe has the role of GroupComponent. \n"
248 "\n"
249 "In the context of M.3100, this semantic is modeled as a "
250 "Trail that is made up of one or more Connections. Both Trails "
251 "and Connections are subclasses of M.3100's Pipe. Because of the "
252 "flexibility of the NetworkPipeComposition association, there is "
253 karl 1.1 "no need to subclass NetworkPipe, as was done in M.3100, but merely "
254 "to instantiate this association to describe the bundling of the "
255 "lower-level pipes (connections), or the sequencing of them. "
256 "How the lower-level pipes are aggregated is described by the "
257 "property, AggregationBehavior, of NetworkPipe. If the pipes "
258 "are combined in a sequence, the ordering is conveyed via "
259 "the property, AggregationSequence, on this association."),
260 MappingStrings {
261 "Recommendation.ITU|M3100.TrailR1.serverConnectionListPackage",
262 "Recommendation.ITU|M3100.TrailR1.clientConnectionListPackage"} ]
263 class CIM_NetworkPipeComposition : CIM_Component {
264
265 [Override ("GroupComponent"), Aggregate, Description (
266 "The higher level pipe that is composed of lower-level "
267 "parts/pipes.") ]
268 CIM_NetworkPipe REF GroupComponent;
269
270 [Override ("PartComponent"), Description (
271 "A pipe which is a part of a higher-level one.") ]
272 CIM_NetworkPipe REF PartComponent;
273
274 karl 1.1 [Description (
275 "Indicates the ordering of the PartComponent pipes in the "
276 "GroupComponent. If the AggregationBehavior property of the "
277 "GroupComponent pipe is set to 0 or 3 (\"Unknown\" or "
278 "\"Combined In Parallel\"), then this property MUST be set "
279 "to 0. If the AggregationBehavior is set to 4 (\"Combined "
280 "In Sequence\"), then this property SHOULD indicate the "
281 "ordering of the component pipes. Ordering starts with 1 "
282 "and larger numbers indicate subsequent pipes. The "
283 "numbering does not have to be in sequence. The word SHOULD "
284 "is used in this Description, since the specific ordering "
285 "of all the component pipes may not be known. In these cases, "
286 "a value of 0 would be placed in AggregationSequence to "
287 "indicate that ordering information is not available.") ]
288 uint16 AggregationSequence;
289 };
290
291
292 // ===================================================================
293 // end of file
294 // ===================================================================
|
Return to
Network27_Pipes.mof
CVS log
Up to [Pegasus] / pegasus / Schemas / CIMPrelim271