Slurm command reference#

pyslurmutils check#

Check whether we can connection and authenticate with the Slurm REST server.

usage: pyslurmutils check [-h] [-l {debug,info,warning,error,critical}]
                          [-u USER_NAME] [-t TOKEN] [-v API_VERSION]
                          [--url URL] [--renewal-url RENEWAL_URL]
                          [--log-dir LOG_DIRECTORY]

Named Arguments#

-l, --log

Possible choices: debug, info, warning, error, critical

Log level (default: warning)

Default: warning

-u, --user

User name (default: “docs”)

Default: “docs”

-t, --token

SLURM access token (default: None)

-v, --api-version

SLURM access token (default: None)

--url

SLURM Rest Server (default: None)

--renewal-url

URL for SLURM token renewal (default: None)

--log-dir

Directory of SLURM job logs (default: None)

pyslurmutils status#

Inspect the status of Slurm jobs.

usage: pyslurmutils status [-h] [-l {debug,info,warning,error,critical}]
                           [-u USER_NAME] [-t TOKEN] [-v API_VERSION]
                           [--url URL] [--renewal-url RENEWAL_URL]
                           [--log-dir LOG_DIRECTORY] [-j JOBID] [-a]
                           [-m INTERVAL]

Named Arguments#

-l, --log

Possible choices: debug, info, warning, error, critical

Log level (default: warning)

Default: warning

-u, --user

User name (default: “docs”)

Default: “docs”

-t, --token

SLURM access token (default: None)

-v, --api-version

SLURM access token (default: None)

--url

SLURM Rest Server (default: None)

--renewal-url

URL for SLURM token renewal (default: None)

--log-dir

Directory of SLURM job logs (default: None)

-j, --jobid

SLURM Job ID (all jobs when not provided)

Default: 0

-a, --all

All users when ‘–jobid’ is not set

Default: False

-m, --monitor

Monitor are intervals of x seconds

Default: 0

pyslurmutils diff#

List the differences between two jobs.

usage: pyslurmutils diff [-h] [-l {debug,info,warning,error,critical}]
                         [-u USER_NAME] [-t TOKEN] [-v API_VERSION]
                         [--url URL] [--renewal-url RENEWAL_URL]
                         [--log-dir LOG_DIRECTORY] [-a] [-m INTERVAL]
                         jobid1 jobid2

Positional Arguments#

jobid1: SLURM Job ID
jobid2: SLURM Job ID

Named Arguments#

-l, --log

Possible choices: debug, info, warning, error, critical

Log level (default: warning)

Default: warning

-u, --user

User name (default: “docs”)

Default: “docs”

-t, --token

SLURM access token (default: None)

-v, --api-version

SLURM access token (default: None)

--url

SLURM Rest Server (default: None)

--renewal-url

URL for SLURM token renewal (default: None)

--log-dir

Directory of SLURM job logs (default: None)

-a, --all

All users when ‘–jobid’ is not set

Default: False

-m, --monitor

Monitor are intervals of x seconds

Default: 0

pyslurmutils cancel#

Cancel Slurm jobs.

usage: pyslurmutils cancel [-h] [-l {debug,info,warning,error,critical}]
                           [-u USER_NAME] [-t TOKEN] [-v API_VERSION]
                           [--url URL] [--renewal-url RENEWAL_URL]
                           [--log-dir LOG_DIRECTORY] [-a]
                           [job_ids ...]

Positional Arguments#

job_ids

SLURM Job ID’s to be cancelled

Default: 0

Named Arguments#

-l, --log

Possible choices: debug, info, warning, error, critical

Log level (default: warning)

Default: warning

-u, --user

User name (default: “docs”)

Default: “docs”

-t, --token

SLURM access token (default: None)

-v, --api-version

SLURM access token (default: None)

--url

SLURM Rest Server (default: None)

--renewal-url

URL for SLURM token renewal (default: None)

--log-dir

Directory of SLURM job logs (default: None)

-a, --all

All jobs when no job ID is provided

Default: False

pyslurmutils submit#

Submit and inline shell script to Slurm.

usage: pyslurmutils submit [-h] [-l {debug,info,warning,error,critical}]
                           [-u USER_NAME] [-t TOKEN] [-v API_VERSION]
                           [--url URL] [--renewal-url RENEWAL_URL]
                           [--log-dir LOG_DIRECTORY] [-a] [-sp NAME=VALUE]
                           [-w]
                           [script ...]

Positional Arguments#

script

Inline script

Default: [‘echo This is a test’]

Named Arguments#

-l, --log

Possible choices: debug, info, warning, error, critical

Log level (default: warning)

Default: warning

-u, --user

User name (default: “docs”)

Default: “docs”

-t, --token

SLURM access token (default: None)

-v, --api-version

SLURM access token (default: None)

--url

SLURM Rest Server (default: None)

--renewal-url

URL for SLURM token renewal (default: None)

--log-dir

Directory of SLURM job logs (default: None)

-a, --all

All jobs when no job ID is provided

Default: False

-sp, --slurm-parameter

SLURM parameters

Default: []

-w, --wait

Wait until the job is finished

Default: False

pyslurmutils version#

Print the Slurm API version used based on the provided CLI arguments.

usage: pyslurmutils version [-h] [-l {debug,info,warning,error,critical}]
                            [-u USER_NAME] [-t TOKEN] [-v API_VERSION]
                            [--url URL] [--renewal-url RENEWAL_URL]
                            [--log-dir LOG_DIRECTORY]

Named Arguments#

-l, --log

Possible choices: debug, info, warning, error, critical

Log level (default: warning)

Default: warning

-u, --user

User name (default: “docs”)

Default: “docs”

-t, --token

SLURM access token (default: None)

-v, --api-version

SLURM access token (default: None)

--url

SLURM Rest Server (default: None)

--renewal-url

URL for SLURM token renewal (default: None)

--log-dir

Directory of SLURM job logs (default: None)