1CONDOR_CONFIG_VAL(1) HTCondor Manual CONDOR_CONFIG_VAL(1)
2
6 condor_config_val - HTCondor Manual
7 Query or set a given HTCondor configuration variable
9
12 condor_config_val <help option>
13 condor_config_val [<location options> ] <edit option>
15 condor_config_val [<location options> ] [<view options> ] vars
17 condor_config_val use category [:template_name ] [-expand ]
19
21 condor_config_val can be used to quickly see what the current HTCondor
22 configuration is on any given machine. Given a space separated set of
23 configuration variables with the vars argument, condor_config_val will
24 report what each of these variables is currently set to. If a given
25 variable is not defined, condor_config_val will halt on that variable,
26 and report that it is not defined. By default, condor_config_val looks
27 in the local machine's configuration files in order to evaluate the
28 variables. Variables and values may instead be queried from a daemon
29 specified using a location option.
30 Raw output of condor_config_val displays the string used to define the
32 configuration variable. This is what is on the right hand side of the
33 equals sign (=) in a configuration file for a variable. The default
34 output is an expanded one. Expanded output recursively replaces any
35 macros within the raw definition of a variable with the macro's raw
36 definition.
37 Each daemon remembers settings made by a successful invocation of con‐
39 dor_config_val. The configuration file is not modified.
40 condor_config_val can be used to persistently set or unset configura‐
42 tion variables for a specific daemon on a given machine using a -set or
43 -unset edit option. Persistent settings remain when the daemon is
44 restarted. Configuration variables for a specific daemon on a given ma‐
45 chine may be set or unset for the time period that the daemon continues
46 to run using a -rset or -runset edit option. These runtime settings
47 will override persistent settings until the daemon is restarted. Any
48 changes made will not take effect until condor_reconfig is invoked.
49 In general, modifying a host's configuration with condor_config_val re‐
51 quires the CONFIG access level, which is disabled on all hosts by de‐
52 fault. Administrators have more fine-grained control over which access
53 levels can modify which settings. See the Security section for more de‐
54 tails on security settings. Further, security considerations require
55 proper settings of configuration variables SETTABLE_ATTRS_<PERMIS‐
56 SION-LEVEL>
57 (see admin-manual/configuration-macros:daemoncore configuration file
59 entries), ENABLE_PERSISTENT_CONFIG (see admin-manual/configura‐
60 tion-macros:daemoncore configuration file entries) and ALLOW... (see
61 admin-manual/configuration-macros:daemoncore configuration file en‐
62 tries) in order to use condor_config_val to change any configuration
63 variable.
64 It is generally wise to test a new configuration on a single machine to
66 ensure that no syntax or other errors in the configuration have been
67 made before the reconfiguration of many machines. Having bad syntax or
68 invalid configuration settings is a fatal error for HTCondor daemons,
69 and they will exit. It is far better to discover such a problem on a
70 single machine than to cause all the HTCondor daemons in the pool to
71 exit. condor_config_val can help with this type of testing.
72
74 -help (help option) Print usage information and exit.
75 -version
77 (help option) Print the HTCondor version information and
78 exit.
79 -set "var = value"
81 (edit option) Sets one or more persistent configuration file
82 variables. The new value remains if the daemon is restarted.
83 One or more variables can be set; the syntax requires double
84 quote marks to identify the pairing of variable name to
85 value, and to permit spaces.
86 -unset var
88 (edit option) Each of the persistent configuration variables
89 listed reverts to its previous value.
90 -rset "var = value"
92 (edit option) Sets one or more configuration file variables.
93 The new value remains as long as the daemon continues run‐
94 ning. One or more variables can be set; the syntax requires
95 double quote marks to identify the pairing of variable name
96 to value, and to permit spaces.
97 -runset var
99 (edit option) Each of the configuration variables listed re‐
100 verts to its previous value as long as the daemon continues
101 running.
102 -summary[:detected]
104 (view option) For all configuration variables that differ
105 from default value, print out the name and value. The values
106 are grouped by the file that last set the variable, and in
107 the order that they were set in that file. If the detected
108 option is added, then variables such as $(OPSYSANDVER) that
109 are detected at runtime are included in the ouput.
110 -dump (view option) For all configuration variables that match
112 vars, display the variables and their values. If no vars are
113 listed, then display all configuration variables and their
114 values. The values will be raw unless -expand, -default, or
115 -evaluate are used.
116 -default
118 (view option) Default values are displayed.
119 -expand
121 (view option) Expanded values are displayed. This is the de‐
122 fault unless -dump is used.
123 -raw (view option) Raw values are displayed.
125 -verbose
127 (view option) Display configuration file name and line number
128 where the variable is set, along with the raw, expanded, and
129 default values of the variable.
130 -debug[:<opts>]
132 (view option) Send output to stderr, overriding a set value
133 of TOOL_DEBUG.
134 -evaluate
136 (view option) Applied only when a location option specifies a
137 daemon. The value of the requested parameter will be evalu‐
138 ated with respect to the ClassAd of that daemon.
139 -used (view option) Applied only when a location option specifies a
141 daemon. Modifies which variables are displayed to only those
142 used by the specified daemon.
143 -unused
145 (view option) Applied only when a location option specifies a
146 daemon. Modifies which variables are displayed to only those
147 not used by the specified daemon.
148 -config
150 (view option) Applied only when the configuration is read
151 from files (the default), and not when applied to a specific
152 daemon. Display the current configuration file that set the
153 variable.
154 -writeconfig[:upgrade] filename
156 (view option) For the configuration read from files (the de‐
157 fault), write to file filename all configuration variables.
158 Values that are the same as internal, compile-time defaults
159 will be preceded by the comment character. If the :upgrade o
160 ption is specified, then values that are the same as the in‐
161 ternal, compile-time defaults are omitted. Variables are in
162 the same order as the they were read from the original con‐
163 figuration files.
164 -macro[:path]
166 (view option) Macro expand the text in vars as the configura‐
167 tion language would. You can use expansion functions such as
168 $F(<var>). If the :path o ption is specified, treat the re‐
169 sult as a path and return the canonical form.
170 -mixedcase
172 (view option) Applied only when the configuration is read
173 from files (the default), and not when applied to a specific
174 daemon. Print variable names with the same letter case used
175 in the variable's definition.
176 -local-name <name>
178 (view option) Applied only when the configuration is read
179 from files (the default), and not when applied to a specific
180 daemon. Inspect the values of attributes that use local
181 names, which is useful to distinguish which daemon when there
182 is more than one of the particular daemon running.
183 -subsystem <daemon>
185 (view option) Applied only when the configuration is read
186 from files (the default), and not when applied to a specific
187 daemon. Specifies the subsystem or daemon name to query, with
188 a default value of the TOOL subsystem.
189 -address <ip:port>
191 (location option) Connect to the given IP address and port
192 number.
193 -pool centralmanagerhostname[:portnumber]
195 (location option) Use the given central manager and an op‐
196 tional port number to find daemons.
197 -name <machine_name>
199 (location option) Query the specified machine's condor_master
200 daemon for its configuration. Does not function together with
201 any of the options: -dump, -config, or -verbose.
202 -master | -schedd | -startd | -collector | -negotiator
204 (location option) The specific daemon to query.
205 use category [:set name ] [-expand ]
207 Display information about configuration templates (see
208 Configuration Templates). Specifying only a category will
209 list the template_names available for that category. Specify‐
210 ing a category and a template_name will display the defini‐
211 tion of that configuration template. Adding the -expand op‐
212 tion will display the expanded definition (with macro substi‐
213 tutions). (-expand has no effect if a template_name is not
214 specified.) Note that there is no dash before use and that
215 spaces are not allowed next to the colon character separating
216 category and template_name.
217
219 condor_config_val will exit with a status value of 0 (zero) upon suc‐
220 cess, and it will exit with the value 1 (one) upon failure.
221
223 Here is a set of examples to show a sequence of operations using con‐
224 dor_config_val. To request the condor_schedd daemon on host perdita to
225 display the value of the MAX_JOBS_RUNNING configuration variable:
226 $ condor_config_val -name perdita -schedd MAX_JOBS_RUNNING
228 500
229 To request the condor_schedd daemon on host perdita to set the value of
231 the MAX_JOBS_RUNNING configuration variable to the value 10.
232 $ condor_config_val -name perdita -schedd -set "MAX_JOBS_RUNNING = 10"
234 Successfully set configuration "MAX_JOBS_RUNNING = 10" on
235 schedd perdita.cs.wisc.edu <128.105.73.32:52067>.
236 A command that will implement the change just set in the previous exam‐
238 ple.
239 $ condor_reconfig -schedd perdita
241 Sent "Reconfig" command to schedd perdita.cs.wisc.edu
242 A re-check of the configuration variable reflects the change imple‐
244 mented:
245 $ condor_config_val -name perdita -schedd MAX_JOBS_RUNNING
247 10
248 To set the configuration variable MAX_JOBS_RUNNING back to what it was
250 before the command to set it to 10:
251 $ condor_config_val -name perdita -schedd -unset MAX_JOBS_RUNNING
253 Successfully unset configuration "MAX_JOBS_RUNNING" on
254 schedd perdita.cs.wisc.edu <128.105.73.32:52067>.
255 A command that will implement the change just set in the previous exam‐
257 ple.
258 $ condor_reconfig -schedd perdita
260 Sent "Reconfig" command to schedd perdita.cs.wisc.edu
261 A re-check of the configuration variable reflects that variable has
263 gone back to is value before initial set of the variable:
264 $ condor_config_val -name perdita -schedd MAX_JOBS_RUNNING
266 500
267 Getting a list of template_names for the role configuration template
269 category:
270 $ condor_config_val use role
272 use ROLE accepts
273 CentralManager
274 Execute
275 Personal
276 Submit
277 Getting the definition of role:personal configuration template:
279 $ condor_config_val use role:personal
281 use ROLE:Personal is
282 CONDOR_HOST=127.0.0.1
283 COLLECTOR_HOST=$(CONDOR_HOST):0
284 DAEMON_LIST=MASTER COLLECTOR NEGOTIATOR STARTD SCHEDD
285 RunBenchmarks=0
286
288 HTCondor Team
289
291 1990-2023, Center for High Throughput Computing, Computer Sciences De‐
292 partment, University of Wisconsin-Madison, Madison, WI, US. Licensed
293 under the Apache License, Version 2.0.
294 Oct 02, 2023 CONDOR_CONFIG_VAL(1)