\SlurmAPI

All URIs are relative to http://localhost/slurm/v0.0.37

Method	HTTP request	Description
SlurmctldCancelJob	Delete /job/{job_id}	cancel or signal job
SlurmctldDiag	Get /diag/	get diagnostics
SlurmctldGetJob	Get /job/{job_id}	get job info
SlurmctldGetJobs	Get /jobs/	get list of jobs
SlurmctldGetNode	Get /node/{node_name}	get node info
SlurmctldGetNodes	Get /nodes/	get all node info
SlurmctldGetPartition	Get /partition/{partition_name}	get partition info
SlurmctldGetPartitions	Get /partitions/	get all partition info
SlurmctldGetReservation	Get /reservation/{reservation_name}	get reservation info
SlurmctldGetReservations	Get /reservations/	get all reservation info
SlurmctldLicenses	Get /licenses/	get all license info
SlurmctldPing	Get /ping/	ping test
SlurmctldSubmitJob	Post /job/submit	submit new job
SlurmctldUpdateJob	Post /job/{job_id}	update job

SlurmctldCancelJob

SlurmctldCancelJob(ctx, jobId).Signal(signal).Execute()

cancel or signal job

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	jobId := int64(789) // int64 | Slurm Job ID
	signal := openapiclient.v0.0.37_signal("HUP") // V0037Signal | signal to send to job (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.SlurmAPI.SlurmctldCancelJob(context.Background(), jobId).Signal(signal).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SlurmAPI.SlurmctldCancelJob``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
jobId	int64	Slurm Job ID

Other Parameters

Other parameters are passed through a pointer to a apiSlurmctldCancelJobRequest struct via the builder pattern

Name	Type	Description	Notes

signal | V0037Signal | signal to send to job |

Return type

(empty response body)

Authorization

user, token

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SlurmctldDiag

V0037Diag SlurmctldDiag(ctx).Execute()

get diagnostics

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SlurmAPI.SlurmctldDiag(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SlurmAPI.SlurmctldDiag``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `SlurmctldDiag`: V0037Diag
	fmt.Fprintf(os.Stdout, "Response from `SlurmAPI.SlurmctldDiag`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiSlurmctldDiagRequest struct via the builder pattern

Return type

V0037Diag

Authorization

user, token

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/x-yaml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SlurmctldGetJob

V0037JobsResponse SlurmctldGetJob(ctx, jobId).Execute()

get job info

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	jobId := int64(789) // int64 | Slurm Job ID

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SlurmAPI.SlurmctldGetJob(context.Background(), jobId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SlurmAPI.SlurmctldGetJob``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `SlurmctldGetJob`: V0037JobsResponse
	fmt.Fprintf(os.Stdout, "Response from `SlurmAPI.SlurmctldGetJob`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
jobId	int64	Slurm Job ID

Other Parameters

Other parameters are passed through a pointer to a apiSlurmctldGetJobRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

V0037JobsResponse

Authorization

user, token

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/x-yaml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SlurmctldGetJobs

V0037JobsResponse SlurmctldGetJobs(ctx).UpdateTime(updateTime).Execute()

get list of jobs

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	updateTime := int64(789) // int64 | Filter if changed since update_time. Use of this parameter can result in faster replies. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SlurmAPI.SlurmctldGetJobs(context.Background()).UpdateTime(updateTime).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SlurmAPI.SlurmctldGetJobs``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `SlurmctldGetJobs`: V0037JobsResponse
	fmt.Fprintf(os.Stdout, "Response from `SlurmAPI.SlurmctldGetJobs`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiSlurmctldGetJobsRequest struct via the builder pattern

Name	Type	Description	Notes
updateTime	int64	Filter if changed since update_time. Use of this parameter can result in faster replies.

Return type

V0037JobsResponse

Authorization

user, token

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/x-yaml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SlurmctldGetNode

V0037NodesResponse SlurmctldGetNode(ctx, nodeName).Execute()

get node info

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	nodeName := "nodeName_example" // string | Slurm Node Name

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SlurmAPI.SlurmctldGetNode(context.Background(), nodeName).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SlurmAPI.SlurmctldGetNode``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `SlurmctldGetNode`: V0037NodesResponse
	fmt.Fprintf(os.Stdout, "Response from `SlurmAPI.SlurmctldGetNode`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
nodeName	string	Slurm Node Name

Other Parameters

Other parameters are passed through a pointer to a apiSlurmctldGetNodeRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

V0037NodesResponse

Authorization

user, token

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/x-yaml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SlurmctldGetNodes

V0037NodesResponse SlurmctldGetNodes(ctx).UpdateTime(updateTime).Execute()

get all node info

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	updateTime := int64(789) // int64 | Filter if changed since update_time. Use of this parameter can result in faster replies. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SlurmAPI.SlurmctldGetNodes(context.Background()).UpdateTime(updateTime).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SlurmAPI.SlurmctldGetNodes``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `SlurmctldGetNodes`: V0037NodesResponse
	fmt.Fprintf(os.Stdout, "Response from `SlurmAPI.SlurmctldGetNodes`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiSlurmctldGetNodesRequest struct via the builder pattern

Name	Type	Description	Notes
updateTime	int64	Filter if changed since update_time. Use of this parameter can result in faster replies.

Return type

V0037NodesResponse

Authorization

user, token

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/x-yaml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SlurmctldGetPartition

V0037PartitionsResponse SlurmctldGetPartition(ctx, partitionName).UpdateTime(updateTime).Execute()

get partition info

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	partitionName := "partitionName_example" // string | Slurm Partition Name
	updateTime := int64(789) // int64 | Filter if there were no partition changes (not limited to partition in URL endpoint) since update_time. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SlurmAPI.SlurmctldGetPartition(context.Background(), partitionName).UpdateTime(updateTime).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SlurmAPI.SlurmctldGetPartition``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `SlurmctldGetPartition`: V0037PartitionsResponse
	fmt.Fprintf(os.Stdout, "Response from `SlurmAPI.SlurmctldGetPartition`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
partitionName	string	Slurm Partition Name

Other Parameters

Other parameters are passed through a pointer to a apiSlurmctldGetPartitionRequest struct via the builder pattern

Name	Type	Description	Notes

updateTime | int64 | Filter if there were no partition changes (not limited to partition in URL endpoint) since update_time. |

Return type

V0037PartitionsResponse

Authorization

user, token

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/x-yaml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SlurmctldGetPartitions

V0037PartitionsResponse SlurmctldGetPartitions(ctx).UpdateTime(updateTime).Execute()

get all partition info

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	updateTime := int64(789) // int64 | Filter if changed since update_time. Use of this parameter can result in faster replies. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SlurmAPI.SlurmctldGetPartitions(context.Background()).UpdateTime(updateTime).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SlurmAPI.SlurmctldGetPartitions``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `SlurmctldGetPartitions`: V0037PartitionsResponse
	fmt.Fprintf(os.Stdout, "Response from `SlurmAPI.SlurmctldGetPartitions`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiSlurmctldGetPartitionsRequest struct via the builder pattern

Name	Type	Description	Notes
updateTime	int64	Filter if changed since update_time. Use of this parameter can result in faster replies.

Return type

V0037PartitionsResponse

Authorization

user, token

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/x-yaml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SlurmctldGetReservation

V0037ReservationsResponse SlurmctldGetReservation(ctx, reservationName).UpdateTime(updateTime).Execute()

get reservation info

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	reservationName := "reservationName_example" // string | Slurm Reservation Name
	updateTime := int64(789) // int64 | Filter if no reservation (not limited to reservation in URL) changed since update_time. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SlurmAPI.SlurmctldGetReservation(context.Background(), reservationName).UpdateTime(updateTime).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SlurmAPI.SlurmctldGetReservation``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `SlurmctldGetReservation`: V0037ReservationsResponse
	fmt.Fprintf(os.Stdout, "Response from `SlurmAPI.SlurmctldGetReservation`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
reservationName	string	Slurm Reservation Name

Other Parameters

Other parameters are passed through a pointer to a apiSlurmctldGetReservationRequest struct via the builder pattern

Name	Type	Description	Notes

updateTime | int64 | Filter if no reservation (not limited to reservation in URL) changed since update_time. |

Return type

V0037ReservationsResponse

Authorization

user, token

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/x-yaml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SlurmctldGetReservations

V0037ReservationsResponse SlurmctldGetReservations(ctx).UpdateTime(updateTime).Execute()

get all reservation info

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	updateTime := int64(789) // int64 | Filter if changed since update_time. Use of this parameter can result in faster replies. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SlurmAPI.SlurmctldGetReservations(context.Background()).UpdateTime(updateTime).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SlurmAPI.SlurmctldGetReservations``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `SlurmctldGetReservations`: V0037ReservationsResponse
	fmt.Fprintf(os.Stdout, "Response from `SlurmAPI.SlurmctldGetReservations`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiSlurmctldGetReservationsRequest struct via the builder pattern

Name	Type	Description	Notes
updateTime	int64	Filter if changed since update_time. Use of this parameter can result in faster replies.

Return type

V0037ReservationsResponse

Authorization

user, token

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/x-yaml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SlurmctldLicenses

V0037Licenses SlurmctldLicenses(ctx).Execute()

get all license info

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SlurmAPI.SlurmctldLicenses(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SlurmAPI.SlurmctldLicenses``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `SlurmctldLicenses`: V0037Licenses
	fmt.Fprintf(os.Stdout, "Response from `SlurmAPI.SlurmctldLicenses`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiSlurmctldLicensesRequest struct via the builder pattern

Return type

V0037Licenses

Authorization

user, token

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/x-yaml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SlurmctldPing

V0037Pings SlurmctldPing(ctx).Execute()

ping test

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SlurmAPI.SlurmctldPing(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SlurmAPI.SlurmctldPing``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `SlurmctldPing`: V0037Pings
	fmt.Fprintf(os.Stdout, "Response from `SlurmAPI.SlurmctldPing`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiSlurmctldPingRequest struct via the builder pattern

Return type

V0037Pings

Authorization

user, token

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/x-yaml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SlurmctldSubmitJob

V0037JobSubmissionResponse SlurmctldSubmitJob(ctx).V0037JobSubmission(v0037JobSubmission).Execute()

submit new job

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	v0037JobSubmission := *openapiclient.NewV0037JobSubmission("Script_example") // V0037JobSubmission | submit new job

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SlurmAPI.SlurmctldSubmitJob(context.Background()).V0037JobSubmission(v0037JobSubmission).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SlurmAPI.SlurmctldSubmitJob``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `SlurmctldSubmitJob`: V0037JobSubmissionResponse
	fmt.Fprintf(os.Stdout, "Response from `SlurmAPI.SlurmctldSubmitJob`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiSlurmctldSubmitJobRequest struct via the builder pattern

Name	Type	Description	Notes
v0037JobSubmission	V0037JobSubmission	submit new job

Return type

V0037JobSubmissionResponse

Authorization

user, token

HTTP request headers

Content-Type: application/json, application/x-yaml
Accept: application/json, application/x-yaml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SlurmctldUpdateJob

SlurmctldUpdateJob(ctx, jobId).V0037JobProperties(v0037JobProperties).Execute()

update job

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	jobId := int64(789) // int64 | Slurm Job ID
	v0037JobProperties := *openapiclient.NewV0037JobProperties(map[string]interface{}(123)) // V0037JobProperties | update job

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.SlurmAPI.SlurmctldUpdateJob(context.Background(), jobId).V0037JobProperties(v0037JobProperties).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SlurmAPI.SlurmctldUpdateJob``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
jobId	int64	Slurm Job ID

Other Parameters

Other parameters are passed through a pointer to a apiSlurmctldUpdateJobRequest struct via the builder pattern

Name	Type	Description	Notes

v0037JobProperties | V0037JobProperties | update job |

Return type

(empty response body)

Authorization

user, token

HTTP request headers

Content-Type: application/json, application/x-yaml
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

SlurmAPI.md

Latest commit

History

SlurmAPI.md

File metadata and controls

\SlurmAPI

SlurmctldCancelJob

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SlurmctldDiag

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SlurmctldGetJob

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SlurmctldGetJobs

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SlurmctldGetNode

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SlurmctldGetNodes

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SlurmctldGetPartition

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SlurmctldGetPartitions

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SlurmctldGetReservation

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SlurmctldGetReservations

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SlurmctldLicenses

Example

Path Parameters