1condor_config_val(1)        General Commands Manual       condor_config_val(1)
2
3
4

Name

6       condor_config_valQuery or set a given HTCondor configuration variable
7

Synopsis

9       condor_config_val<help option>
10
11       condor_config_val[<location options>] <edit option>
12
13       condor_config_val[<location options>] [<view options>] vars
14
15       condor_config_valusecategory[:template_name] [-expand]
16

Description

18       condor_config_valcan  be  used to quickly see what the current HTCondor
19       configuration is on any given machine. Given a space separated  set  of
20       configuration  variables  with  the varsargument, condor_config_valwill
21       report what each of these variables is currently set  to.  If  a  given
22       variable  is  not defined, condor_config_valwill halt on that variable,
23       and report that it is not defined. By  default,  condor_config_vallooks
24       in  the  local  machine's  configuration files in order to evaluate the
25       variables. Variables and values may instead be queried  from  a  daemon
26       specified using a location option.
27
28       Rawoutput  of  condor_config_valdisplays  the string used to define the
29       configuration variable. This is what is on the right hand side  of  the
30       equals  sign  (=)  in  a configuration file for a variable. The default
31       output is an expandedone.  Expanded  output  recursively  replaces  any
32       macros  within  the  raw  definition of a variable with the macro's raw
33       definition.
34
35       Each daemon remembers settings made by a successful invocation of  con‐
36       dor_config_val. The configuration fileis not modified.
37
38       condor_config_valcan be used to persistently set or unset configuration
39       variables for a specific daemon on  a  given  machine  using  a  -setor
40       -unsetedit  option.  Persistent  settings  remain  when  the  daemon is
41       restarted. Configuration variables for a specific  daemon  on  a  given
42       machine may be set or unset for the time period that the daemon contin‐
43       ues to run using a -rsetor -runsetedit option. These  runtime  settings
44       will  override  persistent  settings until the daemon is restarted. Any
45       changes made will not take effect until condor_reconfigis invoked.
46
47       In general, modifying a host's configuration with  condor_config_valre‐
48       quires  the  CONFIGaccess  level,  which  is  disabled  on all hosts by
49       default. Administrators  have  more  fine-grained  control  over  which
50       access  levels  can modify which settings. See section on page for more
51       details on security settings. Further, security considerations  require
52       proper  settings of configuration variables SETTABLE_ATTRS_<PERMISSION-
53       LEVEL>(see ), ENABLE_PERSISTENT_CONFIG(see ), and HOSTALLOW...(see ) in
54       order to use condor_config_valto change any configuration variable.
55
56       It is generally wise to test a new configuration on a single machine to
57       ensure that no syntax or other errors in the  configuration  have  been
58       made  before the reconfiguration of many machines. Having bad syntax or
59       invalid configuration settings is a fatal error for  HTCondor  daemons,
60       and  they  will  exit. It is far better to discover such a problem on a
61       single machine than to cause all the HTCondor daemons in  the  pool  to
62       exit. condor_config_valcan help with this type of testing.
63

Options

65       -help
66
67          (help option) Print usage information and exit.
68
69
70
71       -version
72
73          (help option) Print the HTCondor version information and exit.
74
75
76
77       -set var = value
78
79          (edit  option)  Sets one or more persistent configuration file vari‐
80          ables. The new value remains if the daemon is restarted. One or more
81          variables  can  be  set;  the  syntax requires double quote marks to
82          identify the pairing of variable name to value, and to  permit  spa‐
83          ces.
84
85
86
87       -unset var
88
89          (edit  option) Each of the persistent configuration variables listed
90          reverts to its previous value.
91
92
93
94       -rset var = value
95
96          (edit option) Sets one or more configuration file variables. The new
97          value  remains  as long as the daemon continues running. One or more
98          variables can be set; the syntax  requires  double  quote  marks  to
99          identify  the  pairing of variable name to value, and to permit spa‐
100          ces.
101
102
103
104       -runset var
105
106          (edit option) Each of the configuration variables listed reverts  to
107          its previous value as long as the daemon continues running.
108
109
110
111       -dump
112
113          (view  option) For all configuration variables that match vars, dis‐
114          play the variables and their values. If no varsare listed, then dis‐
115          play  all  configuration variables and their values. The values will
116          be raw unless -expand, -default, or -evaluateare used.
117
118
119
120       -default
121
122          (view option) Default values are displayed.
123
124
125
126       -expand
127
128          (view option) Expanded values are displayed.  This  is  the  default
129          unless -dump is used.
130
131
132
133       -raw
134
135          (view option) Raw values are displayed.
136
137
138
139       -verbose
140
141          (view  option) Display configuration file name and line number where
142          the variable is set, along with the raw, expanded, and default  val‐
143          ues of the variable.
144
145
146
147       -debug[:<opts>]
148
149          (view  option)  Send  output  to  stderr,  overriding a set value of
150          TOOL_DEBUG.
151
152
153
154       -evaluate
155
156          (view option) Applied only when a location optionspecifies a daemon.
157          The  value of the requested parameter will be evaluated with respect
158          to the ClassAd of that daemon.
159
160
161
162       -used
163
164          (view option) Applied only when a location optionspecifies a daemon.
165          Modifies  which  variables  are  displayed to only those used by the
166          specified daemon.
167
168
169
170       -unused
171
172          (view option) Applied only when a location optionspecifies a daemon.
173          Modifies  which variables are displayed to only those notused by the
174          specified daemon.
175
176
177
178       -config
179
180          (view option) Applied only when the configuration is read from files
181          (the default), and notwhen applied to a specific daemon. Display the
182          current configuration file that set the variable.
183
184
185
186       -writeconfig[:upgrade] filename
187
188          (view option) For the configuration read from files  (the  default),
189          write  to  file filenameall configuration variables. Values that are
190          the same as internal, compile-time defaults will be preceded by  the
191          comment  character. If the :upgrade option is specified, then values
192          that are the same as the internal, compile-time defaults  are  omit‐
193          ted.  Variables are in the same order as the they were read from the
194          original configuration files.
195
196
197
198       -macro[:path]
199
200          (view option) Macro expand the text in varsas the configuration lan‐
201          guage  would.  You can use expansion functions such as $F(<var>). If
202          the :path option is specified, treat the result as a path and return
203          the canonical form.
204
205
206
207       -mixedcase
208
209          (view option) Applied only when the configuration is read from files
210          (the default), and notwhen applied to a specific daemon. Print vari‐
211          able  names with the same letter case used in the variable's defini‐
212          tion.
213
214
215
216       -local-name <name>
217
218          (view option) Applied only when the configuration is read from files
219          (the default), and notwhen applied to a specific daemon. Inspect the
220          values of attributes that use local names, which is useful  to  dis‐
221          tinguish  which daemon when there is more than one of the particular
222          daemon running.
223
224
225
226       -subsystem <daemon>
227
228          (view option) Applied only when the configuration is read from files
229          (the  default),  and notwhen applied to a specific daemon. Specifies
230          the subsystem or daemon name to query, with a default value  of  the
231          TOOLsubsystem.
232
233
234
235       -address <ip:port>
236
237          (location option) Connect to the given IP address and port number.
238
239
240
241       -pool centralmanagerhostname[:portnumber]
242
243          (location option) Use the given central manager and an optional port
244          number to find daemons.
245
246
247
248       -name <machine_name>
249
250          (location option) Query the specified machine's  condor_masterdaemon
251          for  its  configuration.  Does not function together with any of the
252          options: -dump, -config, or -verbose.
253
254
255
256       -master | -schedd | -startd | -collector | -negotiator
257
258          (location option) The specific daemon to query.
259
260
261
262       usecategory[:set name] [-expand]
263
264          Display information about configuration templates (see  ).  Specify‐
265          ing  only  a  categorywill list the template_namesavailable for that
266          category. Specifying a categoryand a template_namewill  display  the
267          definition  of that configuration template. Adding the -expandoption
268          will display the expanded  definition  (with  macro  substitutions).
269          (-expandhas no effect if a template_nameis not specified.) Note that
270          there is no dash before useand that spaces are not allowed  next  to
271          the colon character separating categoryand template_name.
272
273
274
275
276

Exit Status

278       condor_config_valwill  exit  with  a status value of 0 (zero) upon suc‐
279       cess, and it will exit with the value 1 (one) upon failure.
280

Examples

282       Here is a set of examples to show a sequence of operations  using  con‐
283       dor_config_val.  To  request the condor_schedddaemon on host perdita to
284       display the value of the MAX_JOBS_RUNNINGconfiguration variable:
285
286          % condor_config_val -name perdita -schedd MAX_JOBS_RUNNING
287          500
288
289       To request the condor_schedddaemon on host perdita to set the value  of
290       the MAX_JOBS_RUNNINGconfiguration variable to the value 10.
291
292          %  condor_config_val  -name perdita -schedd -set "MAX_JOBS_RUNNING =
293       10"
294          Successfully set configuration "MAX_JOBS_RUNNING = 10" on
295          schedd perdita.cs.wisc.edu <128.105.73.32:52067>.
296
297       A command that will implement the change just set in the previous exam‐
298       ple.
299
300          % condor_reconfig -schedd perdita
301          Sent "Reconfig" command to schedd perdita.cs.wisc.edu
302
303       A  re-check  of  the  configuration variable reflects the change imple‐
304       mented:
305
306          % condor_config_val -name perdita -schedd MAX_JOBS_RUNNING
307          10
308
309       To set the configuration variable MAX_JOBS_RUNNINGback to what  it  was
310       before the command to set it to 10:
311
312          % condor_config_val -name perdita -schedd -unset MAX_JOBS_RUNNING
313          Successfully unset configuration "MAX_JOBS_RUNNING" on
314          schedd perdita.cs.wisc.edu <128.105.73.32:52067>.
315
316       A command that will implement the change just set in the previous exam‐
317       ple.
318
319          % condor_reconfig -schedd perdita
320          Sent "Reconfig" command to schedd perdita.cs.wisc.edu
321
322       A re-check of the configuration variable  reflects  that  variable  has
323       gone back to is value before initial set of the variable:
324
325          % condor_config_val -name perdita -schedd MAX_JOBS_RUNNING
326          500
327
328       Getting  a  list  of  template_names for the roleconfiguration template
329       category:
330
331          % condor_config_val use role
332          use ROLE accepts
333            CentralManager
334            Execute
335            Personal
336            Submit
337
338       Getting the definition of role:personalconfiguration template:
339
340          % condor_config_val use role:personal
341          use ROLE:Personal is
342              CONDOR_HOST=127.0.0.1
343           COLLECTOR_HOST=$(CONDOR_HOST):0
344           DAEMON_LIST=MASTER COLLECTOR NEGOTIATOR STARTD SCHEDD
345           RunBenchmarks=0
346

Author

348       Center for High Throughput Computing, University of Wisconsin-Madison
349
351       Copyright (C) 1990-2019 Center for High Throughput Computing,  Computer
352       Sciences  Department, University of Wisconsin-Madison, Madison, WI. All
353       Rights Reserved. Licensed under the Apache License, Version 2.0.
354
355
356
357                                     date                 condor_config_val(1)
Impressum