1RETRACE-SERVER-TAS(1)        Retrace Server Manual       RETRACE-SERVER-TAS(1)
2
3
4

NAME

6       retrace-server-task - Create a task, get and set fields on an existing
7       task
8

SYNOPSIS

10       retrace-server-task create [-h] [-n] [-s SERVER] [-v] [-u | -k] [-t |
11       -m | -f] [-i] [-d] [-bz BUGZILLANO] [-c CASENO] [-e EMAIL] [-o
12       OS_RELEASE] [-p PACKAGE] [-x EXECUTABLE] [-r KERNELVER] [--vmem VMEM]
13       COREFILE
14
15       retrace-server-task restart [-h] [-n] [-s SERVER] [-v] [-bz BUGZILLANO]
16       [-c CASENO] [-e EMAIL] [-r KERNELVER] TASK_ID
17
18       retrace-server-task get [-h] [-n] [-p PASSWORD] [-s SERVER] [-v] [-b |
19       -bz | -c | -e | -m | -t] TASK_ID
20
21       retrace-server-task set [-h] [-n] [-p PASSWORD] [-s SERVER] [-v] [-bz
22       BUGZILLANO] [-c CASENO] [-e EMAIL] TASK_ID
23

DESCRIPTION

25       This tool is able to communicate with Retrace server: create a new
26       task, restart an existing task, get and set values of an existing task.
27       If kerberos ticket is available, all communication uses it. To stop
28       using the ticket you must destroy it (kdestroy).
29

OPERATIONS

31       create
32           Create a new task. Task can be either http task (COREFILE is
33           compressed and sent through http API), manager task (/manager site
34           must be available) or ftp task (same as manager task, but uses ftp
35           file). If none of the options "-t", "-m", or "-f" are given, the
36           following logic is tried. If COREFILE is a local file, then the
37           "-m" option is used, otherwise the "-f" option is used.
38
39       restart
40           Restart an existing task. Note that restarting an existing task
41           removes all files inside the results directory.
42
43       set
44           Write (set) information on an existing task. Available only for
45           manager and ftp task. See retrace-server-interact for setting the
46           success or failure of a task. See SET OPTIONS section for list of
47           set options available.
48
49       get
50           Read (get) information on an existing task. If no parameters
51           specified the output will default to the task status. See GET
52           OPTIONS section for list of get options available.
53
54       batch
55           Very similar to create (has the same parameters) but also waits
56           until task is finished. If the task finishes successfully
57           thebacktrace is downloaded
58

COMMON OPTIONS

60       -h, --help
61           Display help and exit.
62
63       -n, --no-verify
64           Do not verify certificate. (off by default)
65
66       -p, --password PASSWORD
67           Password of the task (only for http tasks)
68
69       -s, --server SERVER
70           URL for Retrace server. If not specified local server is tried and
71           if not available https://retrace.fedoraproject.org/ is used.
72
73       -v, --verbose
74           Be verbose. Note this also turns on debug logging for create, batch
75           or restart operations.
76

CREATE OR BATCH OPTIONS

78       -bz BUGZILLANO, --bugzillano BUGZILLANO
79           Write the bugzillano field in the task to BUGZILLANO. Available
80           only for manager and ftp task.
81
82       -c CASENO, --caseno CASENO
83           Write the caseno field in the task to CASENO. Available only for
84           manager and ftp task.
85
86       -e EMAIL, --email EMAIL
87           Write the email field in the task to EMAIL. Available only for
88           manager and ftp task.
89
90       -d, --no-md5
91           Do not calculate md5sum on the task. Available only for manager and
92           ftp task.
93
94       -u, --userspace_core
95           The COREFILE specified is userspace core.
96
97       -k, --kernel_core
98           The COREFILE specified is kernel core. (default)
99
100       -t, --http
101           The COREFILE is assumed to be a local file, submitted through http
102
103       -f, --ftp
104           The COREFILE is assumed to be on the ftp server as configured in
105           retrace-server
106
107       -m, --manager
108           The COREFILE is assumed to be either a URL that is wget-able or a
109           local file
110
111       -i, --interactive
112           Create an interactive (persistent) task that may be accessed later
113           in an interactive debug session. Without this option, manager and
114           ftp tasks are interactive, and http tasks are not.
115
116       --vmem VMEM
117           Virtual memory file VMEM needed for retracing kernel vmcore
118           snapshots. Only valid for kernel cores.
119
120       -r KERNELVER, --kernelver KERNELVER
121           Force the kernel version in the COREFILE to KERNELVER. Only valid
122           for kernel cores.
123
124       -o OS_RELEASE, --os_release OS_RELEASE
125           Force the version of the operating system in COREFILE to
126           OS_RELEASE. Only valid for userspace cores.
127
128       -p PACKAGE, --package PACKAGE
129           Force the version of the RPM package corresponding to COREFILE to
130           PACKAGE. Only valid for userspace cores.
131
132       -x EXECUTABLE, --executable EXECUTABLE
133           Force the COREDUMP executable to EXECUTABLE. Only valid for
134           userspace cores.
135

RESTART OPTIONS

137       -bz BUGZILLANO, --bugzillano BUGZILLANO
138           Write the bugzillano field in the task to BUGZILLANO. Available
139           only for manager and ftp task.
140
141       -c CASENO, --caseno CASENO
142           Write the caseno field in the task to CASENO. Available only for
143           manager and ftp task.
144
145       -e EMAIL, --email EMAIL
146           Write the email field in the task to EMAIL. Available only for
147           manager and ftp task.
148
149       -r KERNELVER, --kernelver KERNELVER
150           Force the kernel version in the task to KERNELVER. Only valid for
151           kernel cores.
152

GET OPTIONS

154       -b, --backtrace
155           Return the backtrace in a file in the current directory
156
157       -bz, --bugzillano
158           Return the value of the bugzillano field in the task to the
159           terminal. Available only for manager and ftp task.
160
161       -c, --caseno
162           Return the value of the caseno field in the task to the terminal.
163           Available only for manager and ftp task.
164
165       -e, --email
166           Return the value of the email field in the task to the terminal.
167           Available only for manager and ftp task.
168
169       -m, --md5sum
170           Return the md5sum field in the task to the terminal. Available only
171           for manager and ftp task.
172
173       -t, --status
174           Return the status field in the task to the terminal. If no option
175           is given, this field is selected as default.
176

SET OPTIONS

178       -bz BUGZILLANO, --bugzillano BUGZILLANO
179           Write the bugzillano field in the task to BUGZILLANO. Available
180           only for manager and ftp task.
181
182       -c CASENO, --caseno CASENO
183           Write the caseno field in the task to CASENO. Available only for
184           manager and ftp task.
185
186       -e EMAIL, --email EMAIL
187           Write the email field in the task to EMAIL. Available only for
188           manager and ftp task.
189

EXAMPLES

191       Create a task from a local file (kernel vmcore)
192
193           retrace-server-task create ./localfile
194
195       Create a task where the file (kernel vmcore) exists on FTP server
196
197           retrace-server-task create 012345-vmcore
198
199       Create a task for kernel vmcore snapshot with vmem file included
200
201           retrace-server-task create 012345-vmcore.vmss --vmem 012345-vmcore.vmem
202
203       Batch run local file on https://retrace.fedoraproject.org/ (usperspace
204       core)
205
206           retrace-server-task batch -u -t -o "Fedora release 25 (Twenty five)" -p \
207           "coreutils-8.25-17.fc25" -x "/usr/bin/sleep" ./coredump
208
209       Read the md5sum field for task 925483242
210
211           retrace-server-task get --md5sum 925483242
212
213       Write the caseno field for task 925483242 to 01234567
214
215           retrace-server-task set --caseno 01234567 925483242
216
217       Write the bugzillano field for task 31415926 to 53589793, 23846264
218
219           retrace-server-task set --bugzillano 53589793,23846264 31415926
220
221       Restart task 790216008
222
223           retrace-server-task restart 790216008
224
225       Restart task 164167944 forcing kernel version to 4.18.0-80.el8.x86_64
226
227           retrace-server-task restart 790216008 --kernelver 4.18.0-80.el8.x86_64
228

AUTHORS

230       •   Matej Marusak <mmarusak@redhat.com[1]>
231

NOTES

233        1. mmarusak@redhat.com
234           mailto:mmarusak@redhat.com
235
236
237
238retrace-server 1.24.1             02/22/2022             RETRACE-SERVER-TAS(1)
Impressum