Slurm Workload Manager -

    sattach [\fIoptions\fP] <jobid.stepid>
    .SH "DESCRIPTION"
    .LP
    sattach attaches to a running Slurm job step.  By attaching, it makes available
    the IO streams of all of the tasks of a running Slurm job step.  It also
    suitable for use with a parallel debugger like TotalView.

    .SH "OPTIONS"
    .LP

    .TP
    \fB\-h\fR, \fB\-\-help\fR
    Display help information and exit.

    .TP
    \fB\-\-input\-filter\fR[=]<\fItask number\fR>
    .PD 0
    .TP
    \fB\-\-output\-filter\fR[=]<\fItask number\fR>
    .PD 0
    .TP
    \fB\-\-error\-filter\fR[=]<\fItask number\fR>
    .PD
    Only transmit standard input to a single task, or print the standard output
    or standard error from a single task.  The filtering is performed locally in
    sattach.

    .TP
    \fB\-l\fR, \fB\-\-label\fR
    Prepend each line of task standard output or standard error with the task
    number of its origin.

    .TP
    \fB\-\-layout\fR
    Contacts the slurmctld to obtain the task layout information for the job step,
    prints the task layout information, and then exits without attaching to the
    job step.

    .TP
    \fB\-\-pty\fR
    Execute task zero in pseudo terminal.
    Not compatible with the \fB\-\-input\-filter\fR, \fB\-\-output\-filter\fR, or
    \fB\-\-error\-filter\fR options.
    Notes: The terminal size and resize events are ignored by sattach.
    Proper operation requires that the job step be initiated by srun using the
    \-\-pty option.

    .TP
    \fB\-Q\fR, \fB\-\-quiet\fR
    Suppress informational messages from sattach. Errors will still be displayed.

    .TP
    Executing \fBsattach\fR sends a remote procedure call to \fBslurmctld\fR. If
    enough calls from \fBsattach\fR or other Slurm client commands that send remote
    procedure calls to the \fBslurmctld\fR daemon come in at once, it can result in
    a degradation of performance of the \fBslurmctld\fR daemon, possibly resulting
    in a denial of service.
    .PP
    Do not run \fBsattach\fR or other Slurm client commands that send remote
    procedure calls to \fBslurmctld\fR from loops in shell scripts or other
    programs. Ensure that programs limit calls to \fBsattach\fR to the minimum
    necessary for the information you are trying to gather.

    .SH "INPUT ENVIRONMENT VARIABLES"
    .PP
    Upon startup, salloc will read and handle the options set in the following
    environment variables.  Note: Command line options always override environment
    variables settings.

    .TP
    \fBSLURM_CONF\fR
    The location of the Slurm configuration file.
    .TP
    \fBSLURM_EXIT_ERROR\fR
    Specifies the exit code generated when a Slurm error occurs
    (e.g. invalid options).
    This can be used by a script to distinguish application exit codes from
    various Slurm error conditions.

    .SH "EXAMPLES"
    .TP
    Attach to job 15, step 0:

    .nf
    $ sattach 15.0
    .fi

    .TP
    Limit the output to the 5th task of job 65386, step 15:

    .nf
    $ sattach \-\-output\-filter 5 65386.15
    .fi

    .SH "COPYING"
    Copyright (C) 2006\-2007 The Regents of the University of California.
    Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
    .br
    Copyright (C) 2008\-2009 Lawrence Livermore National Security.
    .br
    Copyright (C) 2010\-2013 SchedMD LLC.
    .LP
    This file is part of Slurm, a resource management program.
    \fBsinfo\fR(1), \fBsalloc\fR(1), \fBsbatch\fR(1), \fBsqueue\fR(1),
    \fBscancel\fR(1), \fBscontrol\fR(1),
    \fBslurm.conf\fR(5), \fBsched_setaffinity\fR (2), \fBnuma\fR (3)