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:
{
   "timestamp":1532093619983,
   "timeofday":"2018-07-20 06:33:39.983 GMT-0700 AM",
   "status":"OK",
   "total":1,
   "data":[
	{
	   "compaction":{
		"state":"Scheduled",
		"scheduleTime":"2018-07-20 06:33:38.953 GMT-0700",
		"gateway":"10.10.108.116:8660"
	   }
	}
   ]
}
{"timestamp":1532093619983,"timeofday":"2018-07-20 06:33:39.983 GMT-0700 AM","status":"OK","total":1,"data":[{"compaction":{"state":"Scheduled","scheduleTime":"2018-07-20 06:33:38.953 GMT-0700","gateway":"10.10.108.116:8660"}}]}
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:
{
   "timestamp":1532095481297,
   "timeofday":"2018-07-20 07:04:41.297 GMT-0700 AM",
   "status":"OK",
   "total":1,
   "data":[
	{
	   "offload":{
		"state":"Running",
		"progress":"61%",
		"startTime":"2018-07-20 07:00:02.277 GMT-0700",
		"gateway":"10.10.108.115:8660"
	},
	   "compaction":{
		"state":"Success",
		"progress":"100%",
		"startTime":"2018-07-20 06:34:06.628 GMT-0700",
		"endTime":"2018-07-20 06:40:25.334 GMT-0700",
		"reclaimedDataSize":"0 MB",
		"gateway":"10.10.108.115:8660"
	   }
	}
   ]
}
{"timestamp":1532095481297,"timeofday":"2018-07-20 07:04:41.297 GMT-0700 AM","status":"OK","total":1,"data":[{"offload":{"state":"Running","progress":"61%","startTime":"2018-07-20 07:00:02.277 GMT-0700","gateway":"10.10.108.115:8660"},"compaction":{"state":"Success","progress":"100%","startTime":"2018-07-20 06:34:06.628 GMT-0700","endTime":"2018-07-20 06:40:25.334 GMT-0700","reclaimedDataSize":"0 MB","gateway":"10.10.108.115:8660"}}]}
FailureFatal Indicates the job has failed with non-retriable error. You must resolve the issue and retry the operation. For example:
{
   "timestamp":1531778057385,
   "timeofday":"2018-07-16 09:54:17.385 GMT+0000 PM",
   "status":"OK",
   "total":1,
   "data":[
	{
	   "offload":{
		"state":"FailureFatal",
		"progress":"50%",
		"startTime":"2018-07-16 21:54:01.779 GMT+0000",
		"endTime":"2018-07-16 21:54:05.339 GMT+0000",
		"offloadedDataSize":"0 MB",
		"gateway":"10.10.88.198:8660"
	   }
	}
   ]
}
{"timestamp":1531778057385,"timeofday":"2018-07-16 09:54:17.385 GMT+0000 PM","status":"OK","total":1,"data":[{"offload":{"state":"FailureFatal","progress":"50%","startTime":"2018-07-16 21:54:01.779 GMT+0000","endTime":"2018-07-16 21:54:05.339 GMT+0000","offloadedDataSize":"0 MB","gateway":"10.10.88.198:8660"}}]}
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:
{
   "timestamp":1532624516372,
   "timeofday":"2018-07-26 10:01:56.372 GMT-0700 AM",
   "status":"OK",
   "total":1,
   "data":[
	{
	   "offload":{
	       "state":"FailureRetry, RetryCount: 5",
	       "progress":"50%",
		"startTime":"2018-07-25 17:43:27.924 GMT-0700",
		"endTime":"2018-07-25 17:43:59.108 GMT-0700",
		"offloadedDataSize":"0 MB",
		"gateway":"10.10.25.29:8660"
	   }
	}
   ]
}
{"timestamp":1532624656640,"timeofday":"2018-07-26 10:04:16.640 GMT-0700 AM","status":"OK","total":1,"data":[{"offload":{"state":"FailureRetry, RetryCount: 5","progress":"50%","startTime":"2018-07-25 17:43:27.924 GMT-0700","endTime":"2018-07-25 17:43:59.108 GMT-0700","offloadedDataSize":"0 MB","gateway":"10.10.25.29:8660"}}]}
Success Indicates the job has been successfully completed. For example:
{
   "timestamp":1531311128469,
   "timeofday":"2018-07-11 12:12:08.469 GMT+0000 PM",
   "status":"OK",
   "total":1,
   "data":[
	{
	   "offload":{
              "state":"Success",
              "progress":"100%",
              "startTime":"2018-07-11 12:10:26.290 GMT+0000",
              "endTime":"2018-07-11 12:10:35.521 GMT+0000",
              "offloadedDataSize":"353.16 MB",
              "gateway":"10.10.20.12:8660"
	   },
	   "compaction":{
              "state":"Success",
              "progress":"100%",
              "startTime":"2018-07-11 12:12:01.335 GMT+0000",
              "endTime":"2018-07-11 12:12:02.264 GMT+0000",
              "reclaimedDataSize":"353.097 MB",
              "gateway":"10.10.20.12:8660"
	   }
	}
   ]
}
{"timestamp":1531311128469,"timeofday":"2018-07-11 12:12:08.469 GMT+0000 PM","status":"OK","total":1,"data":[{"offload":{"state":"Success","progress":"100%","startTime":"2018-07-11 12:10:26.290 GMT+0000","endTime":"2018-07-11 12:10:35.521 GMT+0000","offloadedDataSize":"353.16 MB","gateway":"10.10.20.12:8660"},"compaction":{"state":"Success","progress":"100%","startTime":"2018-07-11 12:12:01.335 GMT+0000","endTime":"2018-07-11 12:12:02.264 GMT+0000","reclaimedDataSize":"353.097 MB","gateway":"10.10.20.12:8660"}}]}
Terminated Indicates the job has been terminated. For example:
{
  "timestamp":1503504464179,
  "timeofday":"2017-08-23 04:07:44.179 GMT+0000",
  "status":"OK",
  "total":1,
  "data":[{
      "offload":{
          "state":"Terminated",
          "startTime":"2017-08-23 04:06:06.867 GMT+0000",
          "endTime":"2017-08-23 04:06:38.910 GMT+0000",
          "gateway":"10.10.88.199:8660"
      }
  }]
}
{"timestamp":1503504464179,"timeofday":"2017-08-23 04:07:44.179 GMT+0000","status":"OK","total":1,"data":[{"offload":{"state":"Terminated","startTime":"2017-08-23 04:06:06.867 GMT+0000","endTime":"2017-08-23 04:06:38.910 GMT+0000","gateway":"10.10.88.199:8660"}}]}
TerminateInProgress Indicates that the terminate operation is in progress. For example:
{
   "timestamp":1533005375001,
   "timeofday":"2018-07-30 07:49:35.001 GMT-0700 PM",
   "status":"OK",
   "total":1,
   "data":[
	{
          "offload":{
              "state":"TerminateInProgress",
              "progress":"98%",
              "startTime":"2018-07-30 19:02:37.108 GMT-0700",
              "gateway":"10.10.101.121:8660"
          }
	}
   ]
}
{"timestamp":1533005375001,"timeofday":"2018-07-30 07:49:35.001 GMT-0700 PM","status":"OK","total":1,"data":[{"offload":{"state":"TerminateInProgress","progress":"98%","startTime":"2018-07-30 19:02:37.108 GMT-0700","gateway":"10.10.101.121:8660"}}]}
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:
{
  "timestamp":1515488569411,
  "timeofday":"2018-01-09 01:02:49.411 GMT-0800",
  "status":"OK",
  "total":1,
  "data":[{
    "recall":{
      "state":"TerminatedInternal",
      "progress":"36%",
      "startTime":"2018-01-09 01:01:57.824 GMT-0800",
      "endTime":"2018-01-09 01:02:43.329 GMT-0800",
      "gateway":"10.10.108.150:8660"
    }
  }]
}
{"timestamp":1515488569411,"timeofday":"2018-01-09 01:02:49.411 GMT-0800","status":"OK","total":1,"data":[{"recall":{"state":"TerminatedInternal","progress":"36%","startTime":"2018-01-09 01:01:57.824 GMT-0800","endTime":"2018-01-09 01:02:43.329 GMT-0800","gateway":"10.10.108.150:8660"}}]}

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"}}]}