Share via

3.18.4.4 GenerateClusterNetworkLog (Opnum 6)

  • Article

The GenerateClusterNetworkLog method<49> generates the cluster network log file on cluster nodes. The content and format of the file is implementation-specific but SHOULD contain diagnostic information.

 HRESULT GenerateClusterNetworkLog {
   [ in ] unsigned long SpanMinutes,
   [ in ] ClusterLogExFlag flags,
   [ out ] BSTR* LogFilePath
 };

SpanMinutes: A value, in minutes, that indicates those values that SHOULD be in the log. Events that occurred in the range of Now to (Now – SpanMinutes) MUST be in the log and no others. If ClusterLogFlagLocalTime is set in the Flags field, Now is the GMT on the server; otherwise, it is the local time on the server.

Flags: Is the type ClusterLogExFlag enum as specified in section 2.2.25.

LogFilePath: Has the same meaning as parameter LogFilePath for the GenerateClusterLog method specified in section 3.12.4.1.

Return Values: Return values are the same as the return values for the GenerateClusterLog method specified in section 3.12.4.1.

Return value/code

Description

0x00000000

S_OK

The call was successful.

For any other condition, this method MUST return a value that is not one of the values listed in the preceding table. The client MUST behave in an identical manner for all return values not listed in the preceding table.

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

The opnum field value for this method is 6.

When processing this call, the server MUST do the following:

  • If ClusterLogFlagLocalTime is set in the Flags field, use local time on the server.

  • Generate the health log file with the correct data, honoring the SpanMinutes parameter.

  • Place the file in a valid LogFilePath on the machine, as specified in section 3.18.4.1.

  • Generate the server-relative path to the file.

Return the following information to the client:

  • The server-relative path to the file.