.\" 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_ADVERTISE" "1" "Apr 01, 2024" "" "HTCondor Manual"
.SH NAME
condor_advertise \- HTCondor Manual
.sp
Send a ClassAd to the \fIcondor_collector\fP daemon
  
.SH SYNOPSIS
.sp
\fBcondor_advertise\fP [\fB\-help | \-version\fP ]
.sp
\fBcondor_advertise\fP [\fB\-pool\fP \fIcentralmanagerhostname[:portname]\fP]
[\fB\-debug\fP ] [\fB\-tcp\fP ] [\fB\-udp\fP ] [\fB\-multiple\fP ]
[\fIupdate\-command [classad\-filename]\fP]
.SH DESCRIPTION
.sp
\fIcondor_advertise\fP sends one or more ClassAds to the
\fIcondor_collector\fP daemon on the central manager machine. The optional
argument \fIupdate\-command\fP says what daemon type\(aqs ClassAd is to be
updated; if it is absent, it assumed to be the update command
corresponding to the type of the (first) ClassAd. The optional argument
\fIclassad\-filename\fP is the file from which the ClassAd(s) should be read.
If \fIclassad\-filename\fP is omitted or is the dash character (\(aq\-\(aq), then
the ClassAd(s) are read from standard input. You must specify
\fIupdate\-command\fP if you do not want to read from standard input.
.sp
When \fB\-multiple\fP is specified, multiple ClassAds may be published.
Publishing many ClassAds in a single invocation of \fIcondor_advertise\fP
is more efficient than invoking \fIcondor_advertise\fP once per ClassAd.
The ClassAds are expected to be separated by one or more blank lines.
When \fB\-multiple\fP is not specified, blank lines are ignored (for
backward compatibility). It is best not to rely on blank lines being
ignored, as this may change in the future.
.sp
The \fIupdate\-command\fP may be one of the following strings:
.INDENT 0.0
.INDENT 3.5
UPDATE_STARTD_AD
UPDATE_SCHEDD_AD
UPDATE_MASTER_AD
UPDATE_GATEWAY_AD
UPDATE_CKPT_SRVR_AD
UPDATE_NEGOTIATOR_AD
UPDATE_HAD_AD
UPDATE_AD_GENERIC
UPDATE_SUBMITTOR_AD
UPDATE_COLLECTOR_AD
UPDATE_LICENSE_AD
UPDATE_STORAGE_AD
.UNINDENT
.UNINDENT
.sp
\fIcondor_advertise\fP can also be used to invalidate and delete ClassAds
currently held by the \fIcondor_collector\fP daemon. In this case the
\fIupdate\-command\fP will be one of the following strings:
.INDENT 0.0
.INDENT 3.5
INVALIDATE_STARTD_ADS
INVALIDATE_SCHEDD_ADS
INVALIDATE_MASTER_ADS
INVALIDATE_GATEWAY_ADS
INVALIDATE_CKPT_SRVR_ADS
INVALIDATE_NEGOTIATOR_ADS
INVALIDATE_HAD_ADS
INVALIDATE_ADS_GENERIC
INVALIDATE_SUBMITTOR_ADS
INVALIDATE_COLLECTOR_ADS
INVALIDATE_LICENSE_ADS
INVALIDATE_STORAGE_ADS
.UNINDENT
.UNINDENT
.sp
For any of these INVALIDATE commands, the ClassAd in the required file
will look like the following:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
MyType = \(dqQuery\(dq
TargetType = \(dqMachine\(dq
Name = \(dqcondor.example.com\(dq
Requirements = Name == \(dqcondor.example.com\(dq
.EE
.UNINDENT
.UNINDENT
.sp
The definition for \fBMyType\fP is always \fBQuery\fP\&. \fBTargetType\fP is set
to the \fBMyType\fP of the ad to be deleted. This \fBMyType\fP is
\fBDaemonMaster\fP for the \fIcondor_master\fP ClassAd, \fBMachine\fP for the
\fIcondor_startd\fP ClassAd, \fBScheduler\fP for the \fIcondor_schedd\fP
ClassAd, and \fBNegotiator\fP for the \fIcondor_negotiator\fP ClassAd.
.sp
\fBRequirements\fP is an expression evaluated within the context of ads of
\fBTargetType\fP\&. When \fBRequirements\fP evaluates to \fBTrue\fP, the
matching ad is invalidated. A full example is given below.
.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\-debug\fP
Print debugging information as the command executes.
.TP
\fB\-multiple\fP
Send more than one ClassAd, where the boundary between ClassAds is
one or more blank lines.
.TP
\fB\-pool\fP \fIcentralmanagerhostname[:portname]\fP
Specify a pool by giving the central manager\(aqs host name and an
optional port number. The default is the \fI\%COLLECTOR_HOST\fP
specified in the configuration file.
.TP
\fB\-tcp\fP
Use TCP for communication. Used by default if
\fI\%UPDATE_COLLECTOR_WITH_TCP\fP is true.
.TP
\fB\-udp\fP
Use UDP for communication.
.UNINDENT
.UNINDENT
.UNINDENT
.SH GENERAL REMARKS
.sp
The job and machine ClassAds are regularly updated. Therefore, the
result of \fIcondor_advertise\fP is likely to be overwritten in a very
short time. It is unlikely that either HTCondor users (those who submit
jobs) or administrators will ever have a use for this command. If it is
desired to update or set a ClassAd attribute, the \fIcondor_config_val\fP
command is the proper command to use.
.sp
Attributes are defined in Appendix A of the HTCondor manual.
.sp
For those administrators who do need \fIcondor_advertise\fP, the following
attributes may be included:
.INDENT 0.0
.INDENT 3.5
\fBDaemonStartTime\fP
\fBUpdateSequenceNumber\fP
.UNINDENT
.UNINDENT
.sp
If both of the above are included, the \fIcondor_collector\fP will
automatically include the following attributes:
.INDENT 0.0
.INDENT 3.5
\fBUpdatesTotal\fP
\fBUpdatesLost\fP
\fBUpdatesSequenced\fP
\fBUpdatesHistory\fP
.INDENT 0.0
.INDENT 3.5
Affected by \fI\%COLLECTOR_DAEMON_HISTORY_SIZE\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SH EXAMPLES
.sp
Assume that a machine called condor.example.com is turned off, yet its
\fIcondor_startd\fP ClassAd does not expire for another 20 minutes. To
avoid this machine being matched, an administrator chooses to delete the
machine\(aqs \fIcondor_startd\fP ClassAd. Create a file (called
\fBremove_file\fP in this example) with the three required attributes:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
MyType = \(dqQuery\(dq
TargetType = \(dqMachine\(dq
Name = \(dqcondor.example.com\(dq
Requirements = Name == \(dqcondor.example.com\(dq
.EE
.UNINDENT
.UNINDENT
.sp
This file is used with the command:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ condor_advertise INVALIDATE_STARTD_ADS remove_file
.EE
.UNINDENT
.UNINDENT
.SH EXIT STATUS
.sp
\fIcondor_advertise\fP will exit with a status value of 0 (zero) upon
success, and it will exit with the value 1 (one) upon failure. Success
means that all ClassAds were successfully sent to all
\fIcondor_collector\fP daemons. When there are multiple ClassAds or
multiple \fIcondor_collector\fP daemons, it is possible that some but not
all publications succeed; in this case, the exit status is 1, indicating
failure.
.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.
.