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 /admin-manual/security sec‐
54       tion for more details on security settings. Further, security consider‐
55       ations  require proper settings of configuration variables SETTABLE_AT‐
56       TRS_<PERMISSION-LEVEL>
57
58       (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  HOSTALLOW...
61       (see  admin-manual/configuration-macros:daemoncore  configuration  file
62       entries) in order to use condor_config_val to change any  configuration
63       variable.
64
65       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

OPTIONS

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

EXIT STATUS

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

EXAMPLES

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

AUTHOR

286       HTCondor Team
287
289       1990-2021, Center for High Throughput Computing, Computer Sciences  De‐
290       partment,  University  of  Wisconsin-Madison, Madison, WI, US. Licensed
291       under the Apache License, Version 2.0.
292
293
294
295
2968.8                              Jan 26, 2021             CONDOR_CONFIG_VAL(1)
Impressum