ts runner

List the registered runners — the execution-side processes that carry workloads for an account — check whether one is connected, show a cloud runner's Remote Desktop credentials, and deregister one.

Usage

ts runners [--csv] [--no-trunc]
ts runner <id>
ts runner rdp-credentials <id>
ts runner delete <id> [--force]

Description

A runner is the process that executes work on a machine and holds a tunnel back to the server. It registers itself once, then appears here until it is deregistered.

ts runners lists runners: the runner id, its display name and hostname, its platform and architecture, whether the tunnel is currently up, its status, and when it was last seen. A Server Administrator sees every runner; any other account sees only the runners registered to it. ONLINE is the live answer — whether the server has a connection to it this second — while LAST SEEN is the persisted timestamp and is the useful column when the answer is no.

ts runner <id> prints whether one runner is connected, as JSON. It needs a Server Administrator, or the service credential --local uses on the server itself.

ts runner rdp-credentials prints the Windows account and password a cloud runner's Remote Desktop session signs in with, as the Credentials button on its server's page in the Administration site shows them. It needs a Server Administrator, works only for a runner on an Application Server, and records each reveal in the audit log.

ts runner delete deregisters a runner permanently. If the runner is connected, the server tells it that it has been revoked and the runner process shuts itself down, taking whatever it was executing with it. The runner's session rows are then removed and the registration is deleted, so the runner disappears from ts runners and its stored session history goes with it. An offline runner is deleted just as thoroughly; it simply finds its credentials rejected the next time it tries to connect. Getting the runner back means registering it again from scratch, so the command prompts unless you pass --force.

You can delete a runner registered to your own account; a Server Administrator can delete anyone's, and every delete is recorded in the audit log.

Options

Flag	Description	Default/Values	Notes
--force, -f	Deregister without confirming.		delete only. Required when there is no terminal.
--csv	Tab-separated output, nothing truncated.		ts runners only.
--no-trunc	Do not truncate columns.		ts runners only.

Output

Host:     app01.example.com:3389
Username: turbo-7f3a91
Password: Vq7#pL2m!xR9

rdp-credentials prints the address to connect to, then the account and its password. The password is shown in clear text; under --format=json it is the password field.

Examples

# What is registered, and what is actually connected?
ts runners

# Full hostnames and ids, untruncated
ts runners --no-trunc

# Is one runner connected right now?
ts runner build02-9f3ac21d

# Sign in to a cloud runner's desktop by hand
ts runner rdp-credentials 3f2504e04f8911d39a0c0305e82c3301

# Deregister a runner you are retiring
ts runner delete build02-9f3ac21d --force

# Gotcha: this is not "restart the runner". Deleting one kills the connected
# process, drops its session history, and requires a fresh registration to
# undo. Check the ONLINE column and what it is running before you do it.

Exit Codes

0 on success. -1 when no runner id is given, and when rdp-credentials names a runner that does not run on an Application Server. -4 when no account is signed in, and on ts runner <id> when the account is not a Server Administrator. -5 when you delete another account's runner without being a Server Administrator, and on rdp-credentials when the account is not one. -6 when no runner has that id, and when rdp-credentials finds the runner is not running on its server.

Related Commands

• ts session — Your own sessions, and the runner each one runs on.
• ts server — The Application Servers cloud runners run on.
• ts user — The account a runner is registered to, which is the account that may delete it.