This document describes an older version of Celery (2.1). For the latest stable version please go here.

Built-in Remote Control Commands - celery.worker.control.builtins

celery.worker.control.builtins.add_consumer(panel, queue=None, exchange=None, exchange_type='direct', routing_key=None, **options)
celery.worker.control.builtins.cancel_consumer(panel, queue=None, **_)
celery.worker.control.builtins.disable_events(panel)
celery.worker.control.builtins.dump_active(panel, safe=False, **kwargs)
celery.worker.control.builtins.dump_reserved(panel, safe=False, **kwargs)
celery.worker.control.builtins.dump_revoked(panel, **kwargs)
celery.worker.control.builtins.dump_schedule(panel, safe=False, **kwargs)
celery.worker.control.builtins.dump_tasks(panel, **kwargs)
celery.worker.control.builtins.enable_events(panel)
celery.worker.control.builtins.heartbeat(panel)
celery.worker.control.builtins.ping(panel, **kwargs)
celery.worker.control.builtins.rate_limit(panel, task_name, rate_limit, **kwargs)

Set new rate limit for a task type.

See celery.task.base.Task.rate_limit.

Parameters:
  • task_name – Type of task.
  • rate_limit – New rate limit.
celery.worker.control.builtins.revoke(panel, task_id, **kwargs)

Revoke task by task id.

celery.worker.control.builtins.set_loglevel(panel, loglevel=None)
celery.worker.control.builtins.shutdown(panel, **kwargs)
celery.worker.control.builtins.stats(panel, **kwargs)

Previous topic

Worker Control - celery.worker.control

Next topic

Remote Control Command Registry - celery.worker.control.registry

This Page