CIM_ConnectivityCollection class
Represents a collection of protocol endpoints that are of the same class type and can communicate with each other. In addition, CIM_ConnectivityCollection can contain systems, users, and managed elements that are related to the protocol endpoints. A connectivity collection is hosted by an admin domain or computer system.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Syntax
[UMLPackagePath("CIM::Network::Collections"), Version("2.7.0"), AMENDMENT]
class CIM_ConnectivityCollection : CIM_SystemSpecificCollection
{
string Caption;
string Description;
string ElementName;
string InstanceID;
uint16 ConnectivityStatus;
};
Members
The CIM_ConnectivityCollection class has these types of members:
Properties
The CIM_ConnectivityCollection class has these properties.
-
Caption
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64)
The Caption property is a short textual description (one- line string) of the object.
This property is inherited from CIM_ManagedElement.
-
-
ConnectivityStatus
-
-
Data type: uint16
-
Access type: Read-only
An enumeration that describes the connectivity between the endpoints in the collection.
The possible values are:
-
-
Unknown (0)
-
The system couldn't retrieve the state of the connection.
-
Connectivity/Up (2)
-
The connection is up.
-
No Connectivity/Down (3)
-
The connection is down.
-
Partitioned (4)
-
The connection is partitioned.
Description
-
Data type: string
-
Access type: Read-only
The Description property provides a textual description of the object.
This property is inherited from CIM_ManagedElement.
ElementName
-
Data type: string
-
Access type: Read-only
A user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information.
This property is inherited from CIM_ManagedElement.
InstanceID
-
Data type: string
-
Access type: Read-only
-
Qualifiers: key
Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following \'preferred\' algorithm:
<OrgID>:<LocalID>
Where <OrgID> and <LocalID> are separated by a colon \':\', and where <OrgID> must include a unique name. It can be a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID. Or, it could be a registered ID that is assigned to the business entity by a recognized global authority.(This requirement is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness <OrgID> must not contain a colon (\':\'). When using this algorithm, the first colon to appear in InstanceID must appear between <OrgID> and <LocalID>.
<LocalID> is chosen by the business entity and should not be re-used to identify different underlying (real-world) elements. If the above \'preferred\' algorithm is not used, the defining entity must ensure that the resulting InstanceID is not re-used as any of InstanceIDs produced by this or other providers for the NameSpace of this instance.
For DMTF-defined instances, the \'preferred\' algorithm must be used with the <OrgID> set to \'CIM\'.
This property is inherited from CIM_SystemSpecificCollection.
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2012 R2 |
| Namespace |
Root\Microsoft\IPAM |
| MOF |
|
| DLL |
|