Slurm Workload Manager - Man Pages

# Man Pages

NOTE: This documentation is for Slurm version 20.02.
Documentation for other versions of Slurm is distributed with the code

## Commands

sacct | displays accounting data for all jobs and job steps in the Slurm job accounting log or Slurm database
sacctmgr | Used to view and modify Slurm account information.
salloc | Obtain a Slurm job allocation (a set of nodes), execute a command, and then release the allocation when the command is finished.
sattach | Attach to a Slurm job step.
sbatch | Submit a batch script to Slurm.
sbcast | transmit a file to the nodes allocated to a Slurm job.
scancel | Used to signal jobs or job steps that are under the control of Slurm.
scontrol | Used view and modify Slurm configuration and state.
sdiag | scheduling diagnostic tool.
sinfo | view information about Slurm nodes and partitions.
slurm | Slurm system overview.
smd | failure management support tool.
sprio | view the factors that comprise a job's scheduling priority
sh5util | merge utility for acct_gather_profile plugin.
squeue | view information about jobs located in the Slurm scheduling queue.
sreport | Generate reports from the slurm accounting data.
srun | Run parallel jobs
sshare | Tool for listing the shares of associations to a cluster.
sstat | Display various status information of a running job/step.
strigger | Used set, get or clear Slurm trigger information.
sview | graphical user interface to view and modif. Slurm state.

## Configuration Files

acct_gather.conf | Slurm configuration file for the acct_gather plugins
burst_buffer.conf | Slurm burst buffer configuration
cgroup.conf | Slurm configuration file for the cgroup support
ext_sensors.conf | Slurm configuration file for the external sensor support
gres.conf | Slurm configuration file for generic resource management.
knl.conf | Slurm configuration file for Intel Knights Landing management.
nonstop.conf | Slurm configuration file for failure management.
slurm.conf | Slurm configuration file
slurmdbd.conf | Slurm Database Daemon (SlurmDBD) configuration file
topology.conf | Slurm configuration file for defining the network topology

## Daemons and Other

slurmctld | The central management daemon of Slurm.
slurmd | The compute node daemon for Slurm.
slurmdbd | Slurm Database Daemon.
slurmrestd | The Slurm REST API daemon.
slurmstepd | The job step manager for Slurm.
SPANK | Slurm Plug-in Architecture for Node and job (K)control

Last modified 20 February 2020