slurmrestd(8)

1slurmrestd(8)                  Slurm REST Daemon                 slurmrestd(8)
2
3
4

NAME

6       slurmrestd - Interface to Slurm via REST API.
7

SYNOPSIS

9       slurmrestd [OPTIONS...] <[host]:port|unix:/path/to/socket>...
10

DESCRIPTION

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

OPTIONS

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 to the group be‐
50              longing to to SlurmUser or root or the daemon won't  start  with
51              the default settings.
52
53       -h     Help; print a brief summary of command options.
54
55       -s <OpenAPI plugins to load>
56              Comma-delimited  list of OpenAPI plugins.  Set to "list" to dump
57              a list of the possible plugins to load.  Defaults:  all  builtin
58              supported OpenAPI plugins.
59
60       -t <THREAD COUNT>
61              Specify  number of threads to use to process client connections.
62              Ignored in inetd mode. Default: 20
63
64       -u <user id>
65              Change user id before processing client request. This should  be
66              a  unique  group with no write access or special permissions. Do
67              not set this user to SlurmUser or root or the daemon won't start
68              with the default settings.
69
70       -v     Verbose  operation.  Multiple  -v's  increase verbosity.  Higher
71              verbosity levels will have significant performance impact.
72
73       -V     Print version information and exit.
74

ENVIRONMENT VARIABLES

76       The following environment variables can be used  to  override  settings
77       compiled into slurmctld.
78
79
80       SLURM_CONF
81              The location of the Slurm configuration file.
82
83       SLURM_DEBUG_FLAGS
84              Specify debug flags for slurmrestd to use. See DebugFlags in the
85              slurm.conf(5) man page for a full list of flags. The environment
86              variable takes precedence over the setting in the slurm.conf.
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  using  the  following
106              comma-delimited values:
107
108              disable_unshare_files
109                     Disables unsharing file descriptors with parent process.
110
111              disable_unshare_sysv
112                     Disables unsharing the SYSV namespace.
113
114              disable_user_check
115                     Disables  check that slurmrestd is not running as root or
116                     SlurmUser, or with the root or SlurmUser's primary group.
117

SIGNALS

119       SIGINT
120             slurmrestd will shutdown cleanly.
121
122       SIGPIPE
123             This signal is explicitly ignored.
124

NOTES

126       slurmrestd is designed to run with AuthAltTypes outside  of  the  Munge
127       cluster when configured AuthAltTypes supports this.
128
129

COPYING

131       Copyright (C) 2019-2022 SchedMD LLC.
132
133       This  file  is  part  of Slurm, a resource management program.  For de‐
134       tails, see <https://slurm.schedmd.com/>.
135
136       Slurm is free software; you can redistribute it and/or modify it  under
137       the  terms  of  the GNU General Public License as published by the Free
138       Software Foundation; either version 2 of the License, or (at  your  op‐
139       tion) any later version.
140
141       Slurm  is  distributed  in the hope that it will be useful, but WITHOUT
142       ANY WARRANTY; without even the implied warranty of  MERCHANTABILITY  or
143       FITNESS  FOR  A PARTICULAR PURPOSE.  See the GNU General Public License
144       for more details.
145
146