1 tony  1.1 // ===================================================================
  2           // Title:       Network Topology 2.8
  3           // Filename:    Network28_Topology.mof
  4           // Version:     2.8
  5           // Status:      Preliminary
  6           // Date:        June 6, 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 VLAN (virtual LAN)
 47           //              concepts.
 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
 54           // CR1018 - Classes to define topologies
 55           // ===================================================================
 56           
 57           #pragma Locale ("en_US")
 58           
 59           
 60           // ==================================================================
 61           // DeviceConnectivityCollection
 62           // ==================================================================
 63              [Experimental, Version ("2.7.1000"), Description (
 64 tony  1.1        "DeviceConnectivityCollection describes connectivity WITHIN a "
 65                  "single system.  The system forwards packets among the members "
 66                  "of the collection.  For example, this class is used to "
 67                  "represent connectivity within a router or switch.  There may "
 68                  "be multiple DeviceConnectivityCollection instances for a "
 69                  "system, when multiple forwarding domains exist.  For example, "
 70                  "an Ethernet switch may separate its LANEndpoints into two "
 71                  "groups, each associated with a different virtual LAN.  The "
 72                  "LANEndpoints for each group would be segregated into separate "
 73                  "DeviceConnectivity Collections.") ]
 74           class CIM_DeviceConnectivityCollection : CIM_ConnectivityCollection {
 75           };
 76           
 77           
 78           // ==================================================================
 79           // TopologyGraph
 80           // ==================================================================
 81              [Experimental, Version ("2.7.1000"), Description (
 82                  "TopologyGraph is a general structure for representing network "
 83                  "topologies.  Often, a topology graph consists of a set of "
 84                  "nodes and a set of edges which connect the nodes.  The "
 85 tony  1.1        "TopologyGraph structure is slightly different, in order to "
 86                  "support multipoint links and to express the connectivity "
 87                  "within what would normally be considered a 'node'.  Multipoint "
 88                  "links occur in entities such as IP subnets, where all of the "
 89                  "IP endpoints on the subnet can communicate directly, and "
 90                  "Ethernet links where all of the Ethernet interfaces on the "
 91                  "shared media can communicate directly.  An example of "
 92                  "connectivity within a node is when the various "
 93                  "endpoints/interfaces on a router are connected through the "
 94                  "router's forwarding mechanism.  There may be different groups "
 95                  "of endpoints which communicate within their groups "
 96                  "exclusively.  This is modeled as a "
 97                  "DeviceConnectivityCollection.\n"
 98                  "\n"
 99                  "To represent these examples in a graph structure, "
100                  "TopologyGraph generalizes the node and edge structures of a "
101                  "typical graph.  It is a collection of ConnectivityCollections, "
102                  "which can communicate with one another, and are at the same "
103                  "protocol layer.  ConnectivityCollections are aggregated into "
104                  "Topology Graphs using the MemberOfCollection relationship.\n"
105                  "\n"
106 tony  1.1        "The actual network topology encoded in TopologyGraph is "
107                  "extracted by connecting the ConnectivityCollection instances "
108                  "that share common ProtocolEndpoint instances.  For example, if "
109                  "the graph contains three collections, defined as:\n"
110                  "- Router1={PE1, PE2}, a DeviceConnectivityCollection\n"
111                  "- Link1={PE2, PE3}, an IPConnectivitySubnet\n"
112                  "- Router2={PE3, PE4}, a DeviceConnectivityCollection\n"
113                  "then we can determine that the PE2 interface on Router1 is "
114                  "connected to the PE3 interface on Router2 via the subnet "
115                  "Link1.  By finding all of the endpoints that are in multiple "
116                  "ConnectivityCollections within the graph, and connecting those "
117                  "Collections with common endpoints, we can construct the "
118                  "network topology.") ]
119           class CIM_TopologyGraph : CIM_Collection {
120           
121                 [Key, Description (
122                     "Within the scope of the instantiating Namespace, InstanceID "
123                     "opaquely and uniquely identifies an instance of this "
124                     "class.  In order to ensure uniqueness within the NameSpace, "
125                     "the value of InstanceID SHOULD be constructed using the "
126                     "following 'preferred' algorithm:\n"
127 tony  1.1           "<OrgID>:<LocalID>\n"
128                     "Where <OrgID> and <LocalID> are separated by a colon ':', "
129                     "and where <OrgID> MUST include a copyrighted, trademarked "
130                     "or otherwise unique name that is owned by the business "
131                     "entity creating/defining the InstanceID, or is a registered "
132                     "ID that is assigned to the business entity by a recognized "
133                     "global authority (This is similar to the <Schema "
134                     "Name>_<Class Name> structure of Schema class names.) In "
135                     "addition, to ensure uniqueness <OrgID> MUST NOT contain a "
136                     "colon (':').  When using this algorithm, the first colon to "
137                     "appear in InstanceID MUST appear between <OrgID> and "
138                     "<LocalID>.\n"
139                     "<LocalID> is chosen by the business entity and SHOULD not "
140                     "be re-used to identify different underlying (real-world) "
141                     "elements.  If the above 'preferred' algorithm is not used, "
142                     "the defining entity MUST assure that the resultant "
143                     "InstanceID is not re-used across any InstanceIDs produced "
144                     "by this or other providers for this instance's NameSpace.\n"
145                     "For DMTF defined instances, the 'preferred' algorithm MUST "
146                     "be used with the <OrgID> set to 'CIM'.") ]
147              string InstanceID;
148 tony  1.1 };
149           
150           // ==================================================================
151           // RelatedTopologyGraph
152           // ==================================================================
153              [Association, Experimental, Version ("2.7.1000"), Description (
154                  "RelatedTopologyGraph associates a TopologyGraph instance with "
155                  "a ConnectivityCollection.  This relationship is different from "
156                  "a topology graph collecting ConnectivityCollections.  It "
157                  "describes the embedding of a lower layer topology within a "
158                  "ConnectivityCollection.  For example, a layer 3 IP subnet "
159                  "(represented by an instance of IPConnectivitySubnet) collects "
160                  "a set of IPProtocolEndpoints.  It might also be associated "
161                  "with a TopologyGraph describing the layer 2 switched Ethernet "
162                  "topology over which the IP subnet runs.  This association of "
163                  "Layer 3 to Layer 2 is described as a Dependency relationship, "
164                  "where the Layer 3 connectivity is dependent on the Layer 2 "
165                  "topology.") ]
166           class CIM_RelatedTopologyGraph : CIM_Dependency {
167           
168                 [Override ("Antecedent"), Description (
169 tony  1.1           "A topology graph which underlies a ConnectivityCollection.") ]
170              CIM_TopologyGraph REF Antecedent;
171           
172                 [Override ("Dependent"), Description (
173                     "The ConnectivityCollection which depends on the underlying "
174                     "topology.") ]
175              CIM_ConnectivityCollection REF Dependent;
176           };
177           
178           
179           // ===================================================================
180           // end of file
181           // ===================================================================