1 a.dunfey 1.1 // ===================================================================
2 // Title: Network_Pipes
3 // $State: Exp $
4 // $Date: 2004/11/29 18:31:42 $
5 // $RCSfile: Network_Pipes.mof,v $
6 // $Revision: 1.5.2.3 $
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 models network pipes, based on
49 // the ITU M.3100 definitions.
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 // CR696 - Add M.3100 concepts of Pipe; Define the associations,
57 // HostedPipe, EndpointOfPipe, and PipeComposition
58 // CR850 - Change CIM_Pipe to CIM_NetworkPipe; Propagate this change
59 // through the model; Make similar name changes throughout
60 // the other classes
61 // CR961 - Changes to Enabled and RequestedState in NetworkPipe,
62 // inherited from EnabledLogicalElement
63 // CR982 - Removal of Experimental for preliminary to final
64 a.dunfey 1.1 // CR994 - Update of the InstanceID property Description
65 // Change Log for v2.8
66 // CR1128 - Change subclassing from CIM_Dependency to
67 // CIM_HostedDependency for identified classes. This is
68 // needed as a result of the introduction of HostedDependency
69 // by SysDev
70 // ===================================================================
71
72 #pragma Locale ("en_US")
73
74
75 // ================================================================
76 // NetworkPipe
77 // ================================================================
78 [Version ( "2.7.0" ), Description (
79 "NetworkPipe is a subclass of EnabledLogicalElement, "
80 "representing the state and management of a connection or trail "
81 "between endpoints. This object is different than the "
82 "association between the endpoints (CIM_ActiveConnection) since "
83 "the emphasis is NOT on the endpoints but on the management of "
84 "the pipe itself - its state, configuration, etc. NetworkPipes "
85 a.dunfey 1.1 "are defined in the context of a CIM_Network and represent the "
86 "'transfer of information . . . between . . . endpoints'. These "
87 "concepts are aligned with the definition of the Pipe object in "
88 "ITU's M.3100 specification."),
89 MappingStrings { "Recommendation.ITU|M3100.Pipe",
90 "Recommendation.ITU|M3100.TrailR1",
91 "Recommendation.ITU|M3100.ConnectionR1",
92 "Recommendation.ITU|M3100.SubNetworkConnection" }]
93 class CIM_NetworkPipe : CIM_EnabledLogicalElement {
94
95 [Key, Description (
96 "Within the scope of the instantiating Namespace, InstanceID "
97 "opaquely and uniquely identifies an instance of this class. "
98 "In order to ensure uniqueness within the NameSpace, the "
99 "value of InstanceID SHOULD be constructed using the "
100 "following 'preferred' algorithm: \n"
101 "<OrgID>:<LocalID> \n"
102 "Where <OrgID> and <LocalID> are separated by a colon ':', "
103 "and where <OrgID> MUST include a copyrighted, trademarked "
104 "or otherwise unique name that is owned by the business "
105 "entity creating/defining the InstanceID, or is a registered "
106 a.dunfey 1.1 "ID that is assigned to the business entity by a recognized "
107 "global authority. (This is similar to the <Schema "
108 "Name>_<Class Name> structure of Schema class names.) In "
109 "addition, to ensure uniqueness <OrgID> MUST NOT contain a "
110 "colon (':'). When using this algorithm, the first colon to "
111 "appear in InstanceID MUST appear between <OrgID> and "
112 "<LocalID>. (For DMTF defined instances, the 'preferred' "
113 "algorithm MUST be used with the <OrgID> set to 'CIM'.) \n"
114 "<LocalID> MUST include either a vendor specified unique "
115 "identifier, or if mapping from an ITU M.3100 environment, "
116 "the trailID, connectionID or subNetworkConnectionID of the "
117 "instances of PipeR2."),
118 MappingStrings { "Recommendation.ITU|M3100.TrailR1.trailId",
119 "Recommendation.ITU|M3100.ConnectionR1.connectionID",
120 "Recommendation.ITU|M3100.SubNetworkConnection."
121 "subNetworkConnectionID" }]
122 string InstanceID;
123
124 [Description (
125 "Indicates whether the pipe is bi-directional (value = 2), "
126 "unidirectional (value = 3), or this information is not "
127 a.dunfey 1.1 "known (value = 0). For unidirectional pipes, the source and "
128 "sink are indicated by a property (SourceOrSink) of the "
129 "association, EndpointOfNetworkPipe."),
130 ValueMap { "0", "2", "3" },
131 Values { "Unknown", "Bi-Directional", "Unidirectional" },
132 MappingStrings { "Recommendation.ITU|M3100.Pipe.directionality"
133 }]
134 uint16 Directionality;
135
136 [Description (
137 "Indicates whether the pipe is composed of lower-level "
138 "pipes, and if so, how these lower-level pipes are "
139 "aggregated (in parallel or in sequence). The specific "
140 "instances of NetworkPipe that are combined are described "
141 "using the NetworkPipeComposition association. \n"
142 "\n"
143 "In the context of M.3100, the ability to be composed of "
144 "lower-level pipes is modeled as a Trail. A Trail is made up "
145 "of one or more Connections. (Note that both Trails and "
146 "Connections are subclasses of Pipe). Because of the "
147 "flexibility of the NetworkPipeComposition association, "
148 a.dunfey 1.1 "there is no need to subclass NetworkPipe, as was done in "
149 "M.3100, but merely to instantiate the "
150 "NetworkPipeComposition association to describe the bundling "
151 "of the lower-level pipes (i.e., the connections), or the "
152 "sequencing of them."),
153 ValueMap { "0", "2", "3", "4" },
154 Values { "Unknown", "No Lower-Level Composition",
155 "Combined In Parallel", "Combined In Sequence" }]
156 uint16 AggregationBehavior;
157
158 [Override ( "EnabledState" ),
159 MappingStrings {
160 "Recommendation.ITU|M3100.Pipe.operationalState" }]
161 uint16 EnabledState;
162
163 [Override ( "RequestedState" ), Write,
164 MappingStrings {
165 "Recommendation.ITU|M3100.Pipe.administrativeState" }]
166 uint16 RequestedState = 5;
167 };
168
169 a.dunfey 1.1
170 // ==================================================================
171 // HostedNetworkPipe
172 // ==================================================================
173 [Association, Version ( "2.7.0" ), Description (
174 "HostedNetworkPipe is an association between a pipe and the "
175 "network in whose context the pipe is defined. The cardinality "
176 "of this association is 1-to-many. A network may host many "
177 "pipes, and pipes are scoped/contained by only one network.")]
178 class CIM_HostedNetworkPipe : CIM_HostedDependency {
179
180 [Override ( "Antecedent" ), Min ( 1 ), Max ( 1 ), Description (
181 "The hosting network.")]
182 CIM_Network REF Antecedent;
183
184 [Override ( "Dependent" ), Description (
185 "The pipe in the network.")]
186 CIM_NetworkPipe REF Dependent;
187 };
188
189
190 a.dunfey 1.1 // ==================================================================
191 // EndpointOfNetworkPipe
192 // ==================================================================
193 [Association, Version ( "2.7.0" ), Description (
194 "EndpointOfNetworkPipe describes the endpoints between which a "
195 "pipe transfers information. Whether an endpoint is a source or "
196 "sink is indicated by a property of the association, "
197 "SourceOrSink."),
198 MappingStrings { "Recommendation.ITU|M3100.Pipe.a-TPInstance",
199 "Recommendation.ITU|M3100.Pipe.z-TPInstance" }]
200 class CIM_EndpointOfNetworkPipe : CIM_Dependency {
201
202 [Override ( "Antecedent" ), Min ( 2 ), Max ( 2 ), Description (
203 "One of the endpoints of the pipe.")]
204 CIM_ProtocolEndpoint REF Antecedent;
205
206 [Override ( "Dependent" ), Description (
207 "The pipe which is dependent on the endpoints as the source "
208 "or sink of the transferred information.")]
209 CIM_NetworkPipe REF Dependent;
210
211 a.dunfey 1.1 [Description (
212 "Indicates whether the endpoint is a source (value = 2), or "
213 "sink (value = 3) for the pipe. If this information is not "
214 "applicable, the property is set to 4. If the information is "
215 "not known, the property is set to 0."),
216 ValueMap { "0", "2", "3", "4" },
217 Values { "Unknown", "Source", "Sink", "Not Applicable" }]
218 uint16 SourceOrSink;
219 };
220
221
222 // ==================================================================
223 // NetworkPipeComposition
224 // ==================================================================
225 [Association, Aggregation, Composition, Version ( "2.7.0" ),
226 Description (
227 "NetworkPipeComposition describes the makeup a pipe, based on "
228 "lower-level ones. If the pipe is not composed of lower-level "
229 "entities (i.e., its AggregationBehavior property is set to 2), "
230 "then no instances of this association should be defined where "
231 "the pipe has the role of GroupComponent. \n"
232 a.dunfey 1.1 "\n"
233 "In the context of M.3100, this semantic is modeled as a Trail "
234 "that is made up of one or more Connections. Both Trails and "
235 "Connections are subclasses of M.3100's Pipe. Because of the "
236 "flexibility of the NetworkPipeComposition association, there "
237 "is no need to subclass NetworkPipe, as was done in M.3100, but "
238 "merely to instantiate this association to describe the "
239 "bundling of the lower-level pipes (connections), or the "
240 "sequencing of them. How the lower-level pipes are aggregated "
241 "is described by the property, AggregationBehavior, of "
242 "NetworkPipe. If the pipes are combined in a sequence, the "
243 "ordering is conveyed via the property, AggregationSequence, on "
244 "this association."),
245 MappingStrings {
246 "Recommendation.ITU|M3100.TrailR1.serverConnectionListPackage",
247 "Recommendation.ITU|M3100.TrailR1.clientConnectionListPackage" }]
248 class CIM_NetworkPipeComposition : CIM_Component {
249
250 [Aggregate, Override ( "GroupComponent" ), Description (
251 "The higher level pipe that is composed of lower-level "
252 "parts/pipes.")]
253 a.dunfey 1.1 CIM_NetworkPipe REF GroupComponent;
254
255 [Override ( "PartComponent" ), Description (
256 "A pipe which is a part of a higher-level one.")]
257 CIM_NetworkPipe REF PartComponent;
258
259 [Description (
260 "Indicates the ordering of the PartComponent pipes in the "
261 "GroupComponent. If the AggregationBehavior property of the "
262 "GroupComponent pipe is set to 0 or 3 (\"Unknown\" or "
263 "\"Combined In Parallel\"), then this property MUST be set "
264 "to 0. If the AggregationBehavior is set to 4 (\"Combined In "
265 "Sequence\"), then this property SHOULD indicate the "
266 "ordering of the component pipes. Ordering starts with 1 and "
267 "larger numbers indicate subsequent pipes. The numbering "
268 "does not have to be in sequence. The word SHOULD is used in "
269 "this Description, since the specific ordering of all the "
270 "component pipes may not be known. In these cases, a value "
271 "of 0 would be placed in AggregationSequence to indicate "
272 "that ordering information is not available.")]
273 uint16 AggregationSequence;
274 a.dunfey 1.1 };
275
276
277 // ===================================================================
278 // end of file
279 // ===================================================================
|
Return to
Network_Pipes.mof
CVS log
Up to [Pegasus] / pegasus / Schemas / CIM29