2020-07-27 10:59:08 -07:00
---
layout: docs
2024-12-04 11:01:09 -05:00
page_title: Host resource
description: >-
Learn about using host resources to represent computing elements that are reachable from Boundary. You can organize hosts in host sets and host catalogs.
2020-07-27 10:59:08 -07:00
---
2020-10-10 16:40:06 -04:00
# Hosts
2020-07-27 10:59:08 -07:00
2020-10-11 19:01:35 -04:00
A host is a resource
that represents a computing element with a network address
reachable from Boundary.
A host belongs to a [host catalog][].
2021-04-05 12:04:57 -05:00
Hosts can only be associated with [host sets][]
from the same host catalog as the host.
2020-07-27 10:59:08 -07:00
2023-07-07 14:42:11 -04:00
## Plugin-based host information
2021-11-17 14:11:06 -07:00
2023-07-07 14:42:11 -04:00
Plugin-based hosts are read-only. They are synced by an installed plugin on
2021-11-17 14:11:06 -07:00
the boundary system using the configuration provided it from the
[host catalog][] and [host set][] at an interval (configurable in the
[host set][]).
2020-07-27 10:59:08 -07:00
## Attributes
2020-10-11 19:01:35 -04:00
A host has the following configurable attributes:
- `name` - (optional)
If set, the `name` must be unique within the host's parent [host catalog][].
- `description` - (optional)
2023-07-07 14:42:11 -04:00
### Static host attributes
2020-10-11 19:01:35 -04:00
Static host types have the following additional attribute:
- `address` - (required)
Must be at least 3 characters long and not greater than 255 characters.
2023-07-07 14:42:11 -04:00
## Referenced by
2020-10-11 19:01:35 -04:00
- [Host Catalog][]
- [Host Set][]
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 set]: /boundary/docs/concepts/domain-model/host-sets
[host sets]: /boundary/docs/concepts/domain-model/host-sets
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 Service](/boundary/api-docs/host-service)