Difference between revisions of "CLI zmzimletctl"

 
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
==<font size="4" color="#00007f" face="Arial"> ''' zmzimletctl ''' </font>==
+
{{BC|Certified}}
 +
__FORCETOC__
 +
<div class="col-md-12 ibox-content">
 +
=CLI zmzimletctl=
 +
{{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 is used to deploy Zimlets to users. See Zimlets, Setting Up.</font>
+
=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.
  
==<font size="3" color="#00007f" face="Arial"> ''' Syntax ''' </font>==
+
===Syntax===
 +
zmzimletctl {-l} {command} <zimlet.zip|config.xml|zimlet>
  
<font size="3" color="#000000" face="Arial">  <font size="3" color="#000000" face=""Times New Roman""> '''zmzimletctl {command} <zimletname> <arg>''' </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
{| border="1" cellpadding="8"
+
! align="left" bgcolor="tan"|Description
|+
 
 
|-
 
|-
| valign="middle" |
+
|style="background=white" |<nowiki>deploy</nowiki>
<font size="3" color="#00007f" face="Arial"> ''' Long Name ''' </font>
+
|<nowiki></nowiki>
| valign="middle" |
+
|'''<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
<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>undeploy</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> deploy <zimletname></font>
+
|<nowiki></nowiki>
| valign="top" |
+
|'''<zimlet>''' Uninstall a zimlet from the zimbra server
| valign="top" |
 
<font size="3" color="#000000" face="Arial"> 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</font>
 
 
|-
 
|-
| valign="top" |
+
|style="background=white" |<nowiki>install</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> undeploy </font>
+
|<nowiki></nowiki>
| valign="top" |
+
|'''<zimlet.zip>''' Installs the Zimlet files on the host
| valign="top" |
 
<font size="3" color="#000000" face="Arial"> Uninstall a zimlet from the Zimbra server</font>
 
 
|-
 
|-
| valign="top" |
+
|style="background=white" |<nowiki>ldapDeploy</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> install </font>
+
|<nowiki></nowiki>
| valign="top" |
+
|'''<zimlet>''' Adds the Zimlet entry to the LDAP
| valign="top" |
 
<font size="3" color="#000000" face="Arial"> Installs the Zimlet files on the host </font>
 
 
|-
 
|-
| valign="top" |
+
|style="background=white" |<nowiki>enable</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> ldapDeploy </font>
+
|<nowiki></nowiki>
| valign="top" |
+
|'''<zimlet>''' Enables the Zimlet
| valign="top" |
 
<font size="3" color="#000000" face="Arial"> Adds the Zimlet entry to the LDAP </font>
 
 
|-
 
|-
| valign="top" |
+
|style="background=white" |<nowiki>disable</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> acl </font>
+
|<nowiki></nowiki>
| valign="top" |
+
|'''<zimlet>''' Disables the Zimlet
| valign="top" |
 
<font size="3" color="#000000" face="Arial"> Sets the access control, grand|deny, to a COS</font>
 
 
|-
 
|-
| valign="top" |
+
|style="background=white" |<nowiki>acl</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> enable </font>
+
|<nowiki></nowiki>
| valign="top" |
+
|'''<zimlet> <cos1> {grant<nowiki>|</nowiki>deny} [<cos2> {grant<nowiki>|</nowiki>deny}...]''' Sets the access control, grant|deny, to a COS
| valign="top" |
 
<font size="3" color="#000000" face="Arial"> Enables the Zimlet </font>
 
 
|-
 
|-
| valign="top" |
+
|style="background=white" |<nowiki>listAcls</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> disable </font>
+
|<nowiki></nowiki>
| valign="top" |
+
|'''<zimlet>''' Lists the ACLs for the Zimlets
| valign="top" |
 
<font size="3" color="#000000" face="Arial"> Disables the Zimlet. </font>
 
 
|-
 
|-
| valign="top" |
+
|style="background=white" |<nowiki>listZimlets</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> listAcls </font>
+
|<nowiki></nowiki>
| valign="top" |
+
|View details about all Zimlets on the server
| valign="top" |
 
<font size="3" color="#000000" face="Arial"> Lists the ACLs for the Zimlets </font>
 
 
|-
 
|-
| valign="top" |
+
|style="background=white" |<nowiki>getConfigTemplate</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> listZimlets </font>
+
|<nowiki></nowiki>
| valign="top" |
+
|'''<zimlet.zip>''' Extracts the configuration template from the Zimlet.zip file
| valign="top" |
 
<font size="3" color="#000000" face="Arial"> Shows the status of all the Zimlets on the server</font>
 
 
|-
 
|-
| valign="top" |
+
|style="background=white" |<nowiki>configure</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> getConfigTemplate </font>
+
|<nowiki></nowiki>
| valign="top" |
+
|'''<config.xml>''' Installs the configuration
| valign="top" |
 
<font size="3" color="#000000" face="Arial"> Extracts the configuration template from the Zimlet.zip file</font>
 
 
|-
 
|-
| valign="top" |
+
|style="background=white" |<nowiki>listPriority</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> configure </font>
+
|<nowiki></nowiki>
| valign="top" |
+
|Shows the current Zimlet priorities (0 is high, 9 is low)
| valign="top" |
 
<font size="3" color="#000000" face="Arial"> Installs the configuration </font>
 
 
|-
 
|-
| valign="top" |
+
|style="background=white" |<nowiki>setPriority</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> listPriority </font>
+
|<nowiki></nowiki>
| valign="top" |
+
|'''<zimlet>''' Sets the Zimlet priority
| valign="top" |
 
<font size="3" color="#000000" face="Arial"> Shows the current Zimlet priorities (0 is high, 9 is low)</font>
 
|-
 
| valign="top" |
 
<font size="3" color="#000000" face=""Times New Roman""> setPriority </font>
 
| valign="top" |
 
| valign="top" |
 
<font size="3" color="#000000" face="Arial"> Sets the Zimlet priority </font>
 
 
|}
 
|}
 +
 +
=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|Zimbra Collaboration 7.0, 6.0|5/3/2006}}
 +
 +
[[Category:Command Line Interface]]
 +
[[Category:Zimlets]]
 +
[[Category:ZCS 7.0]]
 +
[[Category:ZCS 6.0]]

Latest revision as of 16:18, 11 July 2015

CLI zmzimletctl

   KB 1499        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.

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


Verified Against: Zimbra Collaboration 7.0, 6.0 Date Created: 5/3/2006
Article ID: https://wiki.zimbra.com/index.php?title=CLI_zmzimletctl 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