Host sets

A host set is a resource 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.

Attributes

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)

• preferred_endpoints - (optional) If set, specifies which IP address or DNS name out of a host's available options is your preferred endpoint for when Boundary establishes a session with the target. The preferred_endpoints attribute may not be valid for all plugin types.

  You can specify multiple endpoints using CIDR or DNS formats to create an order of preferences. CIDR strings should follow the cidr:<valid IPv4/6 CIDR> format, for example, cidr:10.0.0.0/16. DNS strings should follow the dns:<globbed name> format, for example dns:*.internal.

  If you do not specify a preference, Boundary chooses an endpoint using the following built-in priority order:

  1. Private IPv4
  2. Public IPv4
  3. DNS
  4. Private IPv6
  5. Public IPv6

Plugin host set attributes

• 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 set using this host set's plugin. Defaults to 600 seconds, or 10 minutes.

Referenced by

• Host
• Host catalog
• Target

Service API docs

The following services are relevant to this resource:

• Host set service