CLI zmlocalconfig (Local Configuration): Difference between revisions
m (CLI zmlocalconfig (Local Configuration moved to CLI zmlocalconfig (Local Configuration): Fixing title) |
(Updating content to ZCS 6.0... changes not complete, still need to add related articles...) |
||
Line 1: | Line 1: | ||
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]. For the most recent commonly configured settings, see [http://www.zimbra.com/docs/ne/latest/administration_guide/zmlocalconfig.html ZCS Administrator's Guide Network Edition > Appendix C The zmlocalconfig Settings] | |||
=ZCS 6.0.x= | |||
*[http://bugzilla.zimbra.com/show_bug.cgi?id=25456 Bug 25456] - Beginning in ZCS 6.0, zmcluctl now supports hardware only failover with Redhat Cluster Manager. CLI is zmlocalconfig – e zimbra_cluster_mode=hardware. | |||
*[http://bugzilla.zimbra.com/show_bug.cgi?id=31413 Bug 31413] - Beginning in ZCS 6.0, you can now change the default MTA value for the bounce_queue_lifetime parameter through zmlocalconfig. The default is 5-day bounce lifetime. | |||
== | ==zmlocalconfig== | ||
This command is used to set or get the local configuration for a zimbra server. | |||
===Syntax=== | |||
zmlocalconfig [options] | |||
'''''Note:''' Execution of 'zmlocalconfig' without argument shows present Zimbra configuration parameters and values. To see the local config, type:'' | |||
zmlocalconfig | |||
{| border="1" cellpadding=" | ===Description=== | ||
| | {|style="width:100%" border="1" cellpadding="5" cellspacing="0" | ||
! align="left" bgcolor="tan" |Long Name | |||
! align="left" bgcolor="tan" |Short Name | |||
! align="left" bgcolor="tan"|Description | |||
|- | |- | ||
| | |style="background=white" |<nowiki>--config</nowiki> | ||
< | |<nowiki>-c</nowiki> | ||
| | |'''<arg>''' File in which the configuration is stored | ||
< | |||
| | |||
|- | |- | ||
| | |<nowiki>--default</nowiki> | ||
< | |<nowiki>-d</nowiki> | ||
| | |Show default values for keys listed in [args] | ||
< | |||
| | |||
|- | |- | ||
| | |<nowiki>--edit</nowiki> | ||
< | |<nowiki>-e</nowiki> | ||
| | |Edit the configuration file, change keys and values specified. The [args] is in the key=value form. | ||
< | |||
| | |||
|- | |- | ||
| | |<nowiki>--force</nowiki> | ||
< | |<nowiki>-f</nowiki> | ||
| | |Edit the keys whose change is known to be potentially dangerous | ||
< | |||
| | |||
|- | |- | ||
| | |<nowiki>--help</nowiki> | ||
< | |<nowiki>-h</nowiki> | ||
| | |Shows the help for the usage options for this tool | ||
< | |||
| | |||
|- | |- | ||
| | |<nowiki>--help</nowiki> | ||
< | |<nowiki>-h</nowiki> | ||
| | |Displays the usage options for this command | ||
< | |||
| | |||
|- | |- | ||
| | |<nowiki>--info</nowiki> | ||
< | |<nowiki>-i</nowiki> | ||
| | |Shows the documentation for the keys listed in [args] | ||
< | |||
| | |||
|- | |- | ||
| | |<nowiki>--format</nowiki> | ||
< | |<nowiki>-m</nowiki> | ||
| | |'''<arg>''' Shows the values in one of these formats: plain (default), xml, shell, nokey. | ||
< | |||
| | |||
< | |||
|- | |- | ||
| | |<nowiki>--changed</nowiki> | ||
< | |<nowiki>-n</nowiki> | ||
| | |Shows the values for only those keys listed in the [args] that have been changed from their defaults | ||
< | |||
| | |||
|- | |- | ||
| | |<nowiki>--path</nowiki> | ||
< | |<nowiki>-p</nowiki> | ||
| | |Shows which configuration file will be used | ||
< | |||
| | |||
|- | |- | ||
| | |<nowiki>--quiet</nowiki> | ||
< | |<nowiki>-q</nowiki> | ||
| | |Suppress logging | ||
< | |||
| | |||
|- | |- | ||
| | |<nowiki>--random</nowiki> | ||
< | |<nowiki>-r</nowiki> | ||
| | |This option is used with the edit option. Specified key is set to a random password string. | ||
< | |||
| | |||
|- | |- | ||
| | |<nowiki>--show</nowiki> | ||
< | |<nowiki>-s</nowiki> | ||
| | |Forces the display of the password strings | ||
< | |- | ||
| | |<nowiki>--unset</nowiki> | ||
< | |<nowiki>-u</nowiki> | ||
|Remove a configuration key. If this is a key with compiled-in defaults, set its value to the empty string. | |||
|- | |||
|<nowiki>--expand</nowiki> | |||
|<nowiki>-x</nowiki> | |||
|Expand values | |||
|} | |} | ||
===Examples=== | |||
For examples of zmlocalconfig, see [http://www.zimbra.com/docs/ne/latest/administration_guide/zmlocalconfig.html ZCS Administrator's Guide Network Edition > Appendix C The zmlocalconfig Settings]. | |||
=ZCS 5.0= | |||
*[http://www.zimbra.com/docs/ne/5.0.19/administration_guide/A_app-command-line.18.21.html ZCS Administrator's Guide Network Edition 5.0 > Appendix A Command-Line Utilities > zmlocalconfig] | |||
*[http://www.zimbra.com/docs/ne/5.0.19/administration_guide/zmlocalconfig.20.1.html ZCS Administrator's Guide Network Edition 5.0 > Appendix C The zmlocalconfig Settings] | |||
=ZCS 4.5= | |||
*[http://www.zimbra.com/docs/ne/4.5.10/administration_guide/A_app-command-line.14.16.html#1169017 ZCS Administrator's Guide Network Edition 4.5 > Appendix A Command-Line Utilities > zmlocalconfig] | |||
=Related Articles= | |||
{{Article Footer|ZCS 6.0.x|5/3/2006}} | |||
[[Category:Command Line Interface]] | [[Category:Command Line Interface]] | ||
[[Category:ZCS 6.0]] | |||
[[Category:ZCS 5.0]] | |||
[[Category:ZCS 4.5]] |
Revision as of 23:26, 8 December 2009
For the most recent information on this CLI, including syntax and description, see ZCS Administrator's Guide Network Edition > Appendix A Command-Line Utilities. For the most recent commonly configured settings, see ZCS Administrator's Guide Network Edition > Appendix C The zmlocalconfig Settings
ZCS 6.0.x
- Bug 25456 - Beginning in ZCS 6.0, zmcluctl now supports hardware only failover with Redhat Cluster Manager. CLI is zmlocalconfig – e zimbra_cluster_mode=hardware.
- Bug 31413 - Beginning in ZCS 6.0, you can now change the default MTA value for the bounce_queue_lifetime parameter through zmlocalconfig. The default is 5-day bounce lifetime.
zmlocalconfig
This command is used to set or get the local configuration for a zimbra server.
Syntax
zmlocalconfig [options]
Note: Execution of 'zmlocalconfig' without argument shows present Zimbra configuration parameters and values. To see the local config, type:
zmlocalconfig
Description
Long Name | Short Name | Description |
---|---|---|
--config | -c | <arg> File in which the configuration is stored |
--default | -d | Show default values for keys listed in [args] |
--edit | -e | Edit the configuration file, change keys and values specified. The [args] is in the key=value form. |
--force | -f | Edit the keys whose change is known to be potentially dangerous |
--help | -h | Shows the help for the usage options for this tool |
--help | -h | Displays the usage options for this command |
--info | -i | Shows the documentation for the keys listed in [args] |
--format | -m | <arg> Shows the values in one of these formats: plain (default), xml, shell, nokey. |
--changed | -n | Shows the values for only those keys listed in the [args] that have been changed from their defaults |
--path | -p | Shows which configuration file will be used |
--quiet | -q | Suppress logging |
--random | -r | This option is used with the edit option. Specified key is set to a random password string. |
--show | -s | Forces the display of the password strings |
--unset | -u | Remove a configuration key. If this is a key with compiled-in defaults, set its value to the empty string. |
--expand | -x | Expand values |
Examples
For examples of zmlocalconfig, see ZCS Administrator's Guide Network Edition > Appendix C The zmlocalconfig Settings.
ZCS 5.0
- ZCS Administrator's Guide Network Edition 5.0 > Appendix A Command-Line Utilities > zmlocalconfig
- ZCS Administrator's Guide Network Edition 5.0 > Appendix C The zmlocalconfig Settings
ZCS 4.5
Related Articles