1mpi.conf(5) Slurm Configuration File mpi.conf(5)
2
6 mpi.conf - Slurm configuration file to allow the configuration of MPI
7 plugins.
8
11 mpi.conf is an ASCII file which defines parameters that control the be‐
12 havior of MPI plugins. Currently the configuration file can only be
13 used to configure the PMIx plugin, but it can be extended to support
14 other MPI plugins as well. The file will always be located in the same
15 directory as the slurm.conf. This file is optional.
16 Parameter names are case insensitive. Any text following a "#" in the
18 configuration file is treated as a comment through the end of that
19 line. Changes to the configuration file take effect upon restart of
20 Slurm daemons, daemon receipt of the SIGHUP signal, or execution of the
21 command "scontrol reconfigure" unless otherwise noted.
22 Settings from this configuration file can be viewed in the output of
24 "scontrol show config". This configuration file can be included when
25 using "configless" mode. Information from mpi.conf is read at startup
26 or upon reconfigure by slurmctld and slurmd. Instances of slurmstepd
27 for batch steps will receive information about the plugin requested
28 from slurmd.
29
32 PMIxCliTmpDirBase=<path>
33 Directory to have PMIx use for temporary files. Defaults to not
34 being set.
35 PMIxCollFence={mixed|tree|ring}
37 Define the type of fence to use for collecting inter-node data.
38 Defaults to not being set. See also PMIxFenceBarrier.
39 PMIxDebug={0|1}
41 Enable debug logging for the PMIx plugin. Defaults to 0.
42 PMIxDirectConn={true|false}
44 Disable direct launching of tasks. Default is "true".
45 PMIxDirectConnEarly={true|false}
47 Allow early connections to a parent node. Defaults to "false".
48 PMIxDirectConnUCX={true|false}
50 Allow PMIx to use UCX for communication. Defaults to "false".
51 PMIxDirectSameArch={true|false}
53 Enable additional communication optimizations when PMIxDirect‐
54 Conn is set to true, assuming all the job's nodes have the same
55 architecture. Defaults to "false".
56 PMIxEnv=<environment variables>
58 Semicolon separated list of environment variables to be set in
59 job environments to be used by PMIx. Defaults to not being set.
60 PMIxFenceBarrier={true|false}
62 Define whether to fence inter-node communication for data col‐
63 lection. Default is "false". See also PMIxCollFence.
64 PMIxNetDevicesUCX=<device type>
66 Type of network device to use for communication. Defaults to
67 not being set.
68 PMIxTimeout=<time>
70 The maximum time (in seconds) allowed for communication between
71 hosts to take place. Defaults to 10 seconds.
72 PMIxTlsUCX=<tl1>[,<tl2>...]
74 Sets the UCX_TLS variable which restricts the transports to use.
75 The accepted values are defined in the UCX documentation and may
76 vary between installations. Multiple values can be set and must
77 be separated by commas. If not set, UCX tries to use all avail‐
78 able transports and selects the best ones according to their
79 performance capabilities and scale. Defaults to not being set.
80
82 Copyright (C) 2022 SchedMD LLC.
83 This file is part of Slurm, a resource management program. For de‐
85 tails, see <https://slurm.schedmd.com/>.
86 Slurm is free software; you can redistribute it and/or modify it under
88 the terms of the GNU General Public License as published by the Free
89 Software Foundation; either version 2 of the License, or (at your op‐
90 tion) any later version.
91 Slurm is distributed in the hope that it will be useful, but WITHOUT
93 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
94 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
95 for more details.
96
99 slurm.conf(5)
100August 2022 Slurm Configuration File mpi.conf(5)