1CONDOR_CONFIG_VAL(1)            HTCondor Manual           CONDOR_CONFIG_VAL(1)
2
3
4

NAME

6       condor_config_val - HTCondor Manual
7
8       Query or set a given HTCondor configuration variable
9
10

SYNOPSIS

12       condor_config_val <help option>
13
14       condor_config_val [<location options>] <edit option>
15
16       condor_config_val [<location options>] [<view options>] vars
17
18       condor_config_val use category [:template_name] [-expand ]
19

DESCRIPTION

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
31       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
38       Each daemon remembers settings made by a successful invocation of  con‐
39       dor_config_val. The configuration file is not modified.
40
41       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
50       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
58       (see DaemonCore Configuration File  Entries),  ENABLE_PERSISTENT_CONFIG
59       (see  DaemonCore  Configuration  File  Entries)  and HOSTALLOW...  (see
60       DaemonCore Configuration File Entries)  in  order  to  use  condor_con‐
61       fig_val to change any configuration variable.
62
63       It is generally wise to test a new configuration on a single machine to
64       ensure that no syntax or other errors in the  configuration  have  been
65       made  before the reconfiguration of many machines. Having bad syntax or
66       invalid configuration settings is a fatal error for  HTCondor  daemons,
67       and  they  will  exit. It is far better to discover such a problem on a
68       single machine than to cause all the HTCondor daemons in  the  pool  to
69       exit. condor_config_val can help with this type of testing.
70

OPTIONS

72          -help  (help option) Print usage information and exit.
73
74          -version
75                 (help  option)  Print  the  HTCondor  version information and
76                 exit.
77
78          -set "var = value"
79                 (edit option) Sets one or more persistent configuration  file
80                 variables.  The new value remains if the daemon is restarted.
81                 One or more variables can be set; the syntax requires  double
82                 quote  marks  to  identify  the  pairing  of variable name to
83                 value, and to permit spaces.
84
85          -unset var
86                 (edit option) Each of the persistent configuration  variables
87                 listed reverts to its previous value.
88
89          -rset "var = value"
90                 (edit  option) Sets one or more configuration file variables.
91                 The new value remains as long as the  daemon  continues  run‐
92                 ning.  One  or more variables can be set; the syntax requires
93                 double quote marks to identify the pairing of  variable  name
94                 to value, and to permit spaces.
95
96          -runset var
97                 (edit  option) Each of the configuration variables listed re‐
98                 verts to its previous value as long as the  daemon  continues
99                 running.
100
101          -summary
102                 (view  option)  For  all  configuration variables that differ
103                 from default value, print out the name and value. The  values
104                 are  grouped  by  the file that last set the variable, and in
105                 the order that they were set in that file.
106
107          -dump  (view option) For  all  configuration  variables  that  match
108                 vars,  display the variables and their values. If no vars are
109                 listed, then display all configuration  variables  and  their
110                 values.  The  values will be raw unless -expand, -default, or
111                 -evaluate are used.
112
113          -default
114                 (view option) Default values are displayed.
115
116          -expand
117                 (view option) Expanded values are displayed. This is the  de‐
118                 fault unless -dump is used.
119
120          -raw   (view option) Raw values are displayed.
121
122          -verbose
123                 (view option) Display configuration file name and line number
124                 where the variable is set, along with the raw, expanded,  and
125                 default values of the variable.
126
127          -debug[:<opts>]
128                 (view  option)  Send output to stderr, overriding a set value
129                 of TOOL_DEBUG.
130
131          -evaluate
132                 (view option) Applied only when a location option specifies a
133                 daemon.  The  value of the requested parameter will be evalu‐
134                 ated with respect to the ClassAd of that daemon.
135
136          -used  (view option) Applied only when a location option specifies a
137                 daemon.  Modifies which variables are displayed to only those
138                 used by the specified daemon.
139
140          -unused
141                 (view option) Applied only when a location option specifies a
142                 daemon.  Modifies which variables are displayed to only those
143                 not used by the specified daemon.
144
145          -config
146                 (view option) Applied only when  the  configuration  is  read
147                 from  files (the default), and not when applied to a specific
148                 daemon. Display the current configuration file that  set  the
149                 variable.
150
151          -writeconfig[:upgrade] filename
152                 (view  option) For the configuration read from files (the de‐
153                 fault), write to file filename all  configuration  variables.
154                 Values  that  are the same as internal, compile-time defaults
155                 will be preceded by the comment character. If the :upgrade  o
156                 ption  is specified, then values that are the same as the in‐
157                 ternal, compile-time defaults are omitted. Variables  are  in
158                 the  same  order as the they were read from the original con‐
159                 figuration files.
160
161          -macro[:path]
162                 (view option) Macro expand the text in vars as the configura‐
163                 tion  language would. You can use expansion functions such as
164                 $F(<var>). If the :path o ption is specified, treat  the  re‐
165                 sult as a path and return the canonical form.
166
167          -mixedcase
168                 (view  option)  Applied  only  when the configuration is read
169                 from files (the default), and not when applied to a  specific
170                 daemon.  Print  variable names with the same letter case used
171                 in the variable's definition.
172
173          -local-name <name>
174                 (view option) Applied only when  the  configuration  is  read
175                 from  files (the default), and not when applied to a specific
176                 daemon. Inspect the  values  of  attributes  that  use  local
177                 names, which is useful to distinguish which daemon when there
178                 is more than one of the particular daemon running.
179
180          -subsystem <daemon>
181                 (view option) Applied only when  the  configuration  is  read
182                 from  files (the default), and not when applied to a specific
183                 daemon. Specifies the subsystem or daemon name to query, with
184                 a default value of the TOOL subsystem.
185
186          -address <ip:port>
187                 (location  option)  Connect  to the given IP address and port
188                 number.
189
190          -pool centralmanagerhostname[:portnumber]
191                 (location option) Use the given central manager  and  an  op‐
192                 tional port number to find daemons.
193
194          -name <machine_name>
195                 (location option) Query the specified machine's condor_master
196                 daemon for its configuration. Does not function together with
197                 any of the options: -dump, -config, or -verbose.
198
199          -master | -schedd | -startd | -collector | -negotiator
200                 (location option) The specific daemon to query.
201
202          use category [:set name ] [-expand ]
203                 Display   information   about  configuration  templates  (see
204                 Configuration Templates).  Specifying only  a  category  will
205                 list the template_names available for that category. Specify‐
206                 ing a category and a template_name will display  the  defini‐
207                 tion  of  that configuration template. Adding the -expand op‐
208                 tion will display the expanded definition (with macro substi‐
209                 tutions).  (-expand  has  no effect if a template_name is not
210                 specified.) Note that there is no dash before  use  and  that
211                 spaces are not allowed next to the colon character separating
212                 category and template_name.
213

EXIT STATUS

215       condor_config_val will exit with a status value of 0 (zero)  upon  suc‐
216       cess, and it will exit with the value 1 (one) upon failure.
217

EXAMPLES

219       Here  is  a set of examples to show a sequence of operations using con‐
220       dor_config_val. To request the condor_schedd daemon on host perdita  to
221       display the value of the MAX_JOBS_RUNNING configuration variable:
222
223          % condor_config_val -name perdita -schedd MAX_JOBS_RUNNING
224          500
225
226       To request the condor_schedd daemon on host perdita to set the value of
227       the MAX_JOBS_RUNNING configuration variable to the value 10.
228
229          % condor_config_val -name perdita -schedd -set "MAX_JOBS_RUNNING = 10"
230          Successfully set configuration "MAX_JOBS_RUNNING = 10" on
231          schedd perdita.cs.wisc.edu <128.105.73.32:52067>.
232
233       A command that will implement the change just set in the previous exam‐
234       ple.
235
236          % condor_reconfig -schedd perdita
237          Sent "Reconfig" command to schedd perdita.cs.wisc.edu
238
239       A  re-check  of  the  configuration variable reflects the change imple‐
240       mented:
241
242          % condor_config_val -name perdita -schedd MAX_JOBS_RUNNING
243          10
244
245       To set the configuration variable MAX_JOBS_RUNNING back to what it  was
246       before the command to set it to 10:
247
248          % condor_config_val -name perdita -schedd -unset MAX_JOBS_RUNNING
249          Successfully unset configuration "MAX_JOBS_RUNNING" on
250          schedd perdita.cs.wisc.edu <128.105.73.32:52067>.
251
252       A command that will implement the change just set in the previous exam‐
253       ple.
254
255          % condor_reconfig -schedd perdita
256          Sent "Reconfig" command to schedd perdita.cs.wisc.edu
257
258       A re-check of the configuration variable  reflects  that  variable  has
259       gone back to is value before initial set of the variable:
260
261          % condor_config_val -name perdita -schedd MAX_JOBS_RUNNING
262          500
263
264       Getting  a  list  of template_names for the role configuration template
265       category:
266
267          % condor_config_val use role
268          use ROLE accepts
269            CentralManager
270            Execute
271            Personal
272            Submit
273
274       Getting the definition of role:personal configuration template:
275
276          % condor_config_val use role:personal
277          use ROLE:Personal is
278              CONDOR_HOST=127.0.0.1
279          COLLECTOR_HOST=$(CONDOR_HOST):0
280          DAEMON_LIST=MASTER COLLECTOR NEGOTIATOR STARTD SCHEDD
281          RunBenchmarks=0
282

AUTHOR

284       HTCondor Team
285
287       1990-2022, Center for High Throughput Computing, Computer Sciences  De‐
288       partment,  University  of  Wisconsin-Madison, Madison, WI, US. Licensed
289       under the Apache License, Version 2.0.
290
291
292
293
2948.8                              Jun 13, 2022             CONDOR_CONFIG_VAL(1)
Impressum