Difference between revisions of "CLI zmlocalconfig (Local Configuration)"

(<font size="3" color="#00007f" face="Arial"> ''' Description ''' </font>)
 
(14 intermediate revisions by 3 users not shown)
Line 1: Line 1:
==<font size="4" color="#00007f" face="Arial"> ''' zmlocalconfig (Local Configuration) ''' </font>==
+
{{BC|Certified}}
 +
__FORCETOC__
 +
<div class="col-md-12 ibox-content">
 +
=CLI zmlocalconfig (Local Configuration)=
 +
{{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].  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]
  
<font size="3" color="#000000" face="Arial"> This command is used to set or get the local configuration for a Zimbra server. </font>
+
=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.
 +
*[http://bugzilla.zimbra.com/show_bug.cgi?id=31510 Bug 31510] - New installs of ZCS will limit spam/ham cleanup to the first MTA installed.  '''zmlocalconfig -e zmtrainsa cleanup_host=TRUE''' can be set to allow additional hosts to run zmtrainsa --cleanup.  At least one host should have this set to true.   
 +
*[http://bugzilla.zimbra.com/show_bug.cgi?id=36598 Bug 36598] - New values have been appended to the mailboxd_java_options attribute in localconfig.  These options enable Zimbra to debug issues related to GC activites.
 +
**-verbose:gc
 +
**-XX:+PrintGCDetails
 +
**-XX:+PrintGCTimeStamps
 +
**-XX:+PrintGCApplicationStoppedTime
  
===<font size="3" color="#00007f" face="Arial"> ''' Syntax ''' </font>===
+
==zmlocalconfig==
 +
This command is used to set or get the local configuration for a zimbra server.
  
<font size="3" color="#000000" face=""Times New Roman""> '''  zmlocalconfig [options] [args]  ''' </font>
+
===Syntax===
 +
zmlocalconfig [options]
  
<font size="3" color="#000000" face="Arial"> To see the local config type </font><font size="3" color="#000000" face=""Times New Roman"">''' zmlocalconfig '''</font>
+
'''''Note:''' Execution of 'zmlocalconfig' without argument shows present Zimbra configuration parameters and values.  To see the local config, type:''
  
===<font size="3" color="#00007f" face="Arial"> ''' Description ''' </font>===
+
zmlocalconfig
  
{| border="1" cellpadding="8"
+
===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
 
|-
 
|-
| valign="middle" |
+
|style="background=white" |<nowiki>--config</nowiki>
<font size="3" color="#00007f" face="Arial"> ''' Long Name ''' </font>
+
|<nowiki>-c</nowiki>
| valign="middle" |
+
|'''<arg>''' File in which the configuration is stored
<font size="3" color="#00007f" face="Arial"> ''' Short Name''' </font>
 
| valign="middle" |
 
<font size="3" color="#00007f" face="Arial"> ''' Description ''' </font>
 
 
|-
 
|-
| valign="top" |
+
|<nowiki>--default</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> --config <arg> </font>
+
|<nowiki>-d</nowiki>
| valign="top" |
+
|Show default values for keys listed in [args]
<font size="3" color="#000000" face=""Times New Roman""> -c </font>
 
| valign="top" |
 
<font size="3" color="#000000" face="Arial"> File in which the configuration is stored.</font>
 
 
|-
 
|-
| valign="top" |
+
|<nowiki>--edit</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> --default </font>
+
|<nowiki>-e</nowiki>
| valign="top" |
+
|Edit the configuration file, change keys and values specified. The [args] is in the key=value form.
<font size="3" color="#000000" face=""Times New Roman""> -d </font>
 
| valign="top" |
 
<font size="3" color="#000000" face="Arial"> The default values for the keys listedin [args} is listed.</font>
 
 
|-
 
|-
| valign="top" |
+
|<nowiki>--force</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> --edit </font>
+
|<nowiki>-f</nowiki>
| valign="top" |
+
|Edit the keys whose change is known to be potentially dangerous
<font size="3" color="#000000" face=""Times New Roman""> -e </font>
 
| valign="top" |
 
<font size="3" color="#000000" face="Arial"> Edit the configuration file, change keys and values specified. the [args] is in the key=value form.</font>
 
 
|-
 
|-
| valign="top" |
+
|<nowiki>--help</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> --force </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""> -f </font>
 
| valign="top" |
 
<font size="3" color="#000000" face="Arial"> Edit the keys whose change is known to be potentially dangerous.</font>
 
 
|-
 
|-
| valign="top" |
+
|<nowiki>--info</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> '''  '''--help  </font>
+
|<nowiki>-i</nowiki>
| valign="top" |
+
|Shows the documentation for the keys listed in [args]
<font size="3" color="#000000" face=""Times New Roman""> '''  -h  ''' </font>
 
| valign="top" |
 
<font size="3" color="#000000" face="Arial"> Shows the help for the usage options for this tool.</font>
 
 
|-
 
|-
| valign="top" |
+
|<nowiki>--format</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> --info  </font>
+
|<nowiki>-m</nowiki>
| valign="top" |
+
|'''<arg>''' Shows the values in one of these formats: plain (default), xml, shell, nokey.
<font size="3" color="#000000" face=""Times New Roman""> '''  -i  ''' </font>
 
| valign="top" |
 
<font size="3" color="#000000" face="Arial"> Shows the documentation for the keys listed in [args].</font>
 
 
|-
 
|-
| valign="top" |
+
|<nowiki>--changed</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> '''  '''--format <arg>  </font>
+
|<nowiki>-n</nowiki>
| valign="top" |
+
|Shows the values for only those keys listed in the [args] that have been changed from their defaults
<font size="3" color="#000000" face=""Times New Roman""> '''  -m  ''' </font>
 
| valign="top" |
 
<font size="3" color="#000000" face="Arial"> Shows the values in one of these formats: plain (default), xml, shell, nokey.</font>
 
 
|-
 
|-
| valign="top" |
+
|<nowiki>--path</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> --changed </font>
+
|<nowiki>-p</nowiki>
| valign="top" |
+
|Shows which configuration file will be used
<font size="3" color="#000000" face=""Times New Roman""> -n </font>
 
| valign="top" |
 
<font size="3" color="#000000" face="Arial"> Shows the values for only those keys listed in the [args] that have been changed from their defaults.</font>
 
 
|-
 
|-
| valign="top" |
+
|<nowiki>--quiet</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> --path </font>
+
|<nowiki>-q</nowiki>
| valign="top" |
+
|Suppress logging
<font size="3" color="#000000" face=""Times New Roman""> -p </font>
 
| valign="top" |
 
<font size="3" color="#000000" face="Arial"> Shows which configuration file will be used.</font>
 
 
|-
 
|-
| valign="top" |
+
|<nowiki>--random</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> --random </font>
+
|<nowiki>-r</nowiki>
| valign="top" |
+
|This option is used with the edit option. Specified key is set to a random password string.
<font size="3" color="#000000" face=""Times New Roman""> -r </font>
 
| valign="top" |
 
<font size="3" color="#000000" face="Arial"> This option is used with the edit option. Specified key is set to a random password string.</font>
 
 
|-
 
|-
| valign="top" |
+
|<nowiki>--show</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> --show </font>
+
|<nowiki>-s</nowiki>
| valign="top" |
+
|Forces the display of the password strings
<font size="3" color="#000000" face=""Times New Roman""> -s </font>
 
| valign="top" |
 
<font size="3" color="#000000" face="Arial"> Forces the display of the password strings.</font>
 
 
|-
 
|-
| valign="top" |
+
|<nowiki>--unset</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> --expand </font>
+
|<nowiki>-u</nowiki>
| valign="top" |
+
|Remove a configuration key. If this is a key with compiled-in defaults, set its value to the empty string.
<font size="3" color="#000000" face=""Times New Roman""> -x </font>
+
|-
| valign="top" |
+
|<nowiki>--expand</nowiki>
<font size="3" color="#000000" face="Arial"> Expand values. </font>
+
|<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=
 +
*[[:Category:Configuration]]
 +
*[[Configuring Thread Stack Size]]
 +
*[[OpenLDAP Performance Tuning 6.0]]
 +
*[[Tuning Postfix Queue Settings]]
 +
*[[Change_OpenLDAP_slapd_Logging| Change OpenLDAP slapd Logging 5.0 & 4.5]]
 +
*[[Promoting Replica to LDAP Master 6.0]]
 +
*[[Promoting Replica to LDAP Master| Promoting Replica to LDAP Master 5.0 and prior]]
 +
 +
 +
{{Article Footer|ZCS 6.0.x|5/3/2006}}
 +
 +
[[Category:Command Line Interface]]
 +
[[Category:ZCS 7.0]]
 +
[[Category:ZCS 6.0]]

Latest revision as of 16:01, 11 July 2015

CLI zmlocalconfig (Local Configuration)

   KB 1493        Last updated on 2015-07-11  




0.00
(0 votes)

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.
  • Bug 31510 - New installs of ZCS will limit spam/ham cleanup to the first MTA installed. zmlocalconfig -e zmtrainsa cleanup_host=TRUE can be set to allow additional hosts to run zmtrainsa --cleanup. At least one host should have this set to true.
  • Bug 36598 - New values have been appended to the mailboxd_java_options attribute in localconfig. These options enable Zimbra to debug issues related to GC activites.
    • -verbose:gc
    • -XX:+PrintGCDetails
    • -XX:+PrintGCTimeStamps
    • -XX:+PrintGCApplicationStoppedTime

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
--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 4.5

Related Articles


Verified Against: ZCS 6.0.x Date Created: 5/3/2006
Article ID: https://wiki.zimbra.com/index.php?title=CLI_zmlocalconfig_(Local_Configuration) Date Modified: 2015-07-11



Try Zimbra

Try Zimbra Collaboration with a 60-day free trial.
Get it now »

Want to get involved?

You can contribute in the Community, Wiki, Code, or development of Zimlets.
Find out more. »

Looking for a Video?

Visit our YouTube channel to get the latest webinars, technology news, product overviews, and so much more.
Go to the YouTube channel »

Jump to: navigation, search