1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta name="generator" content="HTML Tidy for Linux/x86 (vers 1st August 2004), see www.w3.org">
<title>Script Query XML Syntax</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="Data Queries" href="data_queries.html">
<link rel="PREVIOUS" title="SNMP Query XML Syntax" href="snmp_query_xml.html">
<link rel="NEXT" title="Templates" href="templates.html">
<link rel="STYLESHEET" type="text/css" href="manual.css">
</head>
<body class="SECT1" 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="snmp_query_xml.html" accesskey="P">Prev</a></td>
<td width="80%" align="center" valign="bottom">Chapter 10. Data Queries</td>
<td width="10%" align="right" valign="bottom"><a href="templates.html" accesskey="N">Next</a></td>
</tr>
</table>
<hr align="left" width="100%">
</div>
<div class="SECT1">
<h1 class="SECT1"><a name="SCRIPT_QUERY_XML" id="SCRIPT_QUERY_XML">Script Query XML Syntax</a></h1>
<pre class="PROGRAMLISTING">
<query>
<name>Get Unix Mounted Partitions</name>
<description>Queries a list of mounted partitions on a unix-based host with the 'df' command.</description>
<script_path>perl |path_cacti|/scripts/query_unix_partitions.pl</script_path>
<arg_index>index</arg_index>
<arg_query>query</arg_query>
<arg_get>get</arg_get>
<arg_num_indexes>num_indexes</arg_num_indexes>
<output_delimeter>:</output_delimeter>
<index_order>dskDevice:dskMount</index_order>
<index_order_type>alphabetic</index_order_type>
<index_title_format>|chosen_order_field|</index_title_format>
<fields>
<dskDevice>
<name>Device Name</name>
<direction>input</direction>
<query_name>device</query_name>
</dskDevice>
</fields>
</query>
</pre>
<div class="TABLE">
<a name="AEN984" id="AEN984"></a>
<p><b>Table 10-4. Script Query XML Field Reference</b></p>
<table border="1" frame="border" rules="all" class="CALSTABLE">
<col width="1*">
<col width="2*">
<thead>
<tr>
<th align="center">Field</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>query->name</td>
<td>(Optional) You can enter a "friendly name" for the script query here. It will not be used by Cacti, and is for identification only.</td>
</tr>
<tr>
<td>query->description</td>
<td>(Optional) You can enter a description for the script query here. It will not be used by Cacti, and is for identification only.</td>
</tr>
<tr>
<td>query->script_path</td>
<td>Enter the complete path to the script or executable that is going to handle your script query. When in doubt, specify the pull path to all binaries referenced in this path, the query may not execute otherwise.</td>
</tr>
<tr>
<td>query->arg_index</td>
<td>Enter the argument that is to be passed to the script to retrieve a list of indexes.</td>
</tr>
<tr>
<td>query->arg_query</td>
<td>Enter the argument that is to be passed to the script to retrieve a list of values given a field name.</td>
</tr>
<tr>
<td>query->arg_get</td>
<td>Enter the argument that is to be passed to the script to retrieve a single value given a field name and index value.</td>
</tr>
<tr>
<td>query->arg_num_indexes</td>
<td>Enter the argument that is to be passed to the script to determine the total number of available indexes. If specified, this will be used to determine when to automatically recache this script query when it is attached to a device.</td>
</tr>
<tr>
<td>query->output_delimeter</td>
<td>Enter the one character delimiter that will be used to separate output values. This is only used when you "query" the script in which case it outputs 'index(delimiter)value'.</td>
</tr>
<tr>
<td>query->index_order</td>
<td>As of version 0.8.6, Cacti will attempt to find the best field to index off of based on whether each row in the query is unique and non-null. If specified, Cacti will perform this check on the fields listed here in the order specified. Only input fields can be specified and multiple fields should be delimited with a comma.</td>
</tr>
<tr>
<td>query->index_order_type</td>
<td>
<p>For sorting purposes, specify whether the index is numeric or alphanumeric.</p>
<p><code class="PARAMETER">numeric</code>: The indexes in this script query are to be sorted numerically (ie. 1,2,3,10,20,31)</p>
<p><code class="PARAMETER">alphabetic</code>: The indexes in this script query are to be sorted alphabetically (1,10,2,20,3,31).</p>
</td>
</tr>
<tr>
<td>query->index_title_format</td>
<td>Specify the title format to use when representing an index to the user. Any input field name can be used as a variable if enclosed in pipes (|). The variable <code class="PARAMETER">|chosen_order_field|</code> will be substituted with the field chosen by Cacti to index off of (see index_order above).</td>
</tr>
<tr>
<td>query->fields</td>
<td>Each field contained within the script query must be defined under this tag.</td>
</tr>
<tr>
<td>query->fields->dskDevice</td>
<td>Each defined field in the script query must have a unique name given to it. Do not use spaces or any non-alphanumeric characters, this name must be identifiable within Cacti.</td>
</tr>
<tr>
<td>query->fields->dskDevice->name</td>
<td>Here you can specify a "friendly name" for the field. This name will be used by Cacti to help the user identify this field.</td>
</tr>
<tr>
<td>query->fields->dskDevice->direction</td>
<td>
<p><code class="PARAMETER">input</code>: Input values are the "known" values that you will use to derive the output values, this is where the "query" part of script query comes in. When you create a graph based on a script query, Cacti will prompt you to choose the input value to base the graph on.</p>
<p><code class="PARAMETER">output</code>: Output values are "unknown" values that are returned from the script. A script query may return multiple statistics for a single index. For instance, a single partition could return free disk space, total disk space, fragmentation percentage, etc.</p>
<p>A rule of thumb is that input fields contain semi-static data that is not graphable, while the output fields contain the data that will be graphed.</p>
</td>
</tr>
<tr>
<td>query->fields->dskDevice->query_name</td>
<td>Enter the name that Cacti must use when asking the script for information about this field. For instance, the following should return values: '(script_name) query (query_name)'.</td>
</tr>
</tbody>
</table>
</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="snmp_query_xml.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="templates.html" accesskey="N">Next</a></td>
</tr>
<tr>
<td width="33%" align="left" valign="top">SNMP Query XML Syntax</td>
<td width="34%" align="center" valign="top"><a href="data_queries.html" accesskey="U">Up</a></td>
<td width="33%" align="right" valign="top">Templates</td>
</tr>
</table>
</div>
</body>
</html>
|
