<?xml version="1.0" encoding="UTF-8"?>
<!--
  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  - JASMINe
  - Copyright (C) 2011-2012 Bull S.A.S.
  - Contact: jasmine@ow2.org
  -
  - This library is free software; you can redistribute it and/or
  - modify it under the terms of the GNU Lesser General Public
  - License as published by the Free Software Foundation; either
  - version 2.1 of the License, or any later version.
  -
  - This library 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
  - Lesser General Public License for more details.
  -
  - You should have received a copy of the GNU Lesser General Public
  - License along with this library; if not, write to the Free Software
  - Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
  - USA
  -
  -
  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  - $Id$
  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-->
<sect1 version="5.0" xml:lang="en" xml:id="jasmineprobe.probe_create" xmlns="http://docbook.org/ns/docbook"
  xmlns:xlink="http://www.w3.org/1999/xlink"
  xmlns:xi="http://www.w3.org/2001/XInclude"
  xmlns:svg="http://www.w3.org/2000/svg"
  xmlns:mml="http://www.w3.org/1998/Math/MathML"
  xmlns:html="http://www.w3.org/1999/xhtml"
  xmlns:db="http://docbook.org/ns/docbook">

  <title>Probe definition</title>

    <para>
      In order to define a probe, users can specify:
      <itemizedlist>
       <listitem>
         <para><emphasis role="bold">id</emphasis>: the probe name (must be unique ; generated by JASMINe Probe if not specified by the user).</para>
       </listitem>
       <listitem>
         <para><emphasis role="bold">period</emphasis>: defines the execution period. The default value is 10 sec.</para>
       </listitem>
       <listitem>
         <para><emphasis role="bold">indicators</emphasis>: list of indicators. At least one indicator name should be specified.</para>
       </listitem>
       <listitem>
         <para><emphasis role="bold">outputs</emphasis>: list of outputs. At least one output name should be specified.</para>
       </listitem>
       <listitem>
         <para><emphasis role="bold">targets</emphasis>: list of targets. Optional. If defined, currently only one target is allowed. This target has priority over those specified in the jmx indicators' definition.</para>
       </listitem>
       <listitem>
         <para><emphasis role="bold">start</emphasis>: boolean that specifies, if true, to immediately start the probe after creation completes. Optional (by default the probe start is a separate operation).</para>
       </listitem>
     </itemizedlist>
    </para>

</sect1>
