LinuxCommandLibrary

sacctmgr

Manage Slurm account and cluster information

TLDR

Show current configuration

$ sacctmgr show configuration
copy

Add a cluster to the slurm database
$ sacctmgr add cluster [cluster_name]
copy

Add an account to the slurm database
$ sacctmgr add account [account_name] cluster=[cluster_of_account]
copy

Show details of user/association/cluster/account using a specific format
$ sacctmgr show [user|association|cluster|account] format="Account%10" format="GrpTRES%30"
copy

SYNOPSIS

sacctmgr [options] command [parameters]

PARAMETERS

--help
    Display help message.

--version
    Display version information.

add
    Add new entity to the Slurm database (e.g., user, account, cluster).

modify
    Modify existing entity in the Slurm database.

delete
    Delete entity from the Slurm database.

show
    Show information about entities in the Slurm database.

list
    List entities in the Slurm database.

-i, --immediate
    Immediate mode.

-n, --noheader
    Suppress column headers.

-P, --parsable
    Display information in a parsable format.

DESCRIPTION

The `sacctmgr` command is a powerful command-line tool used to manage Slurm (Simple Linux Utility for Resource Management) accounting. It allows administrators to add, modify, and delete users, accounts, clusters, reservations, and quality of service (QOS) settings within the Slurm database. `sacctmgr` provides a structured way to control resource allocation, track usage, and enforce policies within a Slurm-managed cluster. It is essential for maintaining a fair and efficient computing environment. It interacts directly with the Slurm database, ensuring that all changes are persistently stored. Using `sacctmgr` requires appropriate administrative privileges. Incorrect usage can disrupt cluster operations and impact users, so careful planning and understanding of the command's options are crucial. It supports different storage types for the accounting database such as MySQL or MariaDB. The configuration is defined within the slurm.conf configuration file. It provides fine grained control over the resource allocation and usage.

CAVEATS

Requires appropriate administrative privileges to modify the Slurm database. Incorrect usage can disrupt cluster operations.

COMMAND STRUCTURE

The general structure of the command is 'sacctmgr [options]'. For example, 'sacctmgr add user name=john account=myaccount' adds a user named john to the account myaccount.

COMMON ENTITIES

Frequently managed entities include: users, accounts, clusters, qos (Quality of Service), and reservations. Each entity has specific attributes that can be set using 'sacctmgr'.

ACCOUNT HIERARCHIES

Slurm allows for hierarchical account structures. This lets administrators to create parent and child accounts, enabling finer-grained control over resource allocation and usage reporting.
The parent option during account creation is important for creating this hierarchy.

HISTORY

The `sacctmgr` command was developed as part of the Slurm workload manager to provide a dedicated tool for managing accounting data. It allows administrators to manage Slurm users, accounts, clusters, QOS and more. It's development was crucial to provide a centralized and organized way to manage resources and track usage in high-performance computing environments.

SEE ALSO

scontrol(1), squeue(1), sbatch(1), sacct(1)

Copied to clipboard