Share via


Network Control Codes

The Failover Cluster API defines the following external control codes for networks (there are no internal control codes defined for networks):

Network control codes use the CLUS_OBJECT_NETWORK value of the CLUSTER_CONTROL_OBJECT enumeration to indicate that the control code applies to cluster networks. For more information about control codes, see Control Code Architecture.

Network control codes are enumerated by the CLUSCTL_NETWORK_CODES enumeration.

In this section

CLUSCTL_NETWORK_ENUM_COMMON_PROPERTIES

Retrieves a list of the read/write common network property names.

CLUSCTL_NETWORK_ENUM_PRIVATE_PROPERTIES

Retrieves a list of private property names for a network.

CLUSCTL_NETWORK_GET_CHARACTERISTICS

Retrieves the intrinsic characteristics of a network.

CLUSCTL_NETWORK_GET_COMMON_PROPERTIES

Retrieves the read/write common properties for a network.

CLUSCTL_NETWORK_GET_COMMON_PROPERTY_FMTS

Reserved for future use.

CLUSCTL_NETWORK_GET_FLAGS

Retrieves the flags that are set for a network.

CLUSCTL_NETWORK_GET_ID

Retrieves the cluster database subkey identifier for a network.

CLUSCTL_NETWORK_GET_NAME

Retrieves the name of a network.

CLUSCTL_NETWORK_GET_PRIVATE_PROPERTIES

Retrieves the read/write private properties for a network.

CLUSCTL_NETWORK_GET_PRIVATE_PROPERTY_FMTS

The CLUSCTL_NETWORK_GET_PRIVATE_PROPERTY_FMTS control code is not supported and fails with ERROR_INVALID_FUNCTION.

CLUSCTL_NETWORK_GET_RO_COMMON_PROPERTIES

Retrieves the read-only common properties for a network.

CLUSCTL_NETWORK_GET_RO_PRIVATE_PROPERTIES

Retrieves the read-only private properties for a network.

CLUSCTL_NETWORK_SET_COMMON_PROPERTIES

Updates the read/write common properties for a network.

CLUSCTL_NETWORK_SET_PRIVATE_PROPERTIES

Updates the read/write private properties for a network.

CLUSCTL_NETWORK_UNKNOWN

verifies that control codes are being processed on the node where execution of the control is directed.

CLUSCTL_NETWORK_VALIDATE_COMMON_PROPERTIES

Verifies that a property list contains valid network property names and values and that the list is properly formatted.

CLUSCTL_NETWORK_VALIDATE_PRIVATE_PROPERTIES

Verifies that a property list is properly formatted.

Failover Cluster Control Codes

ClusterNetworkControl

ExecuteNetworkControl Method of the MSCluster_Network Class

CLUSCTL_NETWORK_CODES