Daemon (SlurmDBD) configuration information.
The file will always be located in the same directory as the \fBslurm.conf\fR.
.LP
The contents of the file are case insensitive except for the names of nodes
and files. Any text following a "#" in the configuration file is treated
as a comment through the end of that line.
Changes to the configuration file take effect upon restart of
SlurmDBD or daemon receipt of the SIGHUP signal unless otherwise noted.
.LP
This file should be only on the computer where SlurmDBD executes and
should only be readable by the user which executes SlurmDBD (e.g. "slurm").
If the slurmdbd daemon is started as user root and changes to another
user ID, the configuration file will initially be read as user root, but will
be read as the other user ID in response to a SIGHUP signal.
This file should be protected from unauthorized access since it
contains a database password.
The overall configuration parameters available include:

.TP
\fBAllowNoDefAcct\fR
Remove requirement for users to have a default account.  Boolean, yes to turn
on, no (default) to enforce default accounts.
.IP

.TP
\fBAllResourcesAbsolute\fR
When adding a resource (license) treat allocated/allowed counts as absolute
numbers instead of percentage numbers. Boolean, yes to turn on, no (default)
to use the numbers as percentages instead.
.IP

.TP
\fBArchiveDir\fR
If ArchiveScript is not set the slurmdbd will generate a file that can be
read in anytime with sacctmgr load filename.  This directory is where the
file will be placed after a purge event has happened and archive for that
element is set to true.  Default is /tmp.  The format for this files name is
.na
$ArchiveDir/$ClusterName_$ArchiveObject_archive_$BeginTimeStamp_$endTimeStamp
.ad
We limit archive files to 50000 records per file. If more than 50000 records
exist during that time period, they will be written to a new file.  Subsequent
archive files during the same time period will have ".<number>" appended
to the file, for example .2, with the number increasing by one for each file in
the same time period.
.IP

.TP
\fBArchiveEvents\fR
When purging events also archive them.  Boolean, yes to archive event data,
no otherwise.  Default is no.
.IP
\fBArchiveScript\fR
This script can be executed every time a rollup happens (every hour,
day and month), depending on the Purge*After options.  This script is used
to transfer accounting records out of the database into an archive.  It is
used in place of the internal process used to archive objects.
The script is executed with no arguments, and the following environment
variables are set.
.IP
.RS
.TP
\fBSLURM_ARCHIVE_EVENTS\fR
1 for archive events 0 otherwise.
.IP

.TP
\fBSLURM_ARCHIVE_LAST_EVENT\fR
Time of last event start to archive.
.IP

.TP
\fBSLURM_ARCHIVE_JOBS\fR
1 for archive jobs 0 otherwise.
.IP

.TP
\fBSLURM_ARCHIVE_LAST_JOB\fR
Time of last job submit to archive.
.IP

.TP
\fBSLURM_ARCHIVE_STEPS\fR
1 for archive steps 0 otherwise.
.IP

.TP
\fBSLURM_ARCHIVE_LAST_STEP\fR
Time of last step start to archive.
.IP

.TP
\fBSLURM_ARCHIVE_SUSPEND\fR
1 for archive suspend data 0 otherwise.
.IP

.TP
\fBSLURM_ARCHIVE_TXN\fR
1 for archive transaction data 0 otherwise.
.IP

.TP
\fBSLURM_ARCHIVE_USAGE\fR
1 for archive usage data 0 otherwise.
.TP
\fBArchiveSuspend\fR
When purging suspend data also archive it.  Boolean, yes to archive
suspend data, no otherwise.  Default is no.
.IP

.TP
\fBArchiveTXN\fR
When purging transaction data also archive it.  Boolean, yes to archive
transaction data, no otherwise.  Default is no.
.IP

.TP
\fBArchiveUsage\fR
When purging usage data (Cluster, Association and WCKey) also archive it.
Boolean, yes to archive transaction data, no otherwise.  Default is no.
.IP

.TP
\fBAuthAltTypes\fR
Command separated list of alternative authentication plugins that the slurmdbd
will permit for communication.
.IP

.TP
\fBAuthAltParameters\fR
Used to define alternative authentication plugins options. Multiple options may
be comma separated.
.IP
.RS
.TP
\fBjwks=\fR
Absolute path to JWKS file. Key should be owned by SlurmUser or root, must be
readable by SlurmUser, with suggested permissions of 0400. It must not be
writable by 'other'.
Only RS256 keys are supported, although other key types may be listed in the
file. If set, no HS256 key will be loaded by default (and token generation is
disabled), although the jwt_key setting may be used to explicitly re\-enable
HS256 key use (and token generation).
.IP

.TP
\fBjwt_key=\fR
Absolute path to JWT key file. Key must be HS256. Key should be owned by
SlurmUser or root, must be readable by SlurmUser, with suggested permissions of
0400. It must not be accessible by 'other'.
.RE
.IP

.TP
\fBAuthInfo\fR
Additional information to be used for authentication of communications

.TP
\fBsocket\fR
Path name to a MUNGE daemon socket to use
(e.g. "socket=/var/run/munge/munge.socket.2").
The default value is "/var/run/munge/munge.socket.2".
Used by \fIauth/munge\fR and \fIcred/munge\fR.
.IP

.TP
\fBttl\fR
Credential lifetime, in seconds (e.g. "ttl=300").
The default value is dependent upon the MUNGE installation, but is typically
300 seconds.
.IP

.TP
\fBuse_client_ids\fR
Allow the \fIauth/slurm\fR plugin to authenticate users without relying on
the user information from LDAP or the operating system.
.RE
.IP

.TP
\fBAuthType\fR
Define the authentication method for communications between Slurm
components. SlurmDBD must be terminated prior to changing the value of
\fBAuthType\fR and later restarted. This should match the \fBAuthType\fR used
in slurm.conf.
Acceptable values at present:
.RS
.TP
\fBauth/munge\fR
Indicates that MUNGE is to be used (default).
(See "https://dun.github.io/munge/" for more information).
.IP

.TP
\fBauth/slurm\fR
Use Slurm's internal authentication plugin.
.RE
.IP

.TP
\fBCommitDelay\fR
How many seconds between commits on a connection from a Slurmctld.  This
speeds up inserts into the database dramatically.  If you are running a very
high throughput of jobs you should consider setting this.  In testing, 1 second
improves the slurmdbd performance dramatically and reduces overhead.  There is
a small probability of data loss though since this creates a window in which
if the slurmdbd exits abnormally for any reason the data not
committed could be lost.  While this situation should be very rare,
.IP

.TP
\fBEnableIPv6\fR
Enable using IPv6 addresses for the slurmdbd. When using both IPv4 and IPv6,
address family preferences will be based on your /etc/gai.conf file. This
should also be set in your \fBslurm.conf\fR file.
.IP

.TP
\fBkeepaliveinterval=#\fR
Specifies the interval between keepalive probes on the socket communications
between the backup and primary slurmdbd.
The default value is 30 seconds.
.IP

.TP
\fBkeepaliveprobes=#\fR
Specifies the number of keepalive probes sent on the socket communications
between the backup and primary slurmdbd.
The default value is 3.
.IP

.TP
\fBkeepalivetime=#\fR
Specifies how long to wait before sending keepalive probes between the primary
and backup slurmdbd processes.
The default value is 30 seconds.
.RE
.IP

.TP
\fBDbdAddr\fR
Name that \fBDbdHost\fR should be referred to in establishing a communications
path. This name will be used as an argument to the getaddrinfo() function for
identification. For example, "elx0000" might be used to designate the Ethernet
address for node "lx0000".  By default the \fBDbdAddr\fR will be identical in
value to \fBDbdHost\fR.
.IP

.TP
\fBDbdBackupHost\fR
The short, or long, name of the machine where the backup Slurm Database Daemon
is executed (i.e. the name returned by the command "hostname \-s").
This host must have access to the same underlying database specified by
the 'Storage' options mentioned below.
.IP

.TP
\fBDbdHost\fR
The short, or long, name of the machine where the Slurm Database Daemon is
executed (i.e. the name returned by the command "hostname \-s").
Defines specific subsystems which should provide more detailed event logging.
Multiple subsystems can be specified with comma separators.
Most DebugFlags will result in additional logging messages for the identified
subsystems if \fBDebugLevel\fR is at 'verbose' or higher.
More logging may impact performance.
Valid subsystems available today (with more to come) include:
.IP
.RS
.TP
\fBDB_ARCHIVE\fR
SQL statements/queries when dealing with archiving and purging the database.
.IP

.TP
\fBDB_ASSOC\fR
SQL statements/queries when dealing with associations in the database.
.IP

.TP
\fBDB_EVENT\fR
SQL statements/queries when dealing with (node) events in the database.
.IP

.TP
\fBDB_JOB\fR
SQL statements/queries when dealing with jobs in the database.
.IP

.TP
\fBDB_QOS\fR
SQL statements/queries when dealing with QOS in the database.
.IP

.TP
\fBDB_QUERY\fR
SQL statements/queries when dealing with transactions and such in the database.
.IP

.TP
\fBDB_RESERVATION\fR
SQL statements/queries when dealing with reservations in the database.
.IP

.TP
\fBDB_RESOURCE\fR
SQL statements/queries when dealing with resources like licenses in the
database.
.IP

.TP
\fBDB_STEP\fR
SQL statements/queries when dealing with steps in the database.
\fBDB_WCKEY\fR
SQL statements/queries when dealing with wckeys in the database.
.IP

.TP
\fBFEDERATION\fR
SQL statements/queries when dealing with federations in the database.
.IP

.TP
\fBNetwork\fR
Network details.
.IP

.TP
\fBNetworkRaw\fR
Dump raw hex values of key Network communications.
.RE
.IP

.TP
\fBDebugLevel\fR
The level of detail to provide the Slurm Database Daemon's logs.
The default value is \fBinfo\fR.
.IP
.RS
.TP 10
\fBquiet\fR
Log nothing
.IP

.TP
\fBfatal\fR
Log only fatal errors
.IP

.TP
\fBerror\fR
Log only errors
.IP

.TP
\fBinfo\fR
Log errors and general informational messages
.IP

.TP
\fBverbose\fR
Log errors and verbose informational messages
.IP

.TP
.TP
\fBdebug4\fR
Log errors and verbose informational messages and even more debugging messages
.IP

.TP
\fBdebug5\fR
Log errors and verbose informational messages and even more debugging messages
.RE
.IP

.TP
\fBDebugLevelSyslog\fR
The slurmdbd daemon will log events to the syslog file at the specified
level of detail. If not set, the slurmdbd daemon will log to syslog at
level \fBfatal\fR, unless there is no \fBLogFile\fR and it is running
in the background, in which case it will log to syslog at the level specified
by \fBDebugLevel\fR (at \fBfatal\fR in the case that \fBDebugLevel\fR
is set to \fBquiet\fR) or it is run in the foreground, when it will be set to
quiet.
.IP
.RS
.TP 10
\fBquiet\fR
Log nothing
.IP

.TP
\fBfatal\fR
Log only fatal errors
.IP

.TP
\fBerror\fR
Log only errors
.IP

.TP
\fBinfo\fR
Log errors and general informational messages
.IP

.TP
\fBverbose\fR
Log errors and verbose informational messages
.IP

.TP
\fBdebug\fR
Log errors and verbose informational messages and debugging messages
.IP


.TP
\fBdebug5\fR
Log errors and verbose informational messages and even more debugging messages
.RE
.IP
\fBNOTE\fR: By default, Slurm's systemd service files start daemons in the
foreground with the -D option. This means that systemd will capture
stdout/stderr output and print that to syslog, independent of Slurm printing to
syslog directly. To prevent systemd from doing this, add "StandardOutput=null"
and "StandardError=null" to the respective service files or override files.
.IP

.TP
\fBDefaultQOS\fR
When adding a new cluster this will be used as the qos for the cluster
unless something is explicitly set by the admin with the create.
.IP

.TP
\fBLogFile\fR
Fully qualified pathname of a file into which the Slurm Database Daemon's
logs are written.
The default value is none (performs logging via syslog).
.br
See the section \fBLOGGING\fR in the slurm.conf man page
if a pathname is specified.
.IP

.TP
\fBLogTimeFormat\fR
Format of the timestamp in slurmdbd log files. Accepted format values include
"iso8601", "iso8601_ms", "rfc5424", "rfc5424_ms", "rfc3339", "clock", "short"
and "thread_id". The values ending in "_ms" differ from the ones without in that
fractional seconds with millisecond precision are printed.
The default value is "iso8601_ms". The "rfc5424" formats are the same
as the "iso8601" formats except that the timezone value is also shown.
The "clock" format shows a timestamp in microseconds retrieved
with the C standard clock() function. The "short" format is a short
date and time format. The "thread_id" format shows the timestamp
in the C standard ctime() function form without the year but
including the microseconds, the daemon's process ID and the current thread name
and ID.
A special option "format_stderr" can be added to the format as a comma separated
value (e.g. "LogTimeFormat=iso8601_ms,format_stderr"). It will change the
default format of the logs on stderr stream by prepending the timestamp as
specified by \fBLogTimeFormat\fR.
.IP

.TP
\fBMaxQueryTimeRange\fR
Return an error if a query is against too large of a time span, to prevent
.TP
\fBParameters\fR
Contains arbitrary comma separated parameters used to alter the behavior of
the slurmdbd.
.IP
.RS
.TP
\fBPreserveCaseUser\fR
When defining users do not force lower case which is the default behavior.
.RE
.IP

.TP
\fBPidFile\fR
Fully qualified pathname of a file into which the Slurm Database Daemon
may write its process ID. This may be used for automated signal processing.
The default value is "/var/run/slurmdbd.pid".
.IP

.TP
\fBPluginDir\fR
Identifies the places in which to look for Slurm plugins.
This is a colon\-separated list of directories, like the PATH
environment variable.
The default value is the prefix given at configure time + "/lib/slurm".
.IP

.TP
\fBPrivateData\fR
This controls what type of information is hidden from regular users.
By default, all information is visible to all users.
User \fBSlurmUser\fR, \fBroot\fR, and users with AdminLevel=Admin can always
view all information.
Multiple values may be specified with a comma separator.
Acceptable values include:
.IP
.RS
.TP
\fBaccounts\fR
prevents users from viewing any account definitions unless they are
coordinators of them.
.IP

.TP
\fBevents\fR
prevents users from viewing event information unless they have operator status
or above.
.IP

.TP
\fBjobs\fR
prevents users from viewing job records belonging
.IP

.TP
\fBusers\fR
prevents users from viewing information of any user
other than themselves, this also makes it so users can only see
associations they deal with.
Coordinators can see associations of all users in the account they are
coordinator of, but can only see themselves when listing users.
.RE
.IP

.TP
\fBPurgeEventAfter\fR
Events are purged from the database after this amount of time has passed since
they ended.
This includes node down times and such.
The time is a numeric value and is a number of months.  If you want to purge
more often you can include "hours", or "days" behind the numeric value to get
those more frequent purges (i.e. a value of "12hours" would purge
everything older than 12 hours).
The purge takes place at the start of the each purge interval.
For example, if the purge time is 2 months, the purge would happen at the
beginning of each month.
If not set (default), then event records are never purged.
.IP

.TP
\fBPurgeJobAfter\fR
Individual job records are purged from the database after this amount of time
has passed since they ended.
Aggregated information will be preserved to "PurgeUsageAfter".
The time is a numeric value and is a number of months.  If you want to purge
more often you can include "hours", or "days" behind the numeric value to get
those more frequent purges (i.e. a value of "12hours" would purge
everything older than 12 hours).
The purge takes place at the start of the each purge interval.
For example, if the purge time is 2 months, the purge would happen at the
beginning of each month.
If not set (default), then job records are never purged.
.IP

.TP
\fBPurgeResvAfter\fR
Individual reservation records are purged from the database after this amount
of time has passed since they ended.
Aggregated information will be preserved to "PurgeUsageAfter".
The time is a numeric value and is a number of months.  If you want to purge
more often you can include "hours", or "days" behind the numeric value to get
those more frequent purges (i.e. a value of "12hours" would purge
everything older than 12 hours).
The purge takes place at the start of the each purge interval.
The purge takes place at the start of the each purge interval.
For example, if the purge time is 2 months, the purge would happen at the
beginning of each month.
If not set (default), then job step records are never purged.
.IP

.TP
\fBPurgeSuspendAfter\fR
Individual job suspend records are purged from the database after this amount
of time has passed since they ended.
Aggregated information will be preserved to "PurgeUsageAfter".
The time is a numeric value and is a number of months.  If you want to purge
more often you can include "hours", or "days" behind the numeric value to get
those more frequent purges (i.e. a value of "12hours" would purge
everything older than 12 hours).
The purge takes place at the start of the each purge interval.
For example, if the purge time is 2 months, the purge would happen at the
beginning of each month.
If not set (default), then suspend records are never purged.
.IP

.TP
\fBPurgeTXNAfter\fR
Individual transaction records are purged from the database after this amount
of time has passed since they occurred.
The time is a numeric value and is a number of months.  If you want to purge
more often you can include "hours", or "days" behind the numeric value to get
those more frequent purges (i.e. a value of "12hours" would purge
everything older than 12 hours).
The purge takes place at the start of the each purge interval.
For example, if the purge time is 2 months, the purge would happen at the
beginning of each month.
If not set (default), then transaction records are never purged.
.IP

.TP
\fBPurgeUsageAfter\fR
Usage records (Cluster, Association and WCKey) are purged from the database
after this amount of time has passed since they were created or last modified.
The time is a numeric value and is a number of months.  If you want to purge
more often you can include "hours", or "days" behind the numeric value to get
those more frequent purges (i.e. a value of "12hours" would purge
everything older than 12 hours).
The purge takes place at the start of the each purge interval.
For example, if the purge time is 2 months, the purge would happen at the
beginning of each month.
If not set (default), then usage records are never purged.
.IP

.TP
\fBSlurmUser\fR
The name of the user that the \fBslurmdbd\fR daemon executes as.
Define the name of the backup host the database is running where we are going
to store the data.  This can be viewed as a backup solution when the
StorageHost is not responding.  It is up to the backup solution to enforce the
coherency of the accounting information between the two hosts. With clustered
database solutions (active/passive HA), you would not need to use this feature.
Default is none.
.IP

.TP
\fBStorageHost\fR
Define the name of the host the database is running where we are going
to store the data.
Ideally this should be the host on which slurmdbd executes.
.IP

.TP
\fBStorageLoc\fR
Specify the name of the database as the location where accounting
records are written. Defaults to "slurm_acct_db".
.IP

.TP
\fBStorageParameters\fR
Comma separated list of key\-value pair parameters. Currently
supported values include options to establish a secure connection to the
database:
.IP
.RS
.TP 2
\fBSSL_CERT\fR
The path name of the client public key certificate file.
.IP

.TP
\fBSSL_CA\fR
The path name of the Certificate Authority (CA) certificate file.
.IP

.TP
\fBSSL_CAPATH\fR
The path name of the directory that contains trusted SSL CA certificate files.
.IP

.TP
\fBSSL_KEY\fR
The path name of the client private key file.
.IP

.TP
\fBSSL_CIPHER\fR
The list of permissible ciphers for SSL encryption.
.RE
.TP
\fBStorageType\fR
Define the accounting storage mechanism type.
Acceptable values at present include "accounting_storage/mysql".
The value "accounting_storage/mysql" indicates that accounting records
should be written to a MySQL or MariaDB database specified by the
\fBStorageLoc\fR parameter.
This value must be specified.
.IP

.TP
\fBStorageUser\fR
Define the name of the user we are going to connect to the database
with to store the job accounting data.
.IP

.TP
\fBTCPTimeout\fR
Time permitted for TCP connection to be established. Default value is 2 seconds.
.IP

.TP
\fBTrackSlurmctldDown\fR
Boolean yes or no.  If set the slurmdbd will mark all idle resources on the
cluster as down when a slurmctld disconnects or is no longer reachable.  The
default is no.
.IP

.TP
\fBTrackWCKey\fR
Boolean yes or no.  Used to set display and track of the Workload
Characterization Key. Must be set to track wckey usage.  This must be set to
generate rolled up usage tables from WCKeys.
\fBNOTE\fR: If TrackWCKey is set here and not in your various slurm.conf files
all jobs will be attributed to their default WCKey.
.IP

.SH "EXAMPLE"
.nf
#
# Sample /etc/slurmdbd.conf
#
ArchiveEvents=yes
ArchiveJobs=yes
ArchiveResvs=yes
ArchiveSteps=no
ArchiveSuspend=no
ArchiveTXN=no
ArchiveUsage=no
#ArchiveScript=/usr/sbin/slurm.dbd.archive
AuthInfo=/var/run/munge/munge.socket.2
AuthType=auth/munge
StorageUser=database_mgr
.fi

.SH "COPYING"
Copyright (C) 2008\-2010 Lawrence Livermore National Security.
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
.br
Copyright (C) 2010\-2022 SchedMD LLC.
.LP
This file is part of Slurm, a resource management program.
For details, see <https://slurm.schedmd.com/>.
.LP
Slurm is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 2 of the License, or (at your option)
any later version.
.LP
Slurm is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
details.

.SH "FILES"
/etc/slurmdbd.conf

.SH "SEE ALSO"
.LP
\fBslurm.conf\fR(5),
\fBslurmctld\fR(8), \fBslurmdbd\fR(8)
\fBsyslog\fR (2)