Reservation

Warning

This API is currently being completely reworked, and is subject to be removed in the future when a replacement is introduced

pyslurm.reservation

Access/update/delete slurm reservation Information.

create(reservation_dict={}) method descriptor

Create slurm reservation.

Parameters:

Name	Type	Description	Default
reservation_dict	dict	Reservation information	{}

Returns:

Type	Description
int	0 for success or a slurm error code

delete(ResID) method descriptor

Delete slurm reservation.

Parameters:

Name	Type	Description	Default
ResID	int	ID of the reservation to delete	required

Returns:

Type	Description
int	0 for success or a slurm error code

find(name='', val='') method descriptor

Search for property and associated value in reservation data.

Parameters:

Name	Type	Description	Default
name	str	key string to search	''
val	str	value string to match	''

Returns:

Type	Description
list	List of IDs that match

find_id(resID) method descriptor

Retrieve reservation ID data.

Parameters:

Name	Type	Description	Default
resID	str	Reservation key string to search	required

Returns:

Type	Description
dict	Dictionary of values for given reservation key

get() method descriptor

Get slurm reservation information.

Returns:

Type	Description
dict	Data whose key is the Reservation ID

ids() method descriptor

Return a list of reservation IDs from retrieved data.

Returns:

Type	Description
dict	Dictionary of reservation IDs

lastUpdate() method descriptor

Get the time (epoch seconds) the reservation data was updated.

Returns:

Type	Description
int	epoch seconds

print_reservation_info_msg(oneLiner=0) method descriptor

Output information about all slurm reservations.

Parameters:

Name	Type	Description	Default
oneLiner	int	Print reservation info in one-line	0

update(reservation_dict={}) method descriptor

Update a slurm reservation attributes.

Parameters:

Name	Type	Description	Default
reservation_dict	dict	Reservation information	{}

Returns:

Type	Description
int	0 for success or -1 for error and slurm error code is set