Role
Provides the Role of the network in the cluster. The following table summarizes the attributes of the Role property.
| Attribute | Value |
|---|---|
| Data type |
DWORD |
| Access |
Read/write |
| Structure |
CLUSPROP_DWORD |
| Minimum |
ClusterNetworkRoleNone (0) |
| Maximum |
ClusterNetworkRoleInternalAndClient (3) |
| Default |
ClusterNetworkRoleInternalAndClient |
Remarks
The data value for the Role property can be set to one of the following values of the CLUSTER_NETWORK_ROLE enumeration.
| Name | Value | Description |
|---|---|---|
| ClusterNetworkRoleNone |
0 |
The network is not used by the cluster. |
| ClusterNetworkRoleInternalUse |
1 |
The network is used to carry internal cluster communication. |
| ClusterNetworkRoleClientAccess |
2 |
Not supported. |
| ClusterNetworkRoleInternalAndClient |
3 |
The network is used to connect client systems and to carry internal cluster communication. |
There are some restrictions to the data value. If any IP Address resources reference this network, the Role property may not be changed to ClusterNetworkRoleNone or ClusterNetworkRoleInternalUse. If this network is the only one used for internal cluster communication, the Role property may not be changed to ClusterNetworkRoleNone or ClusterNetworkRoleClientAccess.
Examples
The property value portion of a property list entry for Role can be set with the following example code:
DWORD RoleData = ClusterNetworkRoleClientAccess;
CLUSPROP_DWORD RoleValue;
RoleValue.Syntax.dw = CLUSPROP_SYNTAX_LIST_VALUE_DWORD;
RoleValue.cbLength = sizeof(DWORD);
RoleValue.dw = RoleData;
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2008 Enterprise, Windows Server 2008 Datacenter |