`htcondor2` Enumerations

class htcondor2.AdType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

An enumeration of known ad types.

Any: Matches any type of ad.

Generic

Slot: Slot ads, produced by the condor_startd daemon. Used for matchmaking.

StartDaemon: Ads about the condor_startd daemon itself. Used for location requests and monitoring.

Startd: Either type of ad produced by the condor_startd daemon. Used for backwards compatibility. Use AdType.Slot or AdType.StartDaemon to be explicit.

StartdPrivate

Schedd

Master

Collector

Negotiator

Submitter

Grid

HAD

License

Credd

Defrag

Accounting

class htcondor2.CompletionType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

An enumeration of what a startd can do when it finishes draining.

Nothing: The startd will remain in draining state.

Resume: The startd will start accepting jobs again.

Exit: The startd will exit, and ask the master not to restart it automatically.

Restart: The startd will restart. Many startd configuration changes require a restart to take effect.

Reconfig: The startd will reconfig. Some startd configuration changes, including the START expression, do not require a restart to take effect.

class htcondor2.CredType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

An enumeration of the types of credentials that a condor_credd can manage.

Password: On Windows, HTCondor can only impersonate a user whose password is in the condor_credd.

Kerberos: HTCondor can manage Kerberos credentials, forwarding them to EPs so user jobs can access the user’s files.

OAuth: HTCondor can manage OAuth credentials, automatically renewing them and forwarding them to EPs, where they’re typically used by file transfer plug-ins, although they are also available while the job is running.

class htcondor2.DaemonCommand(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

An enumeration of daemon commands.

DaemonOn

DaemonOff

DaemonOffFast

DaemonOffPeaceful

DaemonsOn

DaemonsOff

DaemonsOffFast

DaemonsOffPeaceful

OffFast

OffForce

OffGraceful

OffPeaceful

Reconfig

Restart

RestartPeaceful

SetForceShutdown

SetPeacefulShutdown

class htcondor2.DaemonType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

An enumeration of known daemon types.

Any: Any type of daemon; useful when specifying queries where all matching daemons should be returned.

Master: A condor_master daemon.

Schedd: A condor_schedd daemon.

Startd: A condor_startd daemon.

Collector: A condor_collector daemon.

Negotiator: A condor_negotiator daemon.

Credd: A condor_credd daemon.

HAD: A condor_had daemon.

Generic: Any other type of daemon.

class htcondor2.DrainType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

An enumeration of draining policies that can be set to a condor_startd.

The following explanations are reminders; the actual policies are way more complicated.

Graceful: The default; jobs are allowed to continue running until they reach their promised max job retirement time. To reduce idle time, all jobs may continue to run until the most distant such deadline, at which point the draining policy effectively becomes the following.

Quick: Job are immediately soft-killed (generally meaning sent a SIGTERM). The startd then waits a certain amount of time to allow jobs to shut down cleanly before the draining policy becomes the following.

Fast: Jobs are immediately hard-killed (generally meaning sent a SIGKILL).

class htcondor2.FileTransferEventType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

An enumeration of file transfer event types.

IN_QUEUED

IN_STARTED

IN_FINISHED

OUT_QUEUED

OUT_STARTED

OUT_FINISHED

class htcondor2.JobAction(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

An enumeration describing the actions that may be performed on a job in the queue.

Hold: Put a job on hold, vacating a running job if necessary. A job will stay in the hold state until explicitly acted upon by the admin or owner.

Release: Release a job from the hold state, returning it to Idle.

Suspend: Suspend the processes of a running job (on Unix platforms, this triggers a SIGSTOP). The job’s processes stay in memory but no longer get scheduled on the CPU.

Continue: Continue a suspended jobs (on Unix, SIGCONT). The processes in a previously suspended job will be scheduled to get CPU time again.

Remove: Remove a job from the Schedd’s queue, cleaning it up first on the remote host (if running). This requires the remote host to acknowledge it has successfully vacated the job, meaning Remove may not be instantaneous.

RemoveX: Immediately remove a job from the schedd queue, even if it means the job is left running on the remote resource.

Vacate: Cause a running job to be killed on the remote resource and return to idle state. With Vacate, jobs may be given significant time to cleanly shut down.

VacateFast: Vacate a running job as quickly as possible, without providing time for the job to cleanly terminate.

class htcondor2.JobEventType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

An enumeration of the types of user log events; corresponds to ULogEventNumber in the C++ source.

SUBMIT

EXECUTE

EXECUTABLE_ERROR

CHECKPOINTED

JOB_EVICTED

JOB_TERMINATED

IMAGE_SIZE

SHADOW_EXCEPTION

GENERIC

JOB_ABORTED

JOB_SUSPENDED

JOB_UNSUSPENDED

JOB_HELD

JOB_RELEASED

NODE_EXECUTE

NODE_TERMINATED

POST_SCRIPT_TERMINATED

GLOBUS_SUBMIT

GLOBUS_SUBMIT_FAILED

GLOBUS_RESOURCE_UP

GLOBUS_RESOURCE_DOWN

REMOTE_ERROR

JOB_DISCONNECTED

JOB_RECONNECTED

JOB_RECONNECT_FAILED

GRID_RESOURCE_UP

GRID_RESOURCE_DOWN

GRID_SUBMIT

JOB_AD_INFORMATION

JOB_STATUS_UNKNOWN

JOB_STATUS_KNOWN

JOB_STAGE_IN

JOB_STAGE_OUT

ATTRIBUTE_UPDATE

PRESKIP

CLUSTER_SUBMIT

CLUSTER_REMOVE

FACTORY_PAUSED

FACTORY_RESUMED

NONE

FILE_TRANSFER

RESERVE_SPACE

RELEASE_SPACE

FILE_COMPLETE

FILE_USED

FILE_REMOVED

DATAFLOW_JOB_SKIPPED

class htcondor2.JobStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

An enumeration of HTCondor job status values.

IDLE

RUNNING

REMOVED

COMPLETED

HELD

TRANSFERRING_OUTPUT

SUSPENDED

class htcondor2.LogLevel(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

An enumeration of “log levels” to use with log(). Some values of this enumeration select types of log messages; others control the format of the header. See the documentation.

Always

Audit

Config

DaemonCore

Error

FullDebug

Hostname

Job

Machine

Network

NoHeader

PID

Priv

Protocol

Security

Status

SubSecond

Terse

Timestamp

Verbose

class htcondor2.QueryOpt(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

An enumeration of the flags that may be sent to the condor_schedd during a query to alter its behavior.

Default: Queries should use default behaviors, and return jobs for all users.

AutoCluster: Instead of returning job ads, return an ad per auto-cluster.

GroupBy: Instead of returning job ads, return an ad for each unique combination of values for the attributes in the projection. Similar to AutoCluster, but using the projection as the significant attributes for auto-clustering.

DefaultMyJobsOnly: Queries should use all default behaviors, and return jobs only for the current user.

SummaryOnly: Instead of returning job ads, return only the final summary ad.

IncludeClusterAd: Query should return raw cluster ads as well as job ads if the cluster ads match the query constraint.

class htcondor2.SubmitMethod(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

An enumeration of reserved values for submit methods.

MinReserved

CondorSubmit

DAGMan

PythonBindings

HTCondorJobSubmit

HTCondorDagSubmit

HTCondorJobSetSubmit

UserSet

MaxReserved

class htcondor2.SubsystemType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

An enumeration of known subsystem types.

Auto

Collector

Daemon

Dagman

GAHP

Job

Master

Negotiator

Schedd

Shadow

SharedPort

Startd

Starter

Submit

Tool

class htcondor2.TransactionFlag(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

An enumeration of the flags affecting the characteristics of a transaction.

Default: The default transaction is not any of the following.

NonDurable: Non-durable transactions are changes that may be lost when the condor_schedd crashes. NonDurable is used for performance, as it eliminates extra fsync() calls.

SetDirty: This marks the changed ClassAds as dirty, causing an update notification to be sent to the condor_shadow and the condor_gridmanager, if they are managing the job.

ShouldLog: Causes any changes to the job queue to be logged in the relevant job event log.

htcondor2 Enumerations

`htcondor2` Enumerations