.\" -*- 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 "oarsh 1"
.TH oarsh 1 2024-04-10 oarsh "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
oarsh \- remote shell connector for OAR batch scheduler.
.PP
oarcp \- oarsh companion to copy files from a node or to a node.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBoarsh\fR [OPTIONS] <NODENAME> [COMMAND]
.PP
\&\fBoarcp\fR [OPTIONS] [NODENAME:]<PATHNAME> [NODENAME:]<PATHNAME>
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Connect to a node from the job submission frontend of the cluster or any other node.
.SH OPTIONS
.IX Header "OPTIONS"
The \fBoarsh\fR mechanism uses \fIOpenSSH\fR client (the ssh command) under the hood to perform connections to remote hosts. Thus most of \fIOpenSSH\fR options can be used (but some are filtered out for security reasons).
.SH ENVIRONMENT
.IX Header "ENVIRONMENT"
.IP \fBOAR_JOB_ID\fR 4
.IX Item "OAR_JOB_ID"
If not using the job-key mechanism, the \fBOAR_JOB_ID\fR environment variable has to be set to give the jobid of the job to connect to on the remote node (a node can run several jobs at a same time). This is only required for connecting from outside the job (e.g. from the job submission frontend).
.IP \fBOAR_JOB_KEY_FILE\fR 4
.IX Item "OAR_JOB_KEY_FILE"
If using the job-key mechanism (see \fBoarsub\fR \-k \-e/\-i), \fBoarsh\fR can use the job-key defined by the \fBOAR_JOB_KEY_FILE\fR environment variable to connect to job on the remote machine. That mechanism can allow one to connect to a job from a machine which is outside the OAR cluster the job belong to (e.g. in a grid of OAR clusters), given the job-key is available on that machine. NB: it is also possible to give the job-key using \fBoarsh\fR \-i option.
.SH EXAMPLES
.IX Header "EXAMPLES"
.IP "Connecting from within our job, from one node to another one (node23):" 4
.IX Item "Connecting from within our job, from one node to another one (node23):"
> oarsh node\-23
.IP "Connecting to a node (node23) of our job (Id: 4242) from the frontal of the cluster:" 4
.IX Item "Connecting to a node (node23) of our job (Id: 4242) from the frontal of the cluster:"
> OAR_JOB_ID=4242 oarsh node\-23
.IP "Connecting to a node (node23) of our job that was submitted using a job-key:" 4
.IX Item "Connecting to a node (node23) of our job that was submitted using a job-key:"
> OAR_JOB_KEY_FILE=~/my_key oarsh node\-23
.IP "Same thing but using OpenSSH-like \fI\-i\fR option:" 4
.IX Item "Same thing but using OpenSSH-like -i option:"
> oarsh \-i ~/my_key node\-23
.SH NOTES
.IX Header "NOTES"
\&\fBoarsh\fR inherits from most of OpenSSH capabilities (e.g. X11 forwarding). However, one feature which \fBoarsh\fR does break is the SSH Agent.
.PP
The user's OpenSSH configuration files (files in the \fI~/.ssh\fR directory) are not used by \fBoarsh\fR.
.PP
For advanced users, when using the job-key mechanism, it is also possible to use ssh directly to connect to a job on a node. Please refer to the documentation of your cluster, or ask the admisitrator of your cluster.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBoarsub\fR\|(1), \fBoardel\fR\|(1) \fBoarstat\fR\|(1), \fBoarnodes\fR\|(1), \fBoarhold\fR\|(1), \fBoarresume\fR\|(1)
.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