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>
47 lines
1.8 KiB
Plaintext
47 lines
1.8 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: hosts list - Command
|
|
description: >-
|
|
The "hosts list" command lists the available host resources within a 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.
|
|
- `list_token` (optional) - An opaque token that is returned from the previous `list` response.
|
|
If you do not supply a value, pagination starts from the beginning.
|
|
- `page_size` (optional) - An unsigned integer that indicates the number of items that should be included on the page of search results.
|
|
If you do not provide a value, or if you provide a value of `0`, Boundary uses the default page size of 1000 items.
|
|
If you configure it, the `page_size` value overrides the default page size.
|
|
Controller administrators can also configure a `max_page_size` option that constrains the maximum page size a user can request.
|
|
|
|
@include 'cmd-option-note.mdx' |