volume remove

Removes the specified volume or mirror. Permissions required: d or fc on the volume.

Syntax

CLI
maprcli volume remove
    [ -cluster <cluster> ]
    [ -force true|false ]
    [ -filter <filter> ]
    [ -deletes3bucket true|false ]
    -name <volume name>
   
REST
Request Type POST
Request URL
http[s]://<host>:<port>/rest/volume/remove?<parameters> 

Parameters

Parameter Description
cluster The cluster on which to run the command.
force Forces the removal of the volume, even if there are dependencies.
name The volume name.
filter All volumes with names that match the filter are removed.
deletes3bucket The default value is false. When the deletes3bucket parameter is set to true, all buckets associated with the volume are deleted. The flag can be used to recursively delete non-WORM(write once read many) buckets associated with the volume, along with the volume itself, only when non-WORM buckets are associated with the volume.The volume deletion fails when WORM buckets are associated with the volume to delete.

Examples

The following command removes the volume by the name, testVolume.
CLI
maprcli volume remove -name testVolume
REST
https://abcdcorp.sj.us:8443/rest/volume/remove?name=testVolume
The following command removes the volume by the name, testVolume, and all non-WORM buckets associated with testVolume.
CLI
maprcli volume remove -name -deletes3bucket true testVolume
REST
https://abcdcorp.sj.us:8443/rest/volume/remove?deletes3bucket=true&name=testVolume