Administration Guide

Zenoss Administration
		Next

Zenoss Administration

Copyright © 2009 Zenoss, Inc., 275 West St. Suite 204, Annapolis, MD 21401, U.S.A. All rights reserved.

This work is licensed under a Creative Commons Attribution Share Alike 3.0 License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/3.0/; or send a letter to Creative Commons, 171 2nd Street, Suite 300, San Francisco, California, 94105, USA.

The Zenoss logo is a registered trademark of Zenoss, Inc. Zenoss and Open Enterprise Management are trademarks of Zenoss, Inc. in the U.S. and other countries.

Flash is a registered trademark of Adobe Systems Incorporated.

Java is a registered trademark of Sun Microsystems, Inc.

Linux is a registered trademark of Linus Torvalds.

Oracle and the Oracle logo are registered trademarks of the Oracle Corporation.

SNMP Informant is a trademark of Garth K. Williams (Informant Systems, Inc.).

Sybase is a registered trademark of Sybase, Inc.

Tomcat is a trademark of the Apache Software Foundation.

Windows is a registered trademark of Microsoft Corporation in the United States and other countries.

All other companies and products mentioned are trademarks and property of their respective owners.

Table of Contents

1. About Zenoss

1. Zenoss High-Level View

1.1. Key Tenets

2. Zenoss Architecture and Technologies

2.1. User Layer
2.2. Data Layer
2.3. Process Layer
2.4. Collection Layer

3. Zenoss' Monitoring Approach

3.1. File System Monitoring

4. Zenoss Terminology

2. Using Zenoss

1. Zenoss Interface and Navigation

1.1. Navigation Menu

1.1.1. Hiding the Menu
1.1.2. Pinning the Menu

1.2. Breadcrumbs

1.3. User Information Area

1.3.1. Update Details

1.4. Portlets

1.4.1. Customizing Portlets

1.5. Zenoss Network Map

1.5.1. Viewing Device and Network Details
1.5.2. Loading Link Data
1.5.3. Filtering by Device Type
1.5.4. Adjusting Viewable Hops
1.5.5. Adjusting the Network Map
1.5.6. Viewing Device or Network Details

1.6. Zenoss Menus

1.6.1. Page Menus
1.6.2. Table Menus

2. Customizing the Zenoss Dashboard

2.1. Selecting Portlets
2.2. Arranging Portlets
2.3. Changing the Dashboard Column Layout

3. Searching for Devices

4. Navigating the Event Console

4.1. Sorting and Filtering Events
4.2. Controlling Page Auto-Refresh
4.3. Viewing Event Details
4.4. Selecting Events
4.5. Managing Events

5. Running Commands from the User Interface

6. Creating and Using Alerts

6.1. Setting SMTP Settings For Alerts

6.2. Creating an Alerting Rule

6.2.1. Define and Enable the Alert
6.2.2. Create the Content of the Alert Message
6.2.3. Create a Schedule for Sending the Alert

6.3. Escalation of Messaging in Zenoss

6.3.1. Creating an Alerting Hierarchy

6.4. Adding Delay and Schedules to Alerting Rules

7. Creating Custom Event Views

3. Discovering and Modeling Devices

1. How Does Zenoss Model Devices?

1.1. ZenModeler Daemon

2. Add a Single Device

2.1. Add a Device Within a Device Class
2.2. Add a Device - Alternate Method

3. Discover Devices

3.1. Discover Devices - Alternate Method
3.2. Classifying Discovered Devices
3.3. Authenticating Devices
3.4. Adding Information to a Device Record

4. Modeling Devices Using SNMP

4.1. Testing to See if a Device is Running SNMP
4.2. Modeling Remote Windows Devices Using SNMP
4.3. Modeling Remote Linux Devices Using SNMP
4.4. Modeling Cisco Devices Using SNMP

5. Modeling Using SSH/COMMAND

5.1. Using Device Class to Monitor Devices Using SSH

6. Modeling Devices Using Port Scan

6.1. Using the /Server/Scan Device Class to Monitor with Port Scan

7. Collector Plugins

7.1. Viewing Collector Plugins for a Device

8. Debugging the Modeling Process

4. Working with Devices

1. Device List

1.1. Device Page Tabs

1.1.1. Status Tab
1.1.2. OS (Operating Systems) Tab
1.1.3. Hardware Tab
1.1.4. Software Tab
1.1.5. Events Tab
1.1.6. Performance (Perf) Tab
1.1.7. Edit Tab

2. Managing Devices and Device Attributes

2.1. Managing Custom Device Properties
2.2. Managing Device zProperties
2.3. Managing Device Templates
2.4. Determining Device Administration
2.5. Clearing Heartbeats
2.6. Pushing Configuration Changes to Zenoss
2.7. Locking Device Configuration
2.8. Renaming a Device
2.9. Remodeling a Device
2.10. Resetting the Device Manage IP Address
2.11. Resetting the Device Community
2.12. Selecting Device Collector Plugins
2.13. Deleting a Device from Zenoss
2.14. Managing Multiple Devices from the Device List
2.15. Dumping and Loading Devices Using XML Lists

5. Properties and Templates

1. zProperties

1.1. zProperties Inheritance and Override

1.1.1. User Interface View

1.2. zProperty Types

1.3. Event zProperties

1.4. Device zProperties

1.5. Service zProperties

1.6. Process zProperties

1.7. Network zProperties

1.8. Manufacturer zProperties

2. Templates

2.1. Template Binding

2.1.1. Device Templates
2.1.2. Component Templates
2.1.3. Interface Templates
2.1.4. Defining Templates in the Device Hierarchy
2.1.5. Applying Templates to Multiple Areas in the Device Hierarchy

6. Core Monitoring

1. Availability Monitoring

1.1. Controlling the Ping Cycle Time

1.2. Using the Predefined /Ping Device Class

1.3. Monitoring TCP Services

1.3.1. ZenStatus
1.3.2. Adding a Service to Monitor
1.3.3. Monitoring Status Service Status Information
1.3.4. Editing Service Information
1.3.5. Configuring Service zProperties
1.3.6. Using the Predefined /Server/Scan Device Class
1.3.7. Monitoring a Service Using a Service Class

1.4. Monitoring Processes

1.4.1. Adding Processes to Monitor
1.4.2. Configuring Process zProperties

2. Performance Monitoring

2.1. About Performance Monitoring

2.2. Performance Templates

2.2.1. Viewing Performance Templates

2.3. Template Binding

2.4. Data Sources

2.4.1. Adding a Data Source

2.5. Data Points

2.6. Data Point Aliases

2.6.1. Alias Formula Evaluation
2.6.2. Adding a Data Point Alias
2.6.3. Zenoss Reports That Use Aliases

2.7. Thresholds

2.8. Performance Graphs

2.8.1. Graph Points
2.8.2. Custom Graph Definition
2.8.3. Graph Commands

2.9. Changing Graph Display Order

3. Monitoring Using ZenCommand

3.1. About ZenCommands
3.2. Example: Writing a ZenCommand (check_http example)
3.3. Example: Collect Data from A ZenCommand
3.4. Plugin Format for ZenCommands
3.5. Testing ZenCommands

4. SNMP Monitoring

5. Monitoring Devices Remotely via SSH

5.1. Installing Zenoss Plugins on the Remote Machine

5.1.1. Zenoss Plugin Installation Technique: RPM
5.1.2. Zenoss Plugin Installation Technique: setuptools
5.1.3. Testing the Plugin Installation
5.1.4. Troubleshooting Plugin Installation
5.1.5. Changing Zenoss to Monitor Devices Remotely Using SSH
5.1.6. Using the Predefined /Server/Cmd Device Class

6. Monitoring Windows Devices

6.1. Device Preparation for Windows Devices
6.2. Setting Windows zProperties
6.3. Testing WMI on a Windows Server
6.4. Optional Windows Configuration
6.5. Modeling Services on Windows Devices
6.6. Collecting Windows Eventlog Events
6.7. Monitoring Windows Performance with SNMP Informant
6.8. Running winexe Commands on Windows Servers

7. Event Management

1. About Events

1.1. Basic Event Fields

1.1.1. device and ipAddress Fields
1.1.2. eventState Field
1.1.3. severity Field
1.1.4. summary and message Fields
1.1.5. evid

1.2. Other Fields

1.3. Details

1.4. De-Duplication

1.5. Auto-Clear Correlation

1.6. Event Consoles

1.6.1. Sorting and Filtering Events
1.6.2. Controlling Auto-Refresh
1.6.3. Viewing Event Details
1.6.4. Selecting Events
1.6.5. Managing Events

1.7. Event Sources

1.7.1. Generated Events
1.7.2. Captured Events

1.8. Creating Events Manually

1.8.1. Creating Events through the User Interface
1.8.2. Creating Events from the Command Line

1.9. Event Classes

1.9.1. Event Class zProperties

1.10. Mapping and Transformation

1.10.1. Event Class Mappings
1.10.2. Event Class Transform

1.11. Event Life Cycle

1.11.1. Automatic Event Aging
1.11.2. Automatic Historical Event Cleanup

1.12. Event Commands

1.12.1. Creating Event Commands

8. 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

9. Organizers and Path Navigation

1. About Organizers and Path Navigation

2.1. Viewing Device Classes
2.2. Setting zProperties at the Class Level
2.3. Defining and Applying Templates at the Class Level
2.4. Creating Classes

3.1. Adding, Moving and Nesting Systems

3.1.1. Moving the Sub-System

4.1. Adding Groups

4.1.1. Moving Groups

5. Locations

5.1. Integration with Google Maps

5.1.1. Overview
5.1.2. API Key
5.1.3. Setting an Address for a Location
5.1.4. Clearing the Google Maps Cache
5.1.5. Network Links
5.1.6. Google Maps Example

5.2. Adding, Moving, and Nesting Locations

5.2.1. Moving Sub-locations

6. Inheritance

10. User Commands

1. About User Commands

2. Defining User Commands

2.1. User Command Example: Echo Command

11. Managing Users

1. About Zenoss User Accounts

2. Creating User Accounts

3. Editing User Accounts

3.1. Associating Objects in Zenoss with Specific Users

4. User Groups

6. Device Access Control Lists

6.1. About Device Access Control Lists in Zenoss

6.2. Key Elements

6.2.1. Permissions and Roles
6.2.2. Administered Objects
6.2.3. Users and Groups
6.2.4. Assigning Administered Object Access
6.2.5. Portlet Access Control

6.3. Setup and Configuration Examples

6.3.1. Restricted User with ZenUser Role
6.3.2. Restricted User with ZenManager Role
6.3.3. Adding Device Organizers
6.3.4. Restricted User Organizer Management
6.3.5. Viewing Events

6.4. Detailed Restricted Screen Functionality

6.4.1. Dashboard
6.4.2. Device List
6.4.3. Device Organizers
6.4.4. Reporting

12. Reporting

1. About Zenoss Reporting

2. Organizing Reports

3. Navigating and Sorting Report Results

4. Exporting Reports

4.1. Advanced: 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 Graph Report
6.2. Adding Graphs
6.3. Customizing Graph Text
6.4. Organizing Graphs

7. MultiGraph Reports

7.1. Creating A 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

10. Advanced Zenoss Reports

13. ZenPacks

1. About ZenPacks

1.1. ZenPacks Provided by Zenoss

2. Installing ZenPacks

2.1. Installing from the Command Line
2.2. Installing from the User Interface
2.3. Installing All Core ZenPacks via RPM

3. Creating ZenPacks

3.1. Packaging and Distributing Your ZenPack

4. Removing ZenPacks

14. General Administration and Settings

1. Email and Pager Settings

1.1. Setting SMTP and SNPP Information

2. Event Manager Settings

2.1. Accessing Event Manager Settings
2.2. Changing Event Database Connection Information
2.3. Changing Event Manager Cache Settings
2.4. Changing Event Manager Maintenance Settings

3. Setting Portlet Permissions

3.1. User Role to ACL Mapping
3.2. Setting Permissions
3.3. Troubleshooting: Users Cannot See All Portlets

4. Backup and Recovery

4.1. Backup (zenbackup)

4.1.1. Backup Options
4.1.2. Backups Tab
4.1.3. Remote Backups

4.2. Restore (zenrestore)

4.2.1. Before You Restore
4.2.2. Restore Options

5. Working with the Job Manager

5.1. Viewing Jobs
5.2. Running the zenjobs Daemon

6. Maintenance and Performance Tuning

6.1. Pack ZEO Database
6.2. Log Rotate Script

A. Zenoss Daemon Commands and Options

1. Automated Modeling Daemons
2. Availability Monitoring Daemons
3. Event Collection Daemons
4. Performance Monitoring Daemons
5. Automated Response Daemons

B. SNMP Device Preparation

1. Net-SNMP
2. SNMP V3 Support
3. Community Information
4. System Contact Information
5. Extra Information

C. Syslog Device Preparation

1. Forwarding Syslog Messages from UNIX/Linux Devices

2. Forwarding Syslog Messages from a Cisco IOS Router

2.1. Other Cisco Syslog Configurations

3. Forwarding Syslog Messages from a Cisco CatOS Switch

4. Forwarding Syslog Messages using Syslog-ng

D. TALES Expressions

1. About Tales Expressions

1.1. Examples

2. TALES Device Attributes

3. Tales Event Attributes

List of Figures

1.1. Zenoss High-Level View
1.2. Zenoss Architecture
1.3. Workflow: Model-Driven Monitoring
1.4. Monitored File System (Threshold Exceeded)
2.1. Zenoss Dashboard
2.2. Navigation Menu
2.3. Breadcrumbs (Navigation)
2.4. User Information Area
2.5. Device Issues Portlet
2.6. Google Maps Portlet
2.7. Top Level Organizers Portlet
2.8. Zenoss Network Map
2.9. Page Menu
2.10. Table Menu
2.11. Customize Dashboard
2.12. Column Layout Dialog
2.13. Device/IP Search Area
2.14. Zenoss Event Console
2.15. Event Details
2.16. Selecting Events
2.17. Command Output
2.18. Settings Tab - SMTP Settings
2.19. Preferences - Edit Tab
2.20. Add Alerting Rule
2.21. Edit Alert Details
2.22. Alerting Rules Message Tab
2.23. Add Active Period
2.24. Alerting Rules - Schedule Details
2.25. Add Event View Dialog
2.26. Custom Event View (Edit Tab)
3.1. Add Device
3.2. Main Device Page
3.3. Add Device Dialog
3.4. Networks Page (Overview Tab)
3.5. Discover Device
4.1. Device List
4.2. Device Page (Status Tab)
4.3. Device Page (OS Tab)
4.4. Device Page (Hardware Tab)
4.5. Device Page (Software Tab)
4.6. Device Page (Events Tab)
4.7. Device Page (Performance Tab)
4.8. Device Page (Edit Tab)
4.9. Device Page (Custom Properties)
4.10. Device Page (zProperties)
4.11. Device Page (Templates)
4.12. Device Page (Administration)
4.13. Edit (Configuration) Lock Dialog
4.14. Reset IP Dialog
4.15. Device Page (Collector Plugins)
5.1. Device Class Hierarchy
5.2. Device Class Hierarchy - Locally Defined Value (Override)
5.3. Device Class Hierarchy - Value Set on Device
5.4. Defined zProperties - Root Level
5.5. zCollectorClientTimeout zProperty - Local Value Set
5.6. Delete Local Property
6.1. Services List - Classes tab
6.2. Individual Service Status Tab
6.3. Individual Service- Edit Tab
6.4. Individual Service - zProperties Tab
6.5. Showing Processes to Monitor
6.6. Service Summary
6.7. Process Monitoring
6.8. Processes Page
6.9. Add OS Process Dialog
6.10. Processes zProperties tab
6.11. Performance Template for Load Average Graph
6.12. Add Data Source
6.13. SNMP Data Source
6.14. Define a Data Point
6.15. CPU Utilization Report
6.16. Alias-Based CPU Utilization Report
6.17. Add Data Point Alias
6.18. Data Point Alias Dialog
6.19. Add a Threshold
6.20. Graph Definition
6.21. Running ZenCommands
6.22. Device Group zProperties Tab
7.1. Event De-Duplication
7.2. Event Auto-Clear
7.3. Event Console
7.4. Event Details
7.5. Selecting Events
7.6. Add Event Dialog
7.7. Event Processing
7.8. Event Life Cycle
9.1. Device Groupings
9.2. Device Class Tab
9.3. Device Class - zProperties Tab
9.4. Device Class - Templates Tab
9.5. Sub-systems Status Menu
9.6. Add Organizer
9.7. Move Organizer
9.8. Zenoss Device Class Tree and Inheritance
10.1. Add User Command
10.2. Define User Command
11.1. User Administration
11.2. Add User
11.3. Edit User
11.4. Administered Objects - Add Object
11.5. Administered Objects - Objects Added
11.6. Administered Objects - Add Administrator
11.7. User Groups (Settings Page)
11.8. Add New User Group
11.9. Add User to Group
12.1. Reports List
12.2. Graph Report
12.3. Graph Report Edit Page
12.4. Graph Report Element
12.5. MultiGraph Report Graphs
12.6. MultiGraph Report Edit Page
12.7. MultiGraph Report Collection
12.8. MultiGraph Report Graph Definition
12.9. MultiGraph Report Graph Group
14.1. Zenoss Settings - Settings Tab
14.2. Event Manager - Edit Tab
14.3. Portlet Permissions
14.4. Jobs List
14.5. Start zenjob Daemon

List of Tables

5.1. Event zProperties
5.2. Device zProperties
5.3. Device zProperties
5.4. Device zProperties
5.5. Service zProperties
5.6. Process zProperties
5.7. Network zProperties
5.8. Network zProperties
14.1. SMTP Options

		Next
		Chapter 1. About Zenoss