Skip to content

ClusterGroup

Sebastian Claesson edited this page Mar 29, 2026 · 1 revision

ClusterGroup

A logical group of clusters.

API Endpoint

/api/virtualization/cluster-groups/

Identifier

name - Unique name.

Properties

Property Type Required Description
name string Yes Unique name.
slug string No URL-friendly identifier (auto-generated from name if omitted, e.g. 'my-datacenter').
description string No A brief description.
comments string No Free-text comments (markdown supported).

Output Properties

Property Type Description
id string NetBox internal ID (read-only, returned after create/update).
url string API URL for this resource.
display string Display name.

Bicep Example

resource productionClusters 'ClusterGroup' = {
  name: 'Production Clusters'
  description: 'All production virtualization clusters'
}

Clone this wiki locally