HTCondor Version 24.0.2 Manual
The HTCondor Software Suite (HTCSS) is a software system that creates a High-Throughput Computing (HTC) environment. This environment might be a single cluster, a set of related clusters on a campus, cloud resources, or national or international federations of computers.
If you are a user of HTCondor, and have been given a login or credentials to use a batch scheduler on an Access Point (sometimes called a scheduler or login node), you may want to read our Quick Start guide here: Users’ Quick Start Guide
If you are a beginning administrator of HTCondor, or want to install it for the first time, please look at our installation guide here: Downloading and Installing
Otherwise, for users of HTCondor who want more information, a complete user’s reference manual is here: Users’ Manual, and a similar complete reference for administrators of HTCondor can be found here: Administrators’ Manual
HTCondor contains many command line tools, each with a traditional Unix “man-page”. These may be found here: Commands Reference (man pages)
Finally, for users writing Python interfaces to HTCondor, our Python API documentation is here: Python Bindings
A complete table of contents follows.
Manual built on November 26, 2024
Quick start guides
Reference Manuals
- Users’ Manual
- Introduction to HTCondor
- Running a Job: the Steps To Take
- Submitting a Job
- Submitting Jobs Without a Shared File System: HTCondor’s File Transfer Mechanism
- Managing a Job
- Automatically managing a job
- How To Debug an Always Idle Job
- Choosing an HTCondor Universe
- Environment and services for a running job
- Job Scheduling
- Job Sets
- Self-Checkpointing Applications
- Submitting to a Remote AP
- Chirp: custom updates to the AP
- Special Environment Considerations
- Bringing Your Own Resources
- Administrators’ Manual
- Introduction
- Starting Up, Shutting Down and Reconfiguring the System
- Introduction to Configuration
- Configuration Macros
- Configuration for Execution Points
- Configuration for Access Points
- Configuration for Central Managers
- Security
- Networking, Port Usage, and CCB
- Files, Directories and Logs
- Third Party/Delegated file, credential and checkpoint transfer
- ClassAds
- DAGMan Workflows
- Python Bindings
Additional Docs
Reference, Glossary and Index
- Commands Reference (man pages)
- HTCondor’s ClassAd Mechanism
- classad_eval
- condor_adstash
- condor_advertise
- condor_annex
- condor_check_password
- condor_check_userlogs
- condor_chirp
- condor_configure
- condor_config_val
- condor_continue
- condor_dagman
- condor_drain
- condor_evicted_files
- condor_fetchlog
- condor_findhost
- condor_gather_info
- condor_gpu_discovery
- condor_history
- condor_hold
- condor_install
- condor_job_router_info
- condor_master
- condor_now
- condor_off
- condor_on
- condor_ping
- condor_pool_job_report
- condor_power
- condor_preen
- condor_prio
- condor_procd
- condor_q
- condor_qedit
- condor_qusers
- condor_qsub
- condor_reconfig
- condor_release
- condor_remote_cluster
- condor_reschedule
- condor_restart
- condor_rm
- condor_rmdir
- condor_router_history
- condor_router_q
- condor_router_rm
- condor_run
- condor_set_shutdown
- condor_sos
- condor_ssh_start
- condor_ssh_to_job
- condor_ssl_fingerprint
- condor_stats
- condor_status
- condor_store_cred
- condor_submit
- condor_submit_dag
- condor_suspend
- condor_tail
- condor_test_token
- condor_token_create
- condor_token_fetch
- condor_token_list
- condor_token_request
- condor_token_request_approve
- condor_token_request_auto_approve
- condor_token_request_list
- condor_top
- condor_transfer_data
- condor_transform_ads
- condor_update_machine_ad
- condor_updates_stats
- condor_upgrade_check
- condor_urlfetch
- condor_userlog
- condor_userprio
- condor_vacate
- condor_vacate_job
- condor_version
- condor_wait
- condor_watch_q
- condor_who
- get_htcondor
- gidd_alloc
- htcondor
- procd_ctl
- ClassAd Attributes
- ClassAd Types
- Accounting ClassAd Attributes
- Job ClassAd Attributes
- Machine ClassAd Attributes
- DaemonMaster ClassAd Attributes
- Scheduler ClassAd Attributes
- Negotiator ClassAd Attributes
- Submitter ClassAd Attributes
- Defrag ClassAd Attributes
- Grid ClassAd Attributes
- Collector ClassAd Attributes
- ClassAd Attributes Added by the condor_collector
- DaemonCore Statistics Attributes
- Codes and Other Needed Values
- Glossary
- Index
Licensing and Copyright
HTCondor is released under the Apache License, Version 2.0.
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/
Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
For complete information and additional license notices see http://htcondor.org/license.html.