1slurmrestd(8) Slurm REST Daemon slurmrestd(8)
2
3
4
6 slurmrestd - Interface to Slurm via REST API.
7
9 slurmrestd [OPTIONS...] <[host]:port|unix:/path/to/socket>...
10
12 slurmrestd is REST API interface for Slurm. It can be used in two
13 modes:
14
15
16 Inetd Mode: slurmrestd will read and write to STDIN and STDOUT. It can
17 detect if it is connected to a socket or a local TTY (interactive
18 mode).
19
20
21 Listen Mode: slurmrestd will open a listening socket on each requested
22 host:port pair or UNIX socket.
23
24
26 [host]:port
27 Hostname and port to listen against. host may be an IPv4/IPv6 IP
28 or a resolvable hostname. Hostnames are only looked up at
29 startup and do not change for the life of the process. host is
30 optional; if not provided, slurmrestd will listen on all network
31 interfaces.
32
33 unix:/path/to/socket
34 Listen on local UNIX socket. Must have permission to create
35 socket in filesystem.
36
37 -a <authentication plugins>
38 Comma-delimited list of authentication plugins to load. Set to
39 "list" to dump a list of the possible plugins to load. De‐
40 faults: all builtin supported REST authentication plugins.
41
42 -f <file>
43 Read Slurm configuration from the specified file. See NOTES be‐
44 low.
45
46 -g <group id>
47 Change group id (and drop supplemental groups) before processing
48 client request. This should be a unique group with no write ac‐
49 cess or special permissions. Do not set this user to SlurmUser
50 or root.
51
52 -h Help; print a brief summary of command options.
53
54 -s <OpenAPI plugins to load>
55 Comma-delimited list of OpenAPI plugins. Set to "list" to dump
56 a list of the possible plugins to load. Defaults: all builtin
57 supported OpenAPI plugins.
58
59 -t <THREAD COUNT>
60 Specify number of threads to use to process client connections.
61 Ignored in inetd mode. Default: 20
62
63 -u <user id>
64 Change user id before processing client request. This should be
65 a unique group with no write access or special permissions. Do
66 not set this user to SlurmUser or root.
67
68 -v Verbose operation. Multiple -v's increase verbosity. Higher
69 verbosity levels will have significant performance impact.
70
71 -V Print version information and exit.
72
74 The following environment variables can be used to override settings
75 compiled into slurmctld.
76
77
78 DISABLE_UNSHARE_SYSV
79 Disables unsharing the SYSV namespace.
80
81 DISABLE_USER_CHECK
82 Disables check that slurmrestd is not running as root or Slur‐
83 mUser.
84
85 SLURM_CONF
86 The location of the Slurm configuration file.
87
88 SLURM_JWT
89 This variable must be set to use JWT token authentication.
90
91 SLURMRESTD_AUTH_TYPES
92 Set allowed authentication types. See -a
93
94 SLURMRESTD_DEBUG
95 Set debug level explicitly. Valid values are 1-10. See -v
96
97 SLURMRESTD_LISTEN
98 Comma-delimited list of host:port pairs or unix sockets to lis‐
99 ten on.
100
101 SLURMRESTD_OPENAPI_PLUGINS
102 Comma-delimited list of OpenAPI plugins to load. See -s
103
104 SLURMRESTD_SECURITY
105 Control slurmrestd security functionality.
106
108 SIGINT
109 slurmrestd will shutdown cleanly.
110
111 SIGPIPE
112 This signal is explicitly ignored.
113
115 slurmrestd is designed to run with AuthAltTypes outside of the Munge
116 cluster when configured AuthAltTypes supports this.
117
118
120 Copyright (C) 2019-2022 SchedMD LLC.
121
122 This file is part of Slurm, a resource management program. For de‐
123 tails, see <https://slurm.schedmd.com/>.
124
125 Slurm is free software; you can redistribute it and/or modify it under
126 the terms of the GNU General Public License as published by the Free
127 Software Foundation; either version 2 of the License, or (at your op‐
128 tion) any later version.
129
130 Slurm is distributed in the hope that it will be useful, but WITHOUT
131 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
132 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
133 for more details.
134
135
137 slurm.conf(5), slurmctld(8), slurmdbd(8)
138
139
140
141April 2022 Slurm REST Daemon slurmrestd(8)