mirror of
https://github.com/gravitational/teleport.git
synced 2026-11-03 07:40:28 +08:00
Paul Gottschling
dfb94c872e
Provide a less overwhelming documentation experience for users by condensing sidebar sections into five, organized loosely around different audiences of the documentation: - **Get Started:** new Teleport users, as well as users of all levels who want to quickly look up key, frequently changing information, such as the changelog and upcoming release information. - **Admin Guides:** intermediate users completing a specific task. This includes all how-to guides in the docs except those in "Get Started" and "Enroll Resources". - **Enroll Resources:** Admin Guides, but for our extensive library of how-to guides for protecting infrastructure resources with Teleport. - **References:** Advanced users looking for comprehensive reference information and architecture guides. This includes all reference guides in the docs. - **User Guides:** Guides for end users looking to access resources. Related changes: - **Move Helm reference partials**. Use the `docs/pages/includes` directory so we can generate the sidebar from `docs/pages/reference`. - **Move the Architecture sidebar section** into "References", and move architecture guides across the documentation into "Architecture". - **Remove "Documentation Overview"** as this is out of date. Now, top-level sidebar sections are more self explanatory. - **Remove "Choose an Edition"**, since we want to elevate Teleport Enterprise (Cloud), making Teleport Enterprise (Self-Hosted) available for certain use cases. - **Add an infrastructure as code section** to Admin Guides.
28 lines
491 B
Plaintext
28 lines
491 B
Plaintext
---
|
|
title: Desktop Access CLI Reference
|
|
description: CLI reference for Teleport desktop access.
|
|
---
|
|
|
|
The following `tctl` commands are used to manage the Teleport Windows Desktop
|
|
Service.
|
|
|
|
- (!docs/pages/includes/tctl.mdx!)
|
|
|
|
Generate a join token for a Windows Desktop Service:
|
|
|
|
```sh
|
|
$ tctl tokens add --type=WindowsDesktop
|
|
```
|
|
|
|
List registered Windows Desktop Services:
|
|
|
|
```sh
|
|
$ tctl get windows_desktop_service
|
|
```
|
|
|
|
List registered Windows desktops:
|
|
|
|
```sh
|
|
$ tctl get windows_desktop
|
|
```
|