.\" -*- 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 "oarwalltime 1"
.TH oarwalltime 1 2024-04-10 oarwalltime "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
oarwalltime \- query or request a change of the walltime of a job handled by the OAR batch scheduler.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBoarwalltime\fR [options] <job_id> [<[+/\-]new walltime>]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This command manages requests to change the walltime of a job.
.PP
If no \fInew walltime\fR is given, the command shows the current walltime change status for the job.
.PP
If a \fInew walltime\fR is given, the command requests a change of the walltime of the job, or update a previous request.
.PP
The \fInew walltime\fR is to be passed in the format [+\-]h:m:s. If no sign is used,
The value is a new walltime absolute value (like passed to oarsub). If prefixed
by +, the request is an increase of the walltime by the passed value. If
prefixed by \-, it is a decrease request.
A walltime change request that has not been yet accepted by the scheduler can be
cancelled by passing the '+0' value.
.PP
Walltime changes can only be requested for a running job.
.PP
There is no warranty that walltime can be increased, since it depends on the resources availability (next jobs).
.PP
Once a request is registered, it will by handled during the next pass of scheduling and granted if it fits with other jobs.
.PP
As per configuration:
.IP \(bu 4
the walltime change functionality may be disabled in your installation, and if not there is a maximum to the possible walltime increase
.IP \(bu 4
a walltime increase request may only be applied some time before the predicted end of the job. That apply time may be computed as a percentage of the walltime of the job
.IP \(bu 4
a walltime increase may happen incrementally, so that other scheduled jobs get more priority. That increment may be computed as a percentage of the walltime of the job
.IP \(bu 4
the functionality may be configured differently from one queue to another.
.PP
\&\fIRead your site's documentation or ask your administrator to know the configured settings.\fR
.SH OPTIONS
.IX Header "OPTIONS"
.IP \fB\-\-force\fR 4
.IX Item "--force"
Request walltime increase to be trialed or applied immediately regardless of any otherwise configured delay.
.IP \fB\-\-whole\fR 4
.IX Item "--whole"
Request walltime increase to be trialed or applied wholly at once, or not applied otherwise.
.IP \fB\-\-delay\-next\-jobs\fR 4
.IX Item "--delay-next-jobs"
Request walltime increase to possibly delay next batch jobs (but not advance reservations), if required to fit in the resources allocation. Warning: this implies delaying any other batch jobs, including the ones from other users. Using this option may be prohibited.
.IP \fB\-\-timeout\fR 4
.IX Item "--timeout"
Specify a timeout (in seconds) after which the walltime change request will be aborted if not already accepted by the scheduler. By default, there is no timeout unless a default timeout is set by the administrator.
.IP "\fB\-h, \-\-help\fR" 4
.IX Item "-h, --help"
Print help command message.
.IP "\fB\-V, \-\-version\fR" 4
.IX Item "-V, --version"
Print OAR version.
.SH NOTES
.IX Header "NOTES"
All changes are logged. Changes using the force or delay-next-jobs options are accounted.
.PP
\&\fIPlease mind the walltime of the job and do not rely too much on that functionality.\fR
.PP
The shell environment variables of the job are not updated (OAR_JOB_WALLTIME, OAR_JOB_WALLTIME_SECONDS).
.PP
Walltime change events for a job are listed in the \fIoarstat\fR output.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBoarstat\fR\|(1), \fBoarsub\fR\|(1), \fBoardel\fR\|(1)
.SH COPYRIGHTS
.IX Header "COPYRIGHTS"
.Vb 1
\& Copyright 2003\-2017 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