1Slurm API(3) Slurm job step initiation functions Slurm API(3)
2
3
4
6 slurm_free_job_step_create_response_msg, slurm_job_step_create - Slurm
7 job step initiation functions
8
9
11 #include <slurm/slurm.h>
12
13 void slurm_free_job_step_create_response_msg (
14 job_step_create_response_msg_t *slurm_step_alloc_resp_msg_ptr
15 );
16
17 int slurm_job_step_create (
18 job_step_create_request_msg_t *slurm_step_alloc_req_msg_ptr,
19 job_step_create_response_msg_t **slurm_step_alloc_resp_msg_pptr
20 );
21
23 slurm_step_alloc_req_msg_ptr
24 Specifies the pointer to the structure with job step request
25 specification. See slurm.h for full details on the data struc‐
26 ture's contents.
27
28 slurm_step_alloc_resp_msg_pptr
29 Specifies the double pointer to the structure to be created and
30 filled with a description of the created job step: node alloca‐
31 tion, credentials, etc. See slurm.h for full details on the data
32 structure's contents.
33
35 slurm_free_job_step_create_response_msg Release the storage generated
36 in response to a call of the function slurm_job_step_create.
37
38 slurm_job_step_create Initialize a job step including the allocation of
39 nodes to it from those already allocate to that job. Always release the
40 response message when no longer required using the function
41 slurm_free_job_step_create_response_msg. The list of host names
42 returned may be matched to their data in the proper order by using the
43 functions hostlist_create, hostlist_shift, and hostlist_destroy.
44
46 On success, zero is returned. On error, -1 is returned, and Slurm error
47 code is set appropriately.
48
50 SLURM_PROTOCOL_VERSION_ERROR Protocol version has changed, re-link your
51 code.
52
53 ESLURM_INVALID_JOB_ID the requested job id does not exist.
54
55 ESLURM_ALREADY_DONE the specified job has already completed and can not
56 be modified.
57
58 ESLURM_ACCESS_DENIED the requesting user lacks authorization for the
59 requested action (e.g. trying to delete or modify another user's job).
60
61 ESLURM_DISABLED the ability to create a job step is currently disabled.
62 This is indicative of the job being suspended. Retry the call as
63 desired.
64
65 ESLURM_INTERCONNECT_FAILURE failed to configure the node interconnect.
66
67 ESLURM_BAD_DIST task distribution specification is invalid.
68
69 SLURM_PROTOCOL_SOCKET_IMPL_TIMEOUT Timeout in communicating with Slurm
70 controller.
71
72
74 These functions are included in the libslurm library, which must be
75 linked to your process for use (e.g. "cc -lslurm myprog.c").
76
77
79 Copyright (C) 2002-2007 The Regents of the University of California.
80 Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
81 CODE-OCEC-09-009. All rights reserved.
82
83 This file is part of Slurm, a resource management program. For
84 details, see <https://slurm.schedmd.com/>.
85
86 Slurm is free software; you can redistribute it and/or modify it under
87 the terms of the GNU General Public License as published by the Free
88 Software Foundation; either version 2 of the License, or (at your
89 option) any later version.
90
91 Slurm is distributed in the hope that it will be useful, but WITHOUT
92 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
93 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
94 for more details.
95
97 hostlist_create(3), hostlist_shift(3), hostlist_destroy(3), srun(1),
98 slurm_get_errno(3), slurm_perror(3), slurm_strerror(3)
99
100
101
102April 2015 Slurm job step initiation functions Slurm API(3)