Service: zimbraAdmin
Namespace: "urn:zimbraAdmin"
AbortHsm SOAP Command

Aborts a running HSM process

Network edition only API TRUE
Authorization token required true
Admin Authorization token required true

AbortHsmRequest

    <AbortHsmRequest /> ## AbortHsmRequest

AbortHsmResponse

The aborted attribute is set to true (1) if an HSM session was running at the time the request was made, false (0) otherwise.

Note: If the abort request is sent after all the blobs for the last mailbox have been moved, but before its database table has been updated, <AbortHsmRequest> will return true even though the process was not really aborted. This state is very unlikely. The official aborted state can be verified with <GetHsmStatusRequest>.

    <AbortHsmResponse aborted="(0|1)" /> ## AbortHsmResponse

The following table describes elements and attributes you can define within a <AbortHsmResponse> element:

XPath Required / Optional Description
@aborted Required (only 1) Type:0|1
Set to true (1) if an HSM session was running at the time the request was made.