3.14.4.2 GetNextAdapterFirewallConfiguration (Opnum 4)

  • Article

The GetNextAdapterFirewallConfiguration method returns information about a specific network adapter attached to the system.

 HRESULT GetNextAdapterFirewallConfiguration(
   [in] unsigned long idx,
   [out] GUID* adapterId,
   [out] CLUSTER_NETWORK_PROFILE* adapterProfile,
   [out] BOOLEAN* serverRulesEnabled,
   [out] BOOLEAN* managementRulesEnabled,
   [out] BOOLEAN* commonRulesEnabled
 );

idx: A 32-bit unsigned integer that indicates the index of the adapter information to retrieve. The server MUST fail this method with error 0x80070057 (E_INVALIDARG) if idx is greater than or equal to the cRetAdapters value returned by the previous call to InitializeAdapterConfiguration (Opnum 3).

adapterId: A GUID that uniquely identifies the network adapter on the system. Upon successful completion of this method, the server MUST set this value. If the method fails, the client MUST ignore this value.

adapterProfile: The firewall profile assigned to the network adapter. Upon successful completion of this method, the server MUST set this value to one of the specified values of CLUSTER_NETWORK_PROFILE. If the method fails, the client MUST ignore this value.

serverRulesEnabled: An output parameter that indicates whether the server is suitable for server-to-server failover cluster communication. Upon successful completion of this method, the server MUST set this value to TRUE if the server is suitable or to FALSE if the server is not suitable. When the server firewall enforces policies specified in [MS-FASP], the server sets this value to TRUE if the group of rules with the localized name "Failover Clusters" is enabled. If the method fails, the client MUST ignore this value.

Value

Meaning

TRUE

-128 — -1

Firewall settings allow the traffic specified previously.

FALSE

0

Firewall settings do not allow the traffic specified previously.

TRUE

1 — 128

Firewall settings allow the traffic specified previously.

managementRulesEnabled: An output parameter that indicates whether the server is compatible with the failover cluster management components. Upon successful completion of this method, the server MUST set this value to TRUE if the server is compatible or to FALSE if the server is not compatible. When the server firewall enforces policies specified in [MS-FASP], the server SHOULD set this value to TRUE if the group of rules with the localized name "Failover Cluster Manager" is enabled. If the method fails, the client MUST ignore this value.

Value

Meaning

TRUE

-128 — -1

Firewall settings allow the traffic specified previously.

FALSE

0

Firewall settings do not allow the traffic specified previously.

TRUE

1 — 128

Firewall settings allow the traffic specified previously.

commonRulesEnabled: An output parameter that indicates whether the server is compatible with the failover cluster components common to failover cluster management and server-to-server failover cluster communications. Upon successful completion of this method, the server MUST set this value to TRUE if the server is compatible or to FALSE if the server is not compatible. When the server firewall enforces policies specified in [MS-FASP], the server SHOULD set this value to TRUE if the group of rules with the localized name "Failover Cluster Common" is enabled. If the method fails, the client MUST ignore this value.

Value

Meaning

TRUE

-128 — -1

Firewall settings allow the traffic specified previously.

FALSE

0

Firewall settings do not allow the traffic specified previously.

TRUE

1 — 128

Firewall settings allow the traffic specified previously.

Return Values: A signed 32-bit value that indicates return status. If the method returns a negative value, it has failed. Zero or positive values indicate success, with the lower 16 bits in positive nonzero values containing warnings or flags defined in the method implementation. For more information about Win32 error codes and HRESULT values, see [MS-ERREF] sections 2.2 and 2.1.

Return value/code

Description

0x00000000

S_OK

The call was successful.

0x80070057

E_INVALIDARG

The value the client specified in idx is greater than or equal to the cRetAdapters value returned by the previous call to InitializeAdapterConfiguration.

0x8000FFFF

E_UNEXPECTED

InitializeAdapterConfiguration has not yet been called.

Exceptions Thrown: No exceptions are thrown beyond those thrown by the underlying RPC protocol [MS-RPCE].

The opnum field value for this method is 4.

The server returns the following information to the client:

  • The output parameters set to the values specified previously.