![Fork me on GitHub](/docs/_next/image/?url=%2Fdocs%2F_next%2Fstatic%2Fmedia%2Fforkme.b9234619.webp&w=256&q=75)
Teleport
Desktop Access CLI Reference
- Version 17.x
- Version 16.x
- Version 15.x
- Version 14.x
- Older Versions
The following tctl
commands are used to manage the Teleport Windows Desktop
Service.
- To check that you can connect to your Teleport cluster, sign in with
tsh login
, then verify that you can runtctl
commands using your current credentials. For example:If you can connect to the cluster and run thetsh login --proxy=teleport.example.com --user=[email protected]tctl statusCluster teleport.example.com
Version 16.2.1
CA pin sha256:abdc1245efgh5678abdc1245efgh5678abdc1245efgh5678abdc1245efgh5678
tctl status
command, you can use your current credentials to run subsequenttctl
commands from your workstation. If you host your own Teleport cluster, you can also runtctl
commands on the computer that hosts the Teleport Auth Service for full permissions.
Generate a join token for a Windows Desktop Service:
$ tctl tokens add --type=WindowsDesktop
List registered Windows Desktop Services:
$ tctl get windows_desktop_service
List registered Windows desktops:
$ tctl get windows_desktop