Files
threshold/website/content/docs/domain-model/hosts.mdx
T

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

59 lines
2.0 KiB
Plaintext
Raw Normal View History

2020-07-27 10:59:08 -07:00
---
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.
2020-07-27 10:59:08 -07:00
---
2025-11-04 10:22:10 -05:00
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
> [!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
2020-07-27 10:59:08 -07: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][].
Hosts can only be associated with [host sets][]
from the same host catalog as the host.
2020-07-27 10:59:08 -07:00
## 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
2025-09-03 15:45:38 -04:00
host catalog and host set at an interval (configurable in the
host set).
2020-07-27 10:59:08 -07:00
## Attributes
A host has the following configurable attributes:
- `name` - (optional)
2025-09-03 15:45:38 -04:00
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
2025-09-03 15:45:38 -04:00
- [Host catalog][]
- [Host set][]
2025-09-03 15:45:38 -04:00
[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:
2025-09-03 15:45:38 -04:00
- [Host service](/boundary/api-docs/host-service)