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

60 lines
2.0 KiB

---
layout: docs
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.
---
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
> [!IMPORTANT]
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
# Hosts
A host is a resource
that represents a computing element with a network address
reachable from Boundary.
A host belongs to a [host catalog][].
Hosts can only be associated with [host sets][]
from the same host catalog as the host.
## Plugin-based host information
Plugin-based hosts are read-only. They are synced by an installed plugin on
the boundary system using the configuration provided it from the
host catalog and host set at an interval (configurable in the
host set).
## Attributes
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)
### Static host attributes
Static host types have the following additional attribute:
- `address` - (required)
Must be at least 3 characters long and not greater than 255 characters.
## Referenced by
- [Host catalog][]
- [Host set][]
[host catalog]: /boundary/docs/domain-model/host-catalogs
[host catalogs]: /boundary/docs/domain-model/host-catalogs
[host set]: /boundary/docs/domain-model/host-sets
[host sets]: /boundary/docs/domain-model/host-sets
## Service API docs
The following services are relevant to this resource:
- [Host service](/boundary/api-docs/host-service)