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/hosts/list.mdx

41 lines
1.1 KiB

---
layout: docs
page_title: hosts list - Command
description: |-
The "hosts list" command lists the hosts within a given scope or resource.
---
# hosts list
Command: `boundary hosts list`
The `boundary hosts list` command lets you list the Boundary hosts within a given scope or resource.
## Example
This example lists all hosts within the host catalog `_1234567890`:
```shell-session
$ boundary hosts list -host-catalog-id _1234567890
```
## Usage
<CodeBlockConfig hideClipboard>
```shell-session
$ boundary hosts 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.
- `-host-catalog-id=<string>` - The host catalog resource to use to produce the list.
You can also specify the host catalog using the **BOUNDARY_HOST_CATALOG_ID** environment variable.
@include 'cmd-option-note.mdx'