1ARCLI(1) ARCLI(1)
2
6 arcli - Autotest RPC Client Application
7
9 arcli [-h] [--host HOST]
10 {host,user,testenvironment,server,linuxdis‐
11 tro,job,label,test,regressionpoint}
12
14 arcli is the Autotest RPC client command line interface application. In
15 a nutshell, it allows users to interact with an Autotest server by
16 means of its RPC service.
17
19 The following list of options are global arcli options. Most options
20 are actually sub command options, as described in the SUB COMMANDS sec‐
21 tion:
22 -h, --help show this help message and exit
24 --host HOST Hostname or IP address for the autotest server
25
27 arcli usage is broken into sub commands. This is the current list of
28 sub commands:
29 · host
31 · job
33 · label
35 · test
37 · server
39 · user
41 · linuxdistro
43 · testenvironment
45 Most sub commands accept common options, such as -n|--name and -i|--id.
47 So, suppose you're looking for a job with an specific ID, you'd use:
48 $ arcli job -i <job_id> ...
50 Likewise, when looking for a host with a given name, you'd use:
52 $ arcli host -n <host_name> ...
54 HOST SUB COMMAND
56 arcli host [-h] (-l | -j | -a | -d | --lock | --unlock | --reverify)
57 [-n NAME] [-i ID]
58 DESCRIPTION
60 The host command allows the user to manipulate hosts on an autotest
61 server, including adding new hosts and removing existing ones.
62 It's also possible to manage their temporary availability, which is
64 known as locking and unlocking machines.
65 If a given host is not in "Ready" state, you can also ask for a re-ver‐
67 ification job to be sent.
68 ACTION ARGUMENTS
70 -l, --list-brief
71 list all records briefly
72 -j, --list-jobs
74 list the jobs running on the listed hosts
75 -a, --add
77 add a new entry
78 -d, --delete
80 delete an existing object
81 --lock locks the host (makes it unavailable to new jobs)
83 --unlock
85 unlocks the host (makes it available to new jobs)
86 --reverify
88 schedules a host reverification job
89 OPTIONAL ARGUMENTS
91 -n, --name
92 name, usually the FQDN
93 -i, --id
95 numeric identification of the host
96 ADDING A NEW HOST
98 To add a new host you just have to provide its name, which is usually
99 the hostname or the fully qualified host name:
100 $ arcli host -a -n host.testgrid.example
102 The long form of the command would be:
104 $ arcli host --add --name host.testgrid.example
106 REMOVING AN EXISTING HOST
108 To remove an existing host you can provide either its name or its
109 numeric identifier:
110 $ arcli host -d -n host.testgrid.example
112 $ arcli host -d -i 1
113 The long form of the command would be:
115 $ arcli host --delete --name host.testgrid.example
117 $ arcli host --delete --id 1
118 LISTING HOSTS
120 You can list the hosts registered on the server by using:
121 $ arcli host -l
123 or:
125 $ arcli host --list-brief
127 LISTING JOBS
129 You can list the test jobs that are currently running on each host by
130 using:
131 $ arcli host -j
133 or:
135 $ arcli host --list-jobs
137 LOCKING A HOST
139 To lock a host and make it unavailable for the server to schedule new
140 jobs on it, run:
141 $ arcli host --lock -n host.fqdn.org
143 You could use a host numeric identifier:
145 $ arcli host --lock -i 1
147 UNLOCKING A HOST
149 To unlock a host and make it available for the server to schedule new
150 jobs on it, run:
151 $ arcli host --unlock -n host.fqdn.org
153 TEST SUB COMMAND
155 arcli test [-h] (-l | -a | -d) [-n NAME] [-i ID]
156 DESCRIPTION
158 The test sub command allows to register new tests and list tests
159 already registered on the Autotest server. Please note that registering
160 a new test means just that, you probably would still need to copy the
161 test files to the server so that it the server can deploy it to test
162 machines.
163 ACTION ARGUMENTS
165 -l, --list-brief
166 list all records briefly
167 -a, --add
169 add a new entry
170 -d, --delete
172 delete an existing object
173 OPTIONAL ARGUMENTS
175 -n, --name
176 name of the object
177 -i, --id
179 numeric identification of the object
180 TESTENVIRONMENT SUB COMMAND
182 arcli testenvironment [-h] (-s SHOW | -d DIFF)
183 DESCRIPTION
185 A test environment is a collection of the environment that existed dur‐
186 ing a test run. Since a test runs on a machine, this environment infor‐
187 mation may be what differs a test with a PASS from a test with a FAIL
188 result.
189 ACTION ARGUMENTS
191 -s, --show
192 show details about a test environment
193 -d, --diff
195 shows differences between two test environments
196 JOB SUB COMMAND
198 arcli job [-h] (-l | -a | -d JOB_ID | -s JOB_ID) [-n NAME] [-i ID]
199 [-c CONTROL_FILE] [-t TEST_TYPE] [-m MACHINES] [-e EMAIL]
200 [-p PRIORITY] [-P PROFILES] [-B REBOOT_BEFORE]
201 [-A REBOOT_AFTER] [--all] [-T TEST_ID] [-E]
202 DESCRIPTION
204 The job command lets users submit new jobs with various parameters,
205 abort jobs that are running and list both currently running jobs and
206 previous jobs submitted to the server.
207 ACTION ARGUMENTS
209 -l, --list-brief
210 list all records briefly
211 -a, --add
213 add (create) a new job
214 -d, --delete
216 delete (abort) a queued or running job
217 -s, --show
219 shows details about a job
220 OPTIONAL ARGUMENTS
222 -n, --name
223 name of the object
224 -i, --id
226 numeric identification of the object
227 -c, --control-file
229 path to the control file defining the job
230 -t, --test-type
232 the type of test
233 -m, --machines
235 the machine specification on where to run the test, either a
236 list of machines or n*label
237 -e, --email
239 A comma seperated list of email addresses to notify of job com‐
240 pletion
241 -p, --priority
243 the priority of test, used by the scheduler
244 -P, --profiles
246 the list of profiles for the hosts
247 -B, --reboot-before
249 Should test machines be rebooted before the job execution?
250 -A, --reboot-after
252 Should test machines be rebooted after the job execution?
253 --all Show all information. Either show all jobs or all information
255 about a given job. Depends on the given command
256 -T, --from-test-number
258 Add (create) a new job using the control filefrom a test regis‐
259 tered on the autotest server
260 -E, --edit-before-sending
262 Open control file in editor before sending the control file to
263 the server.
264 SUBMITTING A NEW JOB
266 The basis for a job in Autotest is a control file, and that's what
267 you'll need before submitting a new job.
268 Suppose you have a local copy of the Autotest source tree at
270 /home/user/autotest, and the sleep test control file at
271 /home/user/autotest/client/tests/sleeptest/control.
272 Also, suppose you want the job to be run on a specific machine named
274 wakemeup.testgrid.example. To send this job you'd run:
275 $ arcli job -a -m wakemeup.testgrid.example -n 'my sleep test' \
277 -c /home/user/autotest/client/tests/sleeptest/control
278 LABEL SUB COMMAND
280 arcli label [-h] (-l | -L | -a | -d) [-n NAME] [-i ID]
281 DESCRIPTION
283 The label command allows to create new labels and list existing labels.
284 ACTION ARGUMENTS
286 -l, --list-brief
287 list all records briefly
288 -L, --list-full
290 list all records with all information
291 -a, --add
293 add a new entry
294 -d, --delete
296 delete an existing object
297 OPTIONAL ARGUMENTS
299 -n, --name
300 name of the object
301 -i, --id
303 numeric identification of the object
304 LINUXDISTRO SUB COMMAND
306 arcli linuxdistro [-h] (-s | -d) [-i ID] [-p PAIR]
307 DESCRIPTION
309 The linuxdistro command allows you to inspect the distribution name and
310 version numbers.
311 ACTION ARGUMENTS
313 -s, --show
314 show details about a linux distro
315 -d, --diff
317 shows differences between two linux distros
318 OPTIONAL ARGUMENTS
320 -i, --id
321 numeric identification of the object
322 -p, --pair
324 pair of linux distro IDs for comparison
325 SERVER SUB COMMAND
327 arcli server [-h] (-s | -l)
328 DESCRIPTION
330 The server command allows you to inspect server characteristics.
331 ACTION ARGUMENTS
333 -s, --status
334 obtain the status of the Autotest server
335 -l, --list-install-profiles
337 list the available installation profiles
338 USER SUB COMMAND
340 arcli user [-h] (-l | -L | -a | -d | -s USER_ID) [-n NAME] [-i ID]
341 DESCRIPTION
343 The user command allows you to inspect user characteristics.
344 ACTION ARGUMENTS
346 -l, --list-brief
347 list all records briefly
348 -L, --list-full
350 list all records with all information
351 -a, --add
353 add a new entry
354 -d, --delete
356 delete an existing object
357 -s, --show
359 shows details about an user
360 OPTIONAL ARGUMENTS
362 -n, --name
363 name of the object
364 -i, --id
366 numeric identification of the object
367
369 /etc/arc.conf
370 system wide configuration file
371 ~/.arc.conf
373 user specific configuration file
374
376 If you find a bug, please report it over our github page as an issue.
377
379 Cleber Rosa <cleber@redhat.com>
3800.7.1 ARCLI(1)