volume offload

Offloads data in the volume to the tier.

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 offload
   [ -cluster cluster_name ]
   [ -ignorerule <true|false> ]
   -name <volume_name>
   [ -scanopten <true|false>. default: true ]
   [ -force <true|false>. default: false ]
REST
Request Type POST
Request URL 
http[s]://<host>:<port>/rest/volume/offload?<parameters>

Parameters

Parameter

Description
cluster The name of the cluster on which to run the command.
ignorerule Specify whether (true) or not (false) to ignore existing rules associated with the volume for offloading data. If value is:
  • true, all data in the volume is offloaded and rules associated with the volume for offload are ignored.
  • false, data is offloaded based on the rules set up for offloading data.
Default value is false.
name The name of the volume.
scanopten The parameter is used for performance optimization. true is the default value, and true indicates that the volume compaction optimizations are enabled. One of the compaction optimizations include skipping containers that do not have enough garbage. This parameter is generally not set to false, except when you wish to disable the performance optimization feature for a particular reason.
-force Set the value as true to initiate a manual offload or compaction on the inline erasure coded volume. Inline erasure coding offloads auto-resume once the initiated offload/compaction is done.
NOTE
Scheduled compactions on IEC volumes takes precedence and proceed stopping the current IEC offloads, IEC offloads auto resume once the scheduled compaction is done

Example

Offload a volume:

  • CLI
  • REST
# /opt/mapr/bin/maprcli volume offload -name sampleVol -json
{
    "timestamp":1501104289006,
    "timeofday":"2017-07-26 02:24:49.006 GMT-0700",
    "status":"OK",
    "total":0,
    "data":[
        
    ],
    "messages":[
        "Successfully started offload."
    ]
}
# curl -X POST 'https://abc.sj.us:8443/rest/volume/offload?name=sampleVol' --user <username>:<password>
{"timestamp":1519947659597,"timeofday":"2018-03-01 03:40:59.597 GMT-0800 PM","status":"OK","total":0,"data":[],"messages":["Successfully started offload."]}