This document describes the current stable version of Celery (5.6). For development docs, go here.

# `celery.apps.multi`

Start/stop/manage workers.

class celery.apps.multi.Cluster(nodes, cmd=None, env=None, on_stopping_preamble=None, on_send_signal=None, on_still_waiting_for=None, on_still_waiting_progress=None, on_still_waiting_end=None, on_node_start=None, on_node_restart=None, on_node_shutdown_ok=None, on_node_status=None, on_node_signal=None, on_node_signal_dead=None, on_node_down=None, on_child_spawn=None, on_child_signalled=None, on_child_failure=None)

  Represent a cluster of workers.

  property data
  find(name)
  getpids(on_down=None)
  kill()
  restart(sig=Signals.SIGTERM)
  send_all(sig)
  shutdown_nodes(nodes, sig=Signals.SIGTERM, retry=None)
  start()
  start_node(node)
  stop(retry=None, callback=None, sig=Signals.SIGTERM)
  stopwait(retry=2, callback=None, sig=Signals.SIGTERM)

class celery.apps.multi.Node(name, cmd=None, append=None, options=None, extra_args=None)

  Represents a node in a cluster.

  alive()
  property argv_with_executable
  property executable
  classmethod from_kwargs(name, **kwargs)
  getopt(*alt)
  handle_process_exit(retcode, on_signalled=None, on_failure=None)
  property logfile
  property pid
  property pidfile
  prepare_argv(argv, path)
  send(sig, on_error=None)
  start(env=None, **kwargs)