.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "oarstat 1"
.TH oarstat 1 2024-04-10 oarstat "OAR commands"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
oarstat \- show information about jobs
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBoarstat\fR [\-X|\-Y|\-J|\-D|\-f] [\-j [jobid]|\-\-array arrayid] [\-\-sql SQL_properties] [\-u [user]] [\-\-array] [\-\-compact] [\-\-format num]
.PP
\&\fBoarstat\fR [\-e|\-p] [\-j jobid | \-\-array arrayid]
.PP
\&\fBoarstat\fR \-s [\-X|\-Y|\-J|\-D] \-j [jobid]
.PP
\&\fBoarstat\fR [\-X|\-Y|\-J|\-D] \-\-gantt "YYYY-MM-DD hh:mm:ss, YYYY-MM-DD hh:mm:ss"
.PP
\&\fBoarstat\fR \-\-accounting "YYYY-MM-DD, YYYY-MM-DD"
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This command is used to show information of jobs in OAR batch scheduler.
.SH OPTIONS
.IX Header "OPTIONS"
.IP "\fB\-f, \-\-full\fR" 4
.IX Item "-f, --full"
Very detailed display. Note that this option does nothing with machine parseable outputs (like \fB\-J\fR), which contain all the available data.
.IP "\fB\-j, \-\-job\fR job_id" 4
.IX Item "-j, --job job_id"
Print information for the given job.
.IP "\fB\-e, \-\-events\fR" 4
.IX Item "-e, --events"
Print job events only. Machine parseable outputs are also available when used in conjunction with correct options (like \fB\-J\fR).
.IP "\fB\-p, \-\-properties\fR" 4
.IX Item "-p, --properties"
Print job properties in the same format as in the \f(CW$OAR_RESOURCE_PROPERTIES_FILE\fR file on the nodes. Machine parseable outputs are also available when used in conjunction with correct options (like \fB\-J\fR). Please note that no properties will be displayed for jobs in "Waiting" state.
.IP "\fB\-s, \-\-state\fR" 4
.IX Item "-s, --state"
Print only the state of a given job. It makes a minimal query to the database, optimized for scripting. Must be used with \-j.
.IP "\fB\-u, \-\-user\fR [login]" 4
.IX Item "-u, --user [login]"
Print information for the current user or the given one.
If used with \-\-accounting, print a more detailed accounting report for the user.
.IP "\fB\-\-array\fR [array_id]" 4
.IX Item "--array [array_id]"
Toggle the visualization of array job information.  If an array_id is provided, print information relative to the subjobs of the given array job.
.IP "\fB\-c, \-\-compact\fR" 4
.IX Item "-c, --compact"
Prints only one line for all the jobs belonging to a same array. The id is replaced by <N>@<id> where "N" is the number of jobs inside the array and "id" is the id of the array. The state is not relevant for an array of jobs (as some jobs may be waiting while others are running for example), so the state column always shows a dash.
.IP \fB\-\-sql\fR 4
.IX Item "--sql"
Restricts display with the SQL where clause on the table jobs (ex: "project = 'p1'")
.IP \fB\-\-format\fR 4
.IX Item "--format"
select the text output format. Available values are:
  1: default
  2: prints system messages
  3: like default but with better naming for fields
.Sp
The users can use the environment variable OAR_OARSTAT_OUTPUT_FORMAT to select the output format 1, 2 or 3.
.IP "\fB\-D, \-\-DUMPER\fR" 4
.IX Item "-D, --DUMPER"
Print result in DUMPER format.
.IP "\fB\-X, \-\-XML\fR" 4
.IX Item "-X, --XML"
Print result in XML format.
.IP "\fB\-Y, \-\-YAML\fR" 4
.IX Item "-Y, --YAML"
Print result in YAML format.
.IP "\fB\-J, \-\-JSON\fR" 4
.IX Item "-J, --JSON"
Print result in JSON format.
.IP "\fB\-g, \-\-gantt\fR ""date_start,date_stop""" 4
.IX Item "-g, --gantt ""date_start,date_stop"""
Print history of jobs and state of resources between two dates like "2006\-03\-30 13:49:27, 2006\-04\-30 13:49:27"
.IP "\fB\-\-accounting\fR ""date_start,date_stop""" 4
.IX Item "--accounting ""date_start,date_stop"""
Shows accounting information between two dates like "2006\-03\-30, 2006\-04\-30".
 If \-\-user is also used, more details are shown for this particular user.
 Warning: the accounting table must be up to date. The update must be done at superuser level with the oaraccounting command.
.IP "\fB\-V, \-\-version\fR" 4
.IX Item "-V, --version"
Print OAR version number.
.IP "\fB\-h, \-\-help\fR" 4
.IX Item "-h, --help"
Print help message.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBoarprint\fR\|(1), \fBoarsub\fR\|(1), \fBoardel\fR\|(1), \fBoarnodes\fR\|(1), \fBoarhold\fR\|(1), \fBoarresume\fR\|(1)
.SH COPYRIGHTS
.IX Header "COPYRIGHTS"
.Vb 1
\& Copyright 2003\-2020 Laboratoire d\*(AqInformatique de Grenoble (http://www.liglab.fr). This software is licensed under the GNU General Public License Version 2 or above. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.Ve