2020-07-27 10:59:08 -07:00
|
|
|
---
|
|
|
|
|
layout: docs
|
2024-12-04 11:01:09 -05:00
|
|
|
page_title: Host set resource
|
|
|
|
|
description: >-
|
|
|
|
|
Learn about using the host set resource to organize and manage hosts that have the same level of access control and belong to the same host catalog.
|
2020-07-27 10:59:08 -07:00
|
|
|
---
|
|
|
|
|
|
2023-07-07 14:42:11 -04:00
|
|
|
# Host sets
|
2020-07-27 10:59:08 -07:00
|
|
|
|
2020-10-09 16:22:26 -04:00
|
|
|
A host set is a resource
|
2020-10-11 20:02:50 -04:00
|
|
|
that represents a collection of [hosts][]
|
|
|
|
|
which are considered equivalent
|
|
|
|
|
for the purposes of access control.
|
|
|
|
|
A host set can only include hosts
|
|
|
|
|
from the same [host catalog][] as the host set.
|
|
|
|
|
A [target][] can reference host sets from host catalogs
|
|
|
|
|
which belong to the same [project][] as the target.
|
2020-07-27 10:59:08 -07:00
|
|
|
|
|
|
|
|
## Attributes
|
2020-10-11 20:02:50 -04:00
|
|
|
|
|
|
|
|
A host set has the following configurable attributes:
|
|
|
|
|
|
|
|
|
|
- `name` - (optional)
|
|
|
|
|
If set, the `name` must be unique within the host set's parent [host catalog][].
|
|
|
|
|
|
|
|
|
|
- `description` - (optional)
|
|
|
|
|
|
2021-11-17 14:11:06 -07:00
|
|
|
- `preferred_endpoints` - (optional)
|
|
|
|
|
A list of selector strings in the format of either `cidr:<valid IPv4/6 CIDR>`
|
|
|
|
|
or `dns:<globbed name>` used to select the addresses of [hosts][] when
|
|
|
|
|
establishing a [session][] with a [target][].
|
|
|
|
|
|
2023-07-07 14:42:11 -04:00
|
|
|
### Plugin host set attributes
|
2021-11-17 14:11:06 -07:00
|
|
|
|
|
|
|
|
- `attributes` - (optional)
|
|
|
|
|
A collection of fields which the plugin uses to lookup which hosts should be
|
|
|
|
|
members of this host set. Often this includes a type of filter using a
|
|
|
|
|
syntax which is usable by the backing service.
|
|
|
|
|
|
|
|
|
|
- `sync_interval_seconds` - (optional)
|
|
|
|
|
The number of seconds between the time boundary syncs the [hosts][] in this
|
2024-06-05 11:54:57 -06:00
|
|
|
set using this host set's plugin. Defaults to `600` seconds, or 10 minutes.
|
2021-11-17 14:11:06 -07:00
|
|
|
|
2023-07-07 14:42:11 -04:00
|
|
|
## Referenced by
|
2020-10-11 20:02:50 -04:00
|
|
|
|
|
|
|
|
- [Host][]
|
|
|
|
|
- [Host Catalog][]
|
|
|
|
|
- [Target][]
|
|
|
|
|
|
2023-01-20 18:17:34 -05:00
|
|
|
[host catalog]: /boundary/docs/concepts/domain-model/host-catalogs
|
|
|
|
|
[host catalogs]: /boundary/docs/concepts/domain-model/host-catalogs
|
|
|
|
|
[host]: /boundary/docs/concepts/domain-model/hosts
|
|
|
|
|
[hosts]: /boundary/docs/concepts/domain-model/hosts
|
|
|
|
|
[project]: /boundary/docs/concepts/domain-model/scopes#projects
|
|
|
|
|
[projects]: /boundary/docs/concepts/domain-model/scopes#projects
|
|
|
|
|
[session]: /boundary/docs/concepts/domain-model/sessions
|
|
|
|
|
[sessions]: /boundary/docs/concepts/domain-model/sessions
|
|
|
|
|
[target]: /boundary/docs/concepts/domain-model/targets
|
|
|
|
|
[targets]: /boundary/docs/concepts/domain-model/targets
|
2020-10-12 17:40:42 -04:00
|
|
|
|
2023-07-07 14:42:11 -04:00
|
|
|
## Service API docs
|
2020-10-12 17:40:42 -04:00
|
|
|
|
|
|
|
|
The following services are relevant to this resource:
|
|
|
|
|
|
2023-01-20 18:17:34 -05:00
|
|
|
- [Host Set Service](/boundary/api-docs/host-set-service)
|
