Slurm REST API

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for heromicro from gravatar.com heromicro

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache 2.0
  • Author: SchedMD LLC
  • Tags OpenAPI , OpenAPI-Generator , Slurm REST API
  • Requires: Python >=3.9
Report project as malware

Project description

slurmrestapi

API to access and control Slurm

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: Slurm-25.11.4
  • Package version: 1.0.0
  • Generator version: 7.20.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.schedmd.com/

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import slurmrestapi

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import slurmrestapi

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import slurmrestapi
from slurmrestapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = slurmrestapi.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: user
configuration.api_key['user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['user'] = 'Bearer'

# Configure Bearer authorization (JWT): bearerAuth
configuration = slurmrestapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: token
configuration.api_key['token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'


# Enter a context with an instance of the API client
with slurmrestapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = slurmrestapi.SlurmApi(api_client)
    job_id = 'job_id_example' # str | Job ID
    signal = 'signal_example' # str | Signal to send to Job (optional)
    flags = 'flags_example' # str | Signalling flags (optional)

    try:
        # cancel or signal job
        api_response = api_instance.slurm_v0041_delete_job(job_id, signal=signal, flags=flags)
        print("The response of SlurmApi->slurm_v0041_delete_job:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling SlurmApi->slurm_v0041_delete_job: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
SlurmApi slurm_v0041_delete_job DELETE /slurm/v0.0.41/job/{job_id} cancel or signal job
SlurmApi slurm_v0041_delete_jobs DELETE /slurm/v0.0.41/jobs/ send signal to list of jobs
SlurmApi slurm_v0041_delete_node DELETE /slurm/v0.0.41/node/{node_name} delete node
SlurmApi slurm_v0041_delete_reservation DELETE /slurm/v0.0.41/reservation/{reservation_name} delete a reservation
SlurmApi slurm_v0041_get_diag GET /slurm/v0.0.41/diag/ get diagnostics
SlurmApi slurm_v0041_get_job GET /slurm/v0.0.41/job/{job_id} get job info
SlurmApi slurm_v0041_get_jobs GET /slurm/v0.0.41/jobs/ get list of jobs
SlurmApi slurm_v0041_get_jobs_state GET /slurm/v0.0.41/jobs/state/ get list of job states
SlurmApi slurm_v0041_get_licenses GET /slurm/v0.0.41/licenses/ get all Slurm tracked license info
SlurmApi slurm_v0041_get_node GET /slurm/v0.0.41/node/{node_name} get node info
SlurmApi slurm_v0041_get_nodes GET /slurm/v0.0.41/nodes/ get node(s) info
SlurmApi slurm_v0041_get_partition GET /slurm/v0.0.41/partition/{partition_name} get partition info
SlurmApi slurm_v0041_get_partitions GET /slurm/v0.0.41/partitions/ get all partition info
SlurmApi slurm_v0041_get_ping GET /slurm/v0.0.41/ping/ ping test
SlurmApi slurm_v0041_get_reconfigure GET /slurm/v0.0.41/reconfigure/ request slurmctld reconfigure
SlurmApi slurm_v0041_get_reservation GET /slurm/v0.0.41/reservation/{reservation_name} get reservation info
SlurmApi slurm_v0041_get_reservations GET /slurm/v0.0.41/reservations/ get all reservation info
SlurmApi slurm_v0041_get_shares GET /slurm/v0.0.41/shares get fairshare info
SlurmApi slurm_v0041_post_job POST /slurm/v0.0.41/job/{job_id} update job
SlurmApi slurm_v0041_post_job_allocate POST /slurm/v0.0.41/job/allocate submit new job allocation without any steps that must be signaled to stop
SlurmApi slurm_v0041_post_job_submit POST /slurm/v0.0.41/job/submit submit new job
SlurmApi slurm_v0041_post_node POST /slurm/v0.0.41/node/{node_name} update node properties
SlurmApi slurm_v0041_post_nodes POST /slurm/v0.0.41/nodes/ batch update node(s)
SlurmApi slurm_v0042_delete_job DELETE /slurm/v0.0.42/job/{job_id} cancel or signal job
SlurmApi slurm_v0042_delete_jobs DELETE /slurm/v0.0.42/jobs/ send signal to list of jobs
SlurmApi slurm_v0042_delete_node DELETE /slurm/v0.0.42/node/{node_name} delete node
SlurmApi slurm_v0042_delete_reservation DELETE /slurm/v0.0.42/reservation/{reservation_name} delete a reservation
SlurmApi slurm_v0042_get_diag GET /slurm/v0.0.42/diag/ get diagnostics
SlurmApi slurm_v0042_get_job GET /slurm/v0.0.42/job/{job_id} get job info
SlurmApi slurm_v0042_get_jobs GET /slurm/v0.0.42/jobs/ get list of jobs
SlurmApi slurm_v0042_get_jobs_state GET /slurm/v0.0.42/jobs/state/ get list of job states
SlurmApi slurm_v0042_get_licenses GET /slurm/v0.0.42/licenses/ get all Slurm tracked license info
SlurmApi slurm_v0042_get_node GET /slurm/v0.0.42/node/{node_name} get node info
SlurmApi slurm_v0042_get_nodes GET /slurm/v0.0.42/nodes/ get node(s) info
SlurmApi slurm_v0042_get_partition GET /slurm/v0.0.42/partition/{partition_name} get partition info
SlurmApi slurm_v0042_get_partitions GET /slurm/v0.0.42/partitions/ get all partition info
SlurmApi slurm_v0042_get_ping GET /slurm/v0.0.42/ping/ ping test
SlurmApi slurm_v0042_get_reconfigure GET /slurm/v0.0.42/reconfigure/ request slurmctld reconfigure
SlurmApi slurm_v0042_get_reservation GET /slurm/v0.0.42/reservation/{reservation_name} get reservation info
SlurmApi slurm_v0042_get_reservations GET /slurm/v0.0.42/reservations/ get all reservation info
SlurmApi slurm_v0042_get_shares GET /slurm/v0.0.42/shares get fairshare info
SlurmApi slurm_v0042_post_job POST /slurm/v0.0.42/job/{job_id} update job
SlurmApi slurm_v0042_post_job_allocate POST /slurm/v0.0.42/job/allocate submit new job allocation without any steps that must be signaled to stop
SlurmApi slurm_v0042_post_job_submit POST /slurm/v0.0.42/job/submit submit new job
SlurmApi slurm_v0042_post_node POST /slurm/v0.0.42/node/{node_name} update node properties
SlurmApi slurm_v0042_post_nodes POST /slurm/v0.0.42/nodes/ batch update node(s)
SlurmApi slurm_v0043_delete_job DELETE /slurm/v0.0.43/job/{job_id} cancel or signal job
SlurmApi slurm_v0043_delete_jobs DELETE /slurm/v0.0.43/jobs/ send signal to list of jobs
SlurmApi slurm_v0043_delete_node DELETE /slurm/v0.0.43/node/{node_name} delete node
SlurmApi slurm_v0043_delete_reservation DELETE /slurm/v0.0.43/reservation/{reservation_name} delete a reservation
SlurmApi slurm_v0043_get_diag GET /slurm/v0.0.43/diag/ get diagnostics
SlurmApi slurm_v0043_get_job GET /slurm/v0.0.43/job/{job_id} get job info
SlurmApi slurm_v0043_get_jobs GET /slurm/v0.0.43/jobs/ get list of jobs
SlurmApi slurm_v0043_get_jobs_state GET /slurm/v0.0.43/jobs/state/ get list of job states
SlurmApi slurm_v0043_get_licenses GET /slurm/v0.0.43/licenses/ get all Slurm tracked license info
SlurmApi slurm_v0043_get_node GET /slurm/v0.0.43/node/{node_name} get node info
SlurmApi slurm_v0043_get_nodes GET /slurm/v0.0.43/nodes/ get node(s) info
SlurmApi slurm_v0043_get_partition GET /slurm/v0.0.43/partition/{partition_name} get partition info
SlurmApi slurm_v0043_get_partitions GET /slurm/v0.0.43/partitions/ get all partition info
SlurmApi slurm_v0043_get_ping GET /slurm/v0.0.43/ping/ ping test
SlurmApi slurm_v0043_get_reconfigure GET /slurm/v0.0.43/reconfigure/ request slurmctld reconfigure
SlurmApi slurm_v0043_get_reservation GET /slurm/v0.0.43/reservation/{reservation_name} get reservation info
SlurmApi slurm_v0043_get_reservations GET /slurm/v0.0.43/reservations/ get all reservation info
SlurmApi slurm_v0043_get_shares GET /slurm/v0.0.43/shares get fairshare info
SlurmApi slurm_v0043_post_job POST /slurm/v0.0.43/job/{job_id} update job
SlurmApi slurm_v0043_post_job_allocate POST /slurm/v0.0.43/job/allocate submit new job allocation without any steps that must be signaled to stop
SlurmApi slurm_v0043_post_job_submit POST /slurm/v0.0.43/job/submit submit new job
SlurmApi slurm_v0043_post_node POST /slurm/v0.0.43/node/{node_name} update node properties
SlurmApi slurm_v0043_post_nodes POST /slurm/v0.0.43/nodes/ batch update node(s)
SlurmApi slurm_v0043_post_reservation POST /slurm/v0.0.43/reservation create or update a reservation
SlurmApi slurm_v0043_post_reservations POST /slurm/v0.0.43/reservations/ create or update reservations
SlurmApi slurm_v0044_delete_job DELETE /slurm/v0.0.44/job/{job_id} cancel or signal job
SlurmApi slurm_v0044_delete_jobs DELETE /slurm/v0.0.44/jobs/ send signal to list of jobs
SlurmApi slurm_v0044_delete_node DELETE /slurm/v0.0.44/node/{node_name} delete node
SlurmApi slurm_v0044_delete_reservation DELETE /slurm/v0.0.44/reservation/{reservation_name} delete a reservation
SlurmApi slurm_v0044_get_diag GET /slurm/v0.0.44/diag/ get diagnostics
SlurmApi slurm_v0044_get_job GET /slurm/v0.0.44/job/{job_id} get job info
SlurmApi slurm_v0044_get_jobs GET /slurm/v0.0.44/jobs/ get list of jobs
SlurmApi slurm_v0044_get_jobs_state GET /slurm/v0.0.44/jobs/state/ get list of job states
SlurmApi slurm_v0044_get_licenses GET /slurm/v0.0.44/licenses/ get all Slurm tracked license info
SlurmApi slurm_v0044_get_node GET /slurm/v0.0.44/node/{node_name} get node info
SlurmApi slurm_v0044_get_nodes GET /slurm/v0.0.44/nodes/ get node(s) info
SlurmApi slurm_v0044_get_partition GET /slurm/v0.0.44/partition/{partition_name} get partition info
SlurmApi slurm_v0044_get_partitions GET /slurm/v0.0.44/partitions/ get all partition info
SlurmApi slurm_v0044_get_ping GET /slurm/v0.0.44/ping/ ping test
SlurmApi slurm_v0044_get_reconfigure GET /slurm/v0.0.44/reconfigure/ request slurmctld reconfigure
SlurmApi slurm_v0044_get_reservation GET /slurm/v0.0.44/reservation/{reservation_name} get reservation info
SlurmApi slurm_v0044_get_reservations GET /slurm/v0.0.44/reservations/ get all reservation info
SlurmApi slurm_v0044_get_resources GET /slurm/v0.0.44/resources/{job_id} get resource layout info
SlurmApi slurm_v0044_get_shares GET /slurm/v0.0.44/shares get fairshare info
SlurmApi slurm_v0044_post_job POST /slurm/v0.0.44/job/{job_id} update job
SlurmApi slurm_v0044_post_job_allocate POST /slurm/v0.0.44/job/allocate submit new job allocation without any steps that must be signaled to stop
SlurmApi slurm_v0044_post_job_submit POST /slurm/v0.0.44/job/submit submit new job
SlurmApi slurm_v0044_post_new_node POST /slurm/v0.0.44/new/node/ create node
SlurmApi slurm_v0044_post_node POST /slurm/v0.0.44/node/{node_name} update node properties
SlurmApi slurm_v0044_post_nodes POST /slurm/v0.0.44/nodes/ batch update node(s)
SlurmApi slurm_v0044_post_reservation POST /slurm/v0.0.44/reservation create or update a reservation
SlurmApi slurm_v0044_post_reservations POST /slurm/v0.0.44/reservations/ create or update reservations
SlurmdbApi slurmdb_v0041_delete_account DELETE /slurmdb/v0.0.41/account/{account_name} Delete account
SlurmdbApi slurmdb_v0041_delete_association DELETE /slurmdb/v0.0.41/association/ Delete association
SlurmdbApi slurmdb_v0041_delete_associations DELETE /slurmdb/v0.0.41/associations/ Delete associations
SlurmdbApi slurmdb_v0041_delete_cluster DELETE /slurmdb/v0.0.41/cluster/{cluster_name} Delete cluster
SlurmdbApi slurmdb_v0041_delete_single_qos DELETE /slurmdb/v0.0.41/qos/{qos} Delete QOS
SlurmdbApi slurmdb_v0041_delete_user DELETE /slurmdb/v0.0.41/user/{name} Delete user
SlurmdbApi slurmdb_v0041_delete_wckey DELETE /slurmdb/v0.0.41/wckey/{id} Delete wckey
SlurmdbApi slurmdb_v0041_get_account GET /slurmdb/v0.0.41/account/{account_name} Get account info
SlurmdbApi slurmdb_v0041_get_accounts GET /slurmdb/v0.0.41/accounts/ Get account list
SlurmdbApi slurmdb_v0041_get_association GET /slurmdb/v0.0.41/association/ Get association info
SlurmdbApi slurmdb_v0041_get_associations GET /slurmdb/v0.0.41/associations/ Get association list
SlurmdbApi slurmdb_v0041_get_cluster GET /slurmdb/v0.0.41/cluster/{cluster_name} Get cluster info
SlurmdbApi slurmdb_v0041_get_clusters GET /slurmdb/v0.0.41/clusters/ Get cluster list
SlurmdbApi slurmdb_v0041_get_config GET /slurmdb/v0.0.41/config Dump all configuration information
SlurmdbApi slurmdb_v0041_get_diag GET /slurmdb/v0.0.41/diag/ Get slurmdb diagnostics
SlurmdbApi slurmdb_v0041_get_instance GET /slurmdb/v0.0.41/instance/ Get instance info
SlurmdbApi slurmdb_v0041_get_instances GET /slurmdb/v0.0.41/instances/ Get instance list
SlurmdbApi slurmdb_v0041_get_job GET /slurmdb/v0.0.41/job/{job_id} Get job info
SlurmdbApi slurmdb_v0041_get_jobs GET /slurmdb/v0.0.41/jobs/ Get job list
SlurmdbApi slurmdb_v0041_get_qos GET /slurmdb/v0.0.41/qos/ Get QOS list
SlurmdbApi slurmdb_v0041_get_single_qos GET /slurmdb/v0.0.41/qos/{qos} Get QOS info
SlurmdbApi slurmdb_v0041_get_tres GET /slurmdb/v0.0.41/tres/ Get TRES info
SlurmdbApi slurmdb_v0041_get_user GET /slurmdb/v0.0.41/user/{name} Get user info
SlurmdbApi slurmdb_v0041_get_users GET /slurmdb/v0.0.41/users/ Get user list
SlurmdbApi slurmdb_v0041_get_wckey GET /slurmdb/v0.0.41/wckey/{id} Get wckey info
SlurmdbApi slurmdb_v0041_get_wckeys GET /slurmdb/v0.0.41/wckeys/ Get wckey list
SlurmdbApi slurmdb_v0041_post_accounts POST /slurmdb/v0.0.41/accounts/ Add/update list of accounts
SlurmdbApi slurmdb_v0041_post_accounts_association POST /slurmdb/v0.0.41/accounts_association/ Add accounts with conditional association
SlurmdbApi slurmdb_v0041_post_associations POST /slurmdb/v0.0.41/associations/ Set associations info
SlurmdbApi slurmdb_v0041_post_clusters POST /slurmdb/v0.0.41/clusters/ Get cluster list
SlurmdbApi slurmdb_v0041_post_config POST /slurmdb/v0.0.41/config Load all configuration information
SlurmdbApi slurmdb_v0041_post_qos POST /slurmdb/v0.0.41/qos/ Add or update QOSs
SlurmdbApi slurmdb_v0041_post_tres POST /slurmdb/v0.0.41/tres/ Add TRES
SlurmdbApi slurmdb_v0041_post_users POST /slurmdb/v0.0.41/users/ Update users
SlurmdbApi slurmdb_v0041_post_users_association POST /slurmdb/v0.0.41/users_association/ Add users with conditional association
SlurmdbApi slurmdb_v0041_post_wckeys POST /slurmdb/v0.0.41/wckeys/ Add or update wckeys
SlurmdbApi slurmdb_v0042_delete_account DELETE /slurmdb/v0.0.42/account/{account_name} Delete account
SlurmdbApi slurmdb_v0042_delete_association DELETE /slurmdb/v0.0.42/association/ Delete association
SlurmdbApi slurmdb_v0042_delete_associations DELETE /slurmdb/v0.0.42/associations/ Delete associations
SlurmdbApi slurmdb_v0042_delete_cluster DELETE /slurmdb/v0.0.42/cluster/{cluster_name} Delete cluster
SlurmdbApi slurmdb_v0042_delete_single_qos DELETE /slurmdb/v0.0.42/qos/{qos} Delete QOS
SlurmdbApi slurmdb_v0042_delete_user DELETE /slurmdb/v0.0.42/user/{name} Delete user
SlurmdbApi slurmdb_v0042_delete_wckey DELETE /slurmdb/v0.0.42/wckey/{id} Delete wckey
SlurmdbApi slurmdb_v0042_get_account GET /slurmdb/v0.0.42/account/{account_name} Get account info
SlurmdbApi slurmdb_v0042_get_accounts GET /slurmdb/v0.0.42/accounts/ Get account list
SlurmdbApi slurmdb_v0042_get_association GET /slurmdb/v0.0.42/association/ Get association info
SlurmdbApi slurmdb_v0042_get_associations GET /slurmdb/v0.0.42/associations/ Get association list
SlurmdbApi slurmdb_v0042_get_cluster GET /slurmdb/v0.0.42/cluster/{cluster_name} Get cluster info
SlurmdbApi slurmdb_v0042_get_clusters GET /slurmdb/v0.0.42/clusters/ Get cluster list
SlurmdbApi slurmdb_v0042_get_config GET /slurmdb/v0.0.42/config Dump all configuration information
SlurmdbApi slurmdb_v0042_get_diag GET /slurmdb/v0.0.42/diag/ Get slurmdb diagnostics
SlurmdbApi slurmdb_v0042_get_instance GET /slurmdb/v0.0.42/instance/ Get instance info
SlurmdbApi slurmdb_v0042_get_instances GET /slurmdb/v0.0.42/instances/ Get instance list
SlurmdbApi slurmdb_v0042_get_job GET /slurmdb/v0.0.42/job/{job_id} Get job info
SlurmdbApi slurmdb_v0042_get_jobs GET /slurmdb/v0.0.42/jobs/ Get job list
SlurmdbApi slurmdb_v0042_get_ping GET /slurmdb/v0.0.42/ping/ ping test
SlurmdbApi slurmdb_v0042_get_qos GET /slurmdb/v0.0.42/qos/ Get QOS list
SlurmdbApi slurmdb_v0042_get_single_qos GET /slurmdb/v0.0.42/qos/{qos} Get QOS info
SlurmdbApi slurmdb_v0042_get_tres GET /slurmdb/v0.0.42/tres/ Get TRES info
SlurmdbApi slurmdb_v0042_get_user GET /slurmdb/v0.0.42/user/{name} Get user info
SlurmdbApi slurmdb_v0042_get_users GET /slurmdb/v0.0.42/users/ Get user list
SlurmdbApi slurmdb_v0042_get_wckey GET /slurmdb/v0.0.42/wckey/{id} Get wckey info
SlurmdbApi slurmdb_v0042_get_wckeys GET /slurmdb/v0.0.42/wckeys/ Get wckey list
SlurmdbApi slurmdb_v0042_post_accounts POST /slurmdb/v0.0.42/accounts/ Add/update list of accounts
SlurmdbApi slurmdb_v0042_post_accounts_association POST /slurmdb/v0.0.42/accounts_association/ Add accounts with conditional association
SlurmdbApi slurmdb_v0042_post_associations POST /slurmdb/v0.0.42/associations/ Set associations info
SlurmdbApi slurmdb_v0042_post_clusters POST /slurmdb/v0.0.42/clusters/ Get cluster list
SlurmdbApi slurmdb_v0042_post_config POST /slurmdb/v0.0.42/config Load all configuration information
SlurmdbApi slurmdb_v0042_post_qos POST /slurmdb/v0.0.42/qos/ Add or update QOSs
SlurmdbApi slurmdb_v0042_post_tres POST /slurmdb/v0.0.42/tres/ Add TRES
SlurmdbApi slurmdb_v0042_post_users POST /slurmdb/v0.0.42/users/ Update users
SlurmdbApi slurmdb_v0042_post_users_association POST /slurmdb/v0.0.42/users_association/ Add users with conditional association
SlurmdbApi slurmdb_v0042_post_wckeys POST /slurmdb/v0.0.42/wckeys/ Add or update wckeys
SlurmdbApi slurmdb_v0043_delete_account DELETE /slurmdb/v0.0.43/account/{account_name} Delete account
SlurmdbApi slurmdb_v0043_delete_association DELETE /slurmdb/v0.0.43/association/ Delete association
SlurmdbApi slurmdb_v0043_delete_associations DELETE /slurmdb/v0.0.43/associations/ Delete associations
SlurmdbApi slurmdb_v0043_delete_cluster DELETE /slurmdb/v0.0.43/cluster/{cluster_name} Delete cluster
SlurmdbApi slurmdb_v0043_delete_single_qos DELETE /slurmdb/v0.0.43/qos/{qos} Delete QOS
SlurmdbApi slurmdb_v0043_delete_user DELETE /slurmdb/v0.0.43/user/{name} Delete user
SlurmdbApi slurmdb_v0043_delete_wckey DELETE /slurmdb/v0.0.43/wckey/{id} Delete wckey
SlurmdbApi slurmdb_v0043_get_account GET /slurmdb/v0.0.43/account/{account_name} Get account info
SlurmdbApi slurmdb_v0043_get_accounts GET /slurmdb/v0.0.43/accounts/ Get account list
SlurmdbApi slurmdb_v0043_get_association GET /slurmdb/v0.0.43/association/ Get association info
SlurmdbApi slurmdb_v0043_get_associations GET /slurmdb/v0.0.43/associations/ Get association list
SlurmdbApi slurmdb_v0043_get_cluster GET /slurmdb/v0.0.43/cluster/{cluster_name} Get cluster info
SlurmdbApi slurmdb_v0043_get_clusters GET /slurmdb/v0.0.43/clusters/ Get cluster list
SlurmdbApi slurmdb_v0043_get_config GET /slurmdb/v0.0.43/config Dump all configuration information
SlurmdbApi slurmdb_v0043_get_diag GET /slurmdb/v0.0.43/diag/ Get slurmdb diagnostics
SlurmdbApi slurmdb_v0043_get_instance GET /slurmdb/v0.0.43/instance/ Get instance info
SlurmdbApi slurmdb_v0043_get_instances GET /slurmdb/v0.0.43/instances/ Get instance list
SlurmdbApi slurmdb_v0043_get_job GET /slurmdb/v0.0.43/job/{job_id} Get job info
SlurmdbApi slurmdb_v0043_get_jobs GET /slurmdb/v0.0.43/jobs/ Get job list
SlurmdbApi slurmdb_v0043_get_ping GET /slurmdb/v0.0.43/ping/ ping test
SlurmdbApi slurmdb_v0043_get_qos GET /slurmdb/v0.0.43/qos/ Get QOS list
SlurmdbApi slurmdb_v0043_get_single_qos GET /slurmdb/v0.0.43/qos/{qos} Get QOS info
SlurmdbApi slurmdb_v0043_get_tres GET /slurmdb/v0.0.43/tres/ Get TRES info
SlurmdbApi slurmdb_v0043_get_user GET /slurmdb/v0.0.43/user/{name} Get user info
SlurmdbApi slurmdb_v0043_get_users GET /slurmdb/v0.0.43/users/ Get user list
SlurmdbApi slurmdb_v0043_get_wckey GET /slurmdb/v0.0.43/wckey/{id} Get wckey info
SlurmdbApi slurmdb_v0043_get_wckeys GET /slurmdb/v0.0.43/wckeys/ Get wckey list
SlurmdbApi slurmdb_v0043_post_accounts POST /slurmdb/v0.0.43/accounts/ Add/update list of accounts
SlurmdbApi slurmdb_v0043_post_accounts_association POST /slurmdb/v0.0.43/accounts_association/ Add accounts with conditional association
SlurmdbApi slurmdb_v0043_post_associations POST /slurmdb/v0.0.43/associations/ Set associations info
SlurmdbApi slurmdb_v0043_post_clusters POST /slurmdb/v0.0.43/clusters/ Get cluster list
SlurmdbApi slurmdb_v0043_post_config POST /slurmdb/v0.0.43/config Load all configuration information
SlurmdbApi slurmdb_v0043_post_qos POST /slurmdb/v0.0.43/qos/ Add or update QOSs
SlurmdbApi slurmdb_v0043_post_tres POST /slurmdb/v0.0.43/tres/ Add TRES
SlurmdbApi slurmdb_v0043_post_users POST /slurmdb/v0.0.43/users/ Update users
SlurmdbApi slurmdb_v0043_post_users_association POST /slurmdb/v0.0.43/users_association/ Add users with conditional association
SlurmdbApi slurmdb_v0043_post_wckeys POST /slurmdb/v0.0.43/wckeys/ Add or update wckeys
SlurmdbApi slurmdb_v0044_delete_account DELETE /slurmdb/v0.0.44/account/{account_name} Delete account
SlurmdbApi slurmdb_v0044_delete_association DELETE /slurmdb/v0.0.44/association/ Delete association
SlurmdbApi slurmdb_v0044_delete_associations DELETE /slurmdb/v0.0.44/associations/ Delete associations
SlurmdbApi slurmdb_v0044_delete_cluster DELETE /slurmdb/v0.0.44/cluster/{cluster_name} Delete cluster
SlurmdbApi slurmdb_v0044_delete_single_qos DELETE /slurmdb/v0.0.44/qos/{qos} Delete QOS
SlurmdbApi slurmdb_v0044_delete_user DELETE /slurmdb/v0.0.44/user/{name} Delete user
SlurmdbApi slurmdb_v0044_delete_wckey DELETE /slurmdb/v0.0.44/wckey/{id} Delete wckey
SlurmdbApi slurmdb_v0044_get_account GET /slurmdb/v0.0.44/account/{account_name} Get account info
SlurmdbApi slurmdb_v0044_get_accounts GET /slurmdb/v0.0.44/accounts/ Get account list
SlurmdbApi slurmdb_v0044_get_association GET /slurmdb/v0.0.44/association/ Get association info
SlurmdbApi slurmdb_v0044_get_associations GET /slurmdb/v0.0.44/associations/ Get association list
SlurmdbApi slurmdb_v0044_get_cluster GET /slurmdb/v0.0.44/cluster/{cluster_name} Get cluster info
SlurmdbApi slurmdb_v0044_get_clusters GET /slurmdb/v0.0.44/clusters/ Get cluster list
SlurmdbApi slurmdb_v0044_get_config GET /slurmdb/v0.0.44/config Dump all configuration information
SlurmdbApi slurmdb_v0044_get_diag GET /slurmdb/v0.0.44/diag/ Get slurmdb diagnostics
SlurmdbApi slurmdb_v0044_get_instance GET /slurmdb/v0.0.44/instance/ Get instance info
SlurmdbApi slurmdb_v0044_get_instances GET /slurmdb/v0.0.44/instances/ Get instance list
SlurmdbApi slurmdb_v0044_get_job GET /slurmdb/v0.0.44/job/{job_id} Get job info
SlurmdbApi slurmdb_v0044_get_jobs GET /slurmdb/v0.0.44/jobs/ Get job list
SlurmdbApi slurmdb_v0044_get_ping GET /slurmdb/v0.0.44/ping/ ping test
SlurmdbApi slurmdb_v0044_get_qos GET /slurmdb/v0.0.44/qos/ Get QOS list
SlurmdbApi slurmdb_v0044_get_single_qos GET /slurmdb/v0.0.44/qos/{qos} Get QOS info
SlurmdbApi slurmdb_v0044_get_tres GET /slurmdb/v0.0.44/tres/ Get TRES info
SlurmdbApi slurmdb_v0044_get_user GET /slurmdb/v0.0.44/user/{name} Get user info
SlurmdbApi slurmdb_v0044_get_users GET /slurmdb/v0.0.44/users/ Get user list
SlurmdbApi slurmdb_v0044_get_wckey GET /slurmdb/v0.0.44/wckey/{id} Get wckey info
SlurmdbApi slurmdb_v0044_get_wckeys GET /slurmdb/v0.0.44/wckeys/ Get wckey list
SlurmdbApi slurmdb_v0044_post_accounts POST /slurmdb/v0.0.44/accounts/ Add/update list of accounts
SlurmdbApi slurmdb_v0044_post_accounts_association POST /slurmdb/v0.0.44/accounts_association/ Add accounts with conditional association
SlurmdbApi slurmdb_v0044_post_associations POST /slurmdb/v0.0.44/associations/ Set associations info
SlurmdbApi slurmdb_v0044_post_clusters POST /slurmdb/v0.0.44/clusters/ Get cluster list
SlurmdbApi slurmdb_v0044_post_config POST /slurmdb/v0.0.44/config Load all configuration information
SlurmdbApi slurmdb_v0044_post_job POST /slurmdb/v0.0.44/job/{job_id} Update job
SlurmdbApi slurmdb_v0044_post_jobs POST /slurmdb/v0.0.44/jobs/ Update jobs
SlurmdbApi slurmdb_v0044_post_qos POST /slurmdb/v0.0.44/qos/ Add or update QOSs
SlurmdbApi slurmdb_v0044_post_tres POST /slurmdb/v0.0.44/tres/ Add TRES
SlurmdbApi slurmdb_v0044_post_users POST /slurmdb/v0.0.44/users/ Update users
SlurmdbApi slurmdb_v0044_post_users_association POST /slurmdb/v0.0.44/users_association/ Add users with conditional association
SlurmdbApi slurmdb_v0044_post_wckeys POST /slurmdb/v0.0.44/wckeys/ Add or update wckeys
UtilApi util_v0044_post_hostlist POST /util/v0.0.44/hostlist Convert an array of host names into hostlist expression
UtilApi util_v0044_post_hostnames POST /util/v0.0.44/hostnames Convert a hostlist expression into array of host names

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

user

  • Type: API key
  • API key parameter name: X-SLURM-USER-NAME
  • Location: HTTP header

token

  • Type: API key
  • API key parameter name: X-SLURM-USER-TOKEN
  • Location: HTTP header

bearerAuth

  • Type: Bearer authentication (JWT)

Author

sales@schedmd.com

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for heromicro from gravatar.com heromicro

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache 2.0
  • Author: SchedMD LLC
  • Tags OpenAPI , OpenAPI-Generator , Slurm REST API
  • Requires: Python >=3.9

Release history Release notifications | RSS feed

This version

25.11.4.0

25.11.3.0

24.5.5

0.0.39.2

0.0.39.1

0.0.38.2

0.0.38.1

0.0.37.2

0.0.37.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

slurmrestapi-25.11.4.0.tar.gz (631.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

slurmrestapi-25.11.4.0-py3-none-any.whl (1.5 MB view details)

Uploaded Python 3

File details

Details for the file slurmrestapi-25.11.4.0.tar.gz.

File metadata

  • Download URL: slurmrestapi-25.11.4.0.tar.gz
  • Upload date:
  • Size: 631.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.12.0 readme-renderer/44.0 requests/2.31.0 requests-toolbelt/1.0.0 urllib3/2.2.3 tqdm/4.67.1 importlib-metadata/8.6.1 keyring/25.6.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.13.12

File hashes

Hashes for slurmrestapi-25.11.4.0.tar.gz
Algorithm Hash digest
SHA256 df5db19cc91b75e9ea7adea1e04fc0f5b873b85d04940ce13e60209ea4468417
MD5 7d35276062de6b80bda37efa036fd67d
BLAKE2b-256 a7ff935aebb496f9954a241783a6ff9b650231e8a780331b2fe5153f04574094

See more details on using hashes here.

File details

Details for the file slurmrestapi-25.11.4.0-py3-none-any.whl.

File metadata

  • Download URL: slurmrestapi-25.11.4.0-py3-none-any.whl
  • Upload date:
  • Size: 1.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.12.0 readme-renderer/44.0 requests/2.31.0 requests-toolbelt/1.0.0 urllib3/2.2.3 tqdm/4.67.1 importlib-metadata/8.6.1 keyring/25.6.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.13.12

File hashes

Hashes for slurmrestapi-25.11.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8f8dd38ba21eaec8cfa31d2ee23f977e5522ecd59a080226ec9a1d5a3ee43157
MD5 8d6dcbb9a1c8e5e45d548dd7b836cdbb
BLAKE2b-256 22e02de125a5cfbef56923d5cc9b86bea2596c17cb87fa97f0de79cf21c95339

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page