> For the complete documentation index, see [llms.txt](https://docs.platform9.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.platform9.com/api-docs/cluster-blueprint/models.md).

# Models

## The Blueprint object

```json
{"openapi":"3.0.1","info":{"title":"Cluster Blueprint API","version":"2.0.0"},"components":{"schemas":{"Blueprint":{"required":["name"],"type":"object","properties":{"name":{"description":"Cluster name","type":"string"},"networkingType":{"description":"Defaults to OVN","default":"ovn","enum":["ovn","ovs"],"type":"string"},"enableDistributedRouting":{"description":"Enable Cluster Wide Distributed Network Routing","default":true,"type":"boolean"},"dnsDomainName":{"description":"DNS Domain Name","type":"string"},"virtualNetworking":{"$ref":"#/components/schemas/VirtualNetworking"},"vmHighAvailability":{"$ref":"#/components/schemas/VMHighAvailability"},"autoResourceRebalancing":{"$ref":"#/components/schemas/AutoResourceRebalancing"},"imageLibraryStorage":{"description":"Library location on filesystem or Cinder volume type","type":"string"},"vmStorage":{"description":"Ephemeral Virtual Machine storage path","type":"string"},"storageBackends":{"$ref":"#/components/schemas/StorageBackends"}}},"VirtualNetworking":{"type":"object","properties":{"enabled":{"description":"Enable Virtual Networking","default":true,"type":"boolean"},"underlayType":{"description":"Underlay Technology","default":"vlan","enum":["vlan","other"],"type":"string"},"vnidRange":{"description":"VLAN / VNID Range","type":"string"}}},"VMHighAvailability":{"type":"object","properties":{"enabled":{"description":"Automatically detect host failure and recover VMs on other cluster hosts","default":false,"type":"boolean"}}},"AutoResourceRebalancing":{"type":"object","properties":{"enabled":{"description":"Automatically rebalance workloads across hosts in the cluster","default":false,"type":"boolean"},"rebalancingStrategy":{"description":"Defaults to vm_workload_consolidation, other supported value is node_resource_consolidation","default":"vm_workload_consolidation","enum":["vm_workload_consolidation","node_resource_consolidation"],"type":"string"},"rebalancingFrequencyMins":{"description":"Rebalancing frequency","default":20,"maximum":60,"minimum":1,"type":"integer"}}},"StorageBackends":{"description":"Persistent Storage Connectivity","type":"object","additionalProperties":{"description":"Volume backend name","type":"object","additionalProperties":{"type":"object","properties":{"driver":{"description":"Storage driver type","enum":["NetApp","LVM"],"type":"string"},"config":{"description":"Configuration distinct based on driver value","type":"object","additionalProperties":{"description":"Flexible configuration parameters based on storage driver","type":"string"}}}}}}}}}
```

## The VirtualNetworking object

```json
{"openapi":"3.0.1","info":{"title":"Cluster Blueprint API","version":"2.0.0"},"components":{"schemas":{"VirtualNetworking":{"type":"object","properties":{"enabled":{"description":"Enable Virtual Networking","default":true,"type":"boolean"},"underlayType":{"description":"Underlay Technology","default":"vlan","enum":["vlan","other"],"type":"string"},"vnidRange":{"description":"VLAN / VNID Range","type":"string"}}}}}}
```

## The VMHighAvailability object

```json
{"openapi":"3.0.1","info":{"title":"Cluster Blueprint API","version":"2.0.0"},"components":{"schemas":{"VMHighAvailability":{"type":"object","properties":{"enabled":{"description":"Automatically detect host failure and recover VMs on other cluster hosts","default":false,"type":"boolean"}}}}}}
```

## The AutoResourceRebalancing object

```json
{"openapi":"3.0.1","info":{"title":"Cluster Blueprint API","version":"2.0.0"},"components":{"schemas":{"AutoResourceRebalancing":{"type":"object","properties":{"enabled":{"description":"Automatically rebalance workloads across hosts in the cluster","default":false,"type":"boolean"},"rebalancingStrategy":{"description":"Defaults to vm_workload_consolidation, other supported value is node_resource_consolidation","default":"vm_workload_consolidation","enum":["vm_workload_consolidation","node_resource_consolidation"],"type":"string"},"rebalancingFrequencyMins":{"description":"Rebalancing frequency","default":20,"maximum":60,"minimum":1,"type":"integer"}}}}}}
```

## The StorageBackends object

```json
{"openapi":"3.0.1","info":{"title":"Cluster Blueprint API","version":"2.0.0"},"components":{"schemas":{"StorageBackends":{"description":"Persistent Storage Connectivity","type":"object","additionalProperties":{"description":"Volume backend name","type":"object","additionalProperties":{"type":"object","properties":{"driver":{"description":"Storage driver type","enum":["NetApp","LVM"],"type":"string"},"config":{"description":"Configuration distinct based on driver value","type":"object","additionalProperties":{"description":"Flexible configuration parameters based on storage driver","type":"string"}}}}}}}}}
```

## The RoleUpdate object

```json
{"openapi":"3.0.1","info":{"title":"Cluster Blueprint API","version":"2.0.0"},"components":{"schemas":{"RoleUpdate":{"required":["backends"],"type":"object","properties":{"backends":{"description":"List of storage backends to associate with the role","type":"array","items":{"description":"List of backend names to associate with the role","type":"string"}}}}}}}
```

## The HostConfigReq object

```json
{"openapi":"3.0.1","info":{"title":"Cluster Blueprint API","version":"2.0.0"},"components":{"schemas":{"HostConfigReq":{"type":"object","properties":{"name":{"type":"string"},"mgmtInterface":{"type":"string"},"vmConsoleInterface":{"type":"string"},"hostLivenessInterface":{"type":"string"},"tunnelingInterface":{"type":"string"},"imagelibInterface":{"type":"string"},"networkLabels":{"type":"object"},"clusterName":{"type":"string"}}}}}}
```

## The HostConfigResponse object

```json
{"openapi":"3.0.1","info":{"title":"Cluster Blueprint API","version":"2.0.0"},"components":{"schemas":{"HostConfigResponse":{"allOf":[{"$ref":"#/components/schemas/HostConfigReq"},{"type":"object","properties":{"id":{"format":"uuid","type":"string"}}}]},"HostConfigReq":{"type":"object","properties":{"name":{"type":"string"},"mgmtInterface":{"type":"string"},"vmConsoleInterface":{"type":"string"},"hostLivenessInterface":{"type":"string"},"tunnelingInterface":{"type":"string"},"imagelibInterface":{"type":"string"},"networkLabels":{"type":"object"},"clusterName":{"type":"string"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.platform9.com/api-docs/cluster-blueprint/models.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.