Bryce Kalow
bd8cc5464e
* migrates nav data format and updates docs pages * removes sidebar_title from content files * updates api docs to work with new format
48 lines
1.1 KiB
Plaintext
48 lines
1.1 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: Domain Model - Hosts
|
|
description: |-
|
|
The anatomy of a Boundary host
|
|
---
|
|
|
|
# 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.
|
|
|
|
## 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]: /docs/concepts/domain-model/host-catalogs
|
|
[host catalogs]: /docs/concepts/domain-model/host-catalogs
|
|
[host set]: /docs/concepts/domain-model/host-sets
|
|
[host sets]: /docs/concepts/domain-model/host-sets
|
|
|
|
## Service API Docs
|
|
|
|
The following services are relevant to this resource:
|
|
|
|
- [Host Service](/api-docs/host-service)
|