About the clean entry point
Prev	Agent entry point overview	Next

---

About the clean entry point

The clean entry point is called automatically by the agent framework when all ongoing tasks associated with a resource must be terminated and the resource must be taken offline, perhaps forcibly. The entry point receives as input the resource name, an encoded reason describing why the entry point is being called, and the ArgList attribute values. It must return 0 if the operation is successful and 1 if unsuccessful.

The reason for calling the entry point is encoded according to the following enum type:

enum VCSAgWhyClean {

VCSAgCleanOfflineHung,

VCSAgCleanOfflineIneffective,

VCSAgCleanOnlineHung,

VCSAgCleanOnlineIneffective,

VCSAgCleanUnexpectedOffline,

VCSAgCleanMonitorHung

};

For script-based Clean entry points, the Clean reason is passed as an integer:

0 => offline hung

1 => offline ineffective

2 => online hung

3 => online ineffective

4 => unexpected offline

5 => monitor hung

The above is an enum type, so same integer value is passed irrespective of whether the entry point is written in C++ or is script-based.

Note   On Windows, VCSAgCleanOfflineHung, VCSAgCleanOnlineHung, and VCSAgCleanMonitorHung do not apply. Entry point timeouts are not configurable parameters on the Windows platform.

• VCSAgCleanOfflineHung

  The offline entry point did not complete within the expected time.

  This parameter is not used on Windows.

  See OfflineTimeout.

• VCSAgCleanOfflineIneffective

  The offline entry point was ineffective. The monitor entry point returned a status other than offline after the scheduled invocation of the offline entry point for the resource.

• VCSAgCleanOnlineHung

  The online entry point did not complete within the expected time.

  This parameter is not used on Windows.

  (See OnlineTimeout.)

• VCSAgCleanOnlineIneffective

  The online entry point was ineffective. The monitor entry point scheduled for the resource after the online entry point invocation returned a status other than online.

• VCSAgCleanUnexpectedOffline

  The online resource faulted because it was taken offline unexpectedly.

• VCSAgCleanMonitorHung

  The online resource faulted because the monitor entry point consistently failed to complete within the expected time.

  This parameter is not used on Windows.

  (See FaultOnMonitorTimeouts.)

The agent supports the following tasks when the clean entry point is implemented:

• Automatically restarts a resource on the local system when the resource faults. (See the RestartLimit attribute for the resource type.)
• Automatically retries the online entry point when the attempt to bring a resource online fails.
• Enables the engine to bring a resource online on another system when the online entry point for the resource fails on the local system.

For the above actions to occur, the clean entry point must run successfully, that is, return an exit code of 0.