API to access and control Slurm
This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.
- API version: Slurm-25.11.3
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://www.schedmd.com/
go get github.com/ubccr/slurmrestpackage main
import (
"context"
"fmt"
"log"
"net/http"
"time"
"github.com/ubccr/slurmrest"
)
func main() {
cfg := slurmrest.NewConfiguration()
cfg.HTTPClient = &http.Client{Timeout: time.Second * 3600}
cfg.Scheme = "http"
cfg.Host = "localhost"
client := slurmrest.NewAPIClient(cfg)
req := jc.client.SlurmAPI.SlurmV0040GetJobs(context.Background())
jobs, resp, err := jc.client.SlurmAPI.SlurmV0040GetJobsExecute(req)
if err != nil {
log.Fatalf("FAIL: %s", err)
} else if resp.StatusCode != 200 {
log.Fatalf("Invalid status code: %d\n", resp.StatusCode)
}
for _, job := range jobs.GetJobs() {
fmt.Printf("Job %s - %s\n", job.GetJobId(), job.GetJobState())
}
}All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| SlurmAPI | SlurmV0044DeleteJob | Delete /slurm/v0.0.44/job/{job_id} | cancel or signal job |
| SlurmAPI | SlurmV0044DeleteJobs | Delete /slurm/v0.0.44/jobs/ | send signal to list of jobs |
| SlurmAPI | SlurmV0044DeleteNode | Delete /slurm/v0.0.44/node/{node_name} | delete node |
| SlurmAPI | SlurmV0044DeleteReservation | Delete /slurm/v0.0.44/reservation/{reservation_name} | delete a reservation |
| SlurmAPI | SlurmV0044GetDiag | Get /slurm/v0.0.44/diag/ | get diagnostics |
| SlurmAPI | SlurmV0044GetJob | Get /slurm/v0.0.44/job/{job_id} | get job info |
| SlurmAPI | SlurmV0044GetJobs | Get /slurm/v0.0.44/jobs/ | get list of jobs |
| SlurmAPI | SlurmV0044GetJobsState | Get /slurm/v0.0.44/jobs/state/ | get list of job states |
| SlurmAPI | SlurmV0044GetLicenses | Get /slurm/v0.0.44/licenses/ | get all Slurm tracked license info |
| SlurmAPI | SlurmV0044GetNode | Get /slurm/v0.0.44/node/{node_name} | get node info |
| SlurmAPI | SlurmV0044GetNodes | Get /slurm/v0.0.44/nodes/ | get node(s) info |
| SlurmAPI | SlurmV0044GetPartition | Get /slurm/v0.0.44/partition/{partition_name} | get partition info |
| SlurmAPI | SlurmV0044GetPartitions | Get /slurm/v0.0.44/partitions/ | get all partition info |
| SlurmAPI | SlurmV0044GetPing | Get /slurm/v0.0.44/ping/ | ping test |
| SlurmAPI | SlurmV0044GetReconfigure | Get /slurm/v0.0.44/reconfigure/ | request slurmctld reconfigure |
| SlurmAPI | SlurmV0044GetReservation | Get /slurm/v0.0.44/reservation/{reservation_name} | get reservation info |
| SlurmAPI | SlurmV0044GetReservations | Get /slurm/v0.0.44/reservations/ | get all reservation info |
| SlurmAPI | SlurmV0044GetResources | Get /slurm/v0.0.44/resources/{job_id} | get resource layout info |
| SlurmAPI | SlurmV0044GetShares | Get /slurm/v0.0.44/shares | get fairshare info |
| SlurmAPI | SlurmV0044PostJob | Post /slurm/v0.0.44/job/{job_id} | update job |
| SlurmAPI | SlurmV0044PostJobAllocate | Post /slurm/v0.0.44/job/allocate | submit new job allocation without any steps that must be signaled to stop |
| SlurmAPI | SlurmV0044PostJobSubmit | Post /slurm/v0.0.44/job/submit | submit new job |
| SlurmAPI | SlurmV0044PostNewNode | Post /slurm/v0.0.44/new/node/ | create node |
| SlurmAPI | SlurmV0044PostNode | Post /slurm/v0.0.44/node/{node_name} | update node properties |
| SlurmAPI | SlurmV0044PostNodes | Post /slurm/v0.0.44/nodes/ | batch update node(s) |
| SlurmAPI | SlurmV0044PostReservation | Post /slurm/v0.0.44/reservation | create or update a reservation |
| SlurmAPI | SlurmV0044PostReservations | Post /slurm/v0.0.44/reservations/ | create or update reservations |
| SlurmdbAPI | SlurmdbV0044DeleteAccount | Delete /slurmdb/v0.0.44/account/{account_name} | Delete account |
| SlurmdbAPI | SlurmdbV0044DeleteAssociation | Delete /slurmdb/v0.0.44/association/ | Delete association |
| SlurmdbAPI | SlurmdbV0044DeleteAssociations | Delete /slurmdb/v0.0.44/associations/ | Delete associations |
| SlurmdbAPI | SlurmdbV0044DeleteCluster | Delete /slurmdb/v0.0.44/cluster/{cluster_name} | Delete cluster |
| SlurmdbAPI | SlurmdbV0044DeleteSingleQos | Delete /slurmdb/v0.0.44/qos/{qos} | Delete QOS |
| SlurmdbAPI | SlurmdbV0044DeleteUser | Delete /slurmdb/v0.0.44/user/{name} | Delete user |
| SlurmdbAPI | SlurmdbV0044DeleteWckey | Delete /slurmdb/v0.0.44/wckey/{id} | Delete wckey |
| SlurmdbAPI | SlurmdbV0044GetAccount | Get /slurmdb/v0.0.44/account/{account_name} | Get account info |
| SlurmdbAPI | SlurmdbV0044GetAccounts | Get /slurmdb/v0.0.44/accounts/ | Get account list |
| SlurmdbAPI | SlurmdbV0044GetAssociation | Get /slurmdb/v0.0.44/association/ | Get association info |
| SlurmdbAPI | SlurmdbV0044GetAssociations | Get /slurmdb/v0.0.44/associations/ | Get association list |
| SlurmdbAPI | SlurmdbV0044GetCluster | Get /slurmdb/v0.0.44/cluster/{cluster_name} | Get cluster info |
| SlurmdbAPI | SlurmdbV0044GetClusters | Get /slurmdb/v0.0.44/clusters/ | Get cluster list |
| SlurmdbAPI | SlurmdbV0044GetConfig | Get /slurmdb/v0.0.44/config | Dump all configuration information |
| SlurmdbAPI | SlurmdbV0044GetDiag | Get /slurmdb/v0.0.44/diag/ | Get slurmdb diagnostics |
| SlurmdbAPI | SlurmdbV0044GetInstance | Get /slurmdb/v0.0.44/instance/ | Get instance info |
| SlurmdbAPI | SlurmdbV0044GetInstances | Get /slurmdb/v0.0.44/instances/ | Get instance list |
| SlurmdbAPI | SlurmdbV0044GetJob | Get /slurmdb/v0.0.44/job/{job_id} | Get job info |
| SlurmdbAPI | SlurmdbV0044GetJobs | Get /slurmdb/v0.0.44/jobs/ | Get job list |
| SlurmdbAPI | SlurmdbV0044GetPing | Get /slurmdb/v0.0.44/ping/ | ping test |
| SlurmdbAPI | SlurmdbV0044GetQos | Get /slurmdb/v0.0.44/qos/ | Get QOS list |
| SlurmdbAPI | SlurmdbV0044GetSingleQos | Get /slurmdb/v0.0.44/qos/{qos} | Get QOS info |
| SlurmdbAPI | SlurmdbV0044GetTres | Get /slurmdb/v0.0.44/tres/ | Get TRES info |
| SlurmdbAPI | SlurmdbV0044GetUser | Get /slurmdb/v0.0.44/user/{name} | Get user info |
| SlurmdbAPI | SlurmdbV0044GetUsers | Get /slurmdb/v0.0.44/users/ | Get user list |
| SlurmdbAPI | SlurmdbV0044GetWckey | Get /slurmdb/v0.0.44/wckey/{id} | Get wckey info |
| SlurmdbAPI | SlurmdbV0044GetWckeys | Get /slurmdb/v0.0.44/wckeys/ | Get wckey list |
| SlurmdbAPI | SlurmdbV0044PostAccounts | Post /slurmdb/v0.0.44/accounts/ | Add/update list of accounts |
| SlurmdbAPI | SlurmdbV0044PostAccountsAssociation | Post /slurmdb/v0.0.44/accounts_association/ | Add accounts with conditional association |
| SlurmdbAPI | SlurmdbV0044PostAssociations | Post /slurmdb/v0.0.44/associations/ | Set associations info |
| SlurmdbAPI | SlurmdbV0044PostClusters | Post /slurmdb/v0.0.44/clusters/ | Get cluster list |
| SlurmdbAPI | SlurmdbV0044PostConfig | Post /slurmdb/v0.0.44/config | Load all configuration information |
| SlurmdbAPI | SlurmdbV0044PostJob | Post /slurmdb/v0.0.44/job/{job_id} | Update job |
| SlurmdbAPI | SlurmdbV0044PostJobs | Post /slurmdb/v0.0.44/jobs/ | Update jobs |
| SlurmdbAPI | SlurmdbV0044PostQos | Post /slurmdb/v0.0.44/qos/ | Add or update QOSs |
| SlurmdbAPI | SlurmdbV0044PostTres | Post /slurmdb/v0.0.44/tres/ | Add TRES |
| SlurmdbAPI | SlurmdbV0044PostUsers | Post /slurmdb/v0.0.44/users/ | Update users |
| SlurmdbAPI | SlurmdbV0044PostUsersAssociation | Post /slurmdb/v0.0.44/users_association/ | Add users with conditional association |
| SlurmdbAPI | SlurmdbV0044PostWckeys | Post /slurmdb/v0.0.44/wckeys/ | Add or update wckeys |
- V0044Account
- V0044AccountShort
- V0044Accounting
- V0044AccountingAllocated
- V0044AccountsAddCond
- V0044AcctGatherEnergy
- V0044Assoc
- V0044AssocDefault
- V0044AssocMax
- V0044AssocMaxJobs
- V0044AssocMaxJobsPer
- V0044AssocMaxPer
- V0044AssocMaxPerAccount
- V0044AssocMaxTres
- V0044AssocMaxTresGroup
- V0044AssocMaxTresMinutes
- V0044AssocMaxTresPer
- V0044AssocMin
- V0044AssocRecSet
- V0044AssocSharesObjWrap
- V0044AssocSharesObjWrapFairshare
- V0044AssocSharesObjWrapTres
- V0044AssocShort
- V0044BfExitFields
- V0044ClusterRec
- V0044ClusterRecAssociations
- V0044ClusterRecController
- V0044ControllerPing
- V0044Coord
- V0044CronEntry
- V0044CronEntryLine
- V0044Float64NoValStruct
- V0044Instance
- V0044InstanceTime
- V0044Job
- V0044JobAllocReq
- V0044JobArray
- V0044JobArrayLimits
- V0044JobArrayLimitsMax
- V0044JobArrayLimitsMaxRunning
- V0044JobArrayResponseMsgEntry
- V0044JobComment
- V0044JobDescMsg
- V0044JobDescMsgRlimits
- V0044JobHet
- V0044JobInfo
- V0044JobInfoPower
- V0044JobMcs
- V0044JobModify
- V0044JobModifyTres
- V0044JobRequired
- V0044JobRes
- V0044JobResCore
- V0044JobResNode
- V0044JobResNodeCpus
- V0044JobResNodeMemory
- V0044JobResNodes
- V0044JobResSocket
- V0044JobReservation
- V0044JobState
- V0044JobSubmitReq
- V0044JobTime
- V0044JobTimeSystem
- V0044JobTimeTotal
- V0044JobTimeUser
- V0044JobTres
- V0044KillJobsMsg
- V0044KillJobsRespJob
- V0044KillJobsRespJobError
- V0044KillJobsRespJobFederation
- V0044License
- V0044Node
- V0044NodeGresLayout
- V0044NodeResourceLayout
- V0044OpenapiAccountsAddCondResp
- V0044OpenapiAccountsAddCondRespStr
- V0044OpenapiAccountsRemovedResp
- V0044OpenapiAccountsResp
- V0044OpenapiAssocsRemovedResp
- V0044OpenapiAssocsResp
- V0044OpenapiClustersRemovedResp
- V0044OpenapiClustersResp
- V0044OpenapiCreateNodeReq
- V0044OpenapiDiagResp
- V0044OpenapiError
- V0044OpenapiInstancesResp
- V0044OpenapiJobAllocResp
- V0044OpenapiJobInfoResp
- V0044OpenapiJobModifyReq
- V0044OpenapiJobModifyResp
- V0044OpenapiJobPostResponse
- V0044OpenapiJobSubmitResponse
- V0044OpenapiKillJobResp
- V0044OpenapiKillJobsResp
- V0044OpenapiLicensesResp
- V0044OpenapiMeta
- V0044OpenapiMetaClient
- V0044OpenapiMetaPlugin
- V0044OpenapiMetaSlurm
- V0044OpenapiMetaSlurmVersion
- V0044OpenapiNodesResp
- V0044OpenapiPartitionResp
- V0044OpenapiPingArrayResp
- V0044OpenapiReservationModResp
- V0044OpenapiReservationResp
- V0044OpenapiResourceLayoutResp
- V0044OpenapiResp
- V0044OpenapiSharesResp
- V0044OpenapiSlurmdbdConfigResp
- V0044OpenapiSlurmdbdJobsResp
- V0044OpenapiSlurmdbdPingResp
- V0044OpenapiSlurmdbdQosRemovedResp
- V0044OpenapiSlurmdbdQosResp
- V0044OpenapiSlurmdbdStatsResp
- V0044OpenapiTresResp
- V0044OpenapiUsersAddCondResp
- V0044OpenapiUsersAddCondRespStr
- V0044OpenapiUsersResp
- V0044OpenapiWarning
- V0044OpenapiWckeyRemovedResp
- V0044OpenapiWckeyResp
- V0044PartPrio
- V0044PartitionInfo
- V0044PartitionInfoAccounts
- V0044PartitionInfoCpus
- V0044PartitionInfoDefaults
- V0044PartitionInfoGroups
- V0044PartitionInfoMaximums
- V0044PartitionInfoMaximumsOversubscribe
- V0044PartitionInfoMinimums
- V0044PartitionInfoNodes
- V0044PartitionInfoPartition
- V0044PartitionInfoPriority
- V0044PartitionInfoQos
- V0044PartitionInfoTimeouts
- V0044PartitionInfoTres
- V0044ProcessExitCodeVerbose
- V0044ProcessExitCodeVerboseSignal
- V0044Qos
- V0044QosLimits
- V0044QosLimitsMax
- V0044QosLimitsMaxActiveJobs
- V0044QosLimitsMaxJobs
- V0044QosLimitsMaxJobsActiveJobs
- V0044QosLimitsMaxJobsActiveJobsPer
- V0044QosLimitsMaxTres
- V0044QosLimitsMaxTresMinutes
- V0044QosLimitsMaxTresMinutesPer
- V0044QosLimitsMaxTresPer
- V0044QosLimitsMaxWallClock
- V0044QosLimitsMaxWallClockPer
- V0044QosLimitsMin
- V0044QosLimitsMinTres
- V0044QosLimitsMinTresPer
- V0044QosPreempt
- V0044ReservationCoreSpec
- V0044ReservationDescMsg
- V0044ReservationInfo
- V0044ReservationInfoPurgeCompleted
- V0044ReservationModReq
- V0044RollupStats
- V0044RollupStatsDaily
- V0044RollupStatsDailyDuration
- V0044RollupStatsHourly
- V0044RollupStatsHourlyDuration
- V0044RollupStatsMonthly
- V0044RollupStatsMonthlyDuration
- V0044ScheduleExitFields
- V0044SharesFloat128Tres
- V0044SharesRespMsg
- V0044SharesUint64Tres
- V0044SlurmStepId
- V0044SlurmdbdPing
- V0044StatsMsg
- V0044StatsMsgRpcDump
- V0044StatsMsgRpcQueue
- V0044StatsMsgRpcType
- V0044StatsMsgRpcUser
- V0044StatsRec
- V0044StatsRpc
- V0044StatsRpcTime
- V0044StatsUser
- V0044Step
- V0044StepCPU
- V0044StepCPURequestedFrequency
- V0044StepNodes
- V0044StepStatistics
- V0044StepStatisticsCPU
- V0044StepStatisticsEnergy
- V0044StepStep
- V0044StepTask
- V0044StepTasks
- V0044StepTime
- V0044StepTimeSystem
- V0044StepTimeTotal
- V0044StepTimeUser
- V0044StepTres
- V0044StepTresConsumed
- V0044StepTresRequested
- V0044Tres
- V0044Uint16NoValStruct
- V0044Uint32NoValStruct
- V0044Uint64NoValStruct
- V0044UpdateNodeMsg
- V0044User
- V0044UserDefault
- V0044UserShort
- V0044UsersAddCond
- V0044Wckey
- V0044WckeyTagStruct
slurmrest Go client is currently maintained by The Center for Computational Research.
The code in this repo was generated from the openapi.json spec files available from Slurm. For more information see https://github.com/SchedMD/slurm/