CLI zmzimletctl: Difference between revisions
(Adding category) |
(Updating content to ZCS 6.0) |
||
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]. | |||
=ZCS 6.0.x= | |||
==zmzimletctl== | |||
This command is used to manage Zimlets and to list all zimlets on the server. See [http://www.zimbra.com/docs/ne/latest/administration_guide/Zimlets.15.1.html#1037203 Working with Zimlets]. Most Zimlet deployment can be competed from the Zimbra administration console. | |||
== | ===Syntax=== | ||
zmzimletctl {-l} {command} <zimlet.zip|config.xml|zimlet> | |||
===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>deploy</nowiki> | ||
< | |<nowiki></nowiki> | ||
| | |'''<zimlet.zip>''' Creates the Zimlet entry in the LDAP server, installs the zimlet files on the Server, grants, access to the members of the default COS, and turns on the Zimlet | ||
< | |||
|- | |- | ||
| | |style="background=white" |<nowiki>undeploy</nowiki> | ||
< | |<nowiki></nowiki> | ||
| | |'''<zimlet>''' Uninstall a zimlet from the zimbra server | ||
| | |||
< | |||
|- | |- | ||
| | |style="background=white" |<nowiki>install</nowiki> | ||
< | |<nowiki></nowiki> | ||
| | |'''<zimlet.zip>''' Installs the Zimlet files on the host | ||
| | |||
< | |||
|- | |- | ||
| | |style="background=white" |<nowiki>ldapDeploy</nowiki> | ||
< | |<nowiki></nowiki> | ||
| | |'''<zimlet>''' Adds the Zimlet entry to the LDAP | ||
| | |||
< | |||
|- | |- | ||
| | |style="background=white" |<nowiki>enable</nowiki> | ||
< | |<nowiki></nowiki> | ||
| | |'''<zimlet>''' Enables the Zimlet | ||
| | |||
< | |||
|- | |- | ||
| | |style="background=white" |<nowiki>disable</nowiki> | ||
< | |<nowiki></nowiki> | ||
| | |'''<zimlet>''' Disables the Zimlet | ||
| | |||
< | |||
|- | |- | ||
| | |style="background=white" |<nowiki>acl</nowiki> | ||
< | |<nowiki></nowiki> | ||
| | |'''<zimlet> <cos1> {grant<nowiki>|</nowiki>deny} [<cos2> {grant<nowiki>|</nowiki>deny}...]''' Sets the access control, grant|deny, to a COS | ||
| | |||
< | |||
|- | |- | ||
| | |style="background=white" |<nowiki>listAcls</nowiki> | ||
< | |<nowiki></nowiki> | ||
| | |'''<zimlet>''' Lists the ACLs for the Zimlets | ||
| | |||
< | |||
|- | |- | ||
| | |style="background=white" |<nowiki>listZimlets</nowiki> | ||
< | |<nowiki></nowiki> | ||
| | |View details about all Zimlets on the server | ||
| | |||
|- | |- | ||
| | |style="background=white" |<nowiki>getConfigTemplate</nowiki> | ||
< | |<nowiki></nowiki> | ||
| | |'''<zimlet.zip>''' Extracts the configuration template from the Zimlet.zip file | ||
| | |||
< | |||
|- | |- | ||
| | |style="background=white" |<nowiki>configure</nowiki> | ||
< | |<nowiki></nowiki> | ||
| | |'''<config.xml>''' Installs the configuration | ||
| | |||
< | |||
|- | |- | ||
| | |style="background=white" |<nowiki>listPriority</nowiki> | ||
< | |<nowiki></nowiki> | ||
| | |Shows the current Zimlet priorities (0 is high, 9 is low) | ||
| | |||
|- | |- | ||
| | |style="background=white" |<nowiki>setPriority</nowiki> | ||
< | |<nowiki></nowiki> | ||
| | |'''<zimlet>''' Sets the Zimlet priority | ||
| | |||
< | |||
|} | |} | ||
=ZCS 5.0.x= | |||
*[http://www.zimbra.com/docs/ne/5.0.19/administration_guide/A_app-command-line.18.43.html#1077532 ZCS Administrator's Guide Network Edition 5.0 > Appendix A Command-Line Utilities > zmzimletctl] | |||
=ZCS 4.5.x= | |||
*[http://www.zimbra.com/docs/ne/4.5.10/administration_guide/A_app-command-line.14.26.html#1077532 ZCS Administrator's Guide Network Edition 4.5 > Appendix A Command-Line Utilities > zmzimletctl] | |||
=Related Articles= | |||
*[[:Category:Zimlets]] | |||
*[[ZCS_6.0:Zimlet_Developers_Guide:Introduction Zimlet Developer's Guide for ZCS 6.0]] | |||
{{Article Footer|ZCS 6.0.x|5/3/2006}} | |||
[[Category:Command Line Interface]] | [[Category:Command Line Interface]] | ||
[[Category:Zimlets]] | |||
[[Category:ZCS 6.0]] | |||
[[Category:ZCS 5.0]] | |||
[[Category:ZCS 4.5]] |
Revision as of 21:27, 19 January 2010
For the most recent information on this CLI, including syntax and description, see ZCS Administrator's Guide Network Edition > Appendix A Command-Line Utilities.
ZCS 6.0.x
zmzimletctl
This command is used to manage Zimlets and to list all zimlets on the server. See Working with Zimlets. Most Zimlet deployment can be competed from the Zimbra administration console.
Syntax
zmzimletctl {-l} {command} <zimlet.zip|config.xml|zimlet>
Description
Long Name | Short Name | Description |
---|---|---|
deploy | <zimlet.zip> Creates the Zimlet entry in the LDAP server, installs the zimlet files on the Server, grants, access to the members of the default COS, and turns on the Zimlet | |
undeploy | <zimlet> Uninstall a zimlet from the zimbra server | |
install | <zimlet.zip> Installs the Zimlet files on the host | |
ldapDeploy | <zimlet> Adds the Zimlet entry to the LDAP | |
enable | <zimlet> Enables the Zimlet | |
disable | <zimlet> Disables the Zimlet | |
acl | deny, to a COS | |
listAcls | <zimlet> Lists the ACLs for the Zimlets | |
listZimlets | View details about all Zimlets on the server | |
getConfigTemplate | <zimlet.zip> Extracts the configuration template from the Zimlet.zip file | |
configure | <config.xml> Installs the configuration | |
listPriority | Shows the current Zimlet priorities (0 is high, 9 is low) | |
setPriority | <zimlet> Sets the Zimlet priority |
ZCS 5.0.x
ZCS 4.5.x
Related Articles