sattach(1)

1sattach(1)                      Slurm Commands                      sattach(1)
2
3
4

NAME

6       sattach - Attach to a Slurm job step.
7

SYNOPSIS

9       sattach [options] <jobid.stepid>
10

DESCRIPTION

12       sattach  attaches  to a running Slurm job step.  By attaching, it makes
13       available the IO streams of all of the tasks of  a  running  Slurm  job
14       step.   It  also  suitable  for  use  with  a  parallel  debugger  like
15       TotalView.
16
17

OPTIONS

19       -h, --help
20              Display help information and exit.
21
22
23       --input-filter[=]<task number>
24       --output-filter[=]<task number>
25       --error-filter[=]<task number>
26              Only transmit standard input to a  single  task,  or  print  the
27              standard  output or standard error from a single task.  The fil‐
28              tering is performed locally in sattach.
29
30
31       -l, --label
32              Prepend each line of task standard output or standard error with
33              the task number of its origin.
34
35
36       --layout
37              Contacts the slurmctld to obtain the task layout information for
38              the job step, prints the task layout information, and then exits
39              without attaching to the job step.
40
41
42       --pty  Execute  task  zero in pseudo terminal.  Not compatible with the
43              --input-filter,  --output-filter,  or  --error-filter   options.
44              Notes:  The  terminal size and resize events are ignored by sat‐
45              tach.  Proper operation requires that the job step be  initiated
46              by srun using the --pty option.
47
48
49       -Q, --quiet
50              Suppress  informational messages from sattach. Errors will still
51              be displayed.
52
53
54       -u, --usage
55              Display brief usage message and exit.
56
57
58       -V, --version
59              Display Slurm version number and exit.
60
61
62       -v, --verbose
63              Increase the  verbosity  of  sattach's  informational  messages.
64              Multiple -v's will further increase sattach's verbosity.
65
66

INPUT ENVIRONMENT VARIABLES

68       Upon  startup,  salloc will read and handle the options set in the fol‐
69       lowing environment variables.  Note: Command line options always  over‐
70       ride environment variables settings.
71
72
73
74       SLURM_CONF          The  location  of  the  Slurm  configuration
75                           file.
76
77       SLURM_EXIT_ERROR    Specifies the exit  code  generated  when  a
78                           Slurm  error  occurs (e.g. invalid options).
79                           This can be used by a script to  distinguish
80                           application  exit  codes  from various Slurm
81                           error conditions.
82
83
84

EXAMPLES

86       sattach 15.0
87
88       sattach --output-filter 5 65386.15
89
90

COPYING

92       Copyright (C) 2006-2007 The Regents of the University  of  Cali‐
93       fornia.  Produced at Lawrence Livermore National Laboratory (cf,
94       DISCLAIMER).
95       Copyright (C) 2008-2009 Lawrence Livermore National Security.
96       Copyright (C) 2010-2013 SchedMD LLC.
97
98       This file is part of Slurm, a resource management program.   For
99       details, see <https://slurm.schedmd.com/>.
100
101       Slurm is free software; you can redistribute it and/or modify it
102       under the terms of the GNU General Public License  as  published
103       by  the  Free  Software  Foundation;  either  version  2  of the
104       License, or (at your option) any later version.
105
106       Slurm is distributed in the hope that it  will  be  useful,  but
107       WITHOUT  ANY WARRANTY; without even the implied warranty of MER‐
108       CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See  the  GNU
109       General Public License for more details.
110
111