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.
Quick start
- Open the tool and fill in the top section — instance prefix, domain suffix, host count, management/vMotion/vSAN/VM/TEP networks, and VLAN IDs.
- Click Apply to propagate those defaults across every tab.
- Work through each tab in order: Overview → Hosts → vCenter → Networking → NSX → Storage → Operations → Automation. Red borders mean a required field is missing.
- Watch the validation badge in the sidebar. When it turns green, your JSON is deployment-ready.
- Copy or export the JSON and use it with the VCF Installer.
When to use this tool
Use the VCF JSON Builder when you need a valid deployment JSON for:
- Initial VCF 9 bootstrap — the VCF Installer takes a JSON spec as input for the first management domain.
- PoC environments — 3-host clusters with reduced sizing requirements.
- Automated redeploys — keep a canonical JSON in version control and re-emit it when rebuilding labs.
- Translating an existing design into JSON — you already know the IP plan, VLANs, and host layout; this tool turns them into the exact schema VCF expects, without hand-editing JSON in a text editor.
It is not a design tool. It assumes you already know:
- Your IP ranges for management, vMotion, vSAN, VM management, and overlay/TEP networks
- Your VLAN IDs
- DNS and NTP server addresses
- Host hardware details (FQDNs, IPs, root passwords, disk layout if using vSAN)
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:
| Field | Example | Used for |
|---|---|---|
| Instance Prefix | m01 | Hostname stem for all components (e.g. m01-cl01, m01-vds01) |
| Domain Suffix | corp.local | DNS domain used in all FQDNs |
| ESX Hostname Base | esx | Prefix for host names: esx01, esx02, … |
| Number of ESX Hosts | 4 | 3 minimum for PoC, 4 for Production, 8 max via dropdown (or custom) |
| Management / vMotion / vSAN / VM / TEP Networks | 192.168.10.0/24 | CIDR ranges for each VCF network plane |
| VLAN IDs | 100, 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:
- SDDC ID and VCF Instance Name — logical identifiers used by SDDC Manager.
- Workflow Type —
VCF(full) orVVF(VMware vSphere Foundation, lighter stack without NSX/Operations). - DNS and NTP servers — at least one primary of each is required.
- Datacenter and Cluster names — match whatever naming convention you’re using.
- Global Password — optional convenience. If set, this password is used for every component that doesn’t have an explicit password.
3. Hosts tab
Per-host inventory. Each row corresponds to one ESXi host and includes:
- Hostname (
esx01.corp.local), management IP, root password - vMotion IP, vSAN IP (if using vSAN), TEP IP
- If using vSAN: cache and capacity disk identifiers (for OSA) or storage tier devices (for ESA)
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
- vCenter FQDN — must resolve in your DNS (or SDDC Manager will fail pre-checks).
- VM Size — tiny, small, medium, large, xlarge. Match to your scale; see the VMware Config Maximums for limits.
- SSO Domain — default
vsphere.local. If you use a different SSO domain convention, set it here. - Root and SSO Admin passwords.
5. Networking tab
The vDS (Distributed Virtual Switch) and network segment configuration:
- DVS name (default
<prefix>-cl01-vds01) - MTU —
9000for jumbo frames (recommended). Must match your physical switch config. - Load balancing policy — typically Route based on originating virtual port (Source Port ID) unless you have a specific reason (LAG, source MAC hash).
- Network segments — the CIDR/VLAN pairs from the defaults block, already populated.
6. NSX tab
NSX Manager cluster config:
- Three-node NSX Manager cluster with VIP (production). For labs, a single node is acceptable.
- Shared credentials — admin, audit, root, CLI passwords.
- TEP & Transport — the TEP network from the defaults block. Transport type is
OVERLAYfor VXLAN/GENEVE tunnels orVLANif you’re not doing overlay.
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:
- vSAN ESA — recommended for new all-NVMe deployments on VCF 9.
- vSAN OSA — legacy hybrid/all-flash with cache+capacity disk groups.
- NFS — external NFS array. Requires server IP, export path, and datastore name.
- VMFS on FC — existing FC SAN. Requires LUN/WWN mapping details.
8. Operations tab
Only applies if you’re deploying VCF (not VVF):
- VCF Operations — the unified ops console (formerly vRealize Operations Manager).
- Fleet Management — lifecycle and patching.
- Operations Collector — if you need a separate collector appliance.
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
| Field | Required | Notes |
|---|---|---|
| Instance Prefix | yes | Lower-case alphanumeric, ≤6 chars recommended |
| Domain Suffix | yes | Must be resolvable in DNS |
| ESX Hostname Base | yes | Combined with host index: esx01, esx02, … |
| Number of ESX Hosts | yes | 3 (PoC) or ≥4 (Production) |
| VCF Version | yes | Default 9.0.2.0 |
| Management Network | yes | CIDR, usually /24 |
| vMotion Network | yes | CIDR, separate subnet from management |
| vSAN Network | if vSAN | CIDR, separate subnet, jumbo MTU |
| VM Management Network | yes | CIDR used by VM traffic |
| Overlay / TEP Network | if NSX overlay | CIDR for TEP addresses |
| Management / vMotion / vSAN / VM / TEP VLAN | yes each | 1–4094; don’t use VLAN 1 |
Tabs
- Overview — SDDC identity, DNS/NTP, datacenter & cluster names, CEIP opt-in, global password.
- Hosts — per-host FQDNs, IPs (mgmt/vMotion/vSAN/TEP), root passwords, vSAN disk claims.
- vCenter — vCenter FQDN, VM size, SSO domain, root & SSO admin passwords.
- SDDC Manager — SDDC Manager FQDN, root/SSH/local passwords (under Overview).
- Networking — DVS name, MTU, load-balancing policy, network segments.
- NSX — NSX Manager cluster (3-node + VIP), credentials, TEP configuration, transport type.
- Storage — vSAN ESA/OSA, NFS, or VMFS-FC with specific fields per type.
- Operations — VCF Operations, Fleet Management, Operations Collector appliances.
- Automation — VCF Automation appliance details.
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.
- Pros: simpler config, better performance with NVMe, native compression
- Requires: all-NVMe hosts on the vSAN ESA HCL
- Fields: per host, list the NVMe device paths (
naa.xxxx) that back vSAN
vSAN OSA (Original Storage Architecture)
The classic hybrid/all-flash model with cache + capacity disk groups.
- Pros: works with mixed hardware
- Fields: per host, cache device + list of capacity devices per disk group
- Limit: up to 5 disk groups per host
NFS
External NFS array mounted as the primary datastore.
- Fields: NFS server IP or FQDN, export path (
/vol/vcf01), datastore name, read-only flag
VMFS on Fibre Channel
Existing FC SAN presenting LUNs to all hosts.
- Fields: LUN WWN, datastore name, shared across all hosts in the cluster
Examples
Minimum-viable lab deployment for VCF 9 testing.
- Prefix:
lab· Domain:vcf.lab· Hosts: 3 (PoC minimum) - Workflow:
VCFwith 1-node NSX Manager - Networks:
10.0.10.0/24mgmt,10.0.11.0/24vMotion,10.0.12.0/24vSAN,10.0.13.0/24VM,10.0.14.0/24TEP - Storage: vSAN ESA · 2× NVMe per host
- Operations/Automation: skipped (optional for PoC)
Typical enterprise management domain.
- Prefix:
m01· Domain:corp.local· Hosts: 4 (Production minimum) - Workflow:
VCFwith 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
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
OVERLAY, you must have a dedicated TEP network and VLAN. A missing TEP CIDR is the most common JSON export error caught by validation.
Related tools
Tools that pair well with the JSON Builder: