SLURM APIs

Overview

All of the SLURM commands utilize a collection of Application Programming Interfaces (APIs). User and system applications can directly use these APIs as desired to achieve tighter integration with SLURM. For example, SLURM data structures and error codes can be directly examined rather than executing SLURM commands and parsing their output. This document describes SLURM APIs. You should see the man pages for individual APIs to get more details.

Get Overall SLURM Information

Get Job Information

Get Job Step Information

Get Node Information

Get Partition Information

Error Handling

Resource Allocation

Job Step Creation

SLURM job steps involve numerous interactions with the slurmd daemon. The job step creation is only the first step in the process. We don't advise direct user creation of job steps, but include the information here for completeness.

Job and Job Step Signaling and Cancelling

Job Completion

Checkpoint

Administrative Functions

Most of these functions can only be executed by user root.

SLURM Host List Support

SLURM uses a condensed format to express node names. For example linux[1-3,6] represents linux1, linux2, linux3, and linux6. These functions permit you to translate the SLURM expression into a list of individual node names.

Last modified 13 November 2005