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/update.mdx

45 lines
1.5 KiB

---
layout: docs
page_title: workers update - Command
description: >-
The "workers update" command updates an existing 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 update
Command: `boundary workers update`
The `boundary workers update` command lets you update a Boundary worker with a given ID.
## Example
This example updates the name and description of a worker with the ID `w_1234567890`:
```shell-session
$ boundary workers update -id w_1234567890 -name "devops" -description "Worker for DevOps"
```
## Usage
<CodeBlockConfig hideClipboard>
```shell-session
$ boundary workers update [options] [args]
```
</CodeBlockConfig>
### Command options
- `description=<string>` - A description to set on the worker.
- `id=<string>` - The ID of the worker you want to update.
- `name=<string>` - The name to set on the worker.
- `version=<int>` - The version of the worker to perform the operation on.
If you do not specify a version, the command performs a check-and-set automatically.
@include 'cmd-option-note.mdx'