.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "CONDOR_SET_SHUTDOWN" "1" "Apr 01, 2024" "" "HTCondor Manual"
.SH NAME
condor_set_shutdown \- HTCondor Manual
.sp
Set a program to execute upon \fIcondor_master\fP shut down
  
.SH SYNOPSIS
.sp
\fBcondor_set_shutdown\fP [\fB\-help | \-version\fP ]
.sp
\fBcondor_set_shutdown\fP \fB\-exec\fP \fIprogramname\fP [\fB\-debug\fP ]
[\fB\-pool\fP \fIcentralmanagerhostname[:portnumber]\fP] [
\fB\-name\fP \fIhostname\fP | \fIhostname\fP | \fB\-addr\fP \fI\(dq<a.b.c.d:port>\(dq\fP
| \fI\(dq<a.b.c.d:port>\(dq\fP | \fB\-constraint\fP \fIexpression\fP | \fB\-all\fP ]
.SH DESCRIPTION
.sp
\fIcondor_set_shutdown\fP sets a program (typically a script) to execute
when the \fIcondor_master\fP daemon shuts down. The
\fB\-exec\fP \fIprogramname\fP argument is required, and specifies the
program to run. The string \fIprogramname\fP must match the string that
defines \fBName\fP in the configuration variable
\fI\%MASTER_SHUTDOWN_<Name>\fP in the \fIcondor_master\fP daemon\(aqs
configuration. If it does not match, the \fIcondor_master\fP will log an
error and ignore the request.
.sp
For security reasons of authentication and authorization, this command
requires ADMINISTRATOR level of access.
.SH OPTIONS
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
\fB\-help\fP
Display usage information
.TP
\fB\-version\fP
Display version information
.TP
\fB\-exec\fP \fIname\fP
Select the program the master should exec the next time it shuts down.
The master will run the program configured as \fBMASTER_SHUTDOWN_<name>\fP
from the configuration of the \fIcondor_master\fP\&.
.TP
\fB\-debug\fP
Causes debugging information to be sent to \fBstderr\fP, based on the
value of the configuration variable \fI\%TOOL_DEBUG\fP\&.
.TP
\fB\-pool\fP \fIcentralmanagerhostname[:portnumber]\fP
Specify a pool by giving the central manager\(aqs host name and an
optional port number
.TP
\fB\-name\fP \fIhostname\fP
Send the command to a machine identified by \fIhostname\fP
.TP
.B \fIhostname\fP
Send the command to a machine identified by \fIhostname\fP
.TP
\fB\-addr\fP \fI\(dq<a.b.c.d:port>\(dq\fP
Send the command to a machine\(aqs master located at \fI\(dq<a.b.c.d:port>\(dq\fP
.TP
.B \fI\(dq<a.b.c.d:port>\(dq\fP
Send the command to a machine located at \fI\(dq<a.b.c.d:port>\(dq\fP
.TP
\fB\-constraint\fP \fIexpression\fP
Apply this command only to machines matching the given ClassAd
\fIexpression\fP
.TP
\fB\-all\fP
Send the command to all machines in the pool
.UNINDENT
.UNINDENT
.UNINDENT
.SH EXIT STATUS
.sp
\fIcondor_set_shutdown\fP will exit with a status value of 0 (zero) upon
success, and it will exit with the value 1 (one) upon failure.
.SH EXAMPLES
.sp
To have all \fIcondor_master\fP daemons run the program \fI/bin/reboot\fP upon
shut down, configure the \fIcondor_master\fP to contain a definition
similar to:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
MASTER_SHUTDOWN_REBOOT = /sbin/reboot
.EE
.UNINDENT
.UNINDENT
.sp
where \fBREBOOT\fP is an invented name for this program that the
\fIcondor_master\fP will execute. On the command line, run
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ condor_set_shutdown \-exec reboot \-all
$ condor_off \-graceful \-all
.EE
.UNINDENT
.UNINDENT
.sp
where the string reboot matches the invented name.
.SH AUTHOR
HTCondor Team
.SH COPYRIGHT
1990-2024, Center for High Throughput Computing, Computer Sciences Department, University of Wisconsin-Madison, Madison, WI, US. Licensed under the Apache License, Version 2.0.
.\" Generated by docutils manpage writer.
.