|
|
(11 intermediate revisions by 6 users not shown) |
Line 1: |
Line 1: |
| ==<font size="4" color="#00007f" face="Arial"> ''' zmvolume ''' </font>==
| | {{BC|Certified}} |
| | __FORCETOC__ |
| | <div class="col-md-12 ibox-content"> |
| | =CLI zmvolume= |
| | {{KB|{{ZC}}|{{ZCS 7.0}}|{{ZCS 6.0}}|}} |
| | {{Archive}}{{WIP}} |
| | For the most recent information on this CLI, including syntax and description, see [http://www.zimbra.com/docs/ne/latest/administration_guide/A_app-command-line.20.1.html ZCS Administrator's Guide Network Edition > Appendix A Command-Line Utilities]. |
|
| |
|
| <font size="3" color="#000000" face="Arial"> This command can be used to manage storage volumes from the CLI. Volumes can be easily managed from the administration console, Server, Volume tab.</font>
| | =ZCS 6.0.x= |
| | ==zmvolume== |
| | This command can be used to manage storage volumes from the CLI. Volumes can be easily managed from the administration console, Server, Volume tab. |
|
| |
|
| ===<font size="3" color="#00007f" face="Arial"> ''' Syntax ''' </font>=== | | ===Syntax=== |
| | zmvolume {-a|-d|-l|-e|-dc|-sc} [options] |
|
| |
|
| <font size="3" color="#000000" face=""Times New Roman""> ''' <font size="3" color="#000000" face=""Times New Roman""> '''zmvolume --add --name <message volume> --type <primaryMessage> --path /<data/''' </font> <font size="3" color="#000000" face=""Times New Roman""> '''msgvol>''' </font> ''' </font>
| | ===Description=== |
| | | {|style="width:100%" border="1" cellpadding="5" cellspacing="0" |
| ===<font size="3" color="#00007f" face="Arial"> ''' Description ''' </font>===
| | ! align="left" bgcolor="tan" |Long Name |
| | | ! align="left" bgcolor="tan" |Short Name |
| <div align="right">
| | ! align="left" bgcolor="tan"|Description |
| | |
| {| border="1" cellpadding="8"
| |
| |+ | |
| |- | | |- |
| | valign="middle" | | | |style="background=white" |<nowiki>--add</nowiki> |
| <font size="3" color="#00007f" face="Arial"> ''' Long Name ''' </font>
| | |<nowiki>-a</nowiki> |
| | valign="middle" |
| | |Adds a volume |
| <font size="3" color="#00007f" face="Arial"> ''' Long Name Second Attribute''' </font> | |
| | valign="middle" | | |
| <font size="3" color="#00007f" face="Arial"> ''' Short Name''' </font> | |
| | valign="middle" | | |
| <font size="3" color="#00007f" face="Arial"> ''' Description ''' </font>
| |
| |- | | |- |
| | valign="top" | | | |style="background=white" |<nowiki>--compress</nowiki> |
| <font size="3" color="#000000" face=""Times New Roman""> ''' <font size="3" color="#000000" face=""Times New Roman""> '''--add''' </font> ''' </font>
| | |<nowiki>-c</nowiki> |
| | valign="top" | | | |'''<arg>''' Compress BLOBs; “true” or “false” |
| <font size="3" color="#000000" face=""Times New Roman""> ''' '''</font> | |
| | valign="top" | | |
| <font size="3" color="#000000" face=""Times New Roman""> ''' <font size="3" color="#000000" face=""Times New Roman""> '''-a''' </font> ''' </font>
| |
| | valign="top" |
| |
| <font size="3" color="#000000" face="Arial"> Adds a volume </font>
| |
| |- | | |- |
| | valign="top" | | | |style="background=white" |<nowiki>--compressionThreshold</nowiki> |
| <font size="3" color="#000000" face=""Times New Roman""> </font>
| | |<nowiki>-ct</nowiki> |
| | valign="top" |
| | |Compression threshold; default 4KB |
| <font size="3" color="#000000" face=""Times New Roman""> ''' <font size="3" color="#000000" face=""Times New Roman""> '''--name <arg>''' </font> ''' </font>
| |
| | valign="top" | | |
| <font size="3" color="#000000" face=""Times New Roman""> ''' <font size="3" color="#000000" face=""Times New Roman""> '''-n''' </font> ''' </font> | |
| | valign="top" | | |
| <font size="3" color="#000000" face="Arial"> Volume name </font>
| |
| |- | | |- |
| | valign="top" | | | |style="background=white" |<nowiki>--delete</nowiki> |
| <font size="3" color="#000000" face=""Times New Roman""> ''' '''</font>
| | |<nowiki>-d</nowiki> |
| | | |Deletes a volume |
| <div> </div>
| |
| | valign="top" | | |
| <font size="3" color="#000000" face=""Times New Roman""> ''' <font size="3" color="#000000" face=""Times New Roman""> '''--type <arg>''' </font> ''' </font> | |
| | valign="top" | | |
| <font size="3" color="#000000" face=""Times New Roman""> ''' <font size="3" color="#000000" face=""Times New Roman""> '''-t''' </font> ''' </font> | |
| | valign="top" | | |
| <font size="3" color="#000000" face="Arial"> Type of volume, primaryMessage, secondaryMessage, or index. SecondaryMessage is used only when the Network Edition, HSM feature is enabled.</font>
| |
| |- | | |- |
| | valign="top" | | | |style="background=white" |<nowiki>--displayCurrent</nowiki> |
| | valign="top" |
| | |<nowiki>-dc</nowiki> |
| <font size="3" color="#000000" face=""Times New Roman""> ''' <font size="3" color="#000000" face=""Times New Roman""> '''--path <arg>''' </font> ''' </font> | | |Displays the current volume |
| | valign="top" | | |
| <font size="3" color="#000000" face=""Times New Roman""> ''' <font size="3" color="#000000" face=""Times New Roman""> '''-p''' </font> ''' </font>
| |
| | valign="top" | | |
| <font size="3" color="#000000" face="Arial"> File system root path of the volume</font>
| |
| |- | | |- |
| | valign="top" | <font size="3" color="#000000" face=""Times New Roman""> </font> | | |style="background=white" |<nowiki>--edit</nowiki> |
| | valign="top" | | | |<nowiki>-e</nowiki> |
| <font size="3" color="#000000" face=""Times New Roman""> ''' <font size="3" color="#000000" face=""Times New Roman""> '''--compress ''' </font> <font size="3" color="#000000" face=""Times New Roman""> '''<arg>''' </font> ''' </font> | | |Edits a volume |
| | |
| <font size="3" color="#000000" face=""Times New Roman""> ''' '''</font>
| |
| | |
| <div> </div>
| |
| | valign="top" | | |
| <font size="3" color="#000000" face=""Times New Roman""> ''' <font size="3" color="#000000" face=""Times New Roman""> '''-c''' </font> ''' </font> | |
| | valign="top" | | |
| <font size="3" color="#000000" face="Arial"> Compress blobs, “true” or “false”. The default is “false.” <br />True means that message blobs whose size are above the compression threshold are compressed.</font>
| |
| |- | | |- |
| | valign="top" | | | |style="background=white" |<nowiki>--help</nowiki> |
| <font size="3" color="#000000" face=""Times New Roman""> ''' ''' </font>
| | |<nowiki>-h</nowiki> |
| | valign="top" |
| | |Shows the help for the usage options for this tool. |
| <font size="3" color="#000000" face=""Times New Roman""> ''' <font size="3" color="#000000" face=""Times New Roman""> '''--''' </font> <font size="3" color="#000000" face=""Times New Roman""> '''compressionThre''' </font> <font size="3" color="#000000" face=""Times New Roman""> '''shold <arg>''' </font> ''' </font>
| |
| | valign="top" | | |
| <font size="3" color="#000000" face=""Times New Roman""> ''' <font size="3" color="#000000" face=""Times New Roman""> '''-ct''' </font> ''' </font> | |
| | valign="top" | | |
| <font size="3" color="#000000" face="Arial"> Compression threshold size is specified in bytes. The default is 4KB</font>
| |
| |- | | |- |
| | valign="top" | | | |style="background=white" |<nowiki>--id</nowiki> |
| <font size="3" color="#000000" face=""Times New Roman""> ''' --edit ''' </font> | | |<nowiki>-id</nowiki> |
| | valign="top" | | | |'''<arg>''' Volume ID |
| <font size="3" color="#000000" face=""Times New Roman""> ''' '''</font> | |
| | |
| <div> </div>
| |
| | valign="top" | | |
| <font size="3" color="#000000" face=""Times New Roman""> ''' -e ''' </font>
| |
| | valign="top" |
| |
| <font size="3" color="#000000" face="Arial"> Edits a volume. Any of the options listed under <font size="3" color="#000000" face=""Times New Roman"">'''--add'''</font> can also be specified to have its volume modified.</font>
| |
| |- | | |- |
| | valign="top" | | | |style="background=white" |<nowiki>--list</nowiki> |
| <font size="3" color="#000000" face=""Times New Roman""> ''' ''' </font>
| | |<nowiki>-l</nowiki> |
| | valign="top" |
| | |Lists volumes |
| <font size="3" color="#000000" face=""Times New Roman""> ''' --id <arg> ''' </font> | |
| | valign="top" | | |
| <font size="3" color="#000000" face=""Times New Roman""> ''' -id ''' </font> | |
| | valign="top" | | |
| <font size="3" color="#000000" face="Arial"> Volume ID </font>
| |
| |- | | |- |
| | valign="top" | | | |style="background=white" |<nowiki>--name</nowiki> |
| <font size="3" color="#000000" face=""Times New Roman""> ''' --delete ''' </font> | | |<nowiki>-n</nowiki> |
| | valign="top" | | | |'''<arg>''' Volume name |
| <font size="3" color="#000000" face=""Times New Roman""> </font> | |
| | valign="top" | | |
| <font size="3" color="#000000" face=""Times New Roman""> ''' -d ''' </font>
| |
| | valign="top" |
| |
| <font size="3" color="#000000" face="Arial"> Deletes a volume </font>
| |
| |- | | |- |
| | valign="top" | | | |style="background=white" |<nowiki>--path</nowiki> |
| | valign="top" |
| | |<nowiki>-p</nowiki> |
| <font size="3" color="#000000" face=""Times New Roman""> ''' --id <arg> ''' </font> | | |'''<arg>''' Root path |
| | valign="top" | | |
| <font size="3" color="#000000" face=""Times New Roman""> ''' -id ''' </font> | |
| | valign="top" | | |
| <font size="3" color="#000000" face="Arial"> Volume ID </font> | |
| |- | | |- |
| | valign="top" | | | |style="background=white" |<nowiki>--server</nowiki> |
| <font size="3" color="#000000" face=""Times New Roman""> ''' --list ''' </font> | | |<nowiki>-s</nowiki> |
| | valign="top" | | | |'''<arg>''' Mail server hostname. Default is localhost. |
| <font size="3" color="#000000" face=""Times New Roman""> </font> | |
| | valign="top" | | |
| <font size="3" color="#000000" face=""Times New Roman""> ''' -l ''' </font>
| |
| | valign="top" |
| |
| <font size="3" color="#000000" face="Arial"> Lists volumes </font>
| |
| |- | | |- |
| | valign="top" | <font size="3" color="#000000" face=""Times New Roman""> </font> | | |style="background=white" |<nowiki>--setCurrent</nowiki> |
| | valign="top" | | | |<nowiki>-sc</nowiki> |
| <font size="3" color="#000000" face=""Times New Roman""> ''' --id <arg> ''' </font> | | |Sets the current volume |
| | valign="top" | | |
| <font size="3" color="#000000" face=""Times New Roman""> ''' -id ''' </font> | |
| | valign="top" | | |
| <font size="3" color="#000000" face="Arial"> ID is optional. If it is specified, just that volume is listed. If not, all volumes are displayed.</font>
| |
| |- | | |- |
| | valign="top" | | | |style="background=white" |<nowiki>--type</nowiki> |
| <font size="3" color="#000000" face=""Times New Roman""> ''' --displayCurrent ''' </font> | | |<nowiki>-t</nowiki> |
| | valign="top" | <font size="3" color="#000000" face=""Times New Roman""> </font>
| | |'''<arg>''' Volume type (primaryMessage, secondaryMessage, or index) |
| | valign="top" | | |
| <font size="3" color="#000000" face=""Times New Roman""> ''' -dc ''' </font>
| |
| | valign="top" |
| |
| <font size="3" color="#000000" face="Arial"> Displays the current volumes </font>
| |
| |- | | |- |
| | valign="top" | | | |style="background=white" |<nowiki>--turnOffSecondary</nowiki> |
| <font size="3" color="#000000" face=""Times New Roman""> ''' --setCurrent ''' </font> | | |<nowiki>-ts</nowiki> |
| | valign="top" | | | |Turns off the current secondary message volume |
| <font size="3" color="#000000" face=""Times New Roman""> </font> | | |} |
| | valign="top" |
| | |
| <font size="3" color="#000000" face=""Times New Roman""> ''' -sc ''' </font>
| | =ZCS 5.0.x= |
| | valign="top" | | | *[http://www.zimbra.com/docs/ne/5.0.19/administration_guide/A_app-command-line.18.42.html#1237216 ZCS Administrator's Guide Network Edition 5.0 > Appendix A Command-Line Utilities > zmvolume] |
| <font size="3" color="#000000" face="Arial"> Sets the volume specified by --id to be the current volume of its volume type.</font>
| | |
| |- | | =ZCS 4.5.x= |
| | valign="top" |
| | *[http://www.zimbra.com/docs/ne/4.5.10/administration_guide/A_app-command-line.14.25.html#1077990 ZCS Administrator's Guide Network Edition 4.5 > Appendix A Command-Line Utilities > zmvolume] |
| <font size="3" color="#000000" face=""Times New Roman"">'''''' </font>
| | |
| | valign="top" |
| | |
| <font size="3" color="#000000" face=""Times New Roman""> ''' --id <arg> ''' </font>
| |
| | valign="top" |
| |
| <font size="3" color="#000000" face=""Times New Roman""> ''' -id ''' </font>
| |
| | valign="top" |
| |
| <font size="3" color="#000000" face="Arial"> Volume ID </font>
| |
| |-
| |
| | valign="top" |
| |
| <font size="3" color="#000000" face=""Times New Roman""> ''' --turnOffSecondary''' </font>
| |
| | valign="top" |
| |
| <font size="3" color="#000000" face=""Times New Roman""> ''' '''</font>
| |
|
| |
|
| <div> </div>
| | {{Article Footer|Zimbra Collaboration 7.0, 6.0|5/3/2006}} |
| | valign="top" | | |
| <font size="3" color="#000000" face=""Times New Roman""> ''' -ts ''' </font>
| |
| | valign="top" |
| |
| <font size="3" color="#000000" face="Arial"> Turns off the current secondary message volume. After this command completes, no current secondary volume is enabled.</font>
| |
| |}
| |
|
| |
|
| </div>
| | [[Category:Command Line Interface]] |
| | [[Category:ZCS 7.0]] |
| | [[Category:ZCS 6.0]] |