Tools / Guides / VCF JSON Builder
// Guide · Pre-deployment & planning

VCF JSON Builder

The VCF JSON Builder is a browser-based form that produces a validated VCF 9 deployment JSON — the payload the VCF Installer consumes to bootstrap your SDDC. Start fresh, or paste an existing JSON to edit it visually. Everything validates as you type.

VCF 9.0.2 Real-time validation PoC + Production vSAN ESA/OSA · NFS · VMFS-FC NSX 3-node cluster VCF Operations VCF Automation
Open the tool Jump to walkthrough

Quick start

  1. Open the tool and fill in the top section — instance prefix, domain suffix, host count, management/vMotion/vSAN/VM/TEP networks, and VLAN IDs.
  2. Click Apply to propagate those defaults across every tab.
  3. Work through each tab in order: Overview → Hosts → vCenter → Networking → NSX → Storage → Operations → Automation. Red borders mean a required field is missing.
  4. Watch the validation badge in the sidebar. When it turns green, your JSON is deployment-ready.
  5. Copy or export the JSON and use it with the VCF Installer.
On this page

When to use this tool

Use the VCF JSON Builder when you need a valid deployment JSON for:

It is not a design tool. It assumes you already know:

💡
If you’re still designing Use the IP Subnet Planner to size your networks, the VLAN Allocation Planner to pick VLAN IDs, the Host Sizing Calculator to decide how many hosts you need, and the Pre-Deployment Checklist to make sure nothing is missing before you generate the JSON.

How it works

The builder is a form with eight tabs, each mapped to a section of the VCF deployment JSON. As you type, it builds the JSON in memory and shows a live preview on the right with validation state. Required fields get red borders when empty; invalid values (bad IPs, malformed CIDRs, short passwords) get red borders and tooltips.

The top defaults block is special — it doesn’t map to a single JSON field. Instead, when you click Apply, it fills in sensible defaults across every other tab (hostnames, IPs, VLANs, DNS, NTP). You can always override any propagated value afterward.

The final output is a single JSON document that matches the VCF Installer schema for the version you select (VCF 9.0.2 by default).

Step-by-step walkthrough

1. Fill in the defaults block

At the top of the form you’ll see a block labelled with prefix, domain, host count, and network/VLAN inputs. Fill in:

FieldExampleUsed for
Instance Prefixm01Hostname stem for all components (e.g. m01-cl01, m01-vds01)
Domain Suffixcorp.localDNS domain used in all FQDNs
ESX Hostname BaseesxPrefix for host names: esx01, esx02, …
Number of ESX Hosts43 minimum for PoC, 4 for Production, 8 max via dropdown (or custom)
Management / vMotion / vSAN / VM / TEP Networks192.168.10.0/24CIDR ranges for each VCF network plane
VLAN IDs100, 101, …Trunked VLAN IDs for each plane

Hit Apply. The tool populates host tables, IP addresses, and VLAN fields across every other tab based on these defaults.

2. Overview tab

High-level SDDC identity and shared settings:

Global Password security Using a shared global password is fine for labs and PoCs, but in production use per-component passwords. Rotate them with the Day 2 Operations Planner after deployment.

3. Hosts tab

Per-host inventory. Each row corresponds to one ESXi host and includes:

Use the Paste buttons if you have the host list elsewhere (spreadsheet, CSV) — they accept columns of IPs and will populate the rows.

4. vCenter tab

5. Networking tab

The vDS (Distributed Virtual Switch) and network segment configuration:

6. NSX tab

NSX Manager cluster config:

VCF vs VVF If you selected VVF as workflow type on the Overview tab, the NSX tab is skipped — VVF doesn’t include NSX.

7. Storage tab

See Choosing a storage type below. Pick one:

8. Operations tab

Only applies if you’re deploying VCF (not VVF):

9. Automation tab

VCF Automation (formerly vRealize Automation) for self-service VM provisioning. Optional — skip if you’re not using it.

10. Export

Click Copy JSON to copy to clipboard, or Export JSON to download a .json file. The JSON is ready to feed directly into the VCF Installer.

Section-by-section reference

Top defaults block — all fields

FieldRequiredNotes
Instance PrefixyesLower-case alphanumeric, ≤6 chars recommended
Domain SuffixyesMust be resolvable in DNS
ESX Hostname BaseyesCombined with host index: esx01, esx02, …
Number of ESX Hostsyes3 (PoC) or ≥4 (Production)
VCF VersionyesDefault 9.0.2.0
Management NetworkyesCIDR, usually /24
vMotion NetworkyesCIDR, separate subnet from management
vSAN Networkif vSANCIDR, separate subnet, jumbo MTU
VM Management NetworkyesCIDR used by VM traffic
Overlay / TEP Networkif NSX overlayCIDR for TEP addresses
Management / vMotion / vSAN / VM / TEP VLANyes each1–4094; don’t use VLAN 1

Tabs

Choosing a storage type

The Storage tab changes its inputs based on the storage type you select:

vSAN ESA (Express Storage Architecture)

VCF 9 default for new all-NVMe deployments. Single tier — every disk is a storage device, no cache/capacity split.

vSAN OSA (Original Storage Architecture)

The classic hybrid/all-flash model with cache + capacity disk groups.

NFS

External NFS array mounted as the primary datastore.

VMFS on Fibre Channel

Existing FC SAN presenting LUNs to all hosts.

💡
Capacity sizing Use the vSAN Capacity Calculator to work out usable capacity after FTT, slack space, and dedup/compression before committing to a disk layout.

Examples

Example · PoC 3-host cluster, vSAN ESA, single NSX node

Minimum-viable lab deployment for VCF 9 testing.

  • Prefix: lab · Domain: vcf.lab · Hosts: 3 (PoC minimum)
  • Workflow: VCF with 1-node NSX Manager
  • Networks: 10.0.10.0/24 mgmt, 10.0.11.0/24 vMotion, 10.0.12.0/24 vSAN, 10.0.13.0/24 VM, 10.0.14.0/24 TEP
  • Storage: vSAN ESA · 2× NVMe per host
  • Operations/Automation: skipped (optional for PoC)
Example · Production 4-host management domain, vSAN OSA, 3-node NSX

Typical enterprise management domain.

  • Prefix: m01 · Domain: corp.local · Hosts: 4 (Production minimum)
  • Workflow: VCF with 3-node NSX Manager cluster + VIP
  • Storage: vSAN OSA · 1 cache NVMe + 4 capacity SSDs per host
  • Operations: VCF Operations medium + Fleet Management
  • Automation: VCF Automation medium
Example · FC SAN cluster (VVF, no NSX)

VVF (vSphere Foundation) deployment using existing FC storage — no NSX, no vSAN.

  • Workflow: VVF — skips NSX and Operations tabs entirely
  • Storage: VMFS on FC · shared LUN WWN
  • Networks: no vSAN or TEP network needed

Common mistakes

🚨
DNS entries missing The VCF Installer will fail pre-checks if any FQDN in the JSON can’t be resolved. Create forward and reverse DNS records for every host, vCenter, SDDC Manager, NSX Manager, and Operations appliance before starting the install. The DNS Zone Designer can generate the BIND or Windows DNS exports for you.
Using VLAN 1 VLAN 1 is the default native VLAN on most switches and often untagged. Don’t use it for management, vMotion, vSAN, or overlay — deployment will complete but you’ll fight teaming/untagged issues forever. Use explicit VLAN IDs (100+ is a common convention).
MTU mismatch If you set MTU 9000 in the tool but your physical switches/uplinks aren’t configured for jumbo frames, vSAN and NSX overlay will silently fragment or drop. Validate end-to-end jumbo with the MTU Path Calculator before using 9000.
Forgetting the TEP network for overlay If your NSX transport type is OVERLAY, you must have a dedicated TEP network and VLAN. A missing TEP CIDR is the most common JSON export error caught by validation.
Passwords shorter than 15 characters VCF 9 enforces a minimum password length for root, SSO admin, and NSX credentials. The validator flags them, but they’re easy to miss in bulk. Use a password manager.

Tools that pair well with the JSON Builder:

FAQ

Does this tool connect to my vCenter or VCF Installer?
No. It’s fully browser-based and never talks to any server. It generates JSON locally in your browser, nothing leaves the page. You copy/export the JSON and feed it to the VCF Installer yourself.
Can I import an existing JSON and edit it?
Yes. Click Paste from clipboard at the top — the tool parses your JSON and populates every tab. Then make edits visually and re-export.
Which VCF versions are supported?
VCF 9.0.2 is the default schema. Other 9.x point releases work the same; older 4.x/5.x schemas differ significantly and aren’t supported.
My validation badge is green but the installer failed. What did I miss?
The tool validates JSON schema and basic values (CIDRs, IPs, passwords). It can’t validate whether your DNS actually has the right records, your NTP server is reachable, or your hosts are in the VCF HCL. Run the Pre-Deployment Checklist to catch environmental issues.
Can I use this for workload domains (not just management)?
The bootstrap JSON is only for the initial management domain. Workload domains are added through SDDC Manager’s UI or API after management is deployed, using a different payload schema.
What happens if I switch between VCF and VVF mid-edit?
The NSX and Operations tabs become hidden/disabled when you select VVF (those components aren’t part of VVF). Your data stays in the form state — switching back to VCF restores them. But if you export as VVF, only VVF-relevant fields are included in the JSON.
How do I rotate passwords after deployment?
After VCF is deployed, use SDDC Manager’s password management workflow — don’t try to edit the JSON. The Day 2 Operations Planner has a runbook for password rotation.
Is this tool affiliated with or endorsed by Broadcom/VMware?
No. VirtualBytes is independent. The JSON schema follows VMware’s public VCF 9 documentation, but this tool is not affiliated with Broadcom or VMware.