RRDXPORT(1)			    rrdtool			   RRDXPORT(1)



NAME
       rrdxport - Export data in XML format based on data from one or several
       RRD

SYNOPSIS
       rrdtool xport [-s--start seconds] [-e--end seconds]
       [-m--maxrows rows] [--step value] [DEF:vname=rrd:ds-name:CF]
       [CDEF:vname=rpn-expression] [XPORT:vname[:legend]]

DESCRIPTION
       The xport functions main purpose is to write an XML formatted repre
       sentation of the data stored in one or several RRDs. It can also
       extract numerical reports.

       If no XPORT statements are found, there will be no output.

       -s--start seconds (default end-1day)
	   The time when the exported range should begin. Time in seconds
	   since epoch (1970-01-01) is required. Negative numbers are relative
	   to the current time. By default one day worth of data will be
	   printed.  See also AT-STYLE TIME SPECIFICATION section in the rrd
	   fetch documentation for a detailed explanation on how to specify
	   time.

       -e--end seconds (default now)
	   The time when the exported range should end. Time in seconds since
	   epoch.  See also AT-STYLE TIME SPECIFICATION section in the rrd
	   fetch documentation for a detailed explanation of ways to specify
	   time.

       -m--maxrows rows (default 400 rows)
	   This works like the -w--width parameter of rrdgraph.  In fact it
	   is exactly the same, but the parameter was renamed to describe its
	   purpose in this module. See rrdgraph documentation for details.

       --step value (default automatic)
	   See rrdgraph documentation.

       DEF:vname=rrd:ds-name:CF
	   See rrdgraph documentation.

       CDEF:vname=rpn-expression
	   See rrdgraph documentation.

       XPORT:vname::legend
	   At least one XPORT statement should be present. The values refer
	   enced by vname are printed. Optionally add a legend.

Output format
       The output is enclosed in an xport element and contains two blocks. The
       first block is enclosed by a meta element and contains some meta data.
       The second block is enclosed by a data element and contains the data
       rows.

       Lets assume that the xport command looks like this:

	 rrdtool xport \
		 --start now-1h --end now \
		 DEF:xx=host-inout.lo.rrd:output:AVERAGE \
		 DEF:yy=host-inout.lo.rrd:input:AVERAGE \
		 CDEF:aa=xx,yy,+,8,* \
		 XPORT:xx:"out bytes" \
		 XPORT:aa:"in and out bits"

       The resulting meta data section is (the values will depend on the RRD
       characteristics):

	 
	   1020611700
	   300
	   1020615600
	   14
	   2
	   

	     out bytes
	     in and out bits
	   
	 

       The resulting data section is:

	 
	   10206117003.4000000000e+005.4400000000e+01
	   10206120003.4000000000e+005.4400000000e+01
	   10206123003.4000000000e+005.4400000000e+01
	   10206126003.4113333333e+005.4581333333e+01
	   10206129003.4000000000e+005.4400000000e+01
	   10206132003.4000000000e+005.4400000000e+01
	   10206135003.4000000000e+005.4400000000e+01
	   10206138003.4000000000e+005.4400000000e+01
	   10206141003.4000000000e+005.4400000000e+01
	   10206144003.4000000000e+005.4400000000e+01
	   10206147003.7333333333e+005.9733333333e+01
	   10206150003.4000000000e+005.4400000000e+01
	   10206153003.4000000000e+005.4400000000e+01
	   1020615600NaNNaN
	 

EXAMPLE 1
	 rrdtool xport \
		 DEF:out=if1-inouts.rrd:outoctets:AVERAGE \
		 XPORT:out:"out bytes"

EXAMPLE 2
	 rrdtool xport \
		 DEF:out1=if1-inouts.rrd:outoctets:AVERAGE \
		 DEF:out2=if2-inouts.rrd:outoctets:AVERAGE \
		 CDEF:sum=out1,out2,+ \
		 XPORT:out1:"if1 out bytes" \
		 XPORT:out2:"if2 out bytes" \
		 XPORT:sum:"output sum"

AUTHOR
       Tobias Oetiker 



1.2.15				  2006-07-14			   RRDXPORT(1)