1CONDOR_OFF(1)                   HTCondor Manual                  CONDOR_OFF(1)
2
3
4

NAME

6       condor_off - HTCondor Manual
7
8       Shutdown HTCondor daemons
9
10

SYNOPSIS

12       condor_off [-help | -version ]
13
14       condor_off  [-graceful | -fast | -peaceful | -force-graceful | -drain ]
15       [-annex name] [-debug[:opts] ] [-pool  centralmanagerhostname[:portnum‐
16       ber]]   [   -name  hostname  |  hostname  |  -addr  "<a.b.c.d:port>"  |
17       "<a.b.c.d:port>" | -constraint expression | -all ] [-daemon  daemonname
18       |  -master]  [-exec  name]  [-reason  "reason-string"] [-request-id id]
19       [-check expr] [-start expr]
20

DESCRIPTION

22       condor_off shuts down a set of the HTCondor daemons running on a set of
23       one  or  more machines.  By default, it does this cleanly, so that jobs
24       have time to shut down.
25
26       The command condor_off without any arguments will shut down all daemons
27       except  condor_master, unless -annex name is specified. The condor_mas‐
28       ter can then handle both local and remote requests to restart the other
29       HTCondor  daemons if need be. To restart HTCondor running on a machine,
30       see the condor_on command.
31
32       When the -drain option is chosen, draining options can be specified  by
33       using the optional -reason, -request-id, -check, and -start arguments.
34
35       With  the  -daemon master option, condor_off will shut down all daemons
36       including the condor_master. Specification  using  the  -daemon  option
37       will shut down only the specified daemon.
38
39       When  shutting  down all daemons including the condor_master, the -exec
40       argument  can  be  used  to  tell  the  master  to  run  a   configured
41       MASTER_SHUTDOWN_<Name> script before it exits.
42
43       For  security reasons of authentication and authorization, this command
44       requires ADMINISTRATOR level of access.
45

OPTIONS

47          -help  Display usage information
48
49          -version
50                 Display version information
51
52          -graceful
53                 The default. If jobs are running, wait for up to the  config‐
54                 ured grace period for them to finish, then exit
55
56          -fast  Quickly  shutdown  daemons,  immediately evicting any running
57                 jobs. A minimum of the first two characters  of  this  option
58                 must be specified, to distinguish it from the -force-graceful
59                 command.
60
61          -peaceful
62                 Wait indefinitely for jobs to finish
63
64          -force-graceful
65                 Force a graceful shutdown, even  after  issuing  a  -peaceful
66                 command. A minimum of the first two characters of this option
67                 must be specified, to distinguish it from the -fast command.
68
69          -drain Send a condor_drain command with the -exit-on-completion  op‐
70                 tion  to  all  condor_startd daemons that are managed by this
71                 master. Then wait for all condor_startd daemons to  exit  be‐
72                 fore before shutting down other daemons.
73
74          -reason "reason-string"
75                 Use  with  -drain  to set a -reason "reason-string" value for
76                 the condor_drain command.
77
78          -request-id id
79                 Use with -drain to set a -request-id id value  for  the  con‐
80                 dor_drain command.
81
82          -check expr
83                 Use  with  -drain  to  set  a  -check expr value for the con‐
84                 dor_drain command.
85
86          -start expr
87                 Use with -drain to set a  -start  expr  value  for  the  con‐
88                 dor_drain command.
89
90          -annex name
91                 Turn  off  master  daemons in the specified annex. By default
92                 this will result  in  the  corresponding  instances  shutting
93                 down.
94
95          -debug[:opts]
96                 Causes  debugging information to be sent to stderr. The debug
97                 level can be set by specifying an optional opts value. Other‐
98                 wise,  the  configuration  variable TOOL_DEBUG sets the debug
99                 level.
100
101          -pool centralmanagerhostname[:portnumber]
102                 Specify a pool by giving the central manager's host name  and
103                 an optional port number
104
105          -name hostname
106                 Send the command to a machine identified by hostname
107
108          hostname
109                 Send the command to a machine identified by hostname
110
111          -addr "<a.b.c.d:port>"
112                 Send   the   command   to   a  machine's  master  located  at
113                 "<a.b.c.d:port>"
114
115          "<a.b.c.d:port>"
116                 Send the command to a machine located at "<a.b.c.d:port>"
117
118          -constraint expression
119                 Apply this command only to machines matching the given  Clas‐
120                 sAd expression
121
122          -all   Send the command to all machines in the pool
123
124          -master
125                 Shutdown the condor_master after shutting down all other dae‐
126                 mons.
127
128          -exec name
129                 When used with -master, the condor_master will run  the  pro‐
130                 gram configured as MASTER_SHUTDOWN_<Name> after shutting down
131                 all other daemons.
132
133          -daemon daemonname
134                 Send the command to the named daemon.  Without  this  option,
135                 the command is sent to the condor_master daemon.
136

GRACEFUL VS. PEACEFUL VS FAST

138       A  "fast"  shutdown will cause the requested daemon to exit.  Jobs run‐
139       ning under a startd that is shutdown fast will be evicted. Jobs running
140       on  a  schedd  that is shutdown fast will be left running for their job
141       lease duration (default of 20 minutes). (That is, assuming  the  corre‐
142       sponding  startd  is not also being shut down). If that schedd restarts
143       before the job lease expires, it will reconnect to these  running  jobs
144       and continue to run them, as long as the schedd and startd are running.
145
146       A  "graceful" shutdown of a schedd is functionally the same as a "fast"
147       shutdown of a schedd.
148
149       A "graceful" shutdown of a startd that has jobs running under it causes
150       the  startd to wait for the jobs to exit of their own accord, up to the
151       MaxJobRetirementTime.  After the MaxJobRetirementTime, the startd  will
152       evict any remaining running jobs and exit.
153
154       A  "peaceful"  shutdown of a startd or schedd will cause that daemon to
155       wait indefinitely for all existing jobs to exit before  shutting  down.
156       During this time, no new jobs will start.
157

EXIT STATUS

159       condor_off  will exit with a status value of 0 (zero) upon success, and
160       it will exit with the value 1 (one) upon failure.
161

EXAMPLES

163       To shut down all daemons (other than condor_master) on the local host:
164
165          $ condor_off
166
167       To shut down only the condor_collector on three named machines:
168
169          $ condor_off  cinnamon cloves vanilla -daemon collector
170
171       To shut down daemons within a pool of machines  other  than  the  local
172       pool,  use  the  -pool  option. The argument is the name of the central
173       manager for the pool. Note that one or more machines  within  the  pool
174       must  be  specified  as the targets for the command. This command shuts
175       down all daemons except the condor_master on the single  machine  named
176       cae17  within  the pool of machines that has condor.cae.wisc.edu as its
177       central manager:
178
179          $ condor_off  -pool condor.cae.wisc.edu -name cae17
180

AUTHOR

182       HTCondor Team
183
185       1990-2023, Center for High Throughput Computing, Computer Sciences  De‐
186       partment,  University  of  Wisconsin-Madison, Madison, WI, US. Licensed
187       under the Apache License, Version 2.0.
188
189
190
191
192                                 Oct 02, 2023                    CONDOR_OFF(1)
Impressum