Network Interface Control Codes

  • Article

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

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

Network interface control codes are enumerated by the CLUSCTL_NETINTERFACE_CODES enumeration.

In this section

CLUSCTL_NETINTERFACE_ENUM_COMMON_PROPERTIES

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

CLUSCTL_NETINTERFACE_ENUM_PRIVATE_PROPERTIES

Retrieves a list of the network interface private properties.

CLUSCTL_NETINTERFACE_GET_CHARACTERISTICS

retrieves the intrinsic characteristics of a network interface.

CLUSCTL_NETINTERFACE_GET_COMMON_PROPERTIES

Retrieves the read/write common properties for a network interface.

CLUSCTL_NETINTERFACE_GET_COMMON_PROPERTY_FMTS

Reserved for future use.

CLUSCTL_NETINTERFACE_GET_FLAGS

Retrieves the flags that are set for a network interface.

CLUSCTL_NETINTERFACE_GET_ID

Retrieves the cluster database subkey identifier for a network interface.

CLUSCTL_NETINTERFACE_GET_NAME

Retrieves the name of a network interface.

CLUSCTL_NETINTERFACE_GET_NETWORK

Retrieves the name of the network to which a network interface is connected.

CLUSCTL_NETINTERFACE_GET_NODE

Retrieves the name of the node in which a network interface is installed. Applications use this control code as a ClusterNetInterfaceControl parameter.

CLUSCTL_NETINTERFACE_GET_PRIVATE_PROPERTIES

Retrieves the read/write private properties for a network interface.

CLUSCTL_NETINTERFACE_GET_PRIVATE_PROPERTY_FMTS

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

CLUSCTL_NETINTERFACE_GET_RO_COMMON_PROPERTIES

Retrieves the read-only common properties for a network interface.

CLUSCTL_NETINTERFACE_GET_RO_PRIVATE_PROPERTIES

Retrieves the read-only private properties for a network interface.

CLUSCTL_NETINTERFACE_SET_COMMON_PROPERTIES

Updates the read/write common properties for a network interface.

CLUSCTL_NETINTERFACE_SET_PRIVATE_PROPERTIES

Updates the read/write private properties for a network interface.

CLUSCTL_NETINTERFACE_UNKNOWN

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

CLUSCTL_NETINTERFACE_VALIDATE_COMMON_PROPERTIES

Verifies that a property list contains valid network interface property names

CLUSCTL_NETINTERFACE_VALIDATE_PRIVATE_PROPERTIES

Verifies that a property list is properly formatted.

Failover Cluster Control Codes

ClusterNetInterfaceControl