1CONDOR_ADVERTISE(1) HTCondor Manual CONDOR_ADVERTISE(1)
2
6 condor_advertise - HTCondor Manual
7 Send a ClassAd to the condor_collector daemon
9
12 condor_advertise [-help | -version ]
13 condor_advertise [-pool centralmanagerhostname[:portname]] [-debug ]
15 [-tcp ] [-udp ] [-multiple ] [update-command [classad-filename]]
16
18 condor_advertise sends one or more ClassAds to the condor_collector
19 daemon on the central manager machine. The optional argument up‐
20 date-command says what daemon type's ClassAd is to be updated; if it is
21 absent, it assumed to be the update command corresponding to the type
22 of the (first) ClassAd. The optional argument classad-filename is the
23 file from which the ClassAd(s) should be read. If classad-filename is
24 omitted or is the dash character ('-'), then the ClassAd(s) are read
25 from standard input. You must specify update-command if you do not want
26 to read from standard input.
27 When -multiple is specified, multiple ClassAds may be published. Pub‐
29 lishing many ClassAds in a single invocation of condor_advertise is
30 more efficient than invoking condor_advertise once per ClassAd. The
31 ClassAds are expected to be separated by one or more blank lines. When
32 -multiple is not specified, blank lines are ignored (for backward com‐
33 patibility). It is best not to rely on blank lines being ignored, as
34 this may change in the future.
35 The update-command may be one of the following strings:
37 UPDATE_STARTD_AD UPDATE_SCHEDD_AD UPDATE_MASTER_AD UPDATE_GATEWAY_AD
38 UPDATE_CKPT_SRVR_AD UPDATE_NEGOTIATOR_AD UPDATE_HAD_AD UP‐
39 DATE_AD_GENERIC UPDATE_SUBMITTOR_AD UPDATE_COLLECTOR_AD UPDATE_LI‐
40 CENSE_AD UPDATE_STORAGE_AD
41 condor_advertise can also be used to invalidate and delete ClassAds
43 currently held by the condor_collector daemon. In this case the up‐
44 date-command will be one of the following strings:
45 INVALIDATE_STARTD_ADS INVALIDATE_SCHEDD_ADS INVALIDATE_MASTER_ADS
46 INVALIDATE_GATEWAY_ADS INVALIDATE_CKPT_SRVR_ADS INVALIDATE_NEGOTIA‐
47 TOR_ADS INVALIDATE_HAD_ADS INVALIDATE_ADS_GENERIC INVALIDATE_SUBMIT‐
48 TOR_ADS INVALIDATE_COLLECTOR_ADS INVALIDATE_LICENSE_ADS INVALI‐
49 DATE_STORAGE_ADS
50 For any of these INVALIDATE commands, the ClassAd in the required file
52 will look like the following:
53 MyType = "Query"
55 TargetType = "Machine"
56 Name = "condor.example.com"
57 Requirements = Name == "condor.example.com"
58 The definition for MyType is always Query. TargetType is set to the My‐
60 Type of the ad to be deleted. This MyType is DaemonMaster for the con‐
61 dor_master ClassAd, Machine for the condor_startd ClassAd, Scheduler
62 for the condor_schedd ClassAd, and Negotiator for the condor_negotiator
63 ClassAd.
64 Requirements is an expression evaluated within the context of ads of
66 TargetType. When Requirements evaluates to True, the matching ad is in‐
67 validated. A full example is given below.
68
70 -help Display usage information
71 -version
73 Display version information
74 -debug Print debugging information as the command executes.
76 -multiple
78 Send more than one ClassAd, where the boundary between Clas‐
79 sAds is one or more blank lines.
80 -pool centralmanagerhostname[:portname]
82 Specify a pool by giving the central manager's host name and
83 an optional port number. The default is the COLLECTOR_HOST
84 specified in the configuration file.
85 -tcp Use TCP for communication. Used by default if UPDATE_COLLEC‐
87 TOR_WITH_TCP is true.
88 -udp Use UDP for communication.
90
92 The job and machine ClassAds are regularly updated. Therefore, the re‐
93 sult of condor_advertise is likely to be overwritten in a very short
94 time. It is unlikely that either HTCondor users (those who submit jobs)
95 or administrators will ever have a use for this command. If it is de‐
96 sired to update or set a ClassAd attribute, the condor_config_val com‐
97 mand is the proper command to use.
98 Attributes are defined in Appendix A of the HTCondor manual.
100 For those administrators who do need condor_advertise, the following
102 attributes may be included:
103 DaemonStartTime UpdateSequenceNumber
104 If both of the above are included, the condor_collector will automati‐
106 cally include the following attributes:
107 UpdatesTotal UpdatesLost UpdatesSequenced UpdatesHistory
108 Affected by COLLECTOR_DAEMON_HISTORY_SIZE .
109
111 Assume that a machine called condor.example.com is turned off, yet its
112 condor_startd ClassAd does not expire for another 20 minutes. To avoid
113 this machine being matched, an administrator chooses to delete the ma‐
114 chine's condor_startd ClassAd. Create a file (called remove_file in
115 this example) with the three required attributes:
116 MyType = "Query"
118 TargetType = "Machine"
119 Name = "condor.example.com"
120 Requirements = Name == "condor.example.com"
121 This file is used with the command:
123 $ condor_advertise INVALIDATE_STARTD_ADS remove_file
125
127 condor_advertise will exit with a status value of 0 (zero) upon suc‐
128 cess, and it will exit with the value 1 (one) upon failure. Success
129 means that all ClassAds were successfully sent to all condor_collector
130 daemons. When there are multiple ClassAds or multiple condor_collector
131 daemons, it is possible that some but not all publications succeed; in
132 this case, the exit status is 1, indicating failure.
133
135 HTCondor Team
136
138 1990-2023, Center for High Throughput Computing, Computer Sciences De‐
139 partment, University of Wisconsin-Madison, Madison, WI, US. Licensed
140 under the Apache License, Version 2.0.
141 Oct 02, 2023 CONDOR_ADVERTISE(1)