Skip to content
BranchesTags

Repository files navigation

slurmrest_python

API to access and control Slurm

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

  • API version: Slurm-25.11.2
  • Package version: 0.0.1
  • Generator version: 7.14.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/coldfront/slurm-python-sdk.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/coldfront/slurm-python-sdk.git)

Then import the package:

importslurmrest_python

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:

importslurmrest_python

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

importslurmrest_pythonfromslurmrest_python.restimportApiExceptionfrompprintimportpprint# Defining the host is optional and defaults to http://localhost# See configuration.py for a list of all supported configuration parameters.configuration=slurmrest_python.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: userconfiguration.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): bearerAuthconfiguration=slurmrest_python.Configuration(
access_token=os.environ["BEARER_TOKEN"]
)
# Configure API key authorization: tokenconfiguration.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 clientwithslurmrest_python.ApiClient(configuration) asapi_client:
# Create an instance of the API classapi_instance=slurmrest_python.SlurmApi(api_client)
job_id='job_id_example'# str | Job IDsignal='signal_example'# str | Signal to send to Job (optional)flags='flags_example'# str | Signalling flags (optional)try:
# cancel or signal jobapi_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)
exceptApiExceptionase:
print("Exception when calling SlurmApi->slurm_v0041_delete_job: %s\n"%e)

Documentation for API Endpoints

All URIs are relative to http://localhost

ClassMethodHTTP requestDescription
SlurmApislurm_v0041_delete_jobDELETE /slurm/v0.0.41/job/{job_id}cancel or signal job
SlurmApislurm_v0041_delete_jobsDELETE /slurm/v0.0.41/jobs/send signal to list of jobs
SlurmApislurm_v0041_delete_nodeDELETE /slurm/v0.0.41/node/{node_name}delete node
SlurmApislurm_v0041_delete_reservationDELETE /slurm/v0.0.41/reservation/{reservation_name}delete a reservation
SlurmApislurm_v0041_get_diagGET /slurm/v0.0.41/diag/get diagnostics
SlurmApislurm_v0041_get_jobGET /slurm/v0.0.41/job/{job_id}get job info
SlurmApislurm_v0041_get_jobsGET /slurm/v0.0.41/jobs/get list of jobs
SlurmApislurm_v0041_get_jobs_stateGET /slurm/v0.0.41/jobs/state/get list of job states
SlurmApislurm_v0041_get_licensesGET /slurm/v0.0.41/licenses/get all Slurm tracked license info
SlurmApislurm_v0041_get_nodeGET /slurm/v0.0.41/node/{node_name}get node info
SlurmApislurm_v0041_get_nodesGET /slurm/v0.0.41/nodes/get node(s) info
SlurmApislurm_v0041_get_partitionGET /slurm/v0.0.41/partition/{partition_name}get partition info
SlurmApislurm_v0041_get_partitionsGET /slurm/v0.0.41/partitions/get all partition info
SlurmApislurm_v0041_get_pingGET /slurm/v0.0.41/ping/ping test
SlurmApislurm_v0041_get_reconfigureGET /slurm/v0.0.41/reconfigure/request slurmctld reconfigure
SlurmApislurm_v0041_get_reservationGET /slurm/v0.0.41/reservation/{reservation_name}get reservation info
SlurmApislurm_v0041_get_reservationsGET /slurm/v0.0.41/reservations/get all reservation info
SlurmApislurm_v0041_get_sharesGET /slurm/v0.0.41/sharesget fairshare info
SlurmApislurm_v0041_post_jobPOST /slurm/v0.0.41/job/{job_id}update job
SlurmApislurm_v0041_post_job_allocatePOST /slurm/v0.0.41/job/allocatesubmit new job allocation without any steps that must be signaled to stop
SlurmApislurm_v0041_post_job_submitPOST /slurm/v0.0.41/job/submitsubmit new job
SlurmApislurm_v0041_post_nodePOST /slurm/v0.0.41/node/{node_name}update node properties
SlurmApislurm_v0041_post_nodesPOST /slurm/v0.0.41/nodes/batch update node(s)
SlurmApislurm_v0042_delete_jobDELETE /slurm/v0.0.42/job/{job_id}cancel or signal job
SlurmApislurm_v0042_delete_jobsDELETE /slurm/v0.0.42/jobs/send signal to list of jobs
SlurmApislurm_v0042_delete_nodeDELETE /slurm/v0.0.42/node/{node_name}delete node
SlurmApislurm_v0042_delete_reservationDELETE /slurm/v0.0.42/reservation/{reservation_name}delete a reservation
SlurmApislurm_v0042_get_diagGET /slurm/v0.0.42/diag/get diagnostics
SlurmApislurm_v0042_get_jobGET /slurm/v0.0.42/job/{job_id}get job info
SlurmApislurm_v0042_get_jobsGET /slurm/v0.0.42/jobs/get list of jobs
SlurmApislurm_v0042_get_jobs_stateGET /slurm/v0.0.42/jobs/state/get list of job states
SlurmApislurm_v0042_get_licensesGET /slurm/v0.0.42/licenses/get all Slurm tracked license info
SlurmApislurm_v0042_get_nodeGET /slurm/v0.0.42/node/{node_name}get node info
SlurmApislurm_v0042_get_nodesGET /slurm/v0.0.42/nodes/get node(s) info
SlurmApislurm_v0042_get_partitionGET /slurm/v0.0.42/partition/{partition_name}get partition info
SlurmApislurm_v0042_get_partitionsGET /slurm/v0.0.42/partitions/get all partition info
SlurmApislurm_v0042_get_pingGET /slurm/v0.0.42/ping/ping test
SlurmApislurm_v0042_get_reconfigureGET /slurm/v0.0.42/reconfigure/request slurmctld reconfigure
SlurmApislurm_v0042_get_reservationGET /slurm/v0.0.42/reservation/{reservation_name}get reservation info
SlurmApislurm_v0042_get_reservationsGET /slurm/v0.0.42/reservations/get all reservation info
SlurmApislurm_v0042_get_sharesGET /slurm/v0.0.42/sharesget fairshare info
SlurmApislurm_v0042_post_jobPOST /slurm/v0.0.42/job/{job_id}update job
SlurmApislurm_v0042_post_job_allocatePOST /slurm/v0.0.42/job/allocatesubmit new job allocation without any steps that must be signaled to stop
SlurmApislurm_v0042_post_job_submitPOST /slurm/v0.0.42/job/submitsubmit new job
SlurmApislurm_v0042_post_nodePOST /slurm/v0.0.42/node/{node_name}update node properties
SlurmApislurm_v0042_post_nodesPOST /slurm/v0.0.42/nodes/batch update node(s)
SlurmApislurm_v0043_delete_jobDELETE /slurm/v0.0.43/job/{job_id}cancel or signal job
SlurmApislurm_v0043_delete_jobsDELETE /slurm/v0.0.43/jobs/send signal to list of jobs
SlurmApislurm_v0043_delete_nodeDELETE /slurm/v0.0.43/node/{node_name}delete node
SlurmApislurm_v0043_delete_reservationDELETE /slurm/v0.0.43/reservation/{reservation_name}delete a reservation
SlurmApislurm_v0043_get_diagGET /slurm/v0.0.43/diag/get diagnostics
SlurmApislurm_v0043_get_jobGET /slurm/v0.0.43/job/{job_id}get job info
SlurmApislurm_v0043_get_jobsGET /slurm/v0.0.43/jobs/get list of jobs
SlurmApislurm_v0043_get_jobs_stateGET /slurm/v0.0.43/jobs/state/get list of job states
SlurmApislurm_v0043_get_licensesGET /slurm/v0.0.43/licenses/get all Slurm tracked license info
SlurmApislurm_v0043_get_nodeGET /slurm/v0.0.43/node/{node_name}get node info
SlurmApislurm_v0043_get_nodesGET /slurm/v0.0.43/nodes/get node(s) info
SlurmApislurm_v0043_get_partitionGET /slurm/v0.0.43/partition/{partition_name}get partition info
SlurmApislurm_v0043_get_partitionsGET /slurm/v0.0.43/partitions/get all partition info
SlurmApislurm_v0043_get_pingGET /slurm/v0.0.43/ping/ping test
SlurmApislurm_v0043_get_reconfigureGET /slurm/v0.0.43/reconfigure/request slurmctld reconfigure
SlurmApislurm_v0043_get_reservationGET /slurm/v0.0.43/reservation/{reservation_name}get reservation info
SlurmApislurm_v0043_get_reservationsGET /slurm/v0.0.43/reservations/get all reservation info
SlurmApislurm_v0043_get_sharesGET /slurm/v0.0.43/sharesget fairshare info
SlurmApislurm_v0043_post_jobPOST /slurm/v0.0.43/job/{job_id}update job
SlurmApislurm_v0043_post_job_allocatePOST /slurm/v0.0.43/job/allocatesubmit new job allocation without any steps that must be signaled to stop
SlurmApislurm_v0043_post_job_submitPOST /slurm/v0.0.43/job/submitsubmit new job
SlurmApislurm_v0043_post_nodePOST /slurm/v0.0.43/node/{node_name}update node properties
SlurmApislurm_v0043_post_nodesPOST /slurm/v0.0.43/nodes/batch update node(s)
SlurmApislurm_v0043_post_reservationPOST /slurm/v0.0.43/reservationcreate or update a reservation
SlurmApislurm_v0043_post_reservationsPOST /slurm/v0.0.43/reservations/create or update reservations
SlurmApislurm_v0044_delete_jobDELETE /slurm/v0.0.44/job/{job_id}cancel or signal job
SlurmApislurm_v0044_delete_jobsDELETE /slurm/v0.0.44/jobs/send signal to list of jobs
SlurmApislurm_v0044_delete_nodeDELETE /slurm/v0.0.44/node/{node_name}delete node
SlurmApislurm_v0044_delete_reservationDELETE /slurm/v0.0.44/reservation/{reservation_name}delete a reservation
SlurmApislurm_v0044_get_diagGET /slurm/v0.0.44/diag/get diagnostics
SlurmApislurm_v0044_get_jobGET /slurm/v0.0.44/job/{job_id}get job info
SlurmApislurm_v0044_get_jobsGET /slurm/v0.0.44/jobs/get list of jobs
SlurmApislurm_v0044_get_jobs_stateGET /slurm/v0.0.44/jobs/state/get list of job states
SlurmApislurm_v0044_get_licensesGET /slurm/v0.0.44/licenses/get all Slurm tracked license info
SlurmApislurm_v0044_get_nodeGET /slurm/v0.0.44/node/{node_name}get node info
SlurmApislurm_v0044_get_nodesGET /slurm/v0.0.44/nodes/get node(s) info
SlurmApislurm_v0044_get_partitionGET /slurm/v0.0.44/partition/{partition_name}get partition info
SlurmApislurm_v0044_get_partitionsGET /slurm/v0.0.44/partitions/get all partition info
SlurmApislurm_v0044_get_pingGET /slurm/v0.0.44/ping/ping test
SlurmApislurm_v0044_get_reconfigureGET /slurm/v0.0.44/reconfigure/request slurmctld reconfigure
SlurmApislurm_v0044_get_reservationGET /slurm/v0.0.44/reservation/{reservation_name}get reservation info
SlurmApislurm_v0044_get_reservationsGET /slurm/v0.0.44/reservations/get all reservation info
SlurmApislurm_v0044_get_resourcesGET /slurm/v0.0.44/resources/{job_id}get resource layout info
SlurmApislurm_v0044_get_sharesGET /slurm/v0.0.44/sharesget fairshare info
SlurmApislurm_v0044_post_jobPOST /slurm/v0.0.44/job/{job_id}update job
SlurmApislurm_v0044_post_job_allocatePOST /slurm/v0.0.44/job/allocatesubmit new job allocation without any steps that must be signaled to stop
SlurmApislurm_v0044_post_job_submitPOST /slurm/v0.0.44/job/submitsubmit new job
SlurmApislurm_v0044_post_new_nodePOST /slurm/v0.0.44/new/node/create node
SlurmApislurm_v0044_post_nodePOST /slurm/v0.0.44/node/{node_name}update node properties
SlurmApislurm_v0044_post_nodesPOST /slurm/v0.0.44/nodes/batch update node(s)
SlurmApislurm_v0044_post_reservationPOST /slurm/v0.0.44/reservationcreate or update a reservation
SlurmApislurm_v0044_post_reservationsPOST /slurm/v0.0.44/reservations/create or update reservations
SlurmdbApislurmdb_v0041_delete_accountDELETE /slurmdb/v0.0.41/account/{account_name}Delete account
SlurmdbApislurmdb_v0041_delete_associationDELETE /slurmdb/v0.0.41/association/Delete association
SlurmdbApislurmdb_v0041_delete_associationsDELETE /slurmdb/v0.0.41/associations/Delete associations
SlurmdbApislurmdb_v0041_delete_clusterDELETE /slurmdb/v0.0.41/cluster/{cluster_name}Delete cluster
SlurmdbApislurmdb_v0041_delete_single_qosDELETE /slurmdb/v0.0.41/qos/{qos}Delete QOS
SlurmdbApislurmdb_v0041_delete_userDELETE /slurmdb/v0.0.41/user/{name}Delete user
SlurmdbApislurmdb_v0041_delete_wckeyDELETE /slurmdb/v0.0.41/wckey/{id}Delete wckey
SlurmdbApislurmdb_v0041_get_accountGET /slurmdb/v0.0.41/account/{account_name}Get account info
SlurmdbApislurmdb_v0041_get_accountsGET /slurmdb/v0.0.41/accounts/Get account list
SlurmdbApislurmdb_v0041_get_associationGET /slurmdb/v0.0.41/association/Get association info
SlurmdbApislurmdb_v0041_get_associationsGET /slurmdb/v0.0.41/associations/Get association list
SlurmdbApislurmdb_v0041_get_clusterGET /slurmdb/v0.0.41/cluster/{cluster_name}Get cluster info
SlurmdbApislurmdb_v0041_get_clustersGET /slurmdb/v0.0.41/clusters/Get cluster list
SlurmdbApislurmdb_v0041_get_configGET /slurmdb/v0.0.41/configDump all configuration information
SlurmdbApislurmdb_v0041_get_diagGET /slurmdb/v0.0.41/diag/Get slurmdb diagnostics
SlurmdbApislurmdb_v0041_get_instanceGET /slurmdb/v0.0.41/instance/Get instance info
SlurmdbApislurmdb_v0041_get_instancesGET /slurmdb/v0.0.41/instances/Get instance list
SlurmdbApislurmdb_v0041_get_jobGET /slurmdb/v0.0.41/job/{job_id}Get job info
SlurmdbApislurmdb_v0041_get_jobsGET /slurmdb/v0.0.41/jobs/Get job list
SlurmdbApislurmdb_v0041_get_qosGET /slurmdb/v0.0.41/qos/Get QOS list
SlurmdbApislurmdb_v0041_get_single_qosGET /slurmdb/v0.0.41/qos/{qos}Get QOS info
SlurmdbApislurmdb_v0041_get_tresGET /slurmdb/v0.0.41/tres/Get TRES info
SlurmdbApislurmdb_v0041_get_userGET /slurmdb/v0.0.41/user/{name}Get user info
SlurmdbApislurmdb_v0041_get_usersGET /slurmdb/v0.0.41/users/Get user list
SlurmdbApislurmdb_v0041_get_wckeyGET /slurmdb/v0.0.41/wckey/{id}Get wckey info
SlurmdbApislurmdb_v0041_get_wckeysGET /slurmdb/v0.0.41/wckeys/Get wckey list
SlurmdbApislurmdb_v0041_post_accountsPOST /slurmdb/v0.0.41/accounts/Add/update list of accounts
SlurmdbApislurmdb_v0041_post_accounts_associationPOST /slurmdb/v0.0.41/accounts_association/Add accounts with conditional association
SlurmdbApislurmdb_v0041_post_associationsPOST /slurmdb/v0.0.41/associations/Set associations info
SlurmdbApislurmdb_v0041_post_clustersPOST /slurmdb/v0.0.41/clusters/Get cluster list
SlurmdbApislurmdb_v0041_post_configPOST /slurmdb/v0.0.41/configLoad all configuration information
SlurmdbApislurmdb_v0041_post_qosPOST /slurmdb/v0.0.41/qos/Add or update QOSs
SlurmdbApislurmdb_v0041_post_tresPOST /slurmdb/v0.0.41/tres/Add TRES
SlurmdbApislurmdb_v0041_post_usersPOST /slurmdb/v0.0.41/users/Update users
SlurmdbApislurmdb_v0041_post_users_associationPOST /slurmdb/v0.0.41/users_association/Add users with conditional association
SlurmdbApislurmdb_v0041_post_wckeysPOST /slurmdb/v0.0.41/wckeys/Add or update wckeys
SlurmdbApislurmdb_v0042_delete_accountDELETE /slurmdb/v0.0.42/account/{account_name}Delete account
SlurmdbApislurmdb_v0042_delete_associationDELETE /slurmdb/v0.0.42/association/Delete association
SlurmdbApislurmdb_v0042_delete_associationsDELETE /slurmdb/v0.0.42/associations/Delete associations
SlurmdbApislurmdb_v0042_delete_clusterDELETE /slurmdb/v0.0.42/cluster/{cluster_name}Delete cluster
SlurmdbApislurmdb_v0042_delete_single_qosDELETE /slurmdb/v0.0.42/qos/{qos}Delete QOS
SlurmdbApislurmdb_v0042_delete_userDELETE /slurmdb/v0.0.42/user/{name}Delete user
SlurmdbApislurmdb_v0042_delete_wckeyDELETE /slurmdb/v0.0.42/wckey/{id}Delete wckey
SlurmdbApislurmdb_v0042_get_accountGET /slurmdb/v0.0.42/account/{account_name}Get account info
SlurmdbApislurmdb_v0042_get_accountsGET /slurmdb/v0.0.42/accounts/Get account list
SlurmdbApislurmdb_v0042_get_associationGET /slurmdb/v0.0.42/association/Get association info
SlurmdbApislurmdb_v0042_get_associationsGET /slurmdb/v0.0.42/associations/Get association list
SlurmdbApislurmdb_v0042_get_clusterGET /slurmdb/v0.0.42/cluster/{cluster_name}Get cluster info
SlurmdbApislurmdb_v0042_get_clustersGET /slurmdb/v0.0.42/clusters/Get cluster list
SlurmdbApislurmdb_v0042_get_configGET /slurmdb/v0.0.42/configDump all configuration information
SlurmdbApislurmdb_v0042_get_diagGET /slurmdb/v0.0.42/diag/Get slurmdb diagnostics
SlurmdbApislurmdb_v0042_get_instanceGET /slurmdb/v0.0.42/instance/Get instance info
SlurmdbApislurmdb_v0042_get_instancesGET /slurmdb/v0.0.42/instances/Get instance list
SlurmdbApislurmdb_v0042_get_jobGET /slurmdb/v0.0.42/job/{job_id}Get job info
SlurmdbApislurmdb_v0042_get_jobsGET /slurmdb/v0.0.42/jobs/Get job list
SlurmdbApislurmdb_v0042_get_pingGET /slurmdb/v0.0.42/ping/ping test
SlurmdbApislurmdb_v0042_get_qosGET /slurmdb/v0.0.42/qos/Get QOS list
SlurmdbApislurmdb_v0042_get_single_qosGET /slurmdb/v0.0.42/qos/{qos}Get QOS info
SlurmdbApislurmdb_v0042_get_tresGET /slurmdb/v0.0.42/tres/Get TRES info
SlurmdbApislurmdb_v0042_get_userGET /slurmdb/v0.0.42/user/{name}Get user info
SlurmdbApislurmdb_v0042_get_usersGET /slurmdb/v0.0.42/users/Get user list
SlurmdbApislurmdb_v0042_get_wckeyGET /slurmdb/v0.0.42/wckey/{id}Get wckey info
SlurmdbApislurmdb_v0042_get_wckeysGET /slurmdb/v0.0.42/wckeys/Get wckey list
SlurmdbApislurmdb_v0042_post_accountsPOST /slurmdb/v0.0.42/accounts/Add/update list of accounts
SlurmdbApislurmdb_v0042_post_accounts_associationPOST /slurmdb/v0.0.42/accounts_association/Add accounts with conditional association
SlurmdbApislurmdb_v0042_post_associationsPOST /slurmdb/v0.0.42/associations/Set associations info
SlurmdbApislurmdb_v0042_post_clustersPOST /slurmdb/v0.0.42/clusters/Get cluster list
SlurmdbApislurmdb_v0042_post_configPOST /slurmdb/v0.0.42/configLoad all configuration information
SlurmdbApislurmdb_v0042_post_qosPOST /slurmdb/v0.0.42/qos/Add or update QOSs
SlurmdbApislurmdb_v0042_post_tresPOST /slurmdb/v0.0.42/tres/Add TRES
SlurmdbApislurmdb_v0042_post_usersPOST /slurmdb/v0.0.42/users/Update users
SlurmdbApislurmdb_v0042_post_users_associationPOST /slurmdb/v0.0.42/users_association/Add users with conditional association
SlurmdbApislurmdb_v0042_post_wckeysPOST /slurmdb/v0.0.42/wckeys/Add or update wckeys
SlurmdbApislurmdb_v0043_delete_accountDELETE /slurmdb/v0.0.43/account/{account_name}Delete account
SlurmdbApislurmdb_v0043_delete_associationDELETE /slurmdb/v0.0.43/association/Delete association
SlurmdbApislurmdb_v0043_delete_associationsDELETE /slurmdb/v0.0.43/associations/Delete associations
SlurmdbApislurmdb_v0043_delete_clusterDELETE /slurmdb/v0.0.43/cluster/{cluster_name}Delete cluster
SlurmdbApislurmdb_v0043_delete_single_qosDELETE /slurmdb/v0.0.43/qos/{qos}Delete QOS
SlurmdbApislurmdb_v0043_delete_userDELETE /slurmdb/v0.0.43/user/{name}Delete user
SlurmdbApislurmdb_v0043_delete_wckeyDELETE /slurmdb/v0.0.43/wckey/{id}Delete wckey
SlurmdbApislurmdb_v0043_get_accountGET /slurmdb/v0.0.43/account/{account_name}Get account info
SlurmdbApislurmdb_v0043_get_accountsGET /slurmdb/v0.0.43/accounts/Get account list
SlurmdbApislurmdb_v0043_get_associationGET /slurmdb/v0.0.43/association/Get association info
SlurmdbApislurmdb_v0043_get_associationsGET /slurmdb/v0.0.43/associations/Get association list
SlurmdbApislurmdb_v0043_get_clusterGET /slurmdb/v0.0.43/cluster/{cluster_name}Get cluster info
SlurmdbApislurmdb_v0043_get_clustersGET /slurmdb/v0.0.43/clusters/Get cluster list
SlurmdbApislurmdb_v0043_get_configGET /slurmdb/v0.0.43/configDump all configuration information
SlurmdbApislurmdb_v0043_get_diagGET /slurmdb/v0.0.43/diag/Get slurmdb diagnostics
SlurmdbApislurmdb_v0043_get_instanceGET /slurmdb/v0.0.43/instance/Get instance info
SlurmdbApislurmdb_v0043_get_instancesGET /slurmdb/v0.0.43/instances/Get instance list
SlurmdbApislurmdb_v0043_get_jobGET /slurmdb/v0.0.43/job/{job_id}Get job info
SlurmdbApislurmdb_v0043_get_jobsGET /slurmdb/v0.0.43/jobs/Get job list
SlurmdbApislurmdb_v0043_get_pingGET /slurmdb/v0.0.43/ping/ping test
SlurmdbApislurmdb_v0043_get_qosGET /slurmdb/v0.0.43/qos/Get QOS list
SlurmdbApislurmdb_v0043_get_single_qosGET /slurmdb/v0.0.43/qos/{qos}Get QOS info
SlurmdbApislurmdb_v0043_get_tresGET /slurmdb/v0.0.43/tres/Get TRES info
SlurmdbApislurmdb_v0043_get_userGET /slurmdb/v0.0.43/user/{name}Get user info
SlurmdbApislurmdb_v0043_get_usersGET /slurmdb/v0.0.43/users/Get user list
SlurmdbApislurmdb_v0043_get_wckeyGET /slurmdb/v0.0.43/wckey/{id}Get wckey info
SlurmdbApislurmdb_v0043_get_wckeysGET /slurmdb/v0.0.43/wckeys/Get wckey list
SlurmdbApislurmdb_v0043_post_accountsPOST /slurmdb/v0.0.43/accounts/Add/update list of accounts
SlurmdbApislurmdb_v0043_post_accounts_associationPOST /slurmdb/v0.0.43/accounts_association/Add accounts with conditional association
SlurmdbApislurmdb_v0043_post_associationsPOST /slurmdb/v0.0.43/associations/Set associations info
SlurmdbApislurmdb_v0043_post_clustersPOST /slurmdb/v0.0.43/clusters/Get cluster list
SlurmdbApislurmdb_v0043_post_configPOST /slurmdb/v0.0.43/configLoad all configuration information
SlurmdbApislurmdb_v0043_post_qosPOST /slurmdb/v0.0.43/qos/Add or update QOSs
SlurmdbApislurmdb_v0043_post_tresPOST /slurmdb/v0.0.43/tres/Add TRES
SlurmdbApislurmdb_v0043_post_usersPOST /slurmdb/v0.0.43/users/Update users
SlurmdbApislurmdb_v0043_post_users_associationPOST /slurmdb/v0.0.43/users_association/Add users with conditional association
SlurmdbApislurmdb_v0043_post_wckeysPOST /slurmdb/v0.0.43/wckeys/Add or update wckeys
SlurmdbApislurmdb_v0044_delete_accountDELETE /slurmdb/v0.0.44/account/{account_name}Delete account
SlurmdbApislurmdb_v0044_delete_associationDELETE /slurmdb/v0.0.44/association/Delete association
SlurmdbApislurmdb_v0044_delete_associationsDELETE /slurmdb/v0.0.44/associations/Delete associations
SlurmdbApislurmdb_v0044_delete_clusterDELETE /slurmdb/v0.0.44/cluster/{cluster_name}Delete cluster
SlurmdbApislurmdb_v0044_delete_single_qosDELETE /slurmdb/v0.0.44/qos/{qos}Delete QOS
SlurmdbApislurmdb_v0044_delete_userDELETE /slurmdb/v0.0.44/user/{name}Delete user
SlurmdbApislurmdb_v0044_delete_wckeyDELETE /slurmdb/v0.0.44/wckey/{id}Delete wckey
SlurmdbApislurmdb_v0044_get_accountGET /slurmdb/v0.0.44/account/{account_name}Get account info
SlurmdbApislurmdb_v0044_get_accountsGET /slurmdb/v0.0.44/accounts/Get account list
SlurmdbApislurmdb_v0044_get_associationGET /slurmdb/v0.0.44/association/Get association info
SlurmdbApislurmdb_v0044_get_associationsGET /slurmdb/v0.0.44/associations/Get association list
SlurmdbApislurmdb_v0044_get_clusterGET /slurmdb/v0.0.44/cluster/{cluster_name}Get cluster info
SlurmdbApislurmdb_v0044_get_clustersGET /slurmdb/v0.0.44/clusters/Get cluster list
SlurmdbApislurmdb_v0044_get_configGET /slurmdb/v0.0.44/configDump all configuration information
SlurmdbApislurmdb_v0044_get_diagGET /slurmdb/v0.0.44/diag/Get slurmdb diagnostics
SlurmdbApislurmdb_v0044_get_instanceGET /slurmdb/v0.0.44/instance/Get instance info
SlurmdbApislurmdb_v0044_get_instancesGET /slurmdb/v0.0.44/instances/Get instance list
SlurmdbApislurmdb_v0044_get_jobGET /slurmdb/v0.0.44/job/{job_id}Get job info
SlurmdbApislurmdb_v0044_get_jobsGET /slurmdb/v0.0.44/jobs/Get job list
SlurmdbApislurmdb_v0044_get_pingGET /slurmdb/v0.0.44/ping/ping test
SlurmdbApislurmdb_v0044_get_qosGET /slurmdb/v0.0.44/qos/Get QOS list
SlurmdbApislurmdb_v0044_get_single_qosGET /slurmdb/v0.0.44/qos/{qos}Get QOS info
SlurmdbApislurmdb_v0044_get_tresGET /slurmdb/v0.0.44/tres/Get TRES info
SlurmdbApislurmdb_v0044_get_userGET /slurmdb/v0.0.44/user/{name}Get user info
SlurmdbApislurmdb_v0044_get_usersGET /slurmdb/v0.0.44/users/Get user list
SlurmdbApislurmdb_v0044_get_wckeyGET /slurmdb/v0.0.44/wckey/{id}Get wckey info
SlurmdbApislurmdb_v0044_get_wckeysGET /slurmdb/v0.0.44/wckeys/Get wckey list
SlurmdbApislurmdb_v0044_post_accountsPOST /slurmdb/v0.0.44/accounts/Add/update list of accounts
SlurmdbApislurmdb_v0044_post_accounts_associationPOST /slurmdb/v0.0.44/accounts_association/Add accounts with conditional association
SlurmdbApislurmdb_v0044_post_associationsPOST /slurmdb/v0.0.44/associations/Set associations info
SlurmdbApislurmdb_v0044_post_clustersPOST /slurmdb/v0.0.44/clusters/Get cluster list
SlurmdbApislurmdb_v0044_post_configPOST /slurmdb/v0.0.44/configLoad all configuration information
SlurmdbApislurmdb_v0044_post_jobPOST /slurmdb/v0.0.44/job/{job_id}Update job
SlurmdbApislurmdb_v0044_post_jobsPOST /slurmdb/v0.0.44/jobs/Update jobs
SlurmdbApislurmdb_v0044_post_qosPOST /slurmdb/v0.0.44/qos/Add or update QOSs
SlurmdbApislurmdb_v0044_post_tresPOST /slurmdb/v0.0.44/tres/Add TRES
SlurmdbApislurmdb_v0044_post_usersPOST /slurmdb/v0.0.44/users/Update users
SlurmdbApislurmdb_v0044_post_users_associationPOST /slurmdb/v0.0.44/users_association/Add users with conditional association
SlurmdbApislurmdb_v0044_post_wckeysPOST /slurmdb/v0.0.44/wckeys/Add or update wckeys
UtilApiutil_v0044_post_hostlistPOST /util/v0.0.44/hostlistConvert an array of host names into hostlist expression
UtilApiutil_v0044_post_hostnamesPOST /util/v0.0.44/hostnamesConvert 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

About

Python SDK for Slurm REST API

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

1 fork
Report repository

Releases

Packages

Contributors

Languages