Trigger

Warning

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

pyslurm.trigger

clear(TriggerID=0, UserID=4294967294, ID=0) method descriptor

Clear or remove a slurm trigger.

Parameters:

Name	Type	Description	Default
TriggerID	str	Trigger Identifier	0
UserID	str	User Identifier	4294967294
ID	str	Job Identifier	0

Returns:

Type	Description
int	0 for success or a slurm error code

get() method descriptor

Get the information on slurm triggers.

Returns:

Type	Description
dict	Dictionary, where keys are the trigger IDs

set(trigger_dict) method descriptor

Set or create a slurm trigger.

Parameters:

Name	Type	Description	Default
trigger_dict	dict	A populated dictionary of trigger information	required

Returns:

Type	Description
int	0 for success or -1 for error, and the slurm error code is set appropriately.