Skip to main content
MI_OperationOptions_SetTimeout function

Sets the operation timeout for a specific operation.

Syntax


 MI_INLINE MI_Result MI_OperationOptions_SetTimeout(
  _Inout_  MI_OperationOptions *options,
  _In_     const MI_Interval *timeout
);

Parameters

options [in, out]

A pointer to a MI_OperationOptions structure.

timeout [in]

A pointer to the new operation timeout value.

Return value

A value of the MI_Result enumeration that specifies the function return code. This can be one of the following codes.

Return codeDescription
MI_RESULT_OK

The operation succeeded.

MI_RESULT_SERVER_LIMITS_EXCEEDED

There is not enough memory to complete the request.

MI_RESULT_INVALID_PARAMETER

One or more parameters passed to the function were not valid.

MI_RESULT_NOT_FOUND

Specified element does not exist.

MI_RESULT_FAILED

A failure not covered by other MI_Result error codes.

 

Remarks

This timeout can be set in the destination options by calling the MI_DestinationOptions_SetTimeout function. However, sometimes one operation may take longer than others. Therefore, it is best to set a reasonable default for all operations, then use this function to override specific operations that may take longer.

If the client is asking for progress, and the provider is reporting progress, the timeout interval will be restarted after each progress report. For enumerations/subscribe/association, the interval is the maximum length before objects are delivered before it times out (subject to the progress comment).

If a client performs an operation (such as an invoke) on a CIM session over Windows Remote Management, the operation can take longer than the operation timeout value if the target server is unreachable (for example, because of server outage, network outage, or an unexpected firewall exception). This excessive wait time occurs because the operation may be divided into suboperations for fetching schema information from the server, and the client continues continues the operation even if one or more of the schema fetch suboperations has been blocked by an unreachable server.

To mitigate this issue and get the client to report the results without an excessive wait time, try one or both of these steps:

  • Set the WinRM network delay time to a very low value by invoking the following command:

    winrm set winrm/config/client @{NetworkDelayms="DesiredValue"}

    where DesiredValue is the network delay value, in milliseconds. The lowest network delay that can be specified is 500 milliseconds.

    The network delay value helps to account for network latency while reaching the target machine. If you set tiny network delay and operation timeout values, however, you might not be able to communicate with a target machine that takes a long time to reach. Also, a change in the network delay value affects the entire machine, not just one operation.

  • When starting the operation (calling a function with an "MI_Session_" prefix), specify the MI_OPERATIONFLAGS_STANDARD_RTTI flag in the flags parameter.

    This changes the operation behavior so that if a fetch schema suboperation fails, the operation is aborted and completes immediately instead of waiting for subsequent fetch schema suboperations to finish. Therefore, if the server was always unreachable when the operation started, the amount of time taken by the operation to complete will be equal to the sum of the operation timeout value and the WinRM network delay value.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Redistributable

Windows Management Framework 3.0 on Windows Server 2008 R2 with SP1, Windows 7 with SP1, and Windows Server 2008 with SP2

Header

Mi.h

See also

MI_DestinationOptions_SetTimeout
MI_OperationOptions_GetTimeout
Windows Remote Management