MSCluster_Network class
The MSCluster_Network class is a dynamic WMI class that represents cluster networks.
The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties.
Syntax
[Dynamic, Provider ("MS_CLUSTER_PROVIDER"), UUID ("{F541DA2A-174C-4000-9066-B755095C7E7A}")]class MSCluster_Network : MSCluster_LogicalElement
{
string Caption;
datetime InstallDate;
string Status;
uint32 Flags;
uint32 Characteristics;
string Name;
string Description;
string Address;
string AddressMask;
uint32 Role;
uint32 State;
string IPv6Addresses[];
string IPv6PrefixLengths[];
string IPv4Addresses[];
string IPv4PrefixLengths[];
uint32 Metric;
boolean AutoMetric;
MSCluster_Property PrivateProperties;
};
Members
The MSCluster_Network class has these types of members:
Methods
The MSCluster_Network class has these methods.
| Method | Description |
|---|---|
| ExecuteNetworkControl |
Executes a control code on the network.
|
| Rename |
Renames the network |
Properties
The MSCluster_Network class has these properties.
- Address
-
- Data type: string
- Access type: Read-only
Provides the address for the entire network or subnet.
- AddressMask
-
- Data type: string
- Access type: Read-only
Provides the mask that distinguishes the network and host portions of an address.
- AutoMetric
-
- Data type: boolean
- Access type: Read/write
Determines whether the metric is to be set by the user or determined automatically.
- Caption
-
- Data type: string
- Access type: Read-only
Provides a short textual description of the network.
Inherited from MSCluster_LogicalElement.
- Characteristics
-
- Data type: uint32
- Access type: Read/write
Provides access to the characteristics set for the network. For a list of possible characteristics, see CLUSCTL_NETWORK_GET_CHARACTERISTICS.
Inherited from MSCluster_LogicalElement.
- Description
-
- Data type: string
- Access type: Read/write
Provides comments about the network.
Inherited from MSCluster_LogicalElement.
- Flags
-
- Data type: uint32
- Access type: Read/write
Provides access to the flags set for the network. For a list of possible flags, see CLUSCTL_NETWORK_GET_FLAGS.
Inherited from MSCluster_LogicalElement.
- InstallDate
-
- Data type: datetime
- Access type: Read-only
Indicates when the network was installed. The lack of a value does not indicate that the network is not installed.
Inherited from MSCluster_LogicalElement.
- IPv4Addresses
-
- Data type: string array
- Access type: Read-only
Provides the IPv4 addresses currently assigned to this network.
- IPv4PrefixLengths
-
- Data type: string array
- Access type: Read-only
Provides the prefix lengths of the IPv4 addresses currently assigned to this network.
- IPv6Addresses
-
- Data type: string array
- Access type: Read-only
Provides the IPv6 addresses currently assigned to this network.
- IPv6PrefixLengths
-
- Data type: string array
- Access type: Read-only
Provides the prefix lengths of the IPv6 addresses currently assigned to this network.
- Metric
-
- Data type: uint32
- Access type: Read/write
The metric of a cluster network (networks with lower values are used first). If this value is set, then the AutoMetric property is set to false.
- Name
-
- Data type: string
- Access type: Read-only
- Qualifiers: Key
Provides the name of the network.
Inherited from MSCluster_LogicalElement.
- PrivateProperties
-
- Data type: MSCluster_Property
- Access type: Read/write
Provides private properties of the network.
- Role
-
- Data type: uint32
- Access type: Read/write
Provides access to the network's Role property.
The Role property describes the role of the network in the cluster. The following are the possible values.
Windows Server 2003:The values are named ClusterNetworkRoleNone, ClusterNetworkRoleClientAccess, ClusterNetworkRoleInternalUse, and ClusterNetworkRoleInternalAndClient from the CLUSTER_NETWORK_ROLE enumeration.
- State
-
- Data type: uint32
- Access type: Read-only
Provides the current state of the network. For a listing of state descriptors, see the GetClusterNetworkState function or the CLUSTER_NETWORK_STATE enumeration.
The following are the possible values.
Value Meaning - StateUnknown
- -1
The operation was not successful.
- StateUnavailable
- 0
All of the network interfaces on the network are unavailable, which means that the nodes that own the network interfaces are down.
- Down
- 1
The network is not operational; none of the nodes on the network can communicate.
- Partitioned
- 2
The network is operational, but two or more nodes on the network cannot communicate. Typically a path-specific problem has occurred.
- Up
- 3
The network is operational; all of the nodes in the cluster can communicate.
- Status
-
- Data type: string
- Access type: Read-only
Indicates the current status of the network.
Inherited from MSCluster_LogicalElement.
Values include the following:
"OK"
"Error"
"Degraded"
"Unknown"
"Pred Fail"
"Starting"
"Stopping"
"Service"
"Stressed"
"NonRecover"
"No Contact"
"Lost Comm"
Remarks
The MSCluster_Network class is derived from the MSCluster_LogicalElement class.
Requirements
|
Minimum supported client | None supported [desktop apps only] |
|---|---|
|
Minimum supported server | Windows Server 2003 Datacenter, Windows Server 2003 Enterprise [desktop apps only] |
|
Namespace |
\\.\Root\MSCluster |
|
MOF |
|
See also
Send comments about this topic to Microsoft
Build date: 11/28/2012
