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

Get all volumes

Authorization token required true
Admin Authorization token required true

GetAllVolumesRequest

    <GetAllVolumesRequest /> ## GetAllVolumesRequest

GetAllVolumesResponse

    <GetAllVolumesResponse> ## GetAllVolumesResponse
        (<volume [id="{volume-id} (short)"] [name="{volume-name}"] [rootpath="{volume-root-path}"]
                    [type="{volume-type} (short)"] [compressBlobs="{compress-blobs} (0|1)"]
                    [compressionThreshold="{compression-threshold} (long)"] [mgbits="(short)"] [mbits="(short)"]
                    [fgbits="(short)"] [fbits="(short)"] [isCurrent="(0|1)"] /> ## VolumeInfo)+
    </GetAllVolumesResponse>

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

XPath Required / Optional Description
/volume Required (1 or more) Information about volumes
/volume@id Optional (0 or 1) Type:short
Volume ID
/volume@name Optional (0 or 1) Type:String
Name or description of volume
/volume@rootpath Optional (0 or 1) Type:String
Absolute path to root of volume, e.g. /opt/zimbra/store
/volume@type Optional (0 or 1) Type:short
Volume type
1 Primary message volume
2 Secondary message volume
10 index volume
/volume@compressBlobs Optional (0 or 1) Type:0|1
Specifies whether blobs in this volume are compressed
/volume@compressionThreshold Optional (0 or 1) Type:long
Long value that specifies the maximum uncompressed file size, in bytes, of blobs that will not be compressed (in other words blobs larger than this threshold are compressed)
/volume@mgbits Optional (0 or 1) Type:short
mgbits
/volume@mbits Optional (0 or 1) Type:short
mbits
/volume@fgbits Optional (0 or 1) Type:short
fgbits
/volume@fbits Optional (0 or 1) Type:short
fbits
/volume@isCurrent Optional (0 or 1) Type:0|1
Set if the volume is current.