volume tierjobstatus
Retrieves the status of the currently running operation (such as offload, recall, or terminate) for a volume.
Permissions Required
The user running the command must have one of the following:
- Full control (fc) on the cluster or volume
- Volume edit permissions
Syntax
- CLI
maprcli volume tierjobstatus [ -cluster <cluster_name> ] -name <volume_name> [ -verbose true|false ]- REST
Request Type GET Request URL http[s]://<host>:<port>/rest/volume/tierjobstatus?<parameters>
Parameters
|
Parameter |
Description |
|---|---|
cluster |
The name of the cluster on which to run the command. |
name |
The name of the volume. |
verbose |
Specifies whether the command output should be verbose. The value for this must
be true to retrieve the status of a compaction operation. The
default value is false. |
Output
The command returns the following:
state |
The status of the offload, recall, or terminate operation. See Statuses below for more information. |
offloadedDataSize |
The amount of data offloaded. This is returned only when returning the status of an offload operation. |
progress |
The percentage of containers that have been processed so far. |
recalledDataSize |
The amount of data recalled. This is returned only when returning the status of a recall operation. |
reclaimedDataSize |
The amount of data purged. This is returned only when returning the status of a compaction job. |
startTime |
The date and timestamp for when the offload operation started. |
endTime |
The date and timestamp for when the offload operation completed. |
gateway |
The IP address of the MAST Gateway used for the tiering operation. |
Statuses
The value for the state field (statuses) can be one of the following:
| State | Description |
|---|---|
| Scheduled | Indicates the job request has reached CLDB, but has not yet been forwarded to
any MAST Gateway service. For example: |
| Running | Indicates the offload or recall job has been forwarded to MAST Gateway
service. The MAST Gateway service can either still be waiting for resources to
run the job or is actually performing the requested job. For example: |
| FailureFatal | Indicates the job has failed with non-retriable error. You must resolve the
issue and retry the operation. For example: |
| FailureRetriable | Indicates the job has failed with an error for which CLDB will retry the job
based on the configuration parameters, cldb.gateway.retry.count and
cldb.gateway.retry.waittime. But if the job is restarted manually
or terminated, CLDB will not retry. For example: |
| Success | Indicates the job has been successfully completed. For example: |
| Terminated | Indicates the job has been terminated. For example: |
| TerminateInProgress | Indicates that the terminate operation is in progress. For example: |
| TerminatedInternal | Indicates the offload operation was terminated by another internal process,
such as when promoting a mirror volume to a read-write volume when offload is in
progress. For example: |
Example
# maprcli volume tierjobstatus -name testVol -json -verbose true
{
"timestamp":1533005419522,
"timeofday":"2018-07-30 07:50:19.522 GMT-0700 PM",
"status":"OK",
"total":1,
"data":[
{
"offload":{
"state":"Success",
"progress":"100%",
"startTime":"2018-07-30 19:00:06.185 GMT-0700",
"endTime":"2018-07-30 19:19:58.303 GMT-0700",
"offloadedDataSize":"2487.911 MB",
"gateway":"10.10.108.117:8660"
},
"compaction":{
"state":"TerminateInProgress",
"progress":"45%",
"startTime":"2018-07-30 19:23:33.504 GMT-0700",
"gateway":"10.10.101.121:8660"
}
}
]
}# curl -k -X GET 'https://server.sj.us:8443/rest/tierjobstatus?name=testVol&verbose=true' --user <username>:<password>
{"timestamp":1533005419522,"timeofday":"2018-07-30 07:50:19.522 GMT-0700 PM","status":"OK","total":1,"data":[{"offload":{"state":"Success","progress":"100%","startTime":"2018-07-30 19:00:06.185 GMT-0700","endTime":"2018-07-30 19:19:58.303 GMT-0700","offloadedDataSize":"2487.911 MB","gateway":"10.10.108.117:8660"},"compaction":{"state":"TerminateInProgress","progress":"45%","startTime":"2018-07-30 19:23:33.504 GMT-0700","gateway":"10.10.101.121:8660"}}]}