Documentation
NOTE: This documentation is for Slurm version 25.11.
Documentation for older versions of Slurm are distributed with the source, ormay be found in thearchive.
Slurm Users
- Quick Start User Guide
- Command/option Summary (two pages)
- Man Pages
- Rosetta Stone of Workload Managers
- Job Array Support
- Heterogeneous Job Support
- CPU Management User and Administrator Guide
- MPI and UPC Users Guide
- Support for Multi-core/Multi-threaded Architectures
- Multi-Cluster Operation
- Profiling Using HDF5 User Guide
- Job Reason Codes
- Job State Codes
- Job Exit Codes
- Resource Binding
Slurm Administrators
- Quick Start Administrator Guide
- Upgrade Guide
- Accounting
- Advanced Resource Reservation Guide
- Authentication Plugins
- Burst Buffer Guide
- Cgroups Guide
- "Configless" Slurm Operation
- Configuration Tool (Full version)
- Configuration Tool (Simplified version)
- Containers
- CPU Management User and Administrator Guide
- Dynamic Nodes
- Elasticsearch Guide
- Job Completion Kafka plugin Guide
- namespace/tmpfs - Job Specific Temporary File Management
- JSON Web Tokens Authentication
- Federated Scheduling Guide
- Job Containment (SSH Session Control) with pam_slurm_adopt
- Kubernetes Guide
- Large Cluster Administration Guide
- License Management
- Hierarchical Resources (HRES) (in Beta)
- Multi-Category Security (MCS) Guide
- Name Service Caching Through NSS Slurm
- Network Configuration Guide
- OpenAPI Plugin Release Notes
- Power Saving Guide (power down idle nodes)
- Prolog and Epilog Guide
- Slurm REST API
- Slurm SELinux Context Management
- Troubleshooting Guide
- User Permissions
- WCKey Management
- Workload Prioritization
- Slurm Scheduling
- Cloud
Slurm Developers
- Contributor Guide
- Programmer Guide
- Application Programmer Interface (API) Guide
- Adding Files or Plugins to Slurm
- Design Information
- Plugin Programmer Guide
- Plugin Interface Details