DAGMan Class

class htcondor2.DAGMan(dag_id)

The DAGMan client that acts as a connection to a running DAGMan process for sending commands.

Parameters:

dag_id (int) – The ClusterId of a DAGMan job to locate once the first command is issued.

property dag_id: int

The ClusterId of a DAGMan job this object will send commands.

halt(reason=None) → tuple[bool, str]

Inform DAGMan to halt a DAGs progress.

Parameters:

reason (str | None) – A message for why the DAG was halted to be printed in the DAGs debug log.

Returns:

Command success and result message.

Return type:

Tuple[bool, str]

resume() → Tuple[bool, str]

Inform DAGMan to resume a hatled DAGs progress.

Returns:

Command success and result message.

Return type:

Tuple[bool, str]

throttle(**kwargs) → ClassAd | str

Set DAGMan throttles.

Parameters:

  • max_nodes (int) – Set maximum number of submitted nodes (Optional).

  • max_idle (int) – Set maximum number of idle jobs (Optional).

  • max_pre (int) – Set maximum number of executing Pre-Scripts (Optional).

  • max_hold (int) – Set maximum number of executing Hold-Scripts (Optional).

  • max_post (int) – Set maximum number of executing Post-Scripts (Optional).

  • max_submits (int) – Set maximum number of job submissions per submit interval (Optional).

Note

At least one of the parameters must be provided.

Returns:

ClassAd containing the DAGMan’s set throttles or an error message.

Return type:

ClassAd | str