How To Install And Use the zenoss.toolbox

Applies To

• Zenoss 6.x
• Zenoss 5.x
• Zenoss 4.x

Summary

The zenoss.toolbox GitHub repository is the source for Zenoss-maintained tools. Toolbox tools cover zodb and catalog integrity as well as maintenance items for Zenoss instances. All tools are to be installed and run from the Zenoss master server as the zenoss user, unless otherwise specified. Consult the detailed instructions for each individual tool before use.

Notes:

• The zenoss.toolbox project is maintained on GitHub: https://github.com/zenoss/zenoss.toolbox.
• Use the toolbox tools ONLY from the "Master" branch - other branches (such as develop) can include untested tools and should not be used in a production environment.

Detailed zenoss.toolbox Tool List:

1. findposkeyerror
2. zencatalogscan
3. zenrelationscan
4. zodbscan
5. zencheckdbstats
6. zenindextool
7. zennetworkclean

Installation Procedures

The Zenoss toolbox is intended to be installed and run only from the master Zenoss server.

Zenoss Toolbox Installation on Zenoss Resource Manager 4.x

Perform the following as the zenoss user to download and install the zenoss_toolkit.zip package:

1. Download the toolbox:
   $ wget -O zenoss_toolbox.zip --no-check-certificate https://github.com/zenoss/zenoss.toolbox/archive/master.zip
2. Use easy_install to install the toolbox:
   $ easy_install zenoss_toolbox.zip

Zenoss Toolbox Installation on Zenoss Resource Manager 5.1.x - 5.2.3

For specific installation instructions on Zenoss Resource Manager 5.1.x - 5.2.3, see Using Zenoss Toolbox in the Zenoss Resource Manager Upgrade Guide for your version of Resource Manager in the Documentation Archive.

Zenoss Toolbox Installation on Zenoss Resource Manager 5.2.4+

As of Zenoss Resource Manager 5.2.4, the Zenoss Toolbox is preinstalled.