You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
boundary/website/content/docs/commands/workers/read.mdx

41 lines
1.2 KiB

---
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'