The Role property provides the role of the network in the cluster.
| Type: | DWORD |
| Access: | Read/write |
| Function: | ClusterNetworkControl |
| Structure: | CLUSPROP_DWORD |
| Control Code: | CLUSCTL_NETWORK_GET_COMMON_PROPERTIES |
When ClusterNetworkControl processes the CLUSCTL_NETWORK_GET_COMMON_PROPERTIES control code, it returns a property list that includes the Role property as one of the entries. The property value portion of the entry contains a CLUSPROP_DWORD structure that is set as follows:
DWORD RoleData = ClusterNetworkRoleClientAccess;
CLUSPROP_DWORD RoleValue;
RoleValue.Syntax = CLUSPROP_SYNTAX_LIST_VALUE_DWORD;
RoleValue.cbLength = sizeof(DWORD);
RoleValue.dw = RoleData;
The data value for the Role property can be set to one of the following values:
| Role property data value | Description |
|---|---|
| ClusterNetworkRoleNone | The network is not used by the cluster. |
| ClusterNetworkRoleClientAccess | The network is used to connect client systems to the cluster. |
| ClusterNetworkRoleInternalUse | The network is used to carry internal cluster communication. |
| ClusterNetworkRoleInternalAndClient | 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 that is used for internal cluster communication, the Role property may not be changed to ClusterNetworkRoleNone or ClusterNetworkRoleClientAccess.
Version: Use Windows NT Server Enterprise Edition 4.0.
Windows CE: Unsupported.
Header: Declared in clusapi.h.