1Slurm API(3) Slurm event trigger management functions Slurm API(3)
2
3
4
6 slurm_init_trigger_msg, slurm_clear_trigger, slurm_free_trigger_msg,
7 slurm_get_triggers, slurm_set_trigger - Slurm event trigger management
8 functions
9
10
12 #include <slurm/slurm.h>
13
14 int slurm_set_trigger (
15 trigger_info_t *trigger_info
16 );
17
18 int slurm_clear_trigger (
19 trigger_info_t *trigger_info
20 );
21
22 int slurm_get_triggers (
23 trigger_info_msg_t **trigger_info_msg
24 );
25
26 int slurm_free_trigger (
27 trigger_info_msg_t *trigger_info_msg
28 );
29
30 int slurm_init_trigger_msg (
31 trigger_info_msg_t *trigger_info_msg
32 );
33
34
36 trigger_info
37 Information about one event trigger including trigger ID, type,
38 time offset, etc. See slurm.h for details.
39
40 trigger_info_msg
41 A data structure including an array of trigger_info structures
42 plus their count. See slurm.h for details.
43
44
46 slurm_set_trigger Create a new event trigger. Note that any trigger ID
47 specified in trigger_info is unused.
48
49 slurm_clear_trigger Clear or remove existing event triggers. If a
50 trigger ID is specified then only that one trigger will be cleared. If
51 a job ID or node name is specified, then all triggers associated with
52 that resource are cleared.
53
54 slurm_get_triggers Get information about all currently configured event
55 triggers. To avoid memory leaks, always follow this with a call to the
56 slurm_free_trigger function.
57
58 slurm_free_trigger Release the memory allocated for the array returned
59 by the slurm_get_triggers function.
60
61 slurm_init_trigger_msg Initialize the data structure to be used in sub‐
62 sequent call to slurm_set_trigger or slurm_clear_trigger.
63
64
66 SLURM_SUCCESS is returned on successful completion, otherwise an error
67 code is returned as described below.
68
69
71 EINVAL Invalid argument
72
73 ESLURM_ACCESS_DENIED Attempt by non-privileged user to set an event
74 trigger.
75
76 ESLURM_ALREADY_DONE Attempt to set an event trigger for a job which has
77 already completed.
78
79 ESLURM_INVALID_NODE_NAME Attempt to set an event trigger for a node
80 name which is invalid.
81
82 ESLURM_INVALID_JOB_ID the specified job id does not exist.
83
84 ESLURM_TRIGGER_DUP there is already an identical event trigger.
85
86
88 These functions are included in the libslurm library, which must be
89 linked to your process for use (e.g. "cc -lslurm myprog.c").
90
91
93 Copyright (C) 2010 Lawrence Livermore National Security. Produced at
94 Lawrence Livermore National Laboratory (cf, DISCLAIMER). Portions
95 Copyright (C) 2014 SchedMD LLC.
96
97 This file is part of Slurm, a resource management program. For
98 details, see <https://slurm.schedmd.com/>.
99
100 Slurm is free software; you can redistribute it and/or modify it under
101 the terms of the GNU General Public License as published by the Free
102 Software Foundation; either version 2 of the License, or (at your
103 option) any later version.
104
105 Slurm is distributed in the hope that it will be useful, but WITHOUT
106 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
107 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
108 for more details.
109
111 strigger(1), slurm_get_errno(3), slurm_perror(3), slurm_strerror(3)
112
113
114
115April 2015 Slurm event trigger management functions Slurm API(3)