cacti-0.8.6j.tar.gz

The Cacti Manual Ian Berry Tony Roman Larry Adams Copyright � 2005 The Cacti Group This project is licensed under the terms of the GPL. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. All product names are property of their respective owners. Such names are used for identification purposes only and are not indicative of endorsement by or of any company, organization, product, or platform. _________________________________________________________ Table of Contents I. Installation 1. Requirements 2. Installing Under Unix 3. Installing Under Windows 4. Upgrading Cacti II. Basics 5. Graph Overview 6. How to Graph Your Network Creating a Device Creating the Graphs 7. Viewing Graphs Graph Trees 8. User Management Creating a New User Realm Permissions Graph Permissions Graph Settings III. Advanced Topics 9. Data Input Methods Creating a Data Input Method Making Your Scripts Work With Cacti 10. Data Queries Creating a Data Query SNMP Query XML Syntax Script Query XML Syntax 11. Templates Graph Templates Data Templates Host Templates 12. PHP Script Server Using the Script Server Upgrade Steps for the Example HostMib Data Queries Migration of Existing PHP Scripts to Script Server Testing Your Script in the Script Server IV. Using Cacti 13. How To Graph a Single SNMP OID Simplest Method of Going from Script to Graph (Walkthrough) 14. Frequently Asked Questions V. Reference 15. Variables Graph Variables Host Variables 16. RRDTool Specific Features GPRINT Presets CDEFs _________________________________________________________ Chapter 1. Requirements Cacti requires that the following software is installed on your system. * RRDTool 1.0.49 or 1.2.x or greater * MySQL 3.23 or greater, 4.0.20d or greater highly recommended for advanced features * PHP 4.1 or greater, 4.3.6 or greater highly recommended for advanced features Packages for RPM-based Operating Systems * httpd * php * php-mysql * php-snmp * mysql * mysql-server * net-snmp Ports for FreeBSD * www/apache2 * net/rrdtool * net/net-snmp * www/php4-cgi * lang/php4 (With MySQL and SNMP Support) * databases/mysql323-server _________________________________________________________ Chapter 2. Installing Under Unix 1. Extract the distribution tarball. shell> tar xzvf cacti-version.tar.gz 2. Create the MySQL database: shell> mysqladmin --user=root create cacti 3. Import the default cacti database: shell> mysql cacti < cacti.sql 4. Optional: Create a MySQL username and password for Cacti. shell> mysql --user=root mysql mysql> GRANT ALL ON cacti.* TO cactiuser@localhost IDENTIFIED BY 'somep assword'; mysql> flush privileges; 5. Edit include/config.php and specify the MySQL user, password and database for your Cacti configuration. $database_default = "cacti"; $database_hostname = "localhost"; $database_username = "cactiuser"; $database_password = "cacti"; 6. Set the appropriate permissions on cacti's directories for graph/log generation. You should execute these commands from inside cacti's directory to change the permissions. shell> chown -R cactiuser rra/ log/ (Enter a valid username for cactiuser, this user will also be used in the next step for data gathering.) 7. Add a line to your /etc/crontab file similar to: */5 * * * * cactiuser php /var/www/html/cacti/poller.php > /dev/null 2> &1 Replace cactiuser with the valid user specified in the previous step. Replace /var/www/html/cacti/ with your full Cacti path. 8. Point your web browser to: http://your-server/cacti/ Log in the with a username/password of admin. You will be required to change this password immediately. Make sure to fill in all of the path variables carefully and correctly on the following screen. _________________________________________________________ Chapter 3. Installing Under Windows Software Compoents Required 1. (Optional) Apache> - This software is optional if running Windows Internet Information Server. 2. Cacti> - Install from the zip distribution and intstall in the web root or your choice. Many choose to install into a "Cacti" sub folder. 3. Cactid - Install from the zip distribution into the c:\cacti directory. Make sure your cactid.conf.dist is located in that directory as well. 4. RRDTool - Install from the Cacti website. Install it into the c:\cacti directory. 5. PHP 4.3.6+ or 5.x - Install into the c:\php folder. If you choose to install into c:\Program Files\php, you will have to use 8.3 filenames to reference it's binaries in Cacti. 6. MySQL 4.x or MySQL 5.x - Install into the default location. This is typically c:\Program Files\MySQL\MySQL Server X.XX. 7. (Optional) Cygwin - Download and execute setup.exe from the Cygwin website. Keep the setup.exe file for later use. 8. (Optional) Net-SNMP - Install to the c:\net-snmp directory. If you choose to use c:\Program Files\net-snmp you will have tu use 8.3 filenames to reference it's binaries in Cacti. Configure PHP 1. If using PHP 4, move the files in c:\php\dlls to c:\php 2. Add the following directory to the existing Windows System PATH environment variable: c:\php. The Windows path can be accessed via the Control Panel at: System | Advanced | Environment Variables | System Variables. 3. Add the following directory to a new Windows System environment variable called PHPRC: c:\php. 4. Add a new Windows System environment variable called MIBDIRS. If using PHP 4, set it to c:\php\mibs. If using PHP 5, set it to c:\php\extras\mibs 5. If using PHP 4.3.5 or less, create the following directory c:\tmp. 6. Rename the file c:\php\php.ini.dist to php.ini, and make the following changes to it: If using PHP 4 add/uncomment the following lines. extension_dir = c:\php\extensions extension=php_snmp.dll extension=php_sockets.dll cgi.force_redirect = 0 If using PHP 5 uncomment the following lines. extension_dir = c:\php\ext extension=php_mysql.dll extension=php_snmp.dll extension=php_sockets.dll cgi.force_redirect = 0 If using PHP 4.3.5 or less include the following line. If using 4.3.6 or greater, you should remove this line if present. session.save_path=c:\tmp 7. In earlier installation guides to PHP, they recommended moving certain DLL's to the c:\winnt\system32 directory. If so, you will have to remove those files. Please review the PHP installation documentation for instructions on removing those files. 8. If you want to allow template importing, uncomment the following line: file_uploads = On 9. Give the user who will be running the scheduled task,