slurm_complete_job(3)

1Slurm API(3)            Slurm job completion functions            Slurm API(3)
2
3
4

NAME

6       slurm_complete_job - Slurm job completion call
7

SYNTAX

9       #include <slurm/slurm.h>
10
11       int slurm_complete_job (
12            uint32_t job_id,
13            uint32_t job_return_code
14       );
15

ARGUMENTS

17       job_id Slurm job id number.
18
19       job_return_code
20              Exit code of the program executed.
21
22

DESCRIPTION

24       slurm_complete_job  Note  the  termination  of a job. This function may
25       only be successfully executed by the job's owner or user root.
26
27

RETURN VALUE

29       On success, zero is returned. On error, -1 is returned, and Slurm error
30       code is set appropriately.
31
32

ERRORS

34       SLURM_PROTOCOL_VERSION_ERROR Protocol version has changed, re-link your
35       code.
36
37       ESLURM_INVALID_JOB_ID the requested job id does not exist.
38
39       ESLURM_ALREADY_DONE the specified job has already completed and can not
40       be modified.
41
42       ESLURM_ACCESS_DENIED  the  requesting  user lacks authorization for the
43       requested action (e.g. trying to delete or modify another user's job).
44
45       ESLURM_INTERCONNECT_FAILURE failed to configure the node interconnect.
46
47       SLURM_PROTOCOL_SOCKET_IMPL_TIMEOUT Timeout in communicating with  Slurm
48       controller.
49
50

NOTE

52       These  functions  are  included  in the libslurm library, which must be
53       linked to your process for use (e.g. "cc -lslurm myprog.c").
54
55

COPYING

57       Copyright (C) 2002-2007 The Regents of the  University  of  California.
58       Copyright (C) 2008-2009 Lawrence Livermore National Security.  Produced
59       at   Lawrence   Livermore   National   Laboratory   (cf,   DISCLAIMER).
60       CODE-OCEC-09-009. All rights reserved.
61
62       This  file  is  part  of  Slurm,  a  resource  management program.  For
63       details, see <https://slurm.schedmd.com/>.
64
65       Slurm is free software; you can redistribute it and/or modify it  under
66       the  terms  of  the GNU General Public License as published by the Free
67       Software Foundation; either version 2  of  the  License,  or  (at  your
68       option) any later version.
69
70       Slurm  is  distributed  in the hope that it will be useful, but WITHOUT
71       ANY WARRANTY; without even the implied warranty of  MERCHANTABILITY  or
72       FITNESS  FOR  A PARTICULAR PURPOSE.  See the GNU General Public License
73       for more details.
74