1topology.conf(5)           Slurm Configuration File           topology.conf(5)
2
3
4

NAME

6       topology.conf  -  Slurm  configuration  file  for  defining the network
7       topology
8
9

PREREQUISITES

11       Topology.conf can only represent a hierarchical network. All  nodes  in
12       the  network must be connected to at least one switch. The network must
13       be fully connected to use a RoutePlugin. Jobs can only span nodes  con‐
14       nected  by  the  same  switch  fabric, even if there are available idle
15       nodes.
16
17

DESCRIPTION

19       topology.conf is an ASCII file which describes  the  cluster's  network
20       topology  for  optimized job resource allocation.  The file will always
21       be located in the same directory as the slurm.conf.
22
23       Parameter names are case insensitive.  Any text following a "#" in  the
24       configuration  file  is  treated  as  a comment through the end of that
25       line.  Changes to the configuration file take effect  upon  restart  of
26       Slurm daemons, daemon receipt of the SIGHUP signal, or execution of the
27       command "scontrol reconfigure" unless otherwise noted.
28
29       The network topology configuration one line defining a switch name  and
30       its  children, either node names or switch names.  Slurm's hostlist ex‐
31       pression parser is used, so the node and switch names need not be  con‐
32       secutive  (e.g.  "Nodes=tux[0-3,12,18-20]" and "Switches=s[0-2,4-8,12]"
33       will parse fine).  An optional link speed may also be specified.
34
35       The topology.conf file for an Infiniband switch  can  be  automatically
36       generated     using    the    slurmibtopology    tool    found    here:
37       <https://ftp.fysik.dtu.dk/Slurm/slurmibtopology.sh>.
38
39       The overall configuration parameters available include:
40
41
42       SwitchName
43              The name of a switch. This name is internal to Slurm  and  arbi‐
44              trary.   Each switch should have a unique name.  This field must
45              be specified.
46
47       Switches
48              Child switches of the named switch.  Either this option  or  the
49              Nodes option must be specified.
50
51       Nodes  Child Nodes of the named leaf switch.  Either this option or the
52              Switches option must be specified.
53
54       LinkSpeed
55              An optional value specifying the performance of this  communica‐
56              tion link.  The units used are arbitrary and this information is
57              currently not used.  It may be used in the  future  to  optimize
58              resource allocations.
59

EXAMPLE

61       ##################################################################
62       # Slurm's network topology configuration file for use with the
63       # topology/tree plugin
64       ##################################################################
65       SwitchName=s0 Nodes=dev[0-5]
66       SwitchName=s1 Nodes=dev[6-11]
67       SwitchName=s2 Nodes=dev[12-17]
68       SwitchName=s3 Switches=s[0-2]
69
70

COPYING

72       Copyright  (C)  2009 Lawrence Livermore National Security.  Produced at
73       Lawrence Livermore National Laboratory (cf, DISCLAIMER).
74       Copyright (C) 2010-2022 SchedMD LLC.
75
76       This file is part of Slurm, a resource  management  program.   For  de‐
77       tails, see <https://slurm.schedmd.com/>.
78
79       Slurm  is free software; you can redistribute it and/or modify it under
80       the terms of the GNU General Public License as published  by  the  Free
81       Software  Foundation;  either version 2 of the License, or (at your op‐
82       tion) any later version.
83
84       Slurm is distributed in the hope that it will be  useful,  but  WITHOUT
85       ANY  WARRANTY;  without even the implied warranty of MERCHANTABILITY or
86       FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General  Public  License
87       for more details.
88
89

SEE ALSO

91       slurm.conf(5)
92
93
94
95January 2022               Slurm Configuration File           topology.conf(5)
Impressum