Skip to content

fasrc/slurmrest_python_sdk

BranchesTags

Repository files navigation

slurmrest_python_0_0_41

API to access and control Slurm

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

  • API version: Slurm-24.11.5&openapi/slurmdbd&openapi/slurmctld
  • 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/fasrc/slurmrest_python_sdk.git

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

Then import the package:

import slurmrest_python_0_0_41

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 slurmrest_python_0_0_41

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import slurmrest_python_0_0_41
from slurmrest_python_0_0_41.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 = slurmrest_python_0_0_41.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 = slurmrest_python_0_0_41.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 slurmrest_python_0_0_41.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = slurmrest_python_0_0_41.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_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)
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

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: Bearer authentication (JWT)

token

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

user

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

Author

sales@schedmd.com

About

Python SDK generated from slurmrestd OpenAPI specs

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages