1sbcast(1) Slurm Commands sbcast(1)
2
6 sbcast - transmit a file to the nodes allocated to a Slurm job.
7
10 sbcast [-CfFjpstvV] SOURCE DEST
11
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 Sb‐
21 castParameters 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
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 -f, --force
39 If the destination file already exists, replace it.
40 -F number, --fanout=number
42 Specify the fanout of messages used for file transfer. Maximum
43 value is currently eight.
44 -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 -p, --preserve
51 Preserves modification times, access times, and modes from the
52 original file.
53 -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 -t seconds, --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 -v, --verbose
69 Provide detailed event logging through program execution.
70 -V, --version
72 Print version information and exit.
73
76 Executing sbcast sends a remote procedure call to slurmctld. If enough
77 calls from sbcast or other Slurm client commands that send remote pro‐
78 cedure calls to the slurmctld daemon come in at once, it can result in
79 a degradation of performance of the slurmctld daemon, possibly result‐
80 ing in a denial of service.
81 Do not run sbcast or other Slurm client commands that send remote pro‐
83 cedure calls to slurmctld from loops in shell scripts or other pro‐
84 grams. Ensure that programs limit calls to sbcast to the minimum neces‐
85 sary for the information you are trying to gather.
86
89 Some sbcast options may be set via environment variables. These envi‐
90 ronment variables, along with their corresponding options, are listed
91 below. (Note: Command line options will always override these set‐
92 tings.)
93 SBCAST_COMPRESS -C, --compress
95 SBCAST_FANOUT -F number, --fanout=number
97 SBCAST_FORCE -f, --force
99 SBCAST_PRESERVE -p, --preserve
101 SBCAST_SIZE -s size, --size=size
103 SBCAST_TIMEOUT -t seconds, --timeout=seconds
105 SLURM_CONF The location of the Slurm configuration file.
107
110 When using SlurmDBD, users who have an AdminLevel defined (Operator or
111 Admin) are given the authority to invoke sbcast on other users jobs.
112
115 Using a batch script, transmit local file my.prog to /tmp/my.proc on
116 the local nodes and then execute it.
117 $ cat my.job
119 #!/bin/bash
120 sbcast my.prog /tmp/my.prog
121 srun /tmp/my.prog
122 $ sbatch --nodes=8 my.job
124 srun: jobid 12345 submitted
125
128 Copyright (C) 2006-2010 The Regents of the University of California.
129 Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
130 Copyright (C) 2010-2016 SchedMD LLC.
131 This file is part of Slurm, a resource management program. For de‐
133 tails, see <https://slurm.schedmd.com/>.
134 Slurm is free software; you can redistribute it and/or modify it under
136 the terms of the GNU General Public License as published by the Free
137 Software Foundation; either version 2 of the License, or (at your op‐
138 tion) any later version.
139 Slurm is distributed in the hope that it will be useful, but WITHOUT
141 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
142 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
143 for more details.
144
147 srun(1)
148February 2021 Slurm Commands sbcast(1)