MSCluster_Network class

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}"), AMENDMENT]
class MSCluster_Network : MSCluster_LogicalElement
{
  string             Caption;
  datetime           InstallDate;
  string             Status;
  uint32             Flags;
  uint32             Characteristics;
  string             Name;
  string             ID;
  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
• Properties

Methods

The MSCluster_Network class has these methods.

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

Qualifiers: MaxLen (64)

A short textual description (one-line string) of the network.

This property is inherited from CIM_ManagedSystemElement.

Characteristics

Data type: uint32

Access type: Read-only

Provides the characteristics of the network. The cluster defines characteristics only for resources. For a description of these characteristics, see CLUSCTL_RESOURCE_GET_CHARACTERISTICS.

**Windows Server 2008 R2 and Windows Server 2008: **

This property is read/write before Windows Server 2012.

This property is inherited from MSCluster_LogicalElement.

Description

Data type: string

Access type: Read/write

Qualifiers: Override (Description)

Provides comments about the network.

Flags

Data type: uint32

Access type: Read-only

Provides access to the flags set for the network. The cluster defines flags only for resources. For a description of these flags, see CLUSCTL_RESOURCE_GET_FLAGS.

**Windows Server 2008 R2 and Windows Server 2008: **

This property is read/write before Windows Server 2012.

This property is inherited from MSCluster_LogicalElement.

ID

Data type: string

Access type: Read-only

The Id of the network.

**Windows Server 2008 R2 and Windows Server 2008: **

This property is not supported before Windows Server 2012.

InstallDate

Data type: datetime

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")

Indicates when the network was installed. A lack of a value does not indicate that the network is not installed.

This property is inherited from CIM_ManagedSystemElement.

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: Override (Name), Key

Provides the name of the network.

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.

None (0)

The network is not used by the cluster.

Cluster (1)

The network is used to carry internal cluster communication.

Client (2)

Not supported.

Both (3)

The network is used to connect client systems and to carry internal cluster communication.

Remarks

The MSCluster_Network class is derived from the MSCluster_LogicalElement class.

Requirements

See also

MSCluster_LogicalElement

Failover Cluster Provider Reference