Skip navigation
Currently Being Moderated

13.3 Installing ZenPacks

VERSION 3  Click to view document history
Created on: Oct 11, 2011 4:59 PM by Zenoss API - Last Modified:  Oct 11, 2011 5:17 PM by Zenoss API

 3. Installing ZenPacks

ZenPacks are distributed as .egg files. You can install ZenPacks from the user interface, or from the command line on the  Resource Manager server.

 3.1. Installing from the User Interface

To upload and install a ZenPack .egg file from the user interface:

  1. From the Navigation menu, select Advanced > Settings.

  2. In the left panel, select ZenPacks.

  3. From (Action menu), select Install ZenPack.

    The Install ZenPack dialog appears.

  4. Browse to and select the .egg file you want to install, and then click OK.

    The file is uploaded to the  Resource Manager server and installed.


After installing the ZenPack, you should restart the system.

 3.2. Installing from the Command Line

Use these commands to install a ZenPack file, and then restart the system:

zenpack --install <filename>
zenoss restart

If you have the source code for the ZenPack you can install directly from that rather than from an .egg file. The command is the same; however, you must specify the directory containing the source code. This copies the source code to $ZENHOME/ZenPacks:

zenpack --install <directoryname>
zenoss restart

If you are developing a ZenPack, you should maintain your source code outside of $ZENHOME/ZenPacks, for two reasons:

  • if you issue a zenpack --remove command it will delete your code from that location and you will lose your files unless you have them backed up elsewhere.

  • if you are maintaining your source code in a version control system it is frequently more convenient to have the files reside elsewhere on the file system.

Using the --link option, you can install the ZenPack but have the system use your code from its current location. Instead of installing your code in $ZENHOME/ZenPacks, the system will create a link in that location that points to your source code directory.

zenpack --link --install <directoryname>
zenoss restart
Comments (0)