OS Manuals

/opt/netbox/venv/bin/rqworker

NetBox - the premier source of truth powering network automation (IPAM, DCIM)

From netbox-4.7 4.7.4-r1 (enterprise-packages), captured 2026-11-08 by running rqworker --help (exit 0). permalink

Usage: rqworker [OPTIONS] [QUEUES]...

  Starts an RQ worker.

Options:
  -b, --burst                     Run in burst mode (quit after all work is
                                  done)
  --logging_level TEXT            Set logging level
  --log-format TEXT               Set the format of the logs
  --date-format TEXT              Set the date format of the logs
  -n, --name TEXT                 Specify a different name
  --results-ttl INTEGER           Default results timeout to be used
  --worker-ttl INTEGER            Worker timeout to be used
  --maintenance-interval INTEGER  Maintenance task interval (in seconds) to be
                                  used
  --job-monitoring-interval INTEGER
                                  Default job monitoring interval to be used
  --disable-job-desc-logging      Turn off description logging.
  -v, --verbose                   Show more output
  -q, --quiet                     Show less output
  --exception-handler TEXT        Exception handler(s) to use
  --pid TEXT                      Write the process ID number to a file at the
                                  specified path
  -d, --disable-default-exception-handler
                                  Disable RQ's default exception handler
  --max-jobs INTEGER              Maximum number of jobs to execute
  --max-idle-time INTEGER         Maximum seconds to stay alive without jobs
                                  to execute
  -s, --with-scheduler            Run worker with scheduler
  -ds, --dequeue-strategy TEXT    Sets a custom stratey to dequeue from
                                  multiple queues
  -S, --serializer TEXT           Serializer to use. Accepts json, pickle, or
                                  a dotted import path.
  -P, --path TEXT                 Specify the import path.
  --connection-class TEXT         Redis client class to use
  --queue-class TEXT              RQ Queue class to use
  -j, --job-class TEXT            RQ Job class to use
  -w, --worker-class TEXT         RQ Worker class to use
  -c, --config TEXT               Module containing RQ settings.
  -u, --url TEXT                  URL describing Redis connection details.
  --help                          Show this message and exit.
Options (28)
OptionDescriptionSource
-b, --burstRun in burst mode (quit after all work is done)help
--logging_level TEXTSet logging levelhelp
--log-format TEXTSet the format of the logshelp
--date-format TEXTSet the date format of the logshelp
-n, --name TEXTSpecify a different namehelp
--results-ttl INTEGERDefault results timeout to be usedhelp
--worker-ttl INTEGERWorker timeout to be usedhelp
--maintenance-interval INTEGERMaintenance task interval (in seconds) to be usedhelp
--job-monitoring-interval INTEGERDefault job monitoring interval to be usedhelp
--disable-job-desc-loggingTurn off description logging.help
-v, --verboseShow more outputhelp
-q, --quietShow less outputhelp
--exception-handler TEXTException handler(s) to usehelp
--pid TEXTWrite the process ID number to a file at the specified pathhelp
-d, --disable-default-exception-handlerDisable RQ's default exception handlerhelp
--max-jobs INTEGERMaximum number of jobs to executehelp
--max-idle-time INTEGERMaximum seconds to stay alive without jobs to executehelp
-s, --with-schedulerRun worker with schedulerhelp
-ds, --dequeue-strategy TEXTSets a custom stratey to dequeue from multiple queueshelp
-S, --serializer TEXTSerializer to use.help
-P, --path TEXTSpecify the import path.help
--connection-class TEXTRedis client class to usehelp
--queue-class TEXTRQ Queue class to usehelp
-j, --job-class TEXTRQ Job class to usehelp
-w, --worker-class TEXTRQ Worker class to usehelp
-c, --config TEXTModule containing RQ settings.help
-u, --url TEXTURL describing Redis connection details.help
--helpShow this message and exit.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.