<head><META http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="mof.css" xmlns:lxslt="http://xml.apache.org/xslt"> <title>DMTF Schema Documentation Schema Documentation</title> </head><html> <body bgcolor="White"> <hr> </hr> <a name="CIM_Network"></a> <H1>Class CIM_Network<BR>extends <a href="CIM_AdminDomain.html">CIM_AdminDomain</a> </H1>Network is a subclass of AdminDomain that groups interconnected networking and computing objects capable of exchanging information. Instances of CIM_Network can represent an enterprise's global network or specific connectivity domains within the global network. These concepts are similar to those defined for the Network object in ITU's M.3100 specification.<h3> Table of Contents<br> <a href="#c_hierarchy">Hierarchy</a> <br> <a href="#c_subclasses">Direct Known Subclasses</a> <br> <a href="#c_qualifiers">Class Qualifiers</a> <br> <a href="#c_properties">Class Properties</a> <br> <a href="#c_methods">Class Methods</a> <br> </h3> <hr> </hr> <H2> <a name="c_hierarchy">Class Hierarchy</a> </H2> <a href="CIM_ManagedElement.html">CIM_ManagedElement</a> <br data="@NAME"> |<br> +--<a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a> <br data="@NAME"> |<br> +--<a href="CIM_LogicalElement.html">CIM_LogicalElement</a> <br data="@NAME"> |<br> +--<a href="CIM_EnabledLogicalElement.html">CIM_EnabledLogicalElement</a> <br data="@NAME"> |<br> +--<a href="CIM_System.html">CIM_System</a> <br data="@NAME"> |<br> +--<a href="CIM_AdminDomain.html">CIM_AdminDomain</a> <br data="@NAME"> |<br> +--<b>CIM_Network</b> <br data="CIM_Network -- CIM_AdminDomain"> <H2> <a name="c_subclasses">Direct Known Subclasses</a> </H2> <H2> <a name="c_qualifiers">Class Qualifiers</a> </H2> <TABLE BORDER="1" CELLPADDING="1" WIDTH="100%"> <TR> <TH>Name</TH><TH>Data Type</TH><TH>Value</TH> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Network is a subclass of AdminDomain that groups interconnected networking and computing objects capable of exchanging information. Instances of CIM_Network can represent an enterprise's global network or specific connectivity domains within the global network. These concepts are similar to those defined for the Network object in ITU's M.3100 specification.</TD> </TR> <TR> <TD VALIGN="TOP">MappingStrings</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Recommendation.ITU|M3100.Network</TD> </TR> <TR> <TD VALIGN="TOP">UMLPackagePath</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM::Network::Systems</TD> </TR> <TR> <TD VALIGN="TOP">Version</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">2.15.0</TD> </TR> </TABLE> <H2> <a name="c_properties">Class Properties</a> </H2> <H3>Inherited Properties</H3> <TABLE BORDER="1" CELLPADDING="1" WIDTH="60%"> <TR> <TH>Name</TH><TH>Data Type</TH><TH>Class Origin</TH> </TR> <TR> <TH VALIGN="TOP">Caption</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_ManagedElement.html">CIM_ManagedElement</a></TD> </TR> <TR> <TH VALIGN="TOP">CommunicationStatus</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> <TR> <TH VALIGN="TOP">CreationClassName</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_System.html">CIM_System</a></TD> </TR> <TR> <TH VALIGN="TOP">Description</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_ManagedElement.html">CIM_ManagedElement</a></TD> </TR> <TR> <TH VALIGN="TOP">DetailedStatus</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> <TR> <TH VALIGN="TOP">ElementName</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_ManagedElement.html">CIM_ManagedElement</a></TD> </TR> <TR> <TH VALIGN="TOP">EnabledDefault</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_EnabledLogicalElement.html">CIM_EnabledLogicalElement</a></TD> </TR> <TR> <TH VALIGN="TOP">EnabledState</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_EnabledLogicalElement.html">CIM_EnabledLogicalElement</a></TD> </TR> <TR> <TH VALIGN="TOP">Generation</TH><TD VALIGN="TOP">uint64</TD><TD VALIGN="TOP"><a href="CIM_ManagedElement.html">CIM_ManagedElement</a></TD> </TR> <TR> <TH VALIGN="TOP">HealthState</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> <TR> <TH VALIGN="TOP">InstallDate</TH><TD VALIGN="TOP">datetime</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> <TR> <TH VALIGN="TOP">InstanceID</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_ManagedElement.html">CIM_ManagedElement</a></TD> </TR> <TR> <TH VALIGN="TOP">Name</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_System.html">CIM_System</a></TD> </TR> <TR> <TH VALIGN="TOP">NameFormat</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_AdminDomain.html">CIM_AdminDomain</a></TD> </TR> <TR> <TH VALIGN="TOP">OperatingStatus</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> <TR> <TH VALIGN="TOP">OtherEnabledState</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_EnabledLogicalElement.html">CIM_EnabledLogicalElement</a></TD> </TR> <TR> <TH VALIGN="TOP">PrimaryOwnerContact</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_System.html">CIM_System</a></TD> </TR> <TR> <TH VALIGN="TOP">PrimaryOwnerName</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_System.html">CIM_System</a></TD> </TR> <TR> <TH VALIGN="TOP">PrimaryStatus</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> <TR> <TH VALIGN="TOP">RequestedState</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_EnabledLogicalElement.html">CIM_EnabledLogicalElement</a></TD> </TR> <TR> <TH VALIGN="TOP">Status</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> <TR> <TH VALIGN="TOP">TimeOfLastStateChange</TH><TD VALIGN="TOP">datetime</TD><TD VALIGN="TOP"><a href="CIM_EnabledLogicalElement.html">CIM_EnabledLogicalElement</a></TD> </TR> <TR> <TH VALIGN="TOP">TransitioningToState</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_EnabledLogicalElement.html">CIM_EnabledLogicalElement</a></TD> </TR> <TR> <TH VALIGN="TOP">AvailableRequestedStates</TH><TD VALIGN="TOP">uint16[]</TD><TD VALIGN="TOP"><a href="CIM_EnabledLogicalElement.html">CIM_EnabledLogicalElement</a></TD> </TR> <TR> <TH VALIGN="TOP">IdentifyingDescriptions</TH><TD VALIGN="TOP">string[]</TD><TD VALIGN="TOP"><a href="CIM_System.html">CIM_System</a></TD> </TR> <TR> <TH VALIGN="TOP">OperationalStatus</TH><TD VALIGN="TOP">uint16[]</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> <TR> <TH VALIGN="TOP">OtherIdentifyingInfo</TH><TD VALIGN="TOP">string[]</TD><TD VALIGN="TOP"><a href="CIM_System.html">CIM_System</a></TD> </TR> <TR> <TH VALIGN="TOP">Roles</TH><TD VALIGN="TOP">string[]</TD><TD VALIGN="TOP"><a href="CIM_System.html">CIM_System</a></TD> </TR> <TR> <TH VALIGN="TOP">StatusDescriptions</TH><TD VALIGN="TOP">string[]</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> </TABLE> <h2> <a name="c_methods">Class Methods</a> </h2> <H3>Local Class Methods</H3> <h4>CreateNetworkPipes (uint32)</h4> <h4>Method Qualifiers (CreateNetworkPipes)</h4> <TABLE BORDER="1" CELLPADDING="1" WIDTH="100%"> <TR> <TH>Name</TH><TH>Data Type</TH><TH>Value</TH> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">This method creates one or more NetworkPipes each representing a connection between a pair of ServiceAccessPoints. If Success (0) is returned, the method completed successfully. A return value of Not Supported (1) indicates the method is not supported. All other values indicate some type of error condition.</TD> </TR> <TR> <TD VALIGN="TOP">Experimental</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TD VALIGN="TOP">ValueMap</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">0, 1, 2, 3, 4, 5, .., 0x8000..0xFFFF</TD> </TR> <TR> <TD VALIGN="TOP">Values</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Success, Not Supported, Unknown/Unspecified Error, Timeout, Failed, Invalid Parameter, DMTF Reserved, Vendor Specific</TD> </TR> </TABLE> <h4>Method Parameters (CreateNetworkPipes)</h4> <TABLE WIDTH="100%" CELLPADDING="1" BORDER="1"> <TR> <TH ROWSPAN="2"><B>Name</B></TH><TH ROWSPAN="2"><B>Type</B></TH><TH COLSPAN="5"><B>Qualifiers</B></TH> </TR> <TR> <TH>Name</TH><TH>Data Type</TH><TH>Value</TH> </TR> <TR> <TH ROWSPAN="7" VALIGN="TOP">Directionality</TH><TD ROWSPAN="7" VALIGN="TOP">uint16[]</TD> </TR> <TR> <TD VALIGN="TOP">ArrayType</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Indexed</TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Directionality indicates whether the pipe is bi-directional (value = 2) or unidirectional (value = 3). For unidirectional pipes, the appropriate ServiceAccessPoint must be referenced for the source and sink.</TD> </TR> <TR> <TD VALIGN="TOP">IN</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_Network.CreateNetworkPipes.SourceSAP, CIM_Network.CreateNetworkPipes.SinkSAP, CIM_Network.CreateNetworkPipes.NetworkPipe</TD> </TR> <TR> <TD VALIGN="TOP">ValueMap</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">2, 3</TD> </TR> <TR> <TD VALIGN="TOP">Values</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Bi-Directional, Unidirectional</TD> </TR> <TR> <TH ROWSPAN="6" VALIGN="TOP">NetworkPipe</TH><TD ROWSPAN="6" VALIGN="TOP"><a href="CIM_NetworkPipe.html">CIM_NetworkPipe</a>[]</TD> </TR> <TR> <TD VALIGN="TOP">ArrayType</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Indexed</TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">A reference to the newly created NetworkPipes.</TD> </TR> <TR> <TD VALIGN="TOP">IN</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_Network.CreateNetworkPipes.SourceSAP, CIM_Network.CreateNetworkPipes.SinkSAP, CIM_Network.CreateNetworkPipes.Directionality</TD> </TR> <TR> <TD VALIGN="TOP">OUT</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TH ROWSPAN="6" VALIGN="TOP">SinkSAP</TH><TD ROWSPAN="6" VALIGN="TOP"><a href="CIM_ServiceAccessPoint.html">CIM_ServiceAccessPoint</a>[]</TD> </TR> <TR> <TD VALIGN="TOP">ArrayType</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Indexed</TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">The endpoints of the NetworkPipe. Pass the sink SAP to this parameter when creating unidirectional NetworkPipes. When creating bi-directional NetworkPipes, it does not matter which SAP reference is passed to this parameter.</TD> </TR> <TR> <TD VALIGN="TOP">IN</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_Network.CreateNetworkPipes.Directionality, CIM_Network.CreateNetworkPipes.SourceSAP, CIM_Network.CreateNetworkPipes.NetworkPipe</TD> </TR> <TR> <TD VALIGN="TOP">Required</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TH ROWSPAN="6" VALIGN="TOP">SourceSAP</TH><TD ROWSPAN="6" VALIGN="TOP"><a href="CIM_ServiceAccessPoint.html">CIM_ServiceAccessPoint</a>[]</TD> </TR> <TR> <TD VALIGN="TOP">ArrayType</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Indexed</TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">The endpoints of the NetworkPipes. Pass the source SAP to this parameter when creating unidirectional NetworkPipes. When creating bi-directional NetworkPipes, it does not matter which SAP reference is passed to this parameter.</TD> </TR> <TR> <TD VALIGN="TOP">IN</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_Network.CreateNetworkPipes.Directionality, CIM_Network.CreateNetworkPipes.SinkSAP, CIM_Network.CreateNetworkPipes.NetworkPipe</TD> </TR> <TR> <TD VALIGN="TOP">Required</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TH ROWSPAN="5" VALIGN="TOP">Job</TH><TD ROWSPAN="5" VALIGN="TOP"> REF <a href="CIM_ConcreteJob.html">CIM_ConcreteJob</a></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Reference to the job (can be null if the task is completed).</TD> </TR> <TR> <TD VALIGN="TOP">IN</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">false</TD> </TR> <TR> <TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_Network.CreateNetworkPipes.SourceSAP, CIM_Network.CreateNetworkPipes.Directionality, CIM_Network.CreateNetworkPipes.NetworkPipe</TD> </TR> <TR> <TD VALIGN="TOP">OUT</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> </TABLE> <H3>Inherited Class Methods</H3> <TABLE BORDER="1" CELLPADDING="1" WIDTH="60%"> <TR> <TH>Name</TH><TH>Return Type</TH><TH>Class Origin</TH> </TR> <TR> <TH VALIGN="TOP">RequestStateChange</TH><TD VALIGN="TOP">uint32</TD><TD VALIGN="TOP"><a href="CIM_EnabledLogicalElement.html">CIM_EnabledLogicalElement</a></TD> </TR> </TABLE> </body> </html>