This is an outdated version of the HTCondor Manual. You can find current documentation at http://htcondor.org/manual.
next up previous contents index
Next: condor_configure Up: 12. Command Reference Manual Previous: condor_compile   Contents   Index

Subsections


condor_config_val

Query or set a given HTCondor configuration variable

Synopsis

condor_config_val <help option>

condor_config_val [<location options>] <edit option>

condor_config_val [<location options>] [<view options>] vars

condor_config_val use category[:template_name] [-expand]

Description

condor_config_val can be used to quickly see what the current HTCondor configuration is on any given machine. Given a space separated set of configuration variables with the vars argument, condor_config_val will report what each of these variables is currently set to. If a given variable is not defined, condor_config_val will halt on that variable, and report that it is not defined. By default, condor_config_val looks in the local machine's configuration files in order to evaluate the variables. Variables and values may instead be queried from a daemon specified using a location option.

Raw output of condor_config_val displays the string used to define the configuration variable. This is what is on the right hand side of the equals sign (=) in a configuration file for a variable. The default output is an expanded one. Expanded output recursively replaces any macros within the raw definition of a variable with the macro's raw definition.

Each daemon remembers settings made by a successful invocation of condor_config_val. The configuration file is not modified.

condor_config_val can be used to persistently set or unset configuration variables for a specific daemon on a given machine using a -set or -unset edit option. Persistent settings remain when the daemon is restarted. Configuration variables for a specific daemon on a given machine may be set or unset for the time period that the daemon continues to run using a -rset or -runset edit option. These runtime settings will override persistent settings until the daemon is restarted. Any changes made will not take effect until condor_reconfig is invoked.

In general, modifying a host's configuration with condor_config_val requires the CONFIG access level, which is disabled on all hosts by default. Administrators have more fine-grained control over which access levels can modify which settings. See section 3.5.24 on page [*] for more details on security settings. Further, security considerations require proper settings of configuration variables SETTABLE_ATTRS_<PERMISSION-LEVEL> (see 3.5.3), ENABLE_PERSISTENT_CONFIG (see 3.5.3), and HOSTALLOW... (see 3.5.3) in order to use condor_config_val to change any configuration variable.

It is generally wise to test a new configuration on a single machine to ensure that no syntax or other errors in the configuration have been made before the reconfiguration of many machines. Having bad syntax or invalid configuration settings is a fatal error for HTCondor daemons, and they will exit. It is far better to discover such a problem on a single machine than to cause all the HTCondor daemons in the pool to exit. condor_config_val can help with this type of testing.

Options

-help
(help option) Print usage information and exit.
-version
(help option) Print the HTCondor version information and exit.
-set "var = value"
(edit option) Sets one or more persistent configuration file variables. The new value remains if the daemon is restarted. One or more variables can be set; the syntax requires double quote marks to identify the pairing of variable name to value, and to permit spaces.
-unset var
(edit option) Each of the persistent configuration variables listed reverts to its previous value.
-rset "var = value"
(edit option) Sets one or more configuration file variables. The new value remains as long as the daemon continues running. One or more variables can be set; the syntax requires double quote marks to identify the pairing of variable name to value, and to permit spaces.
-runset var
(edit option) Each of the configuration variables listed reverts to its previous value as long as the daemon continues running.
-dump
(view option) Display the raw value of all vars listed. If no vars are listed, then print all configuration variables and their values. The -expand, -default, and -evaluate options take precedence over this -dump option, such that the output will not be raw.
-default
(view option) Default values are displayed.
-expand
(view option) Expanded values are displayed. This is the default.
-raw
(view option) Raw values are displayed.
-verbose
(view option) Display configuration file name and line number where the variable is set, along with the raw, expanded, and default values of the variable.
-debug[:<opts>]
(view option) Send output to stderr, overriding a set value of TOOL_DEBUG.
-evaluate
(view option) Applied only when a location option specifies a daemon. The value of the requested parameter will be evaluated with respect to the ClassAd of that daemon.
-used
(view option) Applied only when a location option specifies a daemon. Modifies which variables are displayed to only those used by the specified daemon.
-unused
(view option) Applied only when a location option specifies a daemon. Modifies which variables are displayed to only those not used by the specified daemon.
-config
(view option) Applied only when the configuration is read from files (the default), and not when applied to a specific daemon. Display the current configuration file that set the variable.
-writeconfig[:upgrade] filename
(view option) For the configuration read from files (the default), write to file filename all configuration variables. Values that are the same as internal, compile-time defaults will be preceded by the comment character. If the :upgrade option is specified, then values that are the same as the internal, compile-time defaults are omitted. Variables are in the same order as the they were read from the original configuration files.
-mixedcase
(view option) Applied only when the configuration is read from files (the default), and not when applied to a specific daemon. Print variable names with the same letter case used in the variable's definition.
-local-name <name>
(view option) Applied only when the configuration is read from files (the default), and not when applied to a specific daemon. Inspect the values of attributes that use local names, which is useful to distinguish which daemon when there is more than one of the particular daemon running.
-subsystem <daemon>
(view option) Applied only when the configuration is read from files (the default), and not when applied to a specific daemon. Specifies the subsystem or daemon name to query, with a default value of the TOOL subsystem.
-address $<$ip:port$>$
(location option) Connect to the given IP address and port number.
-pool centralmanagerhostname[:portnumber]
(location option) Use the given central manager and an optional port number to find daemons.
-name <machine_name>
(location option) Query the specified machine's condor_master daemon for its configuration. Does not function together with any of the options: -dump, -config, or -verbose.
-master | -schedd | -startd | -collector | -negotiator
(location option) The specific daemon to query.
use category[:set name] [-expand]
Display information about configuration templates (see  3.4). Specifying only a category will list the template_names available for that category. Specifying a category and a template_name will display the definition of that configuration template. Adding the -expand option will display the expanded definition (with macro substitutions). (-expand has no effect if a template_name is not specified.) Note that there is no dash before use and that spaces are not allowed next to the colon character separating category and template_name.

Exit Status

condor_config_val will exit with a status value of 0 (zero) upon success, and it will exit with the value 1 (one) upon failure.

Examples

Here is a set of examples to show a sequence of operations using condor_config_val. To request the condor_schedd daemon on host perdita to display the value of the MAX_JOBS_RUNNING configuration variable:

   % condor_config_val -name perdita -schedd MAX_JOBS_RUNNING
   500

To request the condor_schedd daemon on host perdita to set the value of the MAX_JOBS_RUNNING configuration variable to the value 10.

   % condor_config_val -name perdita -schedd -set "MAX_JOBS_RUNNING = 10"
   Successfully set configuration "MAX_JOBS_RUNNING = 10" on 
   schedd perdita.cs.wisc.edu <128.105.73.32:52067>.

A command that will implement the change just set in the previous example.

   % condor_reconfig -schedd perdita
   Sent "Reconfig" command to schedd perdita.cs.wisc.edu

A re-check of the configuration variable reflects the change implemented:

   % condor_config_val -name perdita -schedd MAX_JOBS_RUNNING
   10

To set the configuration variable MAX_JOBS_RUNNING back to what it was before the command to set it to 10:

   % condor_config_val -name perdita -schedd -unset MAX_JOBS_RUNNING
   Successfully unset configuration "MAX_JOBS_RUNNING" on 
   schedd perdita.cs.wisc.edu <128.105.73.32:52067>.

A command that will implement the change just set in the previous example.

   % condor_reconfig -schedd perdita
   Sent "Reconfig" command to schedd perdita.cs.wisc.edu

A re-check of the configuration variable reflects that variable has gone back to is value before initial set of the variable:

   % condor_config_val -name perdita -schedd MAX_JOBS_RUNNING
   500

Getting a list of template_names for the role configuration template category:

   % condor_config_val use role
   use ROLE accepts
     CentralManager
     Execute
     Personal
     Submit

Getting the definition of role:personal configuration template:

   % condor_config_val use role:personal
   use ROLE:Personal is
   	   CONDOR_HOST=127.0.0.1
	   COLLECTOR_HOST=$(CONDOR_HOST):0
	   DAEMON_LIST=MASTER COLLECTOR NEGOTIATOR STARTD SCHEDD
	   RunBenchmarks=0

Author

Center for High Throughput Computing, University of Wisconsin-Madison

Copyright

Copyright © 1990-2017 Center for High Throughput Computing, Computer Sciences Department, University of Wisconsin-Madison, Madison, WI. All Rights Reserved. Licensed under the Apache License, Version 2.0.
next up previous contents index
Next: condor_configure Up: 12. Command Reference Manual Previous: condor_compile   Contents   Index