sbcast(1)

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

NAME

6       sbcast - transmit a file to the nodes allocated to a Slurm job.
7
8

SYNOPSIS

10       sbcast [-CfFjpstvV] SOURCE DEST
11
12

DESCRIPTION

14       sbcast  is  used  to transmit a file to all nodes allocated to the cur‐
15       rently active Slurm job.  This command should  only  be  executed  from
16       within  a  Slurm  batch  job  or within the shell spawned after a Slurm
17       job's resource allocation.  SOURCE is the name of a file on the current
18       node.  DEST should be the fully qualified pathname for the file copy to
19       be created on each node.  If a fully qualified  pathname  is  not  pro‐
20       vided,  the  file  will  be  created  in the directory specified in the
21       SbcastParameters parameter in the slurm.conf file (if available) other‐
22       wise it will be created in the current working directory from which the
23       sbcast command is invoked.  DEST should be on a file  system  local  to
24       that  node.  Note that parallel file systems may provide better perfor‐
25       mance than sbcast can provide, although performance will vary  by  file
26       size, degree of parallelism, and network type.
27
28

OPTIONS

30       -C [library], --compress[=library]
31              Compress  the  file  being  transmitted.   The optional argument
32              specifies the data compression library to  be  used.   Supported
33              values are "lz4" (default), "none" and "zlib".  Some compression
34              libraries may be unavailable on some systems.  The default  com‐
35              pression library (and enabling compression itself) may be set in
36              the slurm.conf file using the SbcastParameter option.
37
38       -f, --force
39              If the destination file already exists, replace it.
40
41       -F number, --fanout=number
42              Specify the fanout of messages used for file transfer.   Maximum
43              value is currently eight.
44
45       -j jobID[.stepID], --jobid=jobID[.stepID]
46              Specify  the job ID to use with optional step ID.  If run inside
47              an allocation this is unneeded as the job ID will read from  the
48              environment.
49
50       -p, --preserve
51              Preserves  modification  times, access times, and modes from the
52              original file.
53
54       -s size, --size=size
55              Specify the block size used for file broadcast.   The  size  can
56              have  a suffix of k or m for kilobytes or megabytes respectively
57              (defaults to bytes).  This size subject to  rounding  and  range
58              limits  to  maintain good performance.  The default value is the
59              file size or 8MB, whichever is smaller.  This value may need  to
60              be set on systems with very limited memory.
61
62       -t seconds, fB--timeout=seconds
63              Specify  the  message  timeout in seconds.  The default value is
64              MessageTimeout as reported by "scontrol show config".  Setting a
65              higher  value may be necessitated by relatively slow I/O perfor‐
66              mance on the compute node disks.
67
68       -v, --verbose
69              Provide detailed event logging through program execution.
70
71       -V, --version
72              Print version information and exit.
73
74

ENVIRONMENT VARIABLES

76       Some sbcast options may be set via environment variables.  These  envi‐
77       ronment  variables,  along with their corresponding options, are listed
78       below. (Note: Command line options  will  always  override  these  set‐
79       tings.)
80
81       SBCAST_COMPRESS     -C, --compress
82
83       SBCAST_FANOUT       -F number, fB--fanout=number
84
85       SBCAST_FORCE        -f, --force
86
87       SBCAST_PRESERVE     -p, --preserve
88
89       SBCAST_SIZE         -s size, --size=size
90
91       SBCAST_TIMEOUT      -t seconds, fB--timeout=seconds
92
93       SLURM_CONF          The location of the Slurm configuration file.
94
95

AUTHORIZATION

97       When  using the Slurm db, users who have AdminLevel's defined (Operator
98       or Admin) and users who are account coordinators are given the  author‐
99       ity to invoke sbcast on other user's jobs.
100
101

EXAMPLE

103       Using  a  batch  script, transmit local file my.prog to /tmp/my.proc on
104       the local nodes and then execute it.
105
106       > cat my.job
107       #!/bin/bash
108       sbcast my.prog /tmp/my.prog
109       srun /tmp/my.prog
110
111       > sbatch --nodes=8 my.job
112       srun: jobid 12345 submitted
113
114

COPYING

116       Copyright (C) 2006-2010 The Regents of the  University  of  California.
117       Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
118       Copyright (C) 2010-2016 SchedMD LLC.
119
120       This  file  is  part  of  Slurm,  a  resource  management program.  For
121       details, see <https://slurm.schedmd.com/>.
122
123       Slurm is free software; you can redistribute it and/or modify it  under
124       the  terms  of  the GNU General Public License as published by the Free
125       Software Foundation; either version 2  of  the  License,  or  (at  your
126       option) any later version.
127
128       Slurm  is  distributed  in the hope that it will be useful, but WITHOUT
129       ANY WARRANTY; without even the implied warranty of  MERCHANTABILITY  or
130       FITNESS  FOR  A PARTICULAR PURPOSE.  See the GNU General Public License
131       for more details.
132
133