Class CIM_Network
extends CIM_AdminDomain

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.

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_AllocatedLogicalElement
   |
   +--CIM_System
   |
   +--CIM_AdminDomain
   |
   +--CIM_Network

Direct Known Subclasses

CIM_VLANNetwork

Class Qualifiers

NameData TypeValue
DescriptionstringNetwork 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.
MappingStringsstringRecommendation.ITU|M3100.Network
UMLPackagePathstringCIM::Network::Systems
Versionstring2.39.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
OtherTypeDescriptionstring
DescriptionstringA string that describes the type of the network when the Type[] property contains value 1 ("Other"). This property shall be set to null when Type[] property does not contain value 1 ("Other").
ModelCorrespondencestringCIM_Network.Type
Typeuint16[]
DescriptionstringThis property describes the type of the network.
ValueMapstring1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12
ValuesstringOther, Local Area Network (LAN), Wireless Local Area Network (WLAN), Wide Area Network (WAN), Metropolitan Area Network (MAN), Storage Area Network (SAN), Virtual Local Area Network (VLAN), Ethernet Network, IP Network, IPv4 Network, IPv6 Network, Overlay Network

Inherited Properties

NameData TypeClass Origin
AllocationStatestringCIM_AllocatedLogicalElement
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_System
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
NamestringCIM_System
NameFormatstringCIM_AdminDomain
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PrimaryOwnerContactstringCIM_System
PrimaryOwnerNamestringCIM_System
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StatusstringCIM_ManagedSystemElement
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TransitioningToStateuint16CIM_EnabledLogicalElement
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
IdentifyingDescriptionsstring[]CIM_System
OperationalStatusuint16[]CIM_ManagedSystemElement
OtherIdentifyingInfostring[]CIM_System
Rolesstring[]CIM_System
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

CreateNetworkPipes (uint32)

Method Qualifiers (CreateNetworkPipes)

NameData TypeValue
DescriptionstringThis 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.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, .., 0x8000..0xFFFF
ValuesstringSuccess, Not Supported, Unknown/Unspecified Error, Timeout, Failed, Invalid Parameter, DMTF Reserved, Vendor Specific

Method Parameters (CreateNetworkPipes)

NameTypeQualifiers
NameData TypeValue
Directionalityuint16[]
ArrayTypestringIndexed
DescriptionstringDirectionality 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.
INbooleantrue
ModelCorrespondencestringCIM_Network.CreateNetworkPipes.SourceSAP, CIM_Network.CreateNetworkPipes.SinkSAP, CIM_Network.CreateNetworkPipes.NetworkPipe
ValueMapstring2, 3
ValuesstringBi-Directional, Unidirectional
NetworkPipeCIM_NetworkPipe[]
ArrayTypestringIndexed
DescriptionstringA reference to the newly created NetworkPipes.
INbooleantrue
ModelCorrespondencestringCIM_Network.CreateNetworkPipes.SourceSAP, CIM_Network.CreateNetworkPipes.SinkSAP, CIM_Network.CreateNetworkPipes.Directionality
OUTbooleantrue
SinkSAPCIM_ServiceAccessPoint[]
ArrayTypestringIndexed
DescriptionstringThe 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.
INbooleantrue
ModelCorrespondencestringCIM_Network.CreateNetworkPipes.Directionality, CIM_Network.CreateNetworkPipes.SourceSAP, CIM_Network.CreateNetworkPipes.NetworkPipe
Requiredbooleantrue
SourceSAPCIM_ServiceAccessPoint[]
ArrayTypestringIndexed
DescriptionstringThe 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.
INbooleantrue
ModelCorrespondencestringCIM_Network.CreateNetworkPipes.Directionality, CIM_Network.CreateNetworkPipes.SinkSAP, CIM_Network.CreateNetworkPipes.NetworkPipe
Requiredbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (can be null if the task is completed).
INbooleanfalse
ModelCorrespondencestringCIM_Network.CreateNetworkPipes.SourceSAP, CIM_Network.CreateNetworkPipes.Directionality, CIM_Network.CreateNetworkPipes.NetworkPipe
OUTbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
RequestStateChangeuint32CIM_EnabledLogicalElement