Dan HeathandRobin Beck
b442c1fa60
* docs: Update meta content - CLI * docs: Edits for consistency * docs: More edits for consistency * Apply batch of suggestions from code review Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com> * Apply batch suggestions from code review Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com> * docs: Remove given id references * Update read.mdx * Update read.mdx --------- Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
44 lines
1.2 KiB
Plaintext
44 lines
1.2 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: workers list - Command
|
|
description: >-
|
|
The "workers list" command lists available worker resources in a scope or resource.
|
|
---
|
|
|
|
# workers list
|
|
|
|
Command: `boundary workers list`
|
|
|
|
The `boundary workers list` command lets you list the Boundary workers in a scope or resource.
|
|
|
|
## Example
|
|
|
|
This example lists all workers in the `global` scope:
|
|
|
|
```shell-session
|
|
$ boundary workers list
|
|
```
|
|
|
|
## Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary workers list [options] [args]
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
### Command options
|
|
|
|
- `-filter=<string>` - If set, Boundary filters the list operation before the results are returned.
|
|
The filter operates against each item in the list.
|
|
We recommend that you use single quotes, because the filters contain double quotes.
|
|
Refer to the [Filter resource listings documentation](/boundary/docs/concepts/filtering/resource-listing) for more details.
|
|
- `recursive` - If set, runs the list operation recursively on any child scopes, if the type supports it.
|
|
The default value is `false`.
|
|
- `scope-id=<string>` - The scope from which to list the workers.
|
|
The default value is `global`.
|
|
You can also specify this value using the **BOUNDARY_SCOPE_ID** environment variable.
|
|
|
|
@include 'cmd-option-note.mdx' |