/usr/share/doc/cacti/html/scripts.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>Command Line Scripts</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="The Cacti Manual"
HREF="index.html"><LINK
REL="UP"
TITLE="Reference"
HREF="reference.html"><LINK
REL="PREVIOUS"
TITLE="CDEFs"
HREF="cdefs.html"><LINK
REL="NEXT"
TITLE="Re-Index Hosts"
HREF="cli_poller_reindex_hosts.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
HREF="manual.css"></HEAD
><BODY
CLASS="CHAPTER"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>The Cacti Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="cdefs.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="cli_poller_reindex_hosts.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="CHAPTER"
><H1
><A
NAME="SCRIPTS"
></A
>Chapter 20. Command Line Scripts</H1
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="scripts.html#CLI_REBUILD_POLLER_CACHE"
>Rebuild Poller Cache</A
></DT
><DT
><A
HREF="cli_poller_reindex_hosts.html"
>Re-Index Hosts</A
></DT
><DT
><A
HREF="cli_poller_output_empty.html"
>Empty Poller Output Table</A
></DT
><DT
><A
HREF="cli_poller_graphs_reapply_names.html"
>Reapply Suggested Names to Graphs</A
></DT
><DT
><A
HREF="cli_copy_user.html"
>Copy Local Cacti Users</A
></DT
><DT
><A
HREF="cli_add_device.html"
>Add a New Device</A
></DT
><DT
><A
HREF="cli_add_data_query.html"
>Associate a Data Query to an existing Host</A
></DT
><DT
><A
HREF="cli_add_graph_template.html"
>Associate a Graph Template to an existing Host</A
></DT
><DT
><A
HREF="cli_add_graphs.html"
>Add a New Graph</A
></DT
><DT
><A
HREF="cli_add_tree.html"
>Add Items to a Tree</A
></DT
><DT
><A
HREF="cli_add_perms.html"
>Add Graph Permissions</A
></DT
></DL
></DIV
><P
>Cacti support a number of command line scripts.
			Please find them in the <TT
CLASS="FILENAME"
>./cli</TT
> directory.
			As of current, following scripts are supported:</P
><PRE
CLASS="SCREEN"
>add_device.php
add_data_query.php
add_graph_template.php
add_graphs.php
add_perms.php
add_tree.php
copy_user.php
poller_graphs_reapply_names.php
poller_output_empty.php
poller_reindex_hosts.php
rebuild_poller_cache.php</PRE
><DIV
CLASS="CAUTION"
><P
></P
><TABLE
CLASS="CAUTION"
BORDER="1"
WIDTH="100%"
><TR
><TD
ALIGN="CENTER"
><B
>Numbers may vary!</B
></TD
></TR
><TR
><TD
ALIGN="LEFT"
><P
>In the following examples, several numbers are shown
				as output from various scripts. They will vary between different
				installations. So don't bother, if your numbers will vary</P
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="CLI_REBUILD_POLLER_CACHE"
>Rebuild Poller Cache</A
></H1
><P
>The poller cache holds all commands that cacti will issue during
			the polling process in an internal format. It is possible, to review
			the currenty contents of the poller cache by visiting <KBD
CLASS="USERINPUT"
>System Utilities</KBD
>,
			<KBD
CLASS="USERINPUT"
>View Poller Cache</KBD
>. It is possible to apply filters
			to this view; it will show up like</P
><PRE
CLASS="SCREEN"
>Localhost - Hard Drive Space   	Script Server: /var/www/html/cacti/scripts/ss_host_disk.php ss_host_disk 127.0.0.1 1 1:161:500:somesecret:::::: get total 6
	                        RRD: /var/www/html/cacti/rra/localhost_hdd_total_61.rrd
Localhost - Load Average 	Script: /usr/bin/perl /var/www/html/cacti/scripts/loadavg_multi.pl
	                        RRD: /var/www/html/cacti/rra/localhost_load_1min_5.rrd
Localhost - Logged in Users 	Script: /usr/bin/perl /var/www/html/cacti/scripts/unix_users.pl
	                        RRD: /var/www/html/cacti/rra/localhost_users_6.rrd
Localhost - Memory - Free 	Script: /usr/bin/perl /var/www/html/cacti/scripts/linux_memory.pl MemFree:
	                        RRD: /var/www/html/cacti/rra/localhost_mem_buffers_3.rrd
Localhost - Memory - Free Swap 	Script: /usr/bin/perl /var/www/html/cacti/scripts/linux_memory.pl SwapFree:
	                        RRD: /var/www/html/cacti/rra/localhost_mem_swap_4.rrd
Localhost - mtaReceivedMessages SNMP Version: 1, Community: somesecret, OID: .1.3.6.1.2.1.28.1.1.1.1
	                        RRD: /var/www/html/cacti/rra/localhost_mtareceivedmessages_47.rrd
Localhost - mtaReceivedVolume 	SNMP Version: 1, Community: somesecret, OID: .1.3.6.1.2.1.28.1.1.4.1
	                        RRD: /var/www/html/cacti/rra/localhost_mtareceivedvolume_49.rrd</PRE
><P
>There are several circumstances, that may result in the poller cache
			being out of sync. An example would be a change of the name of a script used in a
			<KBD
CLASS="USERINPUT"
>Data Input Method</KBD
>. This change is <B
CLASS="EMPHASIS"
>not</B
>
			automatically propagated to the poller cache. It is required, to run
			<SPAN
CLASS="APPLICATION"
>php -q rebuild poller_cache.php</SPAN
> manually.</P
><P
>Calling the script with the parameter <KBD
CLASS="USERINPUT"
>--help</KBD
> yields</P
><PRE
CLASS="SCREEN"
><SAMP
CLASS="PROMPT"
>shell&gt;</SAMP
>php -q rebuild_poller_cache.php --help
Cacti Rebuild Poller Cache Script 1.0, Copyright 2004-2011 - The Cacti Group

usage: rebuild_poller_cache.php [-d] [-h] [--help] [-v] [--version]

-d            - Display verbose output during execution
-v --version  - Display this help message
-h --help     - Display this help message</PRE
><P
>Debug mode lists the data sources items that are worked upon.</P
><PRE
CLASS="SCREEN"
><SAMP
CLASS="PROMPT"
>shell&gt;</SAMP
>php -q rebuild_poller_cache.php -d
WARNING: Do not interrupt this script.  Rebuilding the Poller Cache can take quite some time
DEBUG: There are '38' data source elements to update.
DEBUG: Data Source Item '1' of '38' updated
DEBUG: Data Source Item '2' of '38' updated
DEBUG: Data Source Item '3' of '38' updated
DEBUG: Data Source Item '4' of '38' updated
....</PRE
><P
>Without any parameter, some dots are shown as progress indicators.</P
><PRE
CLASS="SCREEN"
><SAMP
CLASS="PROMPT"
>shell&gt;</SAMP
>php -q rebuild_poller_cache.php
WARNING: Do not interrupt this script.  Rebuilding the Poller Cache can take quite some time
......................................
<SAMP
CLASS="PROMPT"
>shell&gt;</SAMP
></PRE
><DIV
CLASS="CAUTION"
><P
></P
><TABLE
CLASS="CAUTION"
BORDER="1"
WIDTH="100%"
><TR
><TD
ALIGN="CENTER"
><B
>Stop the Poller when Rebuilding the Poller Cache</B
></TD
></TR
><TR
><TD
ALIGN="LEFT"
><P
>Rebuilding the poller cache interferes with the poller operation.
				Please make sure, that the poller is not running and will not start
				during a rebuild operation</P
></TD
></TR
></TABLE
></DIV
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="cdefs.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="cli_poller_reindex_hosts.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>CDEFs</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="reference.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Re-Index Hosts</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
cacti 0.8.7i-2ubuntu1 / usr / share / doc / cacti / html / scripts.html
