clean

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:

• VCSAgCleanOfflineHung

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

(See OfflineTimeout.)

• VCSAgCleanOfflineIneffective

The offline entry point was ineffective.

• VCSAgCleanOnlineHung

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

(See OnlineTimeout.)

• VCSAgCleanOnlineIneffective

The online entry point was ineffective.

• 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.

(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. (See the OnlineRetryLimit attribute for the resource type.)

  Enables the VCS 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 return 0.