.\" -*- 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 "oaradmissionrules 1"
.TH oaradmissionrules 1 2024-04-10 oaradmissionrules "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
oaradmissionrules \- manage admission rules
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.IP "\fBoaradmissionrules\fR \-\-show\-all [options]" 4
.IX Item "oaradmissionrules --show-all [options]"
Show all rules
.IP "\fBoaradmissionrules\fR \-\-show <rule\-id> [options]" 4
.IX Item "oaradmissionrules --show <rule-id> [options]"
Show rule #rule\-id
.IP "\fBoaradmissionrules\fR \-\-new [options]" 4
.IX Item "oaradmissionrules --new [options]"
Create a new rule
.IP "\fBoaradmissionrules\fR \-\-modify <rule\-id> [options]" 4
.IX Item "oaradmissionrules --modify <rule-id> [options]"
Modify rule #rule\-id
.IP "\fBoaradmissionrules\fR \-\-delete <rule\-id>" 4
.IX Item "oaradmissionrules --delete <rule-id>"
Delete rule #rule\-id
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Show, create, modify or delete admission rules.
.PP
Admission rules are executed within oarsub. As a result, they provide to the administrator a mechanism to deeply interact with the job submission (e.g.: check or modify the resource request or job types set by the user).
.PP
Rules are run by order of priority, from the lower to the higher value.
.SH OPTIONS
.IX Header "OPTIONS"
.IP "\fB\-s, \-\-show\-all\fR" 4
.IX Item "-s, --show-all"
.RS 4
.PD 0
.IP "\fB\-Y, \-\-enabled\fR" 4
.IX Item "-Y, --enabled"
.PD
Show enabled admission rules only
.IP "\fB\-N, \-\-disabled\fR" 4
.IX Item "-N, --disabled"
Show disabled admission rules only
.RE
.RS 4
.RE
.IP "\fB\-s, \-\-show\-all\fR" 4
.IX Item "-s, --show-all"
.PD 0
.IP "\fB\-s, \-\-show\fR [rule\-id]" 4
.IX Item "-s, --show [rule-id]"
.RS 4
.IP "\fB\-I, \-\-id\fR" 4
.IX Item "-I, --id"
.PD
Show #rule\-id only
.IP "\fB\-f, \-\-full\fR" 4
.IX Item "-f, --full"
Show full script
.IP "\fB\-H, \-\-no\-header\fR" 4
.IX Item "-H, --no-header"
Show script only
.IP "\fB\-w, \-\-to\-file\fR [filename]" 4
.IX Item "-w, --to-file [filename]"
Write script to file (%% replaced by #rule\-id)
.RE
.RS 4
.RE
.IP "\fB\-n, \-\-new\fR" 4
.IX Item "-n, --new"
.PD 0
.IP "\fB\-m, \-\-modify\fR <rule\-id>" 4
.IX Item "-m, --modify <rule-id>"
.RS 4
.IP "\fB\-e, \-\-edit\fR [command]" 4
.IX Item "-e, --edit [command]"
.PD
Edit script using the default editor, or command if provided
.IP "\fB\-r, \-\-from\-file\fR <filename>" 4
.IX Item "-r, --from-file <filename>"
Read script from file instead of running editor
.IP "\fB\-P, \-\-priotity\fR <priority>" 4
.IX Item "-P, --priotity <priority>"
Set priority value for rule
.IP "\fB\-Y, \-\-enabled\fR" 4
.IX Item "-Y, --enabled"
Enable admission rule
.IP "\fB\-N, \-\-disabled\fR" 4
.IX Item "-N, --disabled"
Disable admission rule
.RE
.RS 4
.RE
.IP "\fB\-d, \-\-delete\fR <rule\-id>" 4
.IX Item "-d, --delete <rule-id>"
No option
.IP "\fB\-h, \-\-help\fR" 4
.IX Item "-h, --help"
Print usage
.IP "\fB\-V, \-\-version\fR" 4
.IX Item "-V, --version"
Print OAR version
.SH COPYRIGHTS
.IX Header "COPYRIGHTS"
.Vb 1
\& Copyright 2003\-2016 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