1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
3 <!-- Fill in your name for FIRSTNAME and SURNAME. -->
4 <!-- Please adjust the date whenever revising the manpage. -->
5 <!ENTITY dhdate "<date>June 08, 2010</date>">
6 <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
7 allowed: see man(7), man(1). -->
8 <!ENTITY dhsection "<manvolnum>8</manvolnum>">
9 <!ENTITY dhucpackage "<refentrytitle>gnt-debug</refentrytitle>">
10 <!ENTITY dhpackage "gnt-debug">
12 <!ENTITY debian "<productname>Debian</productname>">
13 <!ENTITY gnu "<acronym>GNU</acronym>">
14 <!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
15 <!ENTITY footer SYSTEM "footer.sgml">
26 <holder>Google Inc.</holder>
34 <refmiscinfo>Ganeti 2.2</refmiscinfo>
37 <refname>&dhpackage;</refname>
39 <refpurpose>Debug commands</refpurpose>
43 <command>&dhpackage; </command>
45 <arg choice="req">command</arg>
46 <arg>arguments...</arg>
50 <title>DESCRIPTION</title>
53 The <command>&dhpackage;</command> is used for debugging the
59 <title>COMMANDS</title>
62 <title>ALLOCATOR</title>
65 <command>allocator</command>
67 <arg>--dir <replaceable>DIRECTION</replaceable></arg>
68 <arg choice="req">--algorithm <replaceable>ALLOCATOR</replaceable>
70 <arg>--mode <replaceable>MODE</replaceable></arg>
71 <arg>--mem <replaceable>MEMORY</replaceable></arg>
72 <arg>--disks <replaceable>DISKS</replaceable></arg>
73 <arg>--disk-template <replaceable>TEMPLATE</replaceable></arg>
74 <arg>--nics <replaceable>NICS</replaceable></arg>
75 <arg>--os-type <replaceable>OS</replaceable></arg>
76 <arg>--vcpus <replaceable>VCPUS</replaceable></arg>
77 <arg>--tags <replaceable>TAGS</replaceable></arg>
78 <arg choice="req"><replaceable>instance</replaceable></arg>
82 Executes a test run of the <emphasis>iallocator</emphasis> framework.
86 The command will build input for a given iallocator script
87 (named with the <option>--algorithm</option> option), and
88 either show this input data (if
89 <replaceable>DIRECTION</replaceable> is
90 <emphasis>in</emphasis>) or run the iallocator script and show
91 its output (if <replaceable>DIRECTION</replaceable> is
92 <emphasis>out</emphasis>).
96 If the <replaceable>MODE</replaceable> is
97 <emphasis>allocate</emphasis>, then an instance definition is
98 built from the other arguments and sent to the script,
99 otherwise (<replaceable>MODE</replaceable> is
100 <emphasis>relocate</emphasis>) an existing instance name must
101 be passed as the first argument.
105 This build of Ganeti will look for iallocator scripts in the
106 following directories: <filename
107 class="directory">@CUSTOM_IALLOCATOR_SEARCH_PATH@</filename>;
108 for more details about this framework, see the HTML or PDF
117 <command>delay</command>
119 <arg>--no-master</arg>
120 <arg choice="opt" rep="repeat">-n <replaceable>NODE</replaceable></arg>
121 <arg choice="req"><replaceable>duration</replaceable></arg>
125 Run a test opcode (a sleep) on the master and on selected nodes
126 (via an RPC call). This serves no other purpose but to execute a
131 The <option>-n</option> option can be given multiple times to
132 select the nodes for the RPC call. By default, the delay will
133 also be executed on the master, unless the
134 <option>--no-master</option> option is passed.
138 The <replaceable>delay</replaceable> argument will be
139 interpreted as a floating point number.
145 <title>SUBMIT-JOB</title>
148 <command>submit-job</command>
149 <arg choice="opt">--verbose</arg>
150 <arg choice="opt">--timing-stats</arg>
151 <arg choice="opt">--job-repeat <option>N</option></arg>
152 <arg choice="opt">--op-repeat <option>N</option></arg>
153 <arg choice="req" rep="repeat">opcodes_file</arg>
157 This command builds a list of opcodes from files in JSON format
158 and submits a job per file to the master daemon. It can be used
159 to test options that are not available via command line.
163 The <option>verbose</option> option will additionally display
164 the corresponding job IDs and the progress in waiting for the
165 jobs; the <option>timing-stats</option> option will show some
166 overall statistics inluding the number of total opcodes, jobs
167 submitted and time spent in each stage (submit, exec, total).
171 The <option>job-repeat</option> and <option>op-repeat</option>
172 options allow to submit multiple copies of the passed arguments;
173 job-repeat will cause N copies of each job (input file) to be
174 submitted (equivalent to passing the arguments N times) while
175 op-repeat will cause N copies of each of the opcodes in the file
176 to be executed (equivalent to each file containing N copies of
183 <title>TEST-JOBQUEUE</title>
186 <command>test-jobqueue</command>
190 Executes a few tests on the job queue. This command might generate
191 failed jobs deliberately.
198 <command>locks</command>
199 <arg>--no-headers</arg>
200 <arg>--separator=<replaceable>SEPARATOR</replaceable></arg>
202 <arg>-o <replaceable>[+]FIELD,...</replaceable></arg>
203 <arg>--interval=<replaceable>SECONDS</replaceable></arg>
208 Shows a list of locks in the master daemon.
212 The <option>--no-headers</option> option will skip the initial
213 header line. The <option>--separator</option> option takes an
214 argument which denotes what will be used between the output
215 fields. Both these options are to help scripting.
219 The <option>-o</option> option takes a comma-separated list of
220 output fields. The available fields and their meaning are:
225 <simpara>Lock name</simpara>
232 Mode in which the lock is currently acquired (exclusive or
240 <simpara>Current lock owner(s)</simpara>
246 <simpara>Threads waiting for the lock</simpara>
253 If the value of the option starts with the character
254 <constant>+</constant>, the new fields will be added to the default
255 list. This allows to quickly see the default list plus a few other
256 fields, instead of retyping the entire list of fields.
260 Use <option>--interval</option> to repeat the listing. A delay
261 specified by the option value in seconds is inserted.
271 <!-- Keep this comment at the end of the file
276 sgml-minimize-attributes:nil
277 sgml-always-quote-attributes:t
280 sgml-parent-document:nil
281 sgml-default-dtd-file:nil
282 sgml-exposed-tags:nil
283 sgml-local-catalogs:nil
284 sgml-local-ecat-files:nil