Zenoss Administration Guide

Table of Contents

1. Introduction

1. Zenoss Overview

1.1. The Zenoss Standard Model

1.2. Availability Monitoring in Zenoss

1.3. Zenoss Event Management System

1.4. Zenoss Performance Monitoring System

2. Detailed Architecture

1. Zenoss Detailed Architecture

2. User Layer

3. Data Layer

4. Collection and Control Services Layer

4.1. Automated Modeling Daemons

4.2. Availability Modeling Daemons

4.3. Event Collection Daemons

4.4. Performance Monitoring Daemons

4.5. Automated Response Daemons

3. Key Concepts

1. Classification

2. zProperties

3. Inheritance and Path Navigation

4. Zenoss Interface and Navigation

1. Zenoss Dashboard

2. Left Navigation Menu

2.1. Main Views

2.2. Classes

2.3. Browse By

2.3.1. Management

2.4. Hiding the Left Navigation Menu

3. Directory Path

4. Device/IP Search Box

5. User Information Area

6. Customizing Zenoss Dashboard Portlets

6.1. Devices Issues Portlet

6.1.1. Configuring the Device Issues Portlet

6.2. Top Level Organizers

6.2.1. Configuring the Top Level Organizer Portlet

6.3. Watch List Portlet

6.3.1. Configuring the Watch List Portal

6.4. Google Maps Portlet

6.4.1. Configuring the Google Maps Portlet

6.5. Zenoss Issues Portlet

6.5.1. Configuring the Zenoss Issues Portlet

6.6. Production States Portlet

6.6.1. Configuring the Production States Portlet

7. Zenoss Network Map

8. "Menu-ized" Elements

8.1. Page Menus

8.2. Table Menus

5. User Management

1. About Zenoss User Accounts

2. Creating New User Accounts

3. Editing User Accounts

3.1. Setting User Passwords

3.2. Editing User Contact Information

3.3. Assigning Roles and Permissions to Users

3.4. Setting the Default User Level

3.5. Setting the Dashboard Timeout and Refresh Time

3.6. Specifying a Default Dashboard Organizer

3.7. Creating Object Associations

4. User Groups

6. Email and Pager Settings

1. About Email and Pager Settings

2. Setting SMTP and SNPP Information

7. Organizers and Path Navigation in Zenoss

1. About Organizers and Path Navigation

2. Classes

2.1. Setting zProperties at the Class Level

2.2. Defining and Applying Templates at the Class Level

2.3. Creating New Classes

3. Systems

3.1. Adding, Moving and Nesting Systems

3.1.1. Moving the Sub-System

4. Groups

4.1. Adding Groups

4.1.1. Moving Groups

5. Locations

5.1. Google Maps Geographic View of Network Health

5.1.1. Overview

5.1.2. API Key

5.1.3. Setting an Address for a Location

5.1.4. Network Links

5.1.5. Google Maps Example

5.2. Adding, Moving, and Nesting Locations

5.2.1. Moving Sub-locations

6. Inheritance

7. Multiple Mix-In Inheritance and Performance (RRD) Template Binding

7.1. Template Binding Example 1

7.2. Template Binding Example 2

8. zProperties

1. About zProperties

2. Event zProperties

3. Device zProperties

4. Service zProperties

5. Network zProperties

6. Manufacturer zProperties

9. Device Inventory and Configuration

1. What is Inventory and Configuration in Zenoss?

2. How Does Zenoss Model Devices?

3. The ZenModeler Daemon

4. Adding an Individual Device

5. Add an Individual Device with Context

6. Auto-Discovery of Devices

7. Device List

7.1. Managing Multiple Devices using the Device List

8. Individual Device Tabs

8.1. Device Status Tab

8.1.1. Device Status Tab Example

8.2. OS (Operating Systems) Tab

8.2.1. File System Monitoring

8.3. Hardware Tab

8.4. Software Tab

8.5. Events Tab

8.6. History Tab

8.7. Performance Tab

8.7.1. Graph Surfing

8.8. Edit Tab

8.9. Custom Tab

8.10. zProperties Tab

8.11. Templates Tab

8.12. Administration Tab

8.13. Collector Plugins tab

8.14. Modifications Tab

9. Searching For a Device By Name or IP Address

10. Editing Device Configurations

11. Managing Devices

11.1. Remodeling a Device

11.2. Changing the Device Class of a Device

11.3. Resetting Device Manage IP

11.4. Renaming a Device

11.5. Locking Device Configurations

11.6. Resetting the Device Community

11.7. Pushing Configuration Changes Back to the Zenoss System

11.8. Clearing Heartbeats

11.9. Deleting Devices From the System

12. Modeling Devices Using SNMP

12.1. Testing to See if a Device is Running SNMP

12.2. Modeling Remote Windows Devices Using SNMP

12.3. Modeling Remote Linux Devices Using SNMP

12.4. Modeling Cisco Devices Using SNMP

13. Modeling Using SSH/COMMAND

13.1. Using Device Class to Monitor Devices Using SSH

14. Modeling Devices Using PortScan

14.1. Using the /Server/Scan Device Class to Monitor with Portscan

15. Modeling Plugins

15.1. Getting a List of Modeling Plugins for a Device

16. Debugging the Modeling Process

17. Using zLinks to Add Custom Links to a Device Status Page

18. Dumping and Loading Devices Using XML Lists

10. Event Monitoring

1. About Event Monitoring In Zenoss

2. Event Concepts

2.1. Event Life Cycle

2.2. De-duplication

2.3. Begin-End Correlation

3. Zenoss Event Console

3.1. Viewing Event Details

4. Generating and Sending a Test Event

4.1. Sending Events from the Command Line

5. Event Classes

5.1. Creating a New Event Class

6. Event Manager Settings

6.1. Accessing Event Manager Settings

6.2. Changing Event Database Connection Information

6.3. Changing Cache Settings for the Event Manager

6.4. Change the Maintenance Settings for the Event Manager

7. Acknowledging Events

8. Moving Events To History

9. Clearing The Event History

10. Event Class Mapping

11. Applying Event and Device Context Using Event zProperties

12. Mapping Events Through the UI

13. Using Mappings to Correlate Events

14. Event Commands

14.1. Create an Event Command Example

14.2. Test the Event Command

15. SNMP Traps and Event Transforms

15.1. SNMP Trap Mapping

15.2. Sending Test Traps

15.3. Transforming Events with Event Mappings

15.4. Event Transforms Based on Device Class

16. Custom Event Views

17. Use ZenMail and ZenPop to Turn Email Messages into Zenoss Events

17.1. ZenMail

17.2. ZenPop

17.3. How Zenoss Translates Various Message Elements to the Event

17.3.1. How Zenoss uses the FROM field

17.3.2. How Zenoss uses the TO Field

17.3.3. How Zenoss uses the SUBJECT Field

17.3.4. How Zenoss uses the Message Body

11. Availability Monitoring

1. Monitoring Topology with ZenPing

1.1. Controlling the Ping Cycle Time

1.2. Using the Predefined /Ping Device Class

2. Monitoring TCP Services

2.1. Zenstatus

2.2. Adding a Service To Monitor

2.3. Monitoring Status Service Status Information

2.4. Editing Service Information

2.5. Configuring Service zProperties

2.6. Using the Predefined /Server/Scan Device Class

2.7. Monitoring a Service Using a Service Class

3. Monitoring Processes

3.1. Adding Processes to Monitor

3.2. Configuring Process zProperties

12. Performance Monitoring

1. Performance Monitoring

2. Performance Templates

2.1. The Templates Page

3. Template Binding

4. Data Sources

5. Data Points

6. Thresholds

7. Graph Definitions

7.1. Graph Points

7.1.1. Data Point Graph Points

7.1.2. Threshold Graph Points

7.1.3. Custom Graph Points

7.2. Custom Graph Definition

7.3. Graph Commands

8. Changing the Order of the Graphs

9. Monitoring A File System and Changing a Threshold

13. Monitoring Devices Remotely via SSH

1. Monitoring Devices Remotely via SSH

1.1. Installing Zenoss Plugins on the Remote Machine

1.1.1. Zenoss Plugin Installation Technique: RPM

1.1.2. Zenoss Plugin Installation Technique: setuptools

1.1.3. Testing the Plugin Installation

1.1.4. Troubleshooting the Plugin Installation

1.1.5. Changing Zenoss to Monitor the Devices Remotely Using SSH

1.1.6. Using the Predefined /Server/Cmd Device Class

14. Monitoring Using ZenCommand

1. About ZenCommands

2. Example: Writing a ZenCommand (check_http example)

3. Collect Data from A ZenCommand

4. Plugin Format for ZenCommands

5. Testing ZenCommands

15. Monitoring Windows Devices

1. Device Preparation for Windows Devices

2. Testing WMI on a Windows Server

3. Other Optional Windows Configuration Items

4. ZenWin Command Line Parameters

5. Modeling Services on Windows Devices

6. Collecting Windows Eventlog Events

7. Monitoring Windows Performance with SNMP-Informant

8. Running Commands on Windows Servers Using Winexe

16. SNMP Monitoring

1. SNMP from the Command Line

17. Alerting Rules

1. Creating and Using Alerts

1.1. Setting SMTP Settings For Alerts

2. Creating a New Alerting Rule

2.1. Define and Enable This Alert

2.2. 1.1.1 Create the Content of the Alert Message

2.3. Create a Schedule for Sending the Alert

3. Escalation of Messaging in Zenoss

3.1. Creating an Alerting Hierarchy

4. Adding Delay and Schedules to Alerting Rules

18. UI Commands

1. About UI Commands

2. Defining UI Commands

2.1. UI Command Example: Echo Command

3. Running Commands from the Zenoss Web UI

4. Auto-Running Commands Based on Events

19. Production States and Maintenance Windows

1. About Production States and Maintenance Windows

2. Production States

2.1. Defining Production States for Devices

3. Maintenance Windows

3.1. Creating and Using Maintenance Windows

20. Reporting

1. About Reporting in Zenoss

2. Organizing Reports

3. Navigating and Sorting Report Results

4. Exporting Reports

4.1. Add An Export Button to a Report

5. Reports Included With Zenoss

5.1. Device Reports

5.2. Event Reports

5.3. Performance Reports

5.4. User Reports

6. Graph Reports

6.1. Creating a New Graph Report

6.2. Adding Graphs

6.3. Customizing Graph Text

6.4. Organizing Graphs

7. MultiGraph Reports

7.1. Creating A New MultiGraph Report

7.2. Collections

7.3. Graph Definitions

7.4. Graph Groups

7.5. Graph Order

8. Creating Custom Reports

8.1. Creating Custom Reports Using the ZMI

8.2. Create A Custom Device Report Example

9. Using Reports to Help Troubleshoot Zenoss Daemons

21. General Zenoss Administration

1. Working with Zenoss from the Command Line

2. Minimal Zenoss - ZEO and Zope

3. Checking the Version of Zenoss

4. Checking for Zenoss Updates

5. Starting and Stopping the Zenoss Daemons

6. Zenoss Daemon Commands and Options

6.1. Configuring Zenoss Daemons

6.2. General Options for All Daemons

6.3. zenhub Options

6.4. zenmodeler Options

6.5. zenperfsnmp Options

6.6. zenperfxmlrpc Options

6.7. zenProcess Options

6.8. zenping Options

6.9. zensyslog Options

6.10. zenstatus Options

6.11. zenactions Options

6.12. zentrap Options

6.13. zencommand Options

7. Troubleshooting Zenoss Daemons

8. Automatic Startup in Linux Environments

9. Using Zenoss with a Remote MySQL Instance

10. Registering MIBs with Zenoss

10.1. Resolving MIB Dependencies

22. Backup, Recovery and Maintenance

1. Backup and Restore

1.1. Backup Details

1.2. Restore Details

1.3. Periodic Backups

1.3.1. Pack ZEO Database

1.3.2. Log Rotate Script

1.3.3. Backing up the MySQL Event Backend

23. ZenPacks

1. Introduction to Zenpacks

1.1. Installing ZenPacks

1.1.1. Installing via the Command Line

1.1.2. Installing via the User Interface

1.1.3. Installing All Core ZenPacks via RPM

1.2. Creating a ZenPack

1.2.1. Packaging and Distributing Your ZenPack

1.3. Example ZenPack

1.4. ZenPack Structure

1.4.1. HelloWorldZenPack/

1.4.2. HelloWorldZenPack/init.py

1.4.3. HelloWorldZenPack/HelloWorld.py

1.4.4. HelloWorldZenPack/daemons

1.4.5. HelloWorldZenPack/datasources

1.4.6. HelloWorldZenPack/modeler

1.4.7. HelloWorldZenPack/objects

1.4.8. HelloWorldZenPack/skins

1.5. Removing a ZenPack

2. Zenoss Core ZenPacks

2.1. ZenJMX ZenPack

2.1.1. About ZenJMX

2.1.2. JMX Background

2.1.3. ZenJMX Capabilities

2.1.4. Single Value Attribute Calls

2.1.5. Multi-Value Attribute Calls

2.1.6. Operation Calls

2.1.7. ZenJMX Behavior

2.1.8. Running the ZenJMX Daemon

2.1.9. Defining Custom JMX Data Sources

2.1.10. Enabling Remote JMX Access

2.1.11. Interrogating an JMX Agent via JConsole

2.1.12. Installing ZenJMX

2.2. ApacheMonitor ZenPack

2.3. DellMonitor ZenPack

2.4. HPMonitor ZenPack

2.5. MySqlMonitor ZenPack

A. Net-SNMP and Zenoss

1. Net-SNMP Configuration Settings

1.1. Community Information

1.2. System Contact Information

1.3. Extra Information

B. Event Database Dictionary

1. Event Database Dictionary

C. TALES Expressions

1. About TALES Expressions

2. TALES Device Attributes

3. TALES Event Attributes

D. Device Preparation

1. Net-SNMP

2. SNMP V3 Support

3. Forwarding Syslog messages from UNIX/Linux Devices

4. Forwarding Syslog Messages from a Cisco IOS Router

4.1. Other Cisco syslog Configurations

5. Forwarding Syslog Messages from a Cisco CatOS Switch

6. Forwarding Syslog Messages using Syslog-ng

E. Zenoss Licensing Information

1. ZENOSS CORE (TM) END USER LICENSE AGREEMENT

2. GNU General Public License