Skip to content

Commit

Permalink
DOC: update documentation for 'qserver' CLI tool
Browse files Browse the repository at this point in the history
  • Loading branch information
dmgav committed Dec 28, 2021
1 parent bb60976 commit eed1dc4
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/source/cli_tools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -356,6 +356,8 @@ periodically requests and displays the status of Queue Server.
qserver environment close # Close RE environment
qserver environment destroy # Destroy RE environment (kill RE worker process)
qserver existing plans # Request the list of existing plans
qserver existing devices # Request the list of existing devices
qserver allowed plans # Request the list of allowed plans
qserver allowed devices # Request the list of allowed devices
qserver permissions reload # Reload user permissions and generate lists of allowed plans and devices.
Expand Down Expand Up @@ -436,6 +438,18 @@ periodically requests and displays the status of Queue Server.
qserver history get # Request plan history
qserver history clear # Clear plan history
qserver function execute <function-params> # Start execution of a function
qserver function execute <function-params> background # ... in the background thread
Example of JSON specification of a function ("args" and "kwargs" are optional):
'{"name": "function_sleep", "args": [20], "kwargs": {}}'
qserver script upload <path-to-file> # Upload a script to RE Worker environment
qserver script upload <path-to-file> background # ... in the background
qserver script upload <path-to-file> update-re # ... allow 'RE' and 'db' to be updated
qserver task load result <task-uid> # Load status or result of a task with the given UID
qserver manager stop # Safely exit RE Manager application
qserver manager stop safe on # Safely exit RE Manager application
qserver manager stop safe off # Force RE Manager application to stop
Expand Down

0 comments on commit eed1dc4

Please sign in to comment.