mirror of
https://github.com/gravitational/teleport.git
synced 2026-11-01 21:52:02 +08:00
Paul Gottschling
3ef5cd8ee9
* Edit tctl instructions to clarify remote login Closes #11464 - Ensure that all example tctl commands are accompanied either by instructions to log in to the cluster or the tctl.mdx partial. - Edit the guides in the Architecture section to remove notes that tctl can only be used locally to the Auth Service. - Edit the user-client-rereqs partial to mention tctl for all editions, since you can log in to tctl remotely for all editions. Not editing guides where: - tctl is run via kubectl exec - tctl is not mentioned in a code block, i.e., only in passing, and a reader isn't expected to run the command on their own while following the guide. - The user is already expected to run tctl on the Auth Service. The docker-compose Getting Started guide is an example of this. * Respond to PR feedback - Provide more context on authenticating with tctl in the CLI reference - Update the link to more information re: tctl in the architecture overview, and indicate that tctl users must authenticate. - Minor tweaks. * Respond to PR feedback - Rephrase the authentication paragraph in the Architecture Overview.
26 lines
475 B
Plaintext
26 lines
475 B
Plaintext
---
|
|
title: Desktop Access CLI Reference
|
|
description: CLI reference for Teleport Desktop Access.
|
|
---
|
|
|
|
The following `tctl` commands are used to manage Teleport Desktop Access.
|
|
|
|
(!docs/pages/includes/tctl.mdx!)
|
|
|
|
Generate a join token for a Windows Desktop Service:
|
|
|
|
```sh
|
|
$ tctl nodes add --roles=WindowsDesktop
|
|
```
|
|
|
|
List registered Windows Desktop Services:
|
|
|
|
```sh
|
|
$ tctl get windows_desktop_service
|
|
```
|
|
|
|
List registered Windows desktops:
|
|
|
|
```sh
|
|
$ tctl get windows_desktop
|
|
``` |