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
18              it is connected to a socket or a locally TTY (interactive mode).
19
20
21       Listen Mode: slurmrestd will open a listening socket on each requested
22              host:port pair or UNIX socket.
23
24
25
26       OPTIONS
27
28
29       [host]:port
30              Hostname  and port to listen against. Host may be (IPv4/IPv6) IP
31              or a resolvable  hostname.  Hostnames  are  only  looked  up  at
32              startup  and  do not change for the life of the process. Host is
33              optional; if not provided slurmrestd will listen on all  network
34              interfaces.
35
36       unix:/path/to/socket
37              Listen  on  local  UNIX  socket.  Must have permission to create
38              socket in filesystem.
39
40       -a <authentication plugins>
41              Comma delimited list of authentication plugins to load.  Set  to
42              "list"  to  dump  a  list  of the possible plugins to load.  De‐
43              faults: all builtin supported REST authentication plugins.
44
45       -f <file>
46              Read Slurm configuration from the specified file. See NOTES  be‐
47              low.
48
49       -g <group id>
50              Change group id (and drop supplemental groups) before processing
51              client request. This should be a unique group with no write  ac‐
52              cess  or  special permissions. Do not set this user to SlurmUser
53              or root.
54
55       -h     Help; print a brief summary of command options.
56
57       -s <OpenAPI plugins to load>
58              Comma delimited list of OpenAPI plugins.  Set to "list" to  dump
59              a  list  of the possible plugins to load.  Defaults: all builtin
60              supported OpenAPI plugins.
61
62       -t <THREAD COUNT>
63              Specify number of threads to use to process client  connections.
64              Ignored in inetd mode. Default: 20
65
66       -u <user id>
67              Change  user id before processing client request. This should be
68              a unique group with no write access or special  permissions.  Do
69              not set this user to SlurmUser or root.
70
71       -v     Verbose  operation.  Multiple  -v's  increase verbosity.  Higher
72              verbosity levels will have significant performance impact.
73
74       -V     Print version information and exit.
75
76

ENVIRONMENT VARIABLES

78       The following environment variables can be used  to  override  settings
79       compiled into slurmctld.
80
81       SLURM_CONF          The location of the Slurm configuration file.
82
83       SLURMRESTD_AUTH_TYPES
84                           Set allowed authentication types. See -a
85
86       SLURMRESTD_DEBUG    Set  debug level explicitly. Valid values are 1-10.
87                           See -v
88
89       SLURMRESTD_LISTEN   Comma delimited list of  host:port  pairs  or  unix
90                           sockets to listen on.
91
92       SLURMRESTD_OPENAPI_PLUGINS
93                           Comma  delimited  list  of OpenAPI plugins to load.
94                           See -s
95
96

SIGNALS

98       SIGINT slurmrestd will shutdown cleanly.
99
100       SIGPIPE
101              This signal is explicitly ignored.
102
103

NOTES

105       slurmrestd is designed to run with AuthAltTypes outside  of  the  Munge
106       cluster when configured AuthAltTypes supports this.
107
108

COPYING

110       Copyright (C) 2019-2020 SchedMD LLC.
111
112       This  file  is  part  of Slurm, a resource management program.  For de‐
113       tails, see <https://slurm.schedmd.com/>.
114
115       Slurm is free software; you can redistribute it and/or modify it  under
116       the  terms  of  the GNU General Public License as published by the Free
117       Software Foundation; either version 2 of the License, or (at  your  op‐
118       tion) any later version.
119
120       Slurm  is  distributed  in the hope that it will be useful, but WITHOUT
121       ANY WARRANTY; without even the implied warranty of  MERCHANTABILITY  or
122       FITNESS  FOR  A PARTICULAR PURPOSE.  See the GNU General Public License
123       for more details.
124
125