Robert Main
18f469105c
* Update website folder to indicate deprecation Adds an alert banner to the top of all MDX files within `/website` to indicate deprecation * Update website README
41 lines
1.2 KiB
Plaintext
41 lines
1.2 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: workers read - Command
|
|
description: >-
|
|
The "workers read" command retrieves the details of a worker resource.
|
|
---
|
|
|
|
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
|
|
> [!IMPORTANT]
|
|
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
|
|
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
|
|
|
|
# workers read
|
|
|
|
Command: `boundary workers read`
|
|
|
|
The `boundary workers read` command lets you read a Boundary worker information for a given ID.
|
|
|
|
## Example
|
|
|
|
This example reads a worker with the ID `w_1234567890`:
|
|
|
|
```shell-session
|
|
$ boundary workers read -id w_1234567890
|
|
```
|
|
|
|
## Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary workers read [options] [args]
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
### Command options
|
|
|
|
- `id=<string>` - The ID of the worker to read.
|
|
|
|
@include 'cmd-option-note.mdx' |