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