Academy/Holodeck Lab Setup & Operations/Holodeck & VCF Command Reference — Complete API Toolkit
This lab targets VCF 5.2.x / 9.0.x

Holodeck & VCF Command Reference — Complete API Toolkit

VCF 5.2.x / 9.0.xAdvancedadminarchitectvcdxreference⏱ 240 min

Command reference for Holodeck 9.0.x (9.0.2.19) and VCF 5.2.x/9.0.x. Superseded for Holodeck 9.1: 9.1 makes -Site mandatory on Import-HoloDeckConfig, retires the DNS cmdlets in favour of Technitium, and extends Update-HoloDeckInstance (-DeployVcfAutomation, -DeploySupervisor, -DeployNewHosts) — see the Holodeck 9.1 labs. Checked against: (1) Official docs at vmware.github.io/Holodeck, (2) VMware blog GA announcements (9.0/9.0.1/9.0.2), (3) Live Holodeck 9.0.2.19 deployment on HPE DL385 Gen10 Plus v2, (4) GitHub issues tracker (12 issues listed in Task 15, snapshot 2026-04-19 — refresh from GitHub). Covers the Holodeck 9.0.x cmdlets in the official command reference (lifecycle, config, network query, DNS/network management, Set-HoloRouter/Reset-HoloRouter, Reset-HoloDeckState), plus New-HoloDeckESXiNodes (Day 2), SDDC Manager REST API (20+ endpoints), vCenter REST API (8+ endpoints), NSX Manager API (4+ endpoints), kubectl commands for HoloRouter, version deprecation history, Offline Depot Appliance guide, Developer Mode env vars, and GitHub known issues tracker. Applicability: Holodeck 9.0.x; VCF 5.2.x-9.0.x (API responses differ by version). Every command includes full parameter tables, real working examples, known gotchas, and validation source.

Objectives

  • Master all 9 Holodeck Toolkit lifecycle cmdlets with full parameter documentation and real-world examples
  • Understand configuration management with the documented config cmdlets (New-HoloDeckConfig, Get-HoloDeckConfig, Import-HoloDeckConfig, Reset-HoloDeckState); Set-HoloDeckConfig is not in the official command reference and is treated as unverified
  • Query Holodeck network topology using 7 query cmdlets: subnets, app networks, IP pools, overlay segments, BGP, DNS, service IPs
  • Authenticate to and query SDDC Manager REST API: tokens, domains, clusters, hosts, vCenters, NSX, network pools, credentials, DNS/NTP, tasks, backups, bundles
  • Authenticate to and query vCenter REST API: session auth, datacenters, folders, hosts, resource pools, datastores, VMs, networks
  • Authenticate to and query NSX Manager API: transport zones, transport node profiles, segments, compute managers
  • Use kubectl to inspect HoloRouter: pods, services, dnsmasq configuration, FRR BGP routing, DHCP logs
  • Build a troubleshooting matrix: what works, what fails, specific error messages, and workarounds
  • Develop proficiency as a reference lab that eliminates need to consult external documentation during lab work
  • Understand Holodeck version evolution: 9.0 → 9.0.1 → 9.0.2 with deprecations, renames, and new features
  • Configure DNS records with Set-HoloDeckDNSConfig and Remove-HoloDeckDNSConfig for custom lab topologies
  • Generate dual-site network configurations with New-HoloDeckNetworkConfig
  • Use the built-in precheck phase of New-HoloDeckInstance as the go/no-go gate before a full deployment
  • Scale lab environments post-deployment using New-HoloDeckESXiNodes for Day 2 host addition
  • Set up and use the Offline Depot Appliance (ODA) for air-gapped deployments with Jupyter Lab and VDT
  • Configure Developer Mode with environment variables for automated/CI-driven deployments
  • Track and work around active GitHub issues affecting Holodeck lab reliability

Prerequisites

Active Holodeck VCF 5.2.2 or 9.0.x lab environment with all management domain components running (SDDC Manager, vCenter, NSX Manager). SSH access to HoloRouter available.

Required skills:

  • PowerShell 7.x fundamentals (cmdlets, variables, pipeline)
  • kubectl CLI basics for Kubernetes pod management
  • REST API concepts: Basic auth, Bearer tokens, JSON responses
  • VCF architecture basics: SDDC Manager, vCenter, NSX, ESXi, domains, clusters
📸 Starting State: S3-9x — Management Domain Deployed (VCF 9.x)

Lab Environment

management_domain: MGMT (1 management cluster + 1 edge cluster)

workload_domain: WLD-01 (optional; 1 workload cluster + 1 edge cluster)

network_scheme: 10.1.x.x (mgmt), 10.2.x.x (site-b if dual-site), 172.16.x.x (overlay)

key_components: {"HoloRouter": "10.1.1.1 (management-subnet gateway; K8s control plane, DNS, DHCP, BGP)", "SDDC_Manager": "10.1.1.5 (sddcmanager-a.site-a.vcf.lab; reported as the SDDC Manager identity by SoS on a Holodeck 9.0.x deployment, Holodeck GitHub issue #94 \u2014 confirm with Get-HoloDeckAppNetwork -Site a)", "vCenter_Mgmt": "vc-mgmt-a.site-a.vcf.lab \u2014 the IP is not published in the Holodeck docs; record it from Get-HoloDeckAppNetwork -Site a (shown as <vc-mgmt-a-ip> in the examples below)", "NSX_Manager": "nsx-mgmt-a.site-a.vcf.lab \u2014 the IP is not published in the Holodeck docs; record it from Get-HoloDeckAppNetwork -Site a (shown as <nsx-mgmt-a-ip> in the examples below)", "vCenter_Wld": "vc-wld01-a.site-a.vcf.lab, if a workload domain is deployed \u2014 record its IP from Get-HoloDeckAppNetwork -Site a (shown as <vc-wld01-a-ip>)"}

Credentials

SystemUsernamePassword
administratoradministrator@vsphere.localSee the password_default entry
password_defaultVMware123!VMware123! (Holodeck default password for all nested components, used identically in the UI and the APIs)
nsx_adminadminVMware123!VMware123!
esxi_rootrootSame as the password_default entry (Holodeck default for the nested ESX root account)
holodeck_sshrootPassword set during HoloRouter OVA deployment (no published default)
  • Environment type: holodeck-vcf

Network details

ItemValue
mgmt subnet10.1.1.0/24
mgmt vlan0
mgmt gateway10.1.1.1
vsan subnet10.1.2.0/25
vmotion subnet10.1.3.0/25
htep subnet10.1.3.128/25
cidr default site a10.1.0.0/20
cidr default site b10.2.0.0/20
overlay range172.16.0.0/12

Constraints

  • All API calls must use IP addresses, not FQDNs (PowerShell DNS resolver limitation)
  • All nested components (SDDC Manager, vCenter, NSX, ESX) use the Holodeck default password from the password_default entry; there is no API-specific password format
  • Holodeck Toolkit cmdlets require Import-HoloDeckConfig before any Get-HoloDeck* queries
  • HoloRouter is a Photon OS (systemd) appliance, but DNSMASQ DNS/DHCP run as Kubernetes pods: manage DNSMASQ with kubectl, not systemctl
  • Some endpoints are missing in VCF 5.2.2 and 9.0.2.19 (documented in Task 10)

Tasks

Task 1 Task 1: Holodeck Toolkit Lifecycle Cmdlets (6 documented, plus the built-in prechecks)

Master all 9 lifecycle management cmdlets with complete parameter reference and real examples

Step 1

New-HoloDeckInstance — Complete Parameter Reference — Deploy a new Holodeck VCF instance with full customization

New-HoloDeckInstance -Version '5.2.2' -InstanceID 'mylab' -vSANMode 'OSA' -WorkloadDomainType 'SharedSSO'
New-HoloDeckInstance -Version '9.0.2.0' -InstanceID 'vcf9lab' -vSANMode 'ESA' -ManagementOnly -NsxEdgeClusterMgmtDomain
New-HoloDeckInstance -Version '9.0.2.0' -InstanceID 'autolab' -DeployVcfAutomation
New-HoloDeckInstance -Version '9.0.2.0' -InstanceID 'tanzu-lab' -DeploySupervisorWkldDomain -DeploySupervisorMgmtDomain
New-HoloDeckInstance -Version '5.2.2' -InstanceID 'site-b' -Site 'b' -CIDR '10.2.0.0/20'
ParameterTypeRequiredDefaultValuesDescription
-Versionstringyes9.0.0.0, 9.0.1.0, 9.0.2.0, 5.2, 5.2.1, 5.2.2VCF deployment version (mandatory, no default). 9.0.x includes VCF Automation and Supervisor options; 5.2.x is legacy. Holodeck 9.1 adds 9.1.0.0, 5.2.3 and 5.2.4.
-InstanceIDstringyesUnique identifier for the Holodeck instance. Used in all subsequent cmdlets.
-CIDRstringno10.1.0.0/20 (Site A), 10.2.0.0/20 (Site B)Management network CIDR. MUST be /20 netmask. Holodeck reserves 4 /22s within the /20.
-vSANModestringnoOSAESA, OSAvSAN mode. ESA = Express Storage Architecture (Holodeck: VCF 9.x). OSA = Original Storage Architecture (default).
-ManagementOnlyswitchnoFalseDeploy management domain only (no workload domain). Useful for testing or minimal deployments.
-WorkloadDomainTypestringnoSharedSSOSharedSSO, IsolatedSSOVCF 5.2 only. SharedSSO = the workload-domain vCenter joins the management SSO domain; IsolatedSSO = the workload-domain vCenter uses a separate SSO domain (wld.sso). Both deploy a dedicated workload-domain vCenter — this is the SSO-topology design decision, not a vCenter count.
-NsxEdgeClusterMgmtDomainswitchnoFalseDeploy NSX edge cluster in management domain.
-NsxEdgeClusterWkldDomainswitchnoFalseDeploy NSX edge cluster in workload domain.
-DeployVcfAutomationswitchnoFalseDeploy VCF Automation (9.0+ only). Adds Automation UI, APIs, and services.
-DeploySupervisorWkldDomainswitchnoFalseDeploy Supervisor cluster in workload domain (9.0+ only). Enables Tanzu/K8s workloads.
-DeploySupervisorMgmtDomainswitchnoFalseDeploy Supervisor cluster in management domain (9.0+ only).
-ProvisionOnlyswitchnoFalseProvision VMs and networks but skip VCF/NSX initialization. Allows manual completion.
-DNSDomainstringnovcf.labDNS domain for all components; sites use site-a.<domain> and site-b.<domain> (e.g., sddcmanager-a.site-a.vcf.lab).
-VLANRangeStartInt32[]no[10,40] (Site A, Site B)Start of the custom VLAN range, one value per site. Site A needs 16 consecutive VLAN IDs and Site B 19. Default VLANs: 0 and 10-25 (Site A), 40-58 (Site B).
-Sitestringnoaa, bSite identifier for dual-site deployments (Site A or Site B).
-DepotTypestringnoOnlineOnline, OfflineDepot source (VCF 9.x only): Online (internet-based) or Offline (offline depot). Input parameters are case-sensitive from Holodeck 9.0.1.
-DeveloperModeswitchnoFalseEnables automated (non-interactive) deployments: the interactive inputs are read from environment variables instead of prompts (see Task 14).
-VVFswitchnoFalseDeploy a VMware vSphere Foundation (VVF) instance (-Version 9.0.0.0 and later only).
-LogLevelstringnoINFOINFO, DEBUG, SUCCESS, WARN, ERRORVerbosity of deployment logs.
Validate Deployment begins; monitor with Get-HoloDeckInstance -InstanceID <id>
Deprecated Parameters:
-Interactive — Removed in 9.0.2. Replacement: Update-HoloDeckInstance cmdlet. Reason: Replaced with dedicated Day 2 cmdlet for better automation support
-DeploySupervisor — Removed in 9.0.2. Replacement: -DeploySupervisorWkldDomain. Reason: Renamed for clarity — now explicit about workload domain scope
Version History:
Holodeck 9.0 (June 30, 2025)
Initial release. Supports VCF 5.2.x and 9.0.0.0. Introduced -Interactive parameter for Day 2 ops. -DeploySupervisor for workload domain.
Deprecated In Later: -Interactive (removed in 9.0.2), -DeploySupervisor (renamed to -DeploySupervisorWkldDomain in 9.0.2)
Holodeck 9.0.1 (October 21, 2025)
Added VCF 9.0.1.0 and 5.2.1/5.2.2 support. Custom VLAN and DNS domain support. Unique port group for dual-site prechecks.
New Parameters: -VLANRangeStart, -DNSDomain
Removed From Dns Cmdlets: -ConfigPath (removed from Set/Remove-HoloDeckDNSConfig), -Update (removed from Set-HoloDeckDNSConfig)
Holodeck 9.0.2 (March 5, 2026)
VCF 9.0.2.0 support. -InstanceID now MANDATORY. Supervisor in management domain. Day 2 via Update-HoloDeckInstance replaces -Interactive.
New Parameters: -DeploySupervisorMgmtDomain
Removed: -Interactive
New Cmdlets: Update-HoloDeckInstance, Get-HoloDeckInstance (enhanced), Get-HolodeckServiceIPPools
Renamed: -DeploySupervisor -> -DeploySupervisorWkldDomain
Step 2

Start-HoloDeckInstance — Power On

Start-HoloDeckInstance -InstanceID mylab
Output
Instance mylab starting... (the nested ESX hosts and the VCF appliances on them power on; allow time for vCenter, NSX and SDDC Manager services to come up)
Start-HoloDeckInstance -InstanceID mylab -Force
Output
Instance starts without the confirmation prompt
ParameterTypeRequiredDescription
-InstanceIDstringyesID of the instance to start
-ForceswitchnoSkip the confirmation prompt
Validate Monitor the nested VMs: Get-HoloDeckInstance -InstanceID mylab, or watch the VM power states in the target vCenter/ESX host
GitHub #108: Start-HoloDeckInstance fails with 'Cannot find associated appliances' — Status: Open (reported Mar 9, 2026)
Workaround: Check GitHub issue for latest workaround or wait for patch
Ref: https://github.com/vmware/Holodeck/issues/108
Step 3

Stop-HoloDeckInstance — Power Off

Stop-HoloDeckInstance -InstanceID mylab
Output
Instance mylab stopping... (expect 2-5 minutes)
Stop-HoloDeckInstance -InstanceID mylab -Force
Output
Instance powers off without the confirmation prompt
ParameterTypeRequiredDescription
-InstanceIDstringyesID of the instance to stop
-ForceswitchnoSkip the power-off confirmation prompt
Validate Verify: Get-HoloDeckInstance -InstanceID mylab and the target vCenter show the instance VMs powered off
Step 4

Remove-HoloDeckInstance — Destroy and Clean Up

Remove-HoloDeckInstance
Output
Removes the nested ESX hosts and the VCF Installer/Cloud Builder VM for the instance in $config (15-second window to abort)
Remove-HoloDeckInstance -ResetHoloRouter
Output
Instance removed and HoloRouter networking cleared; HoloRouter reboots
ParameterTypeRequiredDescription
-InstanceIDstringnoInstance to remove (optional from 9.0.1; if omitted, taken from the loaded $config)
-ResetHoloRouterswitchnoAlso remove this instance's HoloRouter networking (HoloRouter reboots automatically)
Validate Verify: the instance's nested VMs are gone from the target vCenter/ESX host and Get-HoloDeckInstance no longer returns it
Version Notes: 9.0.1 improvement: Optional InstanceID parameter (if omitted, captured from global config). Replaced user confirmation prompt with 15-second abort window (press any key to abort). Source: Blog 9.0.1 GA announcement. Documented syntax: Remove-HoloDeckInstance [-ResetHoloRouter]; a -site or -DualSite parameter does not appear in the command reference.
Step 5

Get-HoloDeckInstance — Query Instance Status

Get-HoloDeckInstance -InstanceID mylab
Output
InstanceID, DeploymentVersion (5.2.2), HoloDeckVersion (9.0.2.19), ESXiVersion (8.0 Update 3), NSXVersion (4.2.3), Status (Running/Stopped), CreatedTime, ComponentHealth, etc.
$instance = Get-HoloDeckInstance -InstanceID mylab; $instance.Status
Output
Running
ParameterTypeRequiredDescription
-InstanceIDstringyesID of the instance to query
Validate Instance details match deployment parameters
Step 6

Update-HoloDeckInstance — Modify Existing Instance — Day 2 operations cmdlet (new in 9.0.2). Replaces New-HoloDeckInstance -Interactive. One parameter set per invocation: -AdditionalCluster (switch) deploys a 3-node vSphere cluster in the domain named by the mandatory -VIDomain (Management or Workload); -AddVcfAutomationAllAppsOrg creates an All Apps Org. Holodeck 9.1 adds further Day 2 sets (-DeployVcfAutomation, -DeploySupervisor with -VIDomain and -SupervisorDeploymentMode, -DeployNewHosts) — see the 9.1 docs, Day 2 Operations.

Update-HoloDeckInstance -Site a -AdditionalCluster -VIDomain Workload
Output
Additional 3-node vSphere cluster deployed in the Site A workload domain
Update-HoloDeckInstance -Site a -AddVcfAutomationAllAppsOrg -VIDomain Management
Output
All Apps Org created in VCF Automation for the management domain
ParameterTypeRequiredValuesDescription
-Sitestringyesa, bSite identifier of the instance
-VIDomainstringyesManagement, WorkloadTarget domain for the operation
-AdditionalClusterswitchnoDeploy an additional 3-node vSphere cluster in the specified domain (parameter set AddCluster)
-AddVcfAutomationAllAppsOrgswitchnoCreate an All Apps Org in VCF Automation for the specified domain (parameter set VcfAutomation; VCF Automation and Supervisor must already be deployed)
Validate Query with Get-HoloDeckInstance to confirm changes
Version Notes: New in 9.0.2; replaces -Interactive. Source: Holodeck 9.1 cmd reference (Update-HoloDeckInstance) and 9.1 GA blog, read 1 Oct 2026.
Step 7

Sync-HoloDeckInstance — not in the official command reference (unverified) — Not in the official Holodeck command reference (9.0.2 or 9.1: 24 cmdlets, New-HoloDeckInstance through Remove-HoloDeckDNSConfig). The cmdlet below surfaced only in earlier Academy drafts; no documentation, release note or GitHub reference describes it, and "Load" is not an approved PowerShell verb. Treat it as unverified until a Get-Command -Module Holodeck capture on a live HoloRouter confirms or refutes it; do not build runbooks on it. Documented equivalent: state is kept on the HoloRouter and New-HoloDeckInstance resumes from the last failure (idempotency); Sync-HolodeckComponents is an internal deployment step, not a user cmdlet.

Get-Command -Module Holodeck | Select-Object Name
Output
The documented cmdlet list; confirm whether Sync-HoloDeckInstance appears before using it
Validate Decision recorded: cmdlet present on your HoloRouter build, or absent (use the documented equivalent)
Step 8

Initialize-HolodeckInstance — not in the official command reference (unverified) — Not in the official Holodeck command reference (9.0.2 or 9.1: 24 cmdlets, New-HoloDeckInstance through Remove-HoloDeckDNSConfig). The cmdlet below surfaced only in earlier Academy drafts; no documentation, release note or GitHub reference describes it, and "Load" is not an approved PowerShell verb. Treat it as unverified until a Get-Command -Module Holodeck capture on a live HoloRouter confirms or refutes it; do not build runbooks on it. Documented equivalent: a new instance is created by New-HoloDeckConfig (target host and credentials) followed by New-HoloDeckInstance -Version -InstanceID.

Get-Command -Module Holodeck | Select-Object Name
Output
The documented cmdlet list; confirm whether Initialize-HolodeckInstance appears before using it
Validate Decision recorded: cmdlet present on your HoloRouter build, or absent (use the documented equivalent)
Step 9

Load-HolodeckInstance — not in the official command reference (unverified) — Not in the official Holodeck command reference (9.0.2 or 9.1: 24 cmdlets, New-HoloDeckInstance through Remove-HoloDeckDNSConfig). The cmdlet below surfaced only in earlier Academy drafts; no documentation, release note or GitHub reference describes it, and "Load" is not an approved PowerShell verb. Treat it as unverified until a Get-Command -Module Holodeck capture on a live HoloRouter confirms or refutes it; do not build runbooks on it. Documented equivalent: instance state is loaded by Import-HoloDeckConfig -ConfigID <id> (9.1: also -Site) at the start of each PowerShell session, and read with Get-HoloDeckInstance -InstanceID.

Get-Command -Module Holodeck | Select-Object Name
Output
The documented cmdlet list; confirm whether Load-HolodeckInstance appears before using it
Validate Decision recorded: cmdlet present on your HoloRouter build, or absent (use the documented equivalent)
Step 10

Built-in prechecks — run at the start of New-HoloDeckInstance (no separate cmdlet) — Holodeck runs its pre-checks when a new deployment is run: binary/content validation, target host reachability, trunk port group and datastore selection, NTP, and (9.1) the soft resource validation that warns when the host is below the recommended size. There is no Start-HoloDeckPrecheck cmdlet in the 9.1 command reference (17 cmdlets); treat the interactive precheck phase of New-HoloDeckInstance as the gate and abort (Ctrl+C) before deployment proceeds if a check fails.

New-HoloDeckInstance -Version 9.0.2.0 -InstanceID mylab -ManagementOnly
Output
Precheck phase: binaries OK, target host reachable, port group/datastore selected, NTP OK, resources >= recommended (or WARN) — then deployment starts
Validate All pre-checks pass in the precheck phase; if any fail, abort, resolve and re-run the same New-HoloDeckInstance command (idempotent resume).
Version Notes: Prechecks documented under Concepts > Built-In PreChecks (Holodeck 9.1 docs). 9.0.1 added unique port-group selection for dual-site; 9.1 added soft resource validation.
Source: Holodeck 9.1 docs (Concepts; cmd reference), read 1 Oct 2026

Validation Gate

✓ Deployed at least one instance with New-HoloDeckInstance

✓ Queried instance status with Get-HoloDeckInstance

✓ Performed power cycle: Stop-HoloDeckInstance, Start-HoloDeckInstance

✓ Updated instance configuration with Update-HoloDeckInstance

✓ Documented the six documented lifecycle cmdlets (New-, Update-, Get-, Stop-, Start-, Remove-HoloDeckInstance) and their outputs

Task 2 Task 2: Holodeck Configuration Management (4 Cmdlets)

Manage Holodeck configurations with New-HoloDeckConfig, Get-HoloDeckConfig and Import-HoloDeckConfig (documented); Set-HoloDeckConfig is recorded as unverified

Step 1

Get-HoloDeckConfig — List All Configurations — Retrieve Holodeck configuration metadata

Get-HoloDeckConfig
Array of configs with ConfigID (SHA5 hash), InstanceID, BasePath, DeploymentVersion, Status, CreatedTime, etc.
Output
ConfigID: a1b2c3d4e5f6g7h8i9j0, InstanceID: mylab, DeploymentVersion: 5.2.2
$config = Get-HoloDeckConfig; $config.ConfigID
Output
a1b2c3d4e5f6g7h8i9j0
Step 2

Import-HoloDeckConfig — Load Config for Query Cmdlets — CRITICAL: Must run before Get-HoloDeck* queries

Get-HoloDeckConfig; Import-HoloDeckConfig -ConfigID <your-config-id>
Configuration imported successfully. No errors.
Validate Next step: Get-HoloDeckSubnet should return results (not errors)
If skipped, all Get-HoloDeck* cmdlets will fail with 'Configuration not found'
ConfigID differs per deployment; if Get-HoloDeckConfig lists several configs, pick yours explicitly (one config = one deployment)
Step 3

Set-HoloDeckConfig — UNVERIFIED (not in the official command reference) — UNVERIFIED: Set-HoloDeckConfig does not appear in the official Holodeck command reference (New-HoloDeckConfig, Get-HoloDeckConfig, Import-HoloDeckConfig, Reset-HoloDeckState are the documented config cmdlets, and the docs say the config JSON is not meant to be edited by hand). The parameter categories below describe the structure of /holodeck-runtime/config/<config-ID>.json as observed; confirm the cmdlet with Get-Command -Module Holodeck before relying on it. The parameter names listed below are not documented by VMware; do not run the examples until Get-Command -Module Holodeck confirms the cmdlet exists. The documented way to change a value is to edit $config.ConfigPath and reload it with Import-HoloDeckConfig (Holodeck 9.0.2 known-issue workaround).

# UNVERIFIED — confirm with Get-Command -Module Holodeck first
$ConfigID = (Get-HoloDeckConfig).ConfigID; Set-HoloDeckConfig -ConfigID $ConfigID -Version '9.0.2.0' -vSANMode 'ESA'
Output
Configuration updated
# UNVERIFIED — confirm with Get-Command -Module Holodeck first
Set-HoloDeckConfig -ConfigID $ConfigID -DeployVcfAutomation $true
Output
VCF Automation enabled in configuration
Target Host
ParameterTypeRequiredValuesDescription
-ConfigIDstringyesConfiguration to modify
-TargetHoststringESXi host FQDN or IP for nested deployment
-UsernamestringESXi root username
-PasswordstringESXi root password
-TargetDatacenterstringExisting vSphere datacenter for nested deployment
-TargetClusterstringExisting ESXi cluster for nested deployment
-TargetDatastorestringDatastore for VM storage
-TargetNetworkstringvSphere port group for external connectivity
-DeprecatedCPUswitchAllow older CPU types (compatibility)
-TargetHostApiTypestringvSphere, OpenStackAPI type of target infrastructure
-HostAgentstringCustom host agent URI
Deployment Options
ParameterTypeValuesDescription
-Versionstring9.0.0.0, 9.0.1.0, 9.0.2.0, 5.2, 5.2.1, 5.2.2VCF version
-sitestringa, bSite identifier
-ManagementOnlyboolManagement domain only
-VVFboolDeploy a VMware vSphere Foundation (VVF) instance
-vSANModestringESA, OSAvSAN storage architecture
-vSphereISOstringCustom vSphere ISO path
-ProvisionOnlyboolProvision without initialization
-WorkloadDomainTypestringSharedSSO, IsolatedSSOWorkload domain SSO type
Networking
ParameterTypeDescription
-NetworkConfigobjectNetwork topology JSON object
-NetworkIdstringNetwork identifier
-NsxEdgeClusterMgmtDomainboolDeploy NSX edge in management domain
-NsxEdgeClusterWkldDomainboolDeploy NSX edge in workload domain
VCF Automation
ParameterTypeDescription
-DeployVcfAutomationboolEnable VCF Automation (9.0+ only)
-VcfAutomationHostProtectionJobEnabledboolEnable host protection job
-VcfAutomationHostProtectionJobVcenterIPstringvCenter IP for automation jobs
-VcfAutomationHostProtectionJobUsernamestringAutomation service account
-VcfAutomationHostProtectionJobPasswordstringAutomation service password
-VcfAutomationHostProtectionJobClusterNamestringTarget cluster for protection jobs
-VcfAutomationHostProtectionJobInstancePrefixstringVM naming prefix
-VcfAutomationHostProtectionJobLogFilestringLog file path
Supervisor/Tanzu
ParameterTypeDescription
-DeploySupervisorWkldDomainboolDeploy Supervisor in workload domain
-DeploySupervisorMgmtDomainboolDeploy Supervisor in management domain
-SupervisorMgmtDomainClusterIdstringCluster ID for Supervisor
-SupervisorMgmtDomainStoragePolicyIdstringvSAN storage policy for Supervisor
-SupervisorMgmtDomainMgmtNetworkIdstringManagement network for Supervisor
-SupervisorMgmtDomainVpcConnectivityProfileIdstringVPC connectivity profile
Workload Domain
ParameterTypeDescription
-ClusterIdstringWorkload cluster ID
-T0PathstringNSX Tier-0 router path
-DomainstringDomain name
-WorkloadDomainClusterImageIdstringvSphere cluster image ID
-WorkloadDomainHostIdsstring[]Host IDs for cluster
-AvnEdgeClusterIdstringNSX edge cluster ID
Additional Cluster
ParameterTypeValuesDescription
-AdditionalClusterTypestringcompute, edgeType of additional cluster
-AdditionalClusterDomainIdstringDomain for cluster
-AdditionalClusterHostIdsstring[]Host IDs for cluster
-AdditionalClusterImageIdstringCluster image ID
-AdditionalClusterNetworkIdstringNetwork ID for cluster
-AdditionalClusterSetupboolEnable cluster setup
-UpdateAdditionalClusterListstring[]List of cluster updates
Proxy/Depot
ParameterTypeValuesDescription
-ProxyProtocolstringhttp, httpsProxy protocol
-ProxyIPstringProxy server IP
-ProxyPortintProxy server port
-ProxyUsernamestringProxy authentication username
-ProxyPasswordstringProxy authentication password
-OfflineDepotIPstringOffline package repository IP
-OfflineDepotPortintOffline depot port
-OfflineDepotProtocolstringhttp, httpsOffline depot protocol
-OfflineDepotUsernamestringOffline depot auth username
-OfflineDepotPasswordstringOffline depot auth password
Generic
ParameterTypeDescription
-ConfigKeystringCustom configuration key
-ConfigValuestringCustom configuration value
Step 4

New-HoloDeckConfig — Create New Configuration — Create a fresh Holodeck configuration

New-HoloDeckConfig -TargetHost '<vCenter or ESX IP/FQDN>' -UserName '<user>' -Password '<password>' -Description 'newlab'
New configuration saved under /holodeck-runtime/config/<config-ID>.json (one config per deployment). Version, vSAN mode and domain options are given later to New-HoloDeckInstance, not here.
Validate Get-HoloDeckConfig returns the new ConfigID
Version Notes: 9.0.1 enhancement: Now validates integrity of config.json template file. If template integrity doesn't match, user sees warning before new config is created. Users should NOT modify the template config file. Source: Blog 9.0.1 GA.
Step 5

Reset-HoloDeckState — Clear Deployment State — Clears the deployment state file ($config.state) to null so that New-HoloDeckInstance no longer resumes from the last recorded step. The action is irreversible.

Reset-HoloDeckState
The state file is cleared
Validate Use only when a failed deployment must start again from the beginning; it clears state only (use Remove-HoloDeckInstance to delete the nested VMs)

Validation Gate

✓ Retrieved configurations with Get-HoloDeckConfig

✓ Imported config with Import-HoloDeckConfig

✓ Checked with Get-Command -Module Holodeck whether Set-HoloDeckConfig exists in your build (it is not in the official command reference)

✓ Created new configuration with New-HoloDeckConfig

✓ Recorded the main sections of your deployment's /holodeck-runtime/config/<config-ID>.json (read-only review)

Task 3 Task 3: Holodeck Network Query Cmdlets (7 Total)

Query complete network topology using 7 specialized cmdlets

Step 1

Get-HoloDeckSubnet — Management Network Subnets — Discover all VLAN subnets in management network

Get-HoloDeckSubnet -Site a | ft -AutoSize
Subnets (10.1.1.0/24 mgmt, 10.1.2.0/25 vsan, 10.1.3.0/25 vmotion, 10.1.3.128/25 htep, etc.), gateways, VLAN IDs, reserved IP ranges
Output
Name: Untagged-HOL, Subnet: 10.1.1.0/24, Gateway: 10.1.1.1, VLAN: 0 (untagged management)
Subnet: 10.1.2.0/25, Type: vSAN, VLAN: <from the Site A range 10-25>
Subnet: 10.1.3.0/25, Type: vMotion, VLAN: <from the Site A range 10-25>
Subnet: 10.1.3.128/25, Type: Host TEP, VLAN: <from the Site A range 10-25>  (illustrative layout — capture the exact names, gateways and VLAN IDs with Get-HoloDeckSubnet -Site a | ft -AutoSize)
Step 2

Get-HoloDeckAppNetwork — Application Networks — Query application-level network segments and IP pools

Get-HoloDeckAppNetwork
Pre-provisioned component IPs/FQDNs for the site, e.g. sddcmanager-a, vc-mgmt-a, nsx-mgmt-a and ESX hosts esx-01a..esx-04a (esx-01a = 10.1.1.10 in the docs' example), all under site-a.vcf.lab
Output
Component: sddcmanager-a, FQDN: sddcmanager-a.site-a.vcf.lab
Component: vc-mgmt-a, FQDN: vc-mgmt-a.site-a.vcf.lab
Component: nsx-mgmt-a, FQDN: nsx-mgmt-a.site-a.vcf.lab
Component: esx-01a, IP: 10.1.1.10, FQDN: esx-01a.site-a.vcf.lab  (illustrative — capture exact values with Get-HoloDeckAppNetwork -Site a)
Step 3

Get-HoloDeckAppIpPools — Service IP Pools — Query IP pools for NSX services and workload VMs

Get-HoloDeckAppIpPools
Pools: VPC Transit (172.16.x.x), Supervisor (10.96.0.0/23), VCFA (198.18.0.0/15), Workload (172.16.1.0/24, etc.)
Output
Pool: vpc-transit, CIDR: 172.16.100.0/24, Type: NSX Transit
Pool: supervisor-pool, CIDR: 10.96.0.0/23, Type: Supervisor (9.0+)
Pool: workload-pool-01, CIDR: 172.16.1.0/24, Gateway: 172.16.1.1, DHCP: 172.16.1.10-172.16.1.200
Step 4

Get-HoloDeckOverlaySubnet — NSX Overlay Segments — Query the NSX overlay subnets the HoloRouter reserves for overlay transport zones and overlay-backed segments (Geneve encapsulation)

Get-HoloDeckOverlaySubnet
Overlay subnets (names, CIDRs, gateways) reserved for NSX overlay transport zones and overlay-backed segments — Geneve encapsulation; capture the exact names and CIDRs from Get-HoloDeckOverlaySubnet -Site a on your build
Output
Segment: region-segment, VNI: 5000, CIDR: 172.16.0.0/24, Encapsulation: Geneve
Segment: dev-segment, VNI: 5001, CIDR: 172.16.1.0/24, Encapsulation: Geneve
Segment: prod-segment, VNI: 5002, CIDR: 172.16.2.0/24, Encapsulation: Geneve
Step 5

Get-HoloDeckBGPConfig — BGP Routing Configuration — Query BGP settings for dynamic routing

Get-HoloDeckBGPConfig
BGP Config: Router AS 65000, Edge Management AS 65001, Edge Workload AS 65002, Password: VMware123!, Neighbors configured
Output
Router ASN: 65000, RouterID: 10.1.1.1
Edge-Mgmt ASN: 65001, Router-ID: 10.1.1.20
Edge-Wld ASN: 65002, Router-ID: 10.1.1.24
BGP Password: VMware123! (configured for all neighbors)
Step 6

Get-HoloDeckDNSConfig — DNS Records — Query all DNS records in Holodeck

Get-HoloDeckDNSConfig
All DNS records: filter by IP or FQDN, resolved IPs, canonical names
Get-HoloDeckDNSConfig | Where-Object { $_.IP -like '10.1.1.*' }
Output
Management component DNS records
Step 7

Get-HoloDeckServiceIPPools — Service IPs (failure observed on one 9.0.2.19 lab) — Query the IP pool allocations for Holodeck infrastructure services (documented as new in Holodeck 9.0.2). One 9.0.2.19 lab returned 'Get-NetworkConfigFilePath not found'; this failure is not in the release notes or the GitHub issue list, so treat it as unconfirmed.

Get-HoloDeckServiceIPPools -Site a
Service IP pool allocations for the site (one lab observed: 'Get-NetworkConfigFilePath not found')
Workaround: Get-Content $config.ConfigPath | ConvertFrom-Json # confirm the service-pool key name on a live lab
Observed on one Holodeck 9.0.2.19 lab: the cmdlet failed with a missing helper function (not in the release notes)
Workaround: read the loaded deployment config (/holodeck-runtime/config/<config-ID>.json via $config.ConfigPath); the template /holodeck-runtime/templates/config.json does not hold your deployment's values

Validation Gate

✓ Ran Get-HoloDeckSubnet and documented all subnets (management, vsan, vmotion, htep)

✓ Ran Get-HoloDeckAppNetwork and found 160+ component FQDNs/IPs

✓ Ran Get-HoloDeckAppIpPools and documented all IP pools

✓ Ran Get-HoloDeckOverlaySubnet and documented 11 overlay segments

✓ Ran Get-HoloDeckBGPConfig and documented AS numbers (65000, 65001, 65002) and BGP password

✓ Ran Get-HoloDeckDNSConfig with filters

✓ Documented Get-HoloDeckServiceIPPools failure (if applicable) and used workaround

Task 4 Task 4: SDDC Manager REST API — Complete Reference (20+ Endpoints)

Master SDDC Manager API authentication and all working endpoints

Step 1

Authentication: POST /v1/tokens — Obtain bearer token for SDDC Manager API

$sddc_ip = '10.1.1.5'
$username = 'administrator@vsphere.local'
$password = 'VMware123!VMware123!'
$body = @{
  username = $username
  password = $password
} | ConvertTo-Json

$response = Invoke-RestMethod -Uri "https://$sddc_ip/v1/tokens" -Method Post -Body $body -ContentType 'application/json' -SkipCertificateCheck
$token = $response.accessToken
$refresh_token = $response.refreshToken
Write-Host "Access Token: $token"
Write-Host "Refresh Token: $refresh_token"
Write-Host "Expires In: $($response.expiresIn) seconds"
TOKEN=$(curl -sk -X POST https://10.1.1.5/v1/tokens \
  -H 'Content-Type: application/json' \
  -d '{"username":"administrator@vsphere.local","password":"VMware123!VMware123!"}' | \
  python3 -c "import sys,json; print(json.load(sys.stdin)['accessToken'])")
echo "Token: $TOKEN"
Output
{
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expiresIn": 3600
}
Username: administrator@vsphere.local or admin@local (Broadcom KB 327195: either account can create the token)
Password is the Holodeck default from the password_default entry (the same value as for the UI); there is no separate API password
Use IP address 10.1.1.5, NOT FQDN sddcmanager-a (PowerShell DNS resolver issue)
Tokens expire after 3600 seconds (1 hour); use refreshToken to extend
Step 2

GET /v1/system — VCF System Information — Get overall VCF system status, version, and configuration

$headers = @{ Authorization = "Bearer $token" }
Invoke-RestMethod -Uri "https://10.1.1.5/v1/system" -Headers $headers -SkipCertificateCheck | ConvertTo-Json
curl -sk https://10.1.1.5/v1/system \
  -H "Authorization: Bearer $TOKEN" | python3 -m json.tool
GET https://10.1.1.5/v1/system
Auth: Bearer $token
Output
{
  "systemId": "system-001",
  "version": "5.2.2.0.0",
  "buildNumber": "1234567",
  "status": "ready",
  "systemTime": "2026-04-19T15:30:00Z",
  "maximumDomains": 10,
  "installedComponents": [
    "vcf",
    "vsan",
    "nsx",
    "sddc-manager"
  ]
}
Endpoint: https://10.1.1.5/v1/system
Step 3

GET /v1/sddc-managers — SDDC Manager appliance — Return the SDDC Manager appliance record (one per VCF instance; availability comes from vSphere HA, there is no SDDC Manager HA cluster or standby node — VCF 5.2 Table 96)

Invoke-RestMethod -Uri "https://10.1.1.5/v1/sddc-managers" -Headers $headers -SkipCertificateCheck | ConvertTo-Json -Depth 10
GET https://10.1.1.5/v1/sddc-managers
Output
{
  "elements": [
    {
      "id": "sddc-mgr-001",
      "hostname": "sddcmanager-a",
      "fqdn": "sddcmanager-a.site-a.vcf.lab",
      "primaryIp": "10.1.1.5",
      "version": "5.2.2.0.0",
      "status": "active"
    }
  ]
}
Endpoint: https://10.1.1.5/v1/sddc-managers
Step 4

GET /v1/domains — All VCF Domains — List management and workload domains

Invoke-RestMethod -Uri "https://10.1.1.5/v1/domains" -Headers $headers -SkipCertificateCheck | ConvertTo-Json -Depth 10
Output
{
  "elements": [
    {
      "id": "domain-1",
      "name": "MGMT",
      "type": "management",
      "status": "READY",
      "clusterCount": 1,
      "hostCount": 4
    },
    {
      "id": "domain-2",
      "name": "WLD-01",
      "type": "workload",
      "status": "READY",
      "clusterCount": 1,
      "hostCount": 3
    }
  ]
}
Endpoint: https://10.1.1.5/v1/domains
Step 5

GET /v1/domains/{domainId}/clusters — Clusters Per Domain — Get clusters within a specific domain NSX Edge nodes are Edge VMs inside the management cluster, not a separate vSphere cluster.

$domain_id = 'domain-1'
Invoke-RestMethod -Uri "https://10.1.1.5/v1/domains/$domain_id/clusters" -Headers $headers -SkipCertificateCheck | ConvertTo-Json -Depth 10
Output
{
  "elements": [
    {
      "id": "cluster-1",
      "name": "mgmt-cluster",
      "type": "management",
      "status": "READY",
      "hostCount": 4
    }
  ]
}
Endpoint: https://10.1.1.5/v1/domains/{domainId}/clusters
Step 6

GET /v1/hosts — All ESXi Hosts — List all ESXi hosts across all clusters and domains

Invoke-RestMethod -Uri "https://10.1.1.5/v1/hosts" -Headers $headers -SkipCertificateCheck | ConvertTo-Json -Depth 10 | head -200
Output
{
  "elements": [
    {
      "id": "host-1",
      "fqdn": "esx-01a.site-a.vcf.lab",
      "ipAddress": "10.1.1.10",
      "clusterid": "cluster-1",
      "cpuCount": 24,
      "memory": 384,
      "vsanMembership": "MEMBER",
      "status": "ONLINE"
    }
  ]
}
Endpoint: https://10.1.1.5/v1/hosts
Step 7

GET /v1/vcenters — vCenter Instances — List all vCenter servers managed by VCF

Invoke-RestMethod -Uri "https://10.1.1.5/v1/vcenters" -Headers $headers -SkipCertificateCheck | ConvertTo-Json -Depth 10
Output
{
  "elements": [
    {
      "id": "vc-1",
      "fqdn": "vc-mgmt-a.site-a.vcf.lab",
      "primaryIp": "<vc-mgmt-a-ip>",
      "domainid": "domain-1",
      "version": "8.0.3",
      "status": "ACTIVE"
    }
  ]
}
Endpoint: https://10.1.1.5/v1/vcenters
Step 8

GET /v1/nsxt-clusters — NSX Manager Clusters — List NSX Manager clusters (the response below is illustrative: nodeCount and version depend on your build, and the Holodeck docs do not state how many NSX Manager nodes it deploys, so record what you observe)

Invoke-RestMethod -Uri "https://10.1.1.5/v1/nsxt-clusters" -Headers $headers -SkipCertificateCheck | ConvertTo-Json -Depth 10
Output
{
  "elements": [
    {
      "id": "nsx-cluster-1",
      "name": "NSX-Cluster",
      "nodeCount": 3,
      "primaryManager": "nsx-manager-01",
      "version": "4.2.3",
      "status": "HEALTHY"
    }
  ]
}
Endpoint: https://10.1.1.5/v1/nsxt-clusters
Step 9

GET /v1/network-pools — Available Network Pools — List IP pools for new domain/cluster provisioning

Invoke-RestMethod -Uri "https://10.1.1.5/v1/network-pools" -Headers $headers -SkipCertificateCheck | ConvertTo-Json -Depth 10
Output
{
  "elements": [
    {
      "id": "pool-1",
      "name": "management-pool",
      "status": "IN_USE",
      "subnet": "10.1.0.0/20",
      "gateway": "10.1.0.1",
      "vlan": 1
    }
  ]
}
Endpoint: https://10.1.1.5/v1/network-pools
Step 10

GET /v1/credentials — Stored Credentials — List the credentials SDDC Manager stores. The response includes each account's password, so treat the output as sensitive and never paste it into notes. Filter with the documented query parameters (resourceType, accountType), e.g. ?resourceType=VCENTER&accountType=USER as the SDDC Manager restore procedure does

Invoke-RestMethod -Uri "https://10.1.1.5/v1/credentials" -Headers $headers -SkipCertificateCheck | ConvertTo-Json -Depth 10
Output
{
  "elements": [
    {
      "id": "cred-1",
      "accountType": "USER",
      "username": "administrator@vsphere.local",
      "creationTime": "2026-01-01T00:00:00Z",
      "lastRotated": "2026-04-01T12:00:00Z",
      "expiryDate": "2026-07-01T00:00:00Z"
    }
  ]
}
Endpoint: https://10.1.1.5/v1/credentials
Step 11

GET /v1/system/dns-configuration — DNS Settings

Invoke-RestMethod -Uri "https://10.1.1.5/v1/system/dns-configuration" -Headers $headers -SkipCertificateCheck | ConvertTo-Json
Endpoint: https://10.1.1.5/v1/system/dns-configuration
Step 12

GET /v1/system/ntp-configuration — NTP Settings

Invoke-RestMethod -Uri "https://10.1.1.5/v1/system/ntp-configuration" -Headers $headers -SkipCertificateCheck | ConvertTo-Json
Endpoint: https://10.1.1.5/v1/system/ntp-configuration
Step 13

GET /v1/tasks — Deployment Task History — Query VCF task history with filtering

Invoke-RestMethod -Uri "https://10.1.1.5/v1/tasks" -Headers $headers -SkipCertificateCheck | ConvertTo-Json -Depth 10 | head -100
# Filter by status
$tasks = Invoke-RestMethod -Uri "https://10.1.1.5/v1/tasks?filter=status%3DFAILED" -Headers $headers -SkipCertificateCheck
$tasks.elements | Where-Object { $_.status -eq 'FAILED' }
Endpoint: https://10.1.1.5/v1/tasks?filter=status%3DSUCCESSFUL
Step 14

GET /v1/backup-configurations — Backup Settings

Invoke-RestMethod -Uri "https://10.1.1.5/v1/backup-configurations" -Headers $headers -SkipCertificateCheck | ConvertTo-Json
Endpoint: https://10.1.1.5/v1/backup-configurations
Step 15

GET /v1/bundles — Software Bundles

Invoke-RestMethod -Uri "https://10.1.1.5/v1/bundles" -Headers $headers -SkipCertificateCheck | ConvertTo-Json
Endpoint: https://10.1.1.5/v1/bundles
Step 16

Non-Working Endpoints & Workarounds — Known failed endpoints and alternatives

EndpointStatusWorkaround
POST /v1/sddc-manager-controller/aboutNOT_FOUND (404)Use GET /v1/system instead
GET /v1/credentials?resourceType=VCENTER&accountType=USERWORKINGDocumented query parameters (resourceType, accountType); no client-side filtering needed
GET /v1/vsan-health-checksNOT_FOUND (404)Use vCenter vSAN REST API instead
GET /v1/resource-certificatesNOT_FOUND (404)Query SSL certs via vCenter or SSH into components directly

Validation Gate

✓ Authenticated to SDDC Manager API with the Holodeck default password

✓ Obtained bearer token and documented expiry (3600 seconds)

✓ Queried /v1/system (system version and status)

✓ Queried /v1/sddc-managers (single appliance per instance)

✓ Queried /v1/domains (management + workload domains)

✓ Queried /v1/clusters per domain

✓ Queried /v1/hosts (all ESXi hosts)

✓ Queried /v1/vcenters (vCenter instances)

✓ Queried /v1/nsxt-clusters (NSX Manager)

✓ Queried /v1/network-pools, /v1/credentials, /v1/dns-configuration, /v1/ntp-configuration

✓ Queried /v1/tasks with filtering

✓ Documented 4 known non-working endpoints with workarounds

Task 5 Task 5: vCenter REST API — Complete Reference (8+ Endpoints)

Master vCenter Session-based authentication and inventory queries

Step 1

Authentication: POST /api/session — Create Session — Establish session with vCenter (NOT Bearer token — uses session ID header)

$vcenter_ip = '<vc-mgmt-a-ip>'
$username = 'administrator@vsphere.local'
$password = 'VMware123!VMware123!'
$auth = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes("$username`:$password"))
$headers_vc = @{ Authorization = "Basic $auth"; Accept = 'application/json' }
$session_id = Invoke-RestMethod -Uri "https://$vcenter_ip/api/session" -Method Post -Headers $headers_vc -SkipCertificateCheck
Write-Host "Session ID: $session_id"
$headers_vc_session = @{ 'vmware-api-session-id' = $session_id }
AUTH=$(echo -n 'administrator@vsphere.local:VMware123!VMware123!' | base64)
SESSION=$(curl -sk -X POST https://<vc-mgmt-a-ip>/api/session \
  -H "Authorization: Basic $AUTH" \
  -H 'Accept: application/json')
echo "Session ID: $SESSION"
vCenter uses Session ID headers, NOT Bearer tokens (unlike SDDC Manager)
Password is the Holodeck default from the password_default entry (same as the UI login)
Use IP <vc-mgmt-a-ip> (management vCenter), NOT FQDN
Session returns plain string, NOT JSON object
Step 2

GET /api/vcenter/datacenter — Datacenters

Invoke-RestMethod -Uri "https://<vc-mgmt-a-ip>/api/vcenter/datacenter" -Headers $headers_vc_session -SkipCertificateCheck | ConvertTo-Json -Depth 10
Output
{
  "value": [
    {
      "datacenter": "datacenter-2",
      "name": "Datacenter-A"
    }
  ]
}
Endpoint: https://<vc-mgmt-a-ip>/api/vcenter/datacenter
Step 3

GET /api/vcenter/folder — Folder Hierarchy

Invoke-RestMethod -Uri "https://<vc-mgmt-a-ip>/api/vcenter/folder" -Headers $headers_vc_session -SkipCertificateCheck | ConvertTo-Json -Depth 10
Endpoint: https://<vc-mgmt-a-ip>/api/vcenter/folder
Step 4

GET /api/vcenter/host — All ESXi Hosts

Invoke-RestMethod -Uri "https://<vc-mgmt-a-ip>/api/vcenter/host" -Headers $headers_vc_session -SkipCertificateCheck | ConvertTo-Json -Depth 10
Endpoint: https://<vc-mgmt-a-ip>/api/vcenter/host
Step 5

GET /api/vcenter/resource-pool — Resource Pools

Invoke-RestMethod -Uri "https://<vc-mgmt-a-ip>/api/vcenter/resource-pool" -Headers $headers_vc_session -SkipCertificateCheck | ConvertTo-Json -Depth 10
Endpoint: https://<vc-mgmt-a-ip>/api/vcenter/resource-pool
Step 6

GET /api/vcenter/datastore — Datastores

Invoke-RestMethod -Uri "https://<vc-mgmt-a-ip>/api/vcenter/datastore" -Headers $headers_vc_session -SkipCertificateCheck | ConvertTo-Json -Depth 10
Endpoint: https://<vc-mgmt-a-ip>/api/vcenter/datastore
Step 7

GET /api/vcenter/vm — Virtual Machines

Invoke-RestMethod -Uri "https://<vc-mgmt-a-ip>/api/vcenter/vm" -Headers $headers_vc_session -SkipCertificateCheck | ConvertTo-Json -Depth 10 | head -100
Endpoint: https://<vc-mgmt-a-ip>/api/vcenter/vm
Step 8

GET /api/vcenter/network — Networks (Port Groups)

Invoke-RestMethod -Uri "https://<vc-mgmt-a-ip>/api/vcenter/network" -Headers $headers_vc_session -SkipCertificateCheck | ConvertTo-Json -Depth 10
Endpoint: https://<vc-mgmt-a-ip>/api/vcenter/network
Step 9

Known Non-Working Endpoint: vSAN Health (8.0.3) — GET /api/vcenter/vsan/clusters returns NOT_FOUND (404) in vCenter 8.0.3

Endpoint: https://<vc-mgmt-a-ip>/api/vcenter/vsan/clusters
Status: NOT_FOUND (404)
Workaround: Query vSAN health via SDDC Manager or use PowerCLI Get-VsanClusterConfiguration

Validation Gate

✓ Authenticated to vCenter with the Holodeck default password and session ID

✓ Queried /api/vcenter/datacenter

✓ Queried /api/vcenter/folder

✓ Queried /api/vcenter/host

✓ Queried /api/vcenter/resource-pool

✓ Queried /api/vcenter/datastore

✓ Queried /api/vcenter/vm

✓ Queried /api/vcenter/network

✓ Documented vSAN health endpoint failure and workaround

Task 6 Task 6: NSX Manager API — Complete Reference (4+ Endpoints)

Query NSX configuration: transport zones, transport node profiles, segments, compute managers

Step 1

Authentication: Basic Auth to NSX Manager — Create Basic auth header for NSX Manager (<nsx-mgmt-a-ip>)

$nsx_ip = '<nsx-mgmt-a-ip>'
$username = 'admin'
$password = 'VMware123!VMware123!'
$auth_nsx = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes("$username`:$password"))
Write-Host "Base64 Auth: $auth_nsx"
# Expected: YWRtaW46Vk13YXJlMTIzIVZNd2FyZTEyMyE=
$headers_nsx = @{ Authorization = "Basic $auth_nsx"; Accept = 'application/json' }
Step 2

GET /api/v1/transport-zones — Transport Zones — Query overlay and VLAN transport zones

Invoke-RestMethod -Uri "https://<nsx-mgmt-a-ip>/api/v1/transport-zones" -Headers $headers_nsx -SkipCertificateCheck | ConvertTo-Json -Depth 10
Output
{
  "results": [
    {
      "id": "1b3a4b5c-6d7e-8f9g-ahij-klmnopqrstuv",
      "display_name": "overlay-tz",
      "transport_type": "OVERLAY",
      "host_switch_name": "nsxvswitch"
    },
    {
      "id": "2c4b5c6d-7e8f-9g0h-ijkl-mnopqrstuvwx",
      "display_name": "vlan-tz",
      "transport_type": "VLAN",
      "host_switch_name": "nsxvswitch"
    }
  ]
}
Endpoint: https://<nsx-mgmt-a-ip>/api/v1/transport-zones
Step 3

GET /policy/api/v1/infra/sites/default/enforcement-points/default/transport-node-profiles — Transport Node Profiles — Query transport node configuration templates

Invoke-RestMethod -Uri "https://<nsx-mgmt-a-ip>/policy/api/v1/infra/sites/default/enforcement-points/default/transport-node-profiles" -Headers $headers_nsx -SkipCertificateCheck | ConvertTo-Json -Depth 10
Endpoint: https://<nsx-mgmt-a-ip>/policy/api/v1/infra/sites/default/enforcement-points/default/transport-node-profiles
Step 4

GET /api/v1/edge-clusters — Edge Clusters — Query NSX edge clusters (may be empty on fresh deploy)

Invoke-RestMethod -Uri "https://<nsx-mgmt-a-ip>/api/v1/edge-clusters" -Headers $headers_nsx -SkipCertificateCheck | ConvertTo-Json -Depth 10
Endpoint: https://<nsx-mgmt-a-ip>/api/v1/edge-clusters
Step 5

GET /policy/api/v1/infra/segments — NSX Segments — Query all logical segments (NSX L2/L3 networks)

Invoke-RestMethod -Uri "https://<nsx-mgmt-a-ip>/policy/api/v1/infra/segments" -Headers $headers_nsx -SkipCertificateCheck | ConvertTo-Json -Depth 10 | head -100
Endpoint: https://<nsx-mgmt-a-ip>/policy/api/v1/infra/segments
Step 6

GET /api/v1/fabric/compute-managers — Compute Managers — Query vCenter integrations with NSX

Invoke-RestMethod -Uri "https://<nsx-mgmt-a-ip>/api/v1/fabric/compute-managers" -Headers $headers_nsx -SkipCertificateCheck | ConvertTo-Json -Depth 10
Endpoint: https://<nsx-mgmt-a-ip>/api/v1/fabric/compute-managers

Validation Gate

✓ Authenticated to NSX Manager (<nsx-mgmt-a-ip>) with the Holodeck default password

✓ Queried /api/v1/transport-zones (overlay + VLAN)

✓ Queried /policy/api/v1/infra/.../transport-node-profiles

✓ Queried /api/v1/edge-clusters

✓ Queried /policy/api/v1/infra/segments (overlay networks)

✓ Queried /api/v1/fabric/compute-managers

Task 7 Task 7: HoloRouter kubectl Commands — K8s Inspection

Master kubectl commands to inspect HoloRouter K8s cluster and verify component connectivity

Step 1

kubectl get pods -A — All Pods Across Namespaces

kubectl get pods -A
HoloRouter infrastructure pods only. On a 9.0.2 HoloRouter the default namespace holds dnsmasq as two Deployments — dnsmasq-dns-deployment (3 pods) and dnsmasq-dhcp-deployment (1 pod) — plus frr-k8s (BGP), frr-k8s-webhook-server and webtop; kube-system holds the Kubernetes control plane and CoreDNS; Technitium replaces dnsmasq in 9.1. VCF components (SDDC Manager, vCenter, NSX Manager) are nested VMs on the nested ESX hosts, not pods. (Holodeck GitHub issue #114, HoloRouter 9.0.2)
kubectl get pods -A | head -30
Output
(excerpt from a HoloRouter 9.0.2, Holodeck GitHub issue #114 — hash suffixes differ on every build)
NAMESPACE      NAME                                      READY   STATUS    RESTARTS   AGE
default        dnsmasq-dhcp-deployment-c9bcb98b6-n5nvw   1/1     Running   0          4h16m
default        dnsmasq-dns-deployment-66d9fbfb9b-6cctv   1/1     Running   0          3h41m
default        dnsmasq-dns-deployment-66d9fbfb9b-b4kgw   1/1     Running   0          3h41m
default        dnsmasq-dns-deployment-66d9fbfb9b-w6bnw   1/1     Running   0          3h41m
default        frr-k8s-jdc6t                             7/7     Running   14         2d4h
default        frr-k8s-webhook-server-5c6bd54d4-sp2cj    1/1     Running   2          2d4h
default        webtop-78cd7b4bb4-448g9                   1/1     Running   2          2d5h
kube-flannel   kube-flannel-ds-vz8lk                     1/1     Running   2          2d5h
kube-system    coredns-5db6bdb8c7-fmzss                  1/1     Running   2          2d4h
...
(no sddc-manager / vcenter / nsx-manager pods — those are nested VMs)
Step 2

kubectl get pods -o wide — Pods with Node Info

kubectl get pods -o wide
Output
(illustrative — pod names follow the 9.0.2 pattern in Holodeck GitHub issue #114; hash suffixes differ on every build)
NAME                                      READY   STATUS    RESTARTS   AGE   NODE
dnsmasq-dhcp-deployment-<hash>            1/1     Running   0          3d    holorouter
dnsmasq-dns-deployment-<hash>             1/1     Running   0          3d    holorouter
dnsmasq-dns-deployment-<hash>             1/1     Running   0          3d    holorouter
dnsmasq-dns-deployment-<hash>             1/1     Running   0          3d    holorouter
frr-k8s-<hash>                            7/7     Running   0          3d    holorouter
webtop-<hash>                             1/1     Running   0          3d    holorouter

SDDC Manager, vCenter and NSX Manager are nested VMs on the nested ESX hosts, not pods (since Holodeck 9.0.2, DNSMASQ runs as 3 DNS pods and 1 DHCP pod).
Step 3

kubectl get svc — All Services

kubectl get svc
Output
(excerpt from a HoloRouter 9.0.2, Holodeck GitHub issue #114; cluster IPs and the external IP list differ per build)
NAME                      TYPE        CLUSTER-IP       EXTERNAL-IP                  PORT(S)
dns-service               ClusterIP   10.106.56.13     192.168.224.1, ... 172.16.3.1   53/TCP,53/UDP
frr-k8s-webhook-service   ClusterIP   10.102.120.175   <none>                       443/TCP
kubernetes                ClusterIP   10.96.0.1        <none>                       443/TCP
webtop                    NodePort    10.108.40.237    <none>

There is no service for SDDC Manager, vCenter or NSX here — reach them at their FQDNs as nested VMs.
Step 4

kubectl get configmap dnsmasq -o yaml — DNS/DHCP Configuration

kubectl get configmap dnsmasq -o yaml
kubectl get configmap dnsmasq -o yaml | head -100
Output
(illustrative — confirm the ConfigMap name with kubectl get configmap -n default; its source manifest is /holodeck-runtime/dnsmasq/dnsmasq_configmap.yaml)
apiVersion: v1
kind: ConfigMap
metadata:
  name: dnsmasq
  namespace: default
data:
  dnsmasq.conf: |
    # Dnsmasq configuration
    listen-address=10.1.1.1
    # DNS records
    address=/sddcmanager-a.site-a.vcf.lab/10.1.1.5
    address=/vc-mgmt-a.site-a.vcf.lab/<vc-mgmt-a-ip>
    address=/nsx-mgmt-a.site-a.vcf.lab/<nsx-mgmt-a-ip>
Step 5

kubectl exec nslookup — DNS Resolution Test

kubectl exec -it $(kubectl get pods -l app=dnsmasq-dns -o name | head -1) -- nslookup sddcmanager-a.site-a.vcf.lab 127.0.0.1
kubectl exec -it <dnsmasq-dns-deployment pod name from kubectl get pods> -- nslookup sddcmanager-a 127.0.0.1
Output
Server:         127.0.0.1
Address:        127.0.0.1#53

Name:   sddcmanager-a
Address: 10.1.1.5
Step 6

kubectl exec FRR vtysh — BGP Routing Status

kubectl exec -it <frr-k8s pod> -c <frr container> -- vtysh -c "show ip route"
kubectl exec -it <frr-k8s pod name> -c <frr container> -- vtysh -c "show bgp summary"
Output
BGP router identifier 10.1.1.1, local AS number 65000
RIB entries 0, using 0 bytes of memory
Peers 2, using 19 KiB of memory
Peer V         AS MsgRcvd MsgSent   TblVer  InQ OutQ  Up/Down State/PfxRcd
router         65001      0       0        0    0    0 00:00:00     0
router         65002      0       0        0    0    0 00:00:00     0
The frr-k8s pod runs several containers (READY 7/7 in Holodeck GitHub issue #114, HoloRouter 9.0.2): take the pod name from kubectl get pods, list its containers with kubectl get pod <frr-k8s pod> -o jsonpath='{.spec.containers[*].name}', and pass the FRR one with -c.
Step 7

kubectl logs dnsmasq-dhcp — DHCP Assignment Logs

kubectl logs $(kubectl get pods -l app=dnsmasq-dhcp -o name | head -1) | grep DHCPACK
kubectl logs <dnsmasq-dhcp-deployment pod name from kubectl get pods> | tail -20
Output
dnsmasq-dhcp[1234]: DHCPACK(<interface>) <leased-ip> <client-mac> <client-hostname>
(illustrative format only: which nested components take DHCP leases depends on your build. Nested hosts use the documented esx-01a..esx-04a.site-a.vcf.lab names on the 10.1.1.0/24 management subnet (esx-01a = 10.1.1.10 in the docs' example); 10.1.2.0/25 is the vSAN subnet.)
Step 8

ip addr show — VLAN Subinterfaces on HoloRouter

ip addr show | grep -E "eth1\.[0-9]|inet "
ip addr show
Output
1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536
    inet 127.0.0.1/8 scope host lo
2: eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500
    inet 192.168.77.20/24 brd 192.168.77.255 scope global eth0
3: eth1: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500
4: eth1.1: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500
    inet 10.1.1.1/24 brd 10.1.1.255 scope global eth1.1
Step 9

cat /etc/resolv.conf — DNS Resolver Configuration

cat /etc/resolv.conf
Output
# Generated by dnsmasq
nameserver 10.1.1.1
search site-a.vcf.lab vcf.lab
Step 10

Important: Manage DNSMASQ with kubectl, not systemctl — HoloRouter is a Photon OS appliance with systemd (for example, persisted iptables rules live in /etc/systemd/scripts/ip4save), but DNSMASQ (3 DNS pods + 1 DHCP pod since Holodeck 9.0.2) runs as Kubernetes workloads. systemctl does not manage DNSMASQ; use kubectl for it.

Wrong: systemctl status dnsmasq (FAILS — dnsmasq is a pod, not a systemd service)
Correct: kubectl get pods -A | grep dnsmasq; kubectl logs <dnsmasq-dns-deployment pod name>

Validation Gate

✓ Ran kubectl get pods -A and identified all major pods

✓ Ran kubectl get pods -o wide and verified node assignments

✓ Ran kubectl get svc and documented service IPs

✓ Ran kubectl get configmap dnsmasq and verified DNS zone records

✓ Tested DNS resolution with kubectl exec nslookup

✓ Verified BGP routing with kubectl exec vtysh

✓ Reviewed DHCP logs with kubectl logs

✓ Checked VLAN interfaces with ip addr show

✓ Confirmed /etc/resolv.conf points to dnsmasq

Task 8 Task 8: PowerCLI Quick Reference — Available Modules

Document PowerCLI modules available on HoloRouter and key cmdlets

Step 1

List All PowerCLI Modules (83 Total)

Get-Module -ListAvailable | Where-Object { $_.CompanyName -like '*VMware*' } | Select-Object Name, Version | Sort-Object Name
83 VMware modules including core, Automation, NSX, vROps, License, ImageBuilder, VUM modules
Key modules: VMware.PowerCLI, VMware.VimAutomation.Core, VMware.VimAutomation.Vds, VMware.VimAutomation.Storage, VMware.VimAutomation.Nsxt, VMware.VimAutomation.HCX, VMware.VimAutomation.WorkloadManagement, VMware.VimAutomation.Security, VMware.Sdk.Vcf.SddcManager, VMware.Sdk.Vcf.CloudBuilder, VMware.Sdk.Nsx.Policy, VMware.VimAutomation.vROps, VMware.VimAutomation.License, VMware.ImageBuilder, VMware.VumAutomation, Holodeck
Step 2

PowerCLI Version and Configuration

Get-PowerCLIVersion
PowerCLI 13.3.0.24145081
Step 3

Core cmdlet patterns for common tasks

Connect-VIServer -Server <vc-mgmt-a-ip> -User administrator@vsphere.local -Password VMware123!VMware123!
Get-Cluster mgmt-cluster | Get-VMHost
Get-Cluster mgmt-cluster | Get-VsanClusterConfiguration
Get-Datastore | Select-Object Name, Type, CapacityGB, FreeSpaceGB

Validation Gate

✓ Listed all PowerCLI modules with Get-Module

✓ Verified PowerCLI version 13.3.0+

✓ Documented 15+ key VMware module names and purposes

Task 9 Task 9: Verified Working vs Non-Working Command Matrix

Build troubleshooting matrix: what works, what fails, error messages, and workarounds

Step 1

SDDC Manager API Working Endpoints Matrix

EndpointStatusNotesCommon ErrorWorkaround
POST /v1/tokensWORKINGUses the Holodeck default password401 Unauthorized → Check the password (Holodeck default) and username
GET /v1/systemWORKINGReturns system status and version
GET /v1/domainsWORKINGLists all domains
GET /v1/hostsWORKINGLarge response; use filtering
GET /v1/credentialsWORKINGResponse includes passwords; treat as sensitive. Filter with resourceType / accountType query parameters
POST /v1/sddc-manager-controller/aboutNOT_FOUND (404)Legacy endpoint removed404 Not FoundUse GET /v1/system instead
GET /v1/credentials?resourceType=VCENTER&accountType=USERWORKINGDocumented filter (resourceType, accountType); used by the SDDC Manager restore procedure
Step 2

vCenter REST API Working Endpoints Matrix

EndpointStatusNotesCommon ErrorWorkaround
POST /api/sessionWORKINGUses Basic auth; returns plain string session ID401 Unauthorized → Check the password (Holodeck default) and username
GET /api/vcenter/datacenterWORKINGLists datacenters
GET /api/vcenter/hostWORKINGLists all hosts
GET /api/vcenter/vmWORKINGLarge response; may take 10+ secondsUse pagination or filter by folder
GET /api/vcenter/vsan/clustersNOT_FOUND (404)Not available in vCenter 8.0.3404 Not FoundUse PowerCLI Get-VsanClusterConfiguration or SDDC Manager API
Step 3

NSX Manager API Working Endpoints Matrix

EndpointStatusNotesCommon ErrorWorkaround
GET /api/v1/transport-zonesWORKINGLists overlay and VLAN TZs
GET /policy/api/v1/infra/segmentsWORKINGLists segments; may be empty on fresh deploy
Step 4

Holodeck Toolkit Cmdlets Working/Non-Working Matrix

CmdletStatusRequirementCommon ErrorWorkaround
Get-HoloDeckSubnetWORKINGImport-HoloDeckConfig firstConfiguration not found → Run Import-HoloDeckConfig
Get-HoloDeckAppNetworkWORKINGImport-HoloDeckConfig first
Get-HoloDeckBGPConfigWORKINGImport-HoloDeckConfig first
Get-HoloDeckServiceIPPoolsFAILED on one 9.0.2.19 lab (unconfirmed)Import-HoloDeckConfig firstGet-NetworkConfigFilePath not foundRead $config.ConfigPath (/holodeck-runtime/config/<config-ID>.json) with Get-Content | ConvertFrom-Json
Step 5

kubectl Commands Working/Non-Working Matrix

CommandStatusPurposeCommon ErrorWorkaround
kubectl get pods -AWORKINGList all pods
kubectl get svcWORKINGList all services
systemctl status dnsmasqFAILSCheck dnsmasq serviceUnit not found (dnsmasq is a pod, not systemd service)Use kubectl logs $(kubectl get pods -l app=dnsmasq-dns -o name | head -1)
kubectl delete pod nsx-manager-0NOT APPLICABLE'Restart NSX Manager' via KubernetesNo such pod — NSX Manager is a nested VM on the management ESX hostsRestart the NSX Manager VM from the nested vCenter (or Stop/Start-HoloDeckInstance for the whole instance)
Step 6

Common Error Messages and Resolutions

401 Unauthorized (SDDC Manager or vCenter)
Cause: Incorrect username or password
Fix: Verify the Holodeck default password (see the password_default entry) and the administrator@vsphere.local username. Use IP not FQDN. Check curl uses Invoke-RestMethod not Invoke-WebRequest alias.
Configuration not found (Holodeck Toolkit)
Cause: Import-HoloDeckConfig not run before Get-HoloDeck* cmdlets
Fix: Run Get-HoloDeckConfig, then Import-HoloDeckConfig -ConfigID <your-config-id> (Holodeck 9.1: add -Site a)
Get-NetworkConfigFilePath not found (Get-HoloDeckServiceIPPools)
Cause: Observed on one Holodeck 9.0.2.19 lab (missing helper function); not in the release notes
Fix: Read the loaded config instead: Get-Content $config.ConfigPath | ConvertFrom-Json (file: /holodeck-runtime/config/<config-ID>.json)
404 Not Found (vCenter /api/vcenter/vsan/clusters)
Cause: Endpoint not available in vCenter 8.0.3
Fix: Use PowerCLI: Connect-VIServer <vc-mgmt-a-ip>; Get-Cluster | Get-VsanClusterConfiguration
curl: command not found or behaves oddly (PowerShell)
Cause: curl is aliased to Invoke-WebRequest in PowerShell
Fix: Use Invoke-RestMethod or /usr/bin/curl (full path) in bash

Validation Gate

✓ Documented 10+ working SDDC Manager endpoints

✓ Documented 4+ working vCenter endpoints

✓ Documented 4+ working NSX endpoints

✓ Documented all 9 Holodeck Toolkit lifecycle cmdlets

✓ Documented 7 Holodeck query cmdlets (including failure case)

✓ Documented 5+ kubectl commands

✓ Compiled 5+ common error messages with resolutions

✓ Created final matrix suitable for quick reference during lab work

Task 10 Task 10: Complete Lab Environment Verification Checklist

Final comprehensive verification that all APIs, cmdlets, and tools are functional

Step 1

Holodeck Toolkit Connectivity Test

Expected result All 4 steps execute without errors; subnets and app networks enumerated
Run: Get-HoloDeckConfig (note your deployment's ConfigID), then Import-HoloDeckConfig -ConfigID <id> (the Holodeck module is pre-loaded on HoloRouter; Holodeck 9.1 also needs -Site a)
Run: Get-HoloDeckInstance -InstanceID <instance>
Run: Get-HoloDeckSubnet (must return subnets, not errors)
Run: Get-HoloDeckAppNetwork (must return ~160 IPs/FQDNs)
Step 2

SDDC Manager API Authentication Test

Expected result Token obtained; /v1/system query returns version 5.2.2 or 9.0.x
Construct auth payload: $body = @{ username='administrator@vsphere.local'; password='VMware123!VMware123!' }
POST to /v1/tokens: $response = Invoke-RestMethod -Uri 'https://10.1.1.5/v1/tokens' -Method Post -Body $body -ContentType 'application/json' -SkipCertificateCheck
Extract token: $token = $response.accessToken
Query /v1/system with token: Invoke-RestMethod -Uri 'https://10.1.1.5/v1/system' -Headers @{ Authorization="Bearer $token" } -SkipCertificateCheck
Step 3

vCenter REST API Authentication Test

Expected result Session ID obtained; datacenter query returns at least one datacenter
Create Basic auth: $auth = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes('administrator@vsphere.local:VMware123!VMware123!'))
POST to /api/session: $session_id = Invoke-RestMethod -Uri 'https://<vc-mgmt-a-ip>/api/session' -Method Post -Headers @{ Authorization="Basic $auth" } -SkipCertificateCheck
Query /api/vcenter/datacenter with session: Invoke-RestMethod -Uri 'https://<vc-mgmt-a-ip>/api/vcenter/datacenter' -Headers @{ 'vmware-api-session-id'=$session_id } -SkipCertificateCheck
Step 4

NSX Manager API Authentication Test

Expected result Transport zones query returns overlay + VLAN zones
Create Basic auth for NSX: $auth_nsx = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes('admin:VMware123!VMware123!'))
Query /api/v1/transport-zones: Invoke-RestMethod -Uri 'https://<nsx-mgmt-a-ip>/api/v1/transport-zones' -Headers @{ Authorization="Basic $auth_nsx" } -SkipCertificateCheck
Step 5

HoloRouter kubectl Access Test

Expected result SSH connects; kubectl commands work; DNS resolution successful
SSH to HoloRouter: ssh root@10.1.1.1
List all pods: kubectl get pods -A
Verify dnsmasq pod: kubectl get pods -l app=dnsmasq-dns
Test DNS: kubectl exec -it <dnsmasq-dns-deployment pod name> -- nslookup sddcmanager-a 127.0.0.1

Validation Gate

✓ Holodeck Toolkit: Config import and query cmdlets functional

✓ SDDC Manager API: Token-based auth and /v1/system query successful

✓ vCenter REST API: Session-based auth and datacenter query successful

✓ NSX Manager API: Basic auth and transport zones query successful

✓ HoloRouter kubectl: Pod enumeration and DNS resolution successful

✓ All logins verified with the Holodeck default password

✓ All IPs verified against Get-HoloDeckAppNetwork -Site a and recorded (SDDC Manager 10.1.1.5, management vCenter, NSX Manager, HoloRouter 10.1.1.1)

✓ Document created with all working commands, parameters, and examples

✓ Error resolution guide compiled for 5+ common failure scenarios

Task 11 Task 11: DNS & Network Management Cmdlets (6 Total)

Manage DNS records and generate network configurations for dual-site deployments. These cmdlets are essential for custom lab topologies and multi-environment setups.

Source: Holodeck documentation (vmware.github.io/Holodeck), Command Reference page

Step 1

Set-HoloDeckDNSConfig — Add/Update DNS Record — Create or update a DNS record in the HoloRouter DNS configuration. Used for adding custom hostname-to-IP mappings beyond the defaults.

Set-HoloDeckDNSConfig -DNSRecord '10.1.5.100 custom-app.site-a.vcf.lab'
Output
DNS record added: 10.1.5.100 custom-app.site-a.vcf.lab
Set-HoloDeckDNSConfig -SearchDNSRecord '10.1.5.100 custom-app.site-a.vcf.lab' -ReplaceDNSRecord '10.1.5.110 custom-app.site-a.vcf.lab'
Output
DNS record replaced
ParameterTypeRequiredDescription
-DNSRecordstringyesSingle-quoted record '<IP> <FQDN>' to add, e.g. '10.1.5.100 custom-app.site-a.vcf.lab'
-SearchDNSRecord / -ReplaceDNSRecordstringnoReplace an existing record: search string and replacement, both single-quoted
Validate Verify with Get-HoloDeckDNSConfig or nslookup from HoloRouter
Version Notes: Valid only for Holodeck versions up to and including 9.0.2. From Holodeck 9.1, DNS is managed in Technitium (web UI at https://dns.vcf.lab). Source: Holodeck 9.1 docs, How To > Add or Update DNS entries.
Step 2

Remove-HoloDeckDNSConfig — Delete DNS Record — Remove a DNS record from the HoloRouter DNS configuration.

Remove-HoloDeckDNSConfig -DNSRecord '10.1.5.100 custom-app.site-a.vcf.lab'
Output
DNS record removed
ParameterTypeRequiredDescription
-DNSRecordstringyesSingle-quoted record '<IP> <FQDN>' to remove
Validate Verify with Get-HoloDeckDNSConfig — record should be absent
Version Notes: Valid only up to Holodeck 9.0.2; 9.1 uses Technitium (https://dns.vcf.lab). Source: Holodeck 9.1 docs, How To > Remove DNS entries.
Step 3

New-HoloDeckNetworkConfig — Generate Dual-Site Network Configuration — Generate network configuration for dual-site Holodeck deployments. MUST be run before New-HoloDeckInstance for Site B to ensure non-overlapping network allocation. Documented dual-site order: New-HoloDeckNetworkConfig -Site a, New-HoloDeckNetworkConfig -Site b, then Set-HoloRouter -dualsite, then New-HoloDeckInstance per site.

New-HoloDeckNetworkConfig -MasterCIDR '10.2.0.0/20' -Site b
Output
Network configuration generated for Site B with default VLAN range (40+) and DNS domain (vcf.lab)
New-HoloDeckNetworkConfig -MasterCIDR '10.3.0.0/20' -Site a -VLANRangeStart 100 -DNSDomain 'lab2.local'
Output
Custom network config: VLANs starting at 100, DNS domain lab2.local
ParameterTypeRequiredDefaultValuesDescription
-MasterCIDRstringyesMaster CIDR block (must be /20). Example: 10.2.0.0/20
-NoOfSubnetsintnoNumber of subnets to generate within the CIDR
-bgpPasswordstringnoBGP peering password for inter-site routing
-Sitestringyesa, bTarget site for network config
-VLANRangeStartintno10 (Site A), 40 (Site B)Starting VLAN ID. New in 9.0.1.
-DNSDomainstringnovcf.labCustom DNS domain. New in 9.0.1.
Validate Config file generated; verify with Get-HoloDeckConfig before deploying
Version Notes: -VLANRangeStart and -DNSDomain added in 9.0.1.
Step 4

New-HoloDeckESXiNodes — Add ESXi Hosts Post-Deployment (Day 2) — Dynamically add nested ESXi hosts to an existing Holodeck deployment. Essential for scaling lab environments after initial deployment. Note: This cmdlet appears in Getting Started docs but NOT in the Command Reference page — possible official docs oversight.

New-HoloDeckESXiNodes -Nodes 3 -CPU 8 -MemoryInGb 64 -vSANMode 'ESA'
Output
3 ESXi nodes deployed with 8 CPU cores and 64 GB RAM each
ParameterTypeRequiredValuesDescription
-NodesintyesNumber of ESXi nodes to add
-CPUintnoCPU cores per node
-MemoryInGbintnoMemory per node in GB
-Sitestringnoa, bTarget site
-vSANModestringnoESA, OSAvSAN mode for new nodes
Validate Verify new hosts appear in vCenter inventory and SDDC Manager commission list
GitHub #113: New-HoloDeckESXiNodes fails — Status: Open (reported Mar 13, 2026) — Workaround provided
Ref: https://github.com/vmware/Holodeck/issues/113
Step 5

Set-HoloRouter / Reset-HoloRouter — HoloRouter Networking Setup and Reset — Set-HoloRouter configures DNSMASQ, FRR and the VLANs on HoloRouter; -dualsite adds VRF separation for a dual-site build and is a required step after New-HoloDeckNetworkConfig for both sites. Reset-HoloRouter uninstalls the DNSMASQ, FRR and VLAN configuration; run Set-HoloRouter again to re-initialise.

Set-HoloRouter -dualsite
Output
(run after New-HoloDeckNetworkConfig for Site a and Site b, before New-HoloDeckInstance)
Reset-HoloRouter
Output
(removes DNSMASQ, FRR and VLAN configuration — affects every instance on this HoloRouter)
ParameterTypeRequiredDescription
-dualsiteswitchnoConfigure HoloRouter for two sites (VRF separation)
-CIDRstring[]noCustom CIDRs for HoloRouter routes
Validate Check the site networks with Get-HoloDeckSubnet -Site a and -Site b before running New-HoloDeckInstance
Version Notes: Syntax per the Holodeck 9.0.x command reference: Set-HoloRouter [-dualsite] [-CIDR <String[]>]; Reset-HoloRouter.

Validation Gate

✓ Added at least one custom DNS record with Set-HoloDeckDNSConfig

✓ Verified DNS resolution from HoloRouter

✓ Removed a DNS record with Remove-HoloDeckDNSConfig

✓ Generated network config for Site B with New-HoloDeckNetworkConfig

✓ Understood New-HoloDeckESXiNodes limitations (GitHub #113)

✓ Recorded where Set-HoloRouter -dualsite sits in the dual-site sequence and what Reset-HoloRouter removes

Task 12 Task 12: Holodeck Version History & Deprecation Tracker

Comprehensive version-by-version changelog for VCDX study. Understand what changed, what was deprecated, and what's new across all 3 releases.

Source: Holodeck documentation (vmware.github.io/Holodeck), Release Notes page, and the Holodeck GA announcement blogs

Releases:

  • Version: Holodeck 9.0

    Release Date: June 30, 2025

    Blog Author: Jatin Purohit

    Vcf Versions Supported:

    • 5.2
    • 9.0.0.0

    Resource Requirements: ~30 CPU cores, ~325 GB memory, ~1.1 TB disk (full VCF 9.0 mgmt + workload)

    Download Token: Required — VCF entitlement via: purchased, trial, NFR, pass VCP, or VCP + VMUG Advantage

    Key Features:

    • HoloRouter (Photon OS) with K8s-based DNS/DHCP/NTP/BGP/Proxy services
    • VCF and VVF deployment support
    • vSAN ESA and OSA support
    • Online and offline depot with proxy
    • Optional Supervisor in workload domain
    • Optional NSX Edge Cluster in management and/or workload domain
    • ProvisionOnly mode for greenfield experience
    • -Interactive parameter for Day 2 operations

    Cmdlets Introduced:

    • New-HoloDeckInstance
    • Start-HoloDeckInstance
    • Stop-HoloDeckInstance
    • Remove-HoloDeckInstance
    • New-HoloDeckConfig
    • Get-HoloDeckConfig
    • Set-HoloDeckConfig
    • Import-HoloDeckConfig
    • New-HoloDeckNetworkConfig
    • Get-HoloDeckSubnet
    • Get-HoloDeckAppNetwork
    • Get-HoloDeckAppIpPools
    • Get-HoloDeckOverlaySubnet
    • Get-HoloDeckBGPConfig
    • Get-HoloDeckDNSConfig
    • Set-HoloDeckDNSConfig
    • Remove-HoloDeckDNSConfig

    Cmdlets Note: Set-HoloDeckConfig is not in the official command reference either (configs are created by New-HoloDeckConfig and the docs say not to edit them by hand); it is kept in Task 2 as unverified.

  • Version: Holodeck 9.0.1

    Release Date: October 21, 2025

    Blog Author: Ben Sier

    Vcf Versions Supported:

    • 5.2
    • 5.2.1
    • 5.2.2
    • 9.0.0.0
    • 9.0.1.0

    Key Enhancements:

    • Multi-version support: Added VCF 5.2.1, 5.2.2, 9.0.1.0
    • Custom VLAN allocation: -VLANRangeStart parameter on New-HoloDeckInstance and New-HoloDeckNetworkConfig
    • Custom DNS domain: -DNSDomain parameter (default remains vcf.lab)
    • New-HoloDeckConfig template validation: Warns if template modified
    • Remove-HoloDeckInstance: 15-second abort window replaces prompt
    • Unique port group selection for dual-site prechecks
    • NSX Image validation fixes

    Parameters Removed:

    • -ConfigPath (from Set-HoloDeckDNSConfig and Remove-HoloDeckDNSConfig)
    • -Update (from Set-HoloDeckDNSConfig)

    Known Issues Introduced:

    • SDDC Manager loopback /etc/hosts issue (#42)
    • VMCA Certificate installation failure (#43)
    • VCF Ops Collector hang (#46)
    • VCF Download Tool proxy failure (#22)
  • Version: Holodeck 9.0.2

    Release Date: March 5, 2026

    Blog Author: Dhruv Tyagi

    Vcf Versions Supported:

    • 5.2
    • 5.2.1
    • 5.2.2
    • 9.0.0.0
    • 9.0.1.0
    • 9.0.2.0

    Key Enhancements:

    • VCF 9.0.2.0 deployment support
    • Supervisor in management domain: -DeploySupervisorMgmtDomain
    • VCF Automation All Apps Org as Day 2 operation
    • Update-HoloDeckInstance: New Day 2 cmdlet replacing -Interactive
    • Get-HoloDeckInstance: Enhanced with nested component details
    • Get-HolodeckServiceIPPools: New cmdlet for service IP visibility
    • -InstanceID now MANDATORY on New-HoloDeckInstance
    • Dedicated error logging with stack traces
    • DNSMASQ split into 3 DNS pods + 1 DHCP pod
    • Automated HTTPS certificate trust for offline depot
    • Smart retry logic for bundle downloads

    Parameters Deprecated:

    • -Interactive (REMOVED — replaced by Update-HoloDeckInstance)
    • -DeploySupervisor (RENAMED to -DeploySupervisorWkldDomain)

    New Cmdlets:

    • Update-HoloDeckInstance
    • Get-HolodeckServiceIPPools

    Known Issues:

    • GitHub #108: Start-HoloDeckInstance fails — missing Appliance property
    • GitHub #109: dnsmasq ConfigMap resets after reboot
    • GitHub #113: New-HoloDeckESXiNodes fails
    • GitHub #114: Dnsmasq non-responsive while pod Running
    • GitHub #116: Error getting trunk port groups
    • GitHub #117: Failed to create TKC from pre-installed supervisor

Deprecation Summary

Parameters Removed In 9 0 1:

  • -ConfigPath (DNS cmdlets)
  • -Update (Set-HoloDeckDNSConfig)

Parameters Removed In 9 0 2:

  • -Interactive (New-HoloDeckInstance)
Parameters Renamed In 9 0 2

-Deploysupervisor: -DeploySupervisorWkldDomain

Parameters Added In 9 0 1:

  • -VLANRangeStart
  • -DNSDomain

Parameters Added In 9 0 2:

  • -DeploySupervisorMgmtDomain

Cmdlets Added In 9 0 2:

  • Update-HoloDeckInstance
  • Get-HolodeckServiceIPPools

Task 13 Task 13: Offline Depot Appliance (ODA) — Air-Gapped Lab Setup

Understand and configure the Offline Depot Appliance for air-gapped or bandwidth-constrained Holodeck deployments. VCDX-relevant for understanding depot architecture and binary management.

Source: Holodeck documentation (vmware.github.io/Holodeck), Offline Depot page

Overview: The ODA is a pre-built appliance that provides local binary storage for Holodeck deployments. Eliminates internet dependency for VCF binary downloads. Includes Jupyter Lab for interactive management and VDT (VCF Download Tool, which replaces OBTU) for CLI-based operations.

Deployment Options:

  • Management network deployment: ODA accessible from HoloRouter and nested VMs
  • Isolated network: ODA on separate network with routing to Holodeck subnets

Access Methods:

  • Method: Web UI

    Url: http://<oda-ip>

    Description: Landing page with links to all tools

  • Method: Jupyter Lab

    Url: http://<oda-ip>:8888

    Description: Interactive notebook for depot management

  • Method: SSH

    Command: ssh admin@<oda-ip>

    Description: Command-line access as admin (password set during OVA deployment); sudo su for root

Binary Population Methods:

  • Method: Automatic

    Description: ODA downloads binaries automatically using build token

    Requires: Internet access + brcm_build_token

  • Method: Jupyter Lab

    Description: Interactive download via Jupyter notebooks

    Requires: Internet access + build token

  • Method: VDT CLI

    Description: VCF Download Tool (VDT) command-line interface (/root/vdt/bin)

    Requires: Internet access + build token

  • Method: Manual/Air-Gapped

    Description: Manually copy binaries to /var/www/build/PROD/COMP/...

    Requires: Physical media or sneakernet transfer

    Directory Structure: /var/www/build/PROD/<COMPONENT>/<VERSION>/

Https Configuration:

  • Step 1: Generate CSR on ODA
  • Step 2: Sign CSR with CA (or self-signed)
  • Step 3: Install certificate chain
  • Step 4: Configure NGINX (/etc/nginx/nginx.conf) for HTTPS
  • Step 5: Restart services and verify

Storage Expansion: Use parted + resize2fs to expand ODA disk when more space is needed for additional VCF versions

Download Token Sources: purchased VCF license, trial, NFR, pass VCP exam, or VCP + VMUG Advantage

Task 14 Task 14: Developer Mode & Environment Variables

Configure Holodeck Developer Mode for automated/CI-driven deployments. Essential for repeatable lab provisioning and integration with automation pipelines.

Source: Holodeck documentation (vmware.github.io/Holodeck), Getting Started page

Overview: Developer Mode enables non-interactive, fully automated Holodeck deployments by pre-setting configuration via environment variables. Eliminates all user prompts during deployment.

Online Depot Variables:

  • Name: $env:brcm_build_token

    Value: build

    Description: Broadcom build token for binary downloads

  • Name: $env:enable_proxy

    Value: y | n

    Description: Enable HTTP proxy

  • Name: $env:proxy_protocol

    Value: http | https

    Description: Proxy protocol

  • Name: $env:proxy_ip

    Value: <ip>

    Description: Proxy server IP

  • Name: $env:proxy_port

    Value: <port>

    Description: Proxy server port

  • Name: $env:enable_proxy_auth

    Value: y | n

    Description: Enable proxy authentication

  • Name: $env:proxy_username

    Value: <user>

    Description: Proxy auth username

  • Name: $env:proxy_password

    Value: <pass>

    Description: Proxy auth password

Offline Depot Variables:

  • Name: $env:offline_depot_ip

    Value: <ip>

    Description: ODA IP address

  • Name: $env:offline_depot_port

    Value: <port>

    Description: ODA port (80 for the default HTTP depot; 443 if HTTPS was configured)

  • Name: $env:offline_depot_protocol

    Value: http | https

    Description: ODA protocol

  • Name: $env:offline_depot_username

    Value: <user>

    Description: ODA username (blank allowed for an unauthenticated HTTP depot)

  • Name: $env:offline_depot_password

    Value: <pwd>

    Description: ODA password

Target Host Variables:

  • Name: $env:datastore_name

    Value: <datastore_name>

    Description: Datastore on the target host for the nested VMs (documented)

  • Name: $env:trunk_port_group_name

    Value: <trunk_port_group_name>

    Description: Trunk port group (VLAN 4095) for the nested hosts (documented)

  • Name: $env:cluster_name

    Value: <cluster_name>

    Description: vSphere cluster — only when the target is a vCenter (documented)

  • Name: $env:dc_name

    Value: <datacenter_name>

    Description: vSphere datacenter — only when the target is a vCenter (documented)

Usage Example: Set all environment variables before running New-HoloDeckInstance. The cmdlet detects Developer Mode and skips all interactive prompts.

Target Host Note: The target host and its credentials are supplied with New-HoloDeckConfig -TargetHost -UserName -Password, not through environment variables. Run New-HoloDeckConfig and New-HoloDeckInstance with -DeveloperMode.

Task 15 Task 15: Active GitHub Issues & Troubleshooting (snapshot 2026-04-19 — refresh from GitHub)

Track known issues, workarounds, and community-reported bugs affecting Holodeck lab reliability. Critical for VCDX candidates to understand what might break during lab work.

Source: https://github.com/vmware/Holodeck/issues — 12 issues listed below (snapshot 2026-04-19; check the live tracker for current status)

#TitleDateImpactVCDX Relevance
#117Failed to create TKC from pre-installed supervisorApr 16, 2026Cannot create Tanzu Kubernetes Clusters from Holodeck-deployed SupervisorHIGH — affects Supervisor and K8s workload testing
#116Error getting trunk port groupsApr 12, 2026Precheck failure prevents deploymentMEDIUM — precheck workaround available
#114Dnsmasq can still become non-responsive while pod remains RunningMar 24, 2026DNS resolution fails even though pod shows Running status. Misleading health check.CRITICAL — DNS is #1 pain point in Holodeck environments
#113New-HoloDeckESXiNodes failsMar 13, 2026Cannot add ESXi hosts post-deploymentHIGH — affects Day 2 host scaling
#109dnsmasq ConfigMap server= directive resets after Holorouter rebootMar 9, 2026DNS forwarding configuration lost on HoloRouter restartHIGH — affects lab persistence
#108Start-HoloDeckInstance fails — missing Appliance propertyMar 9, 2026Cannot restart stopped instancesCRITICAL — affects basic instance management
#94Problem deploying NSX Edge clusterFeb 14, 2026NSX Edge deployment failureHIGH — affects edge routing and overlay networking
#46VCF 9 Management Domain hangs at VCF Ops Collector (Cloud Proxy)Sep 29, 2025Management domain deployment stallsHIGH — common deployment blocker
#43Failed to install VMCA Certificate on SDDC ManagerSep 11, 2025Certificate management failureHIGH — certificate management is VCDX topic
#42SDDC Manager loopback /etc/hosts causes deployment failuresSep 11, 2025Multiple workflow failures from incorrect /etc/hosts entryHIGH — affects multiple deployment workflows
#22VCF Download Tool failing with proxy configuredJul 24, 2025Cannot download binaries through proxyMEDIUM — proxy-specific issue
#10VM deployment fail — 'VM with name not found'Jul 3, 2025VM naming/filter mismatch during deploymentMEDIUM — intermittent deployment issue
Key Patterns:

Dns Issues: Issues #114, #109 — DNS remains the most common pain point. The 9.0.2 dnsmasq split (3 DNS + 1 DHCP pod) improved reliability but didn't fully resolve it.

Certificate Issues: Issues #43, #65 — Certificate trust between components (VMCA/SDDC Manager, HoloRouter/vCenter) is a recurring theme.

Deployment Blockers: Issues #46, #42, #10 — Various deployment stall points; most have workarounds.

Day2 Limitations: Issues #113, #117 — Day 2 operations (host scaling, TKC creation) have known bugs.

Before starting any Holodeck lab session, check https://github.com/vmware/Holodeck/issues for latest status and workarounds.

Task 16 Task 16: VCF 9.0 vs 5.2 Feature Comparison (Holodeck Context)

Understand the feature delta between VCF 9.0 and 5.2 as deployed in Holodeck. Critical for VCDX candidates to articulate the evolution of VCF architecture.

Source: Holodeck documentation (vmware.github.io/Holodeck), Holodeck Environment Overview

Vcf 9 0 Only:

  • VVF (VMware vSphere Foundation) deployment support
  • vSAN ESA (Express Storage Architecture) support
  • VCF Installer (replaces Cloud Builder from 5.2)
  • VCF Automation (optional Day 2 — All Apps Org)
  • Supervisor deployment in management and/or workload domain
  • VCF Operations integration
  • -DeploySupervisorWkldDomain and -DeploySupervisorMgmtDomain parameters
  • -DeployVcfAutomation parameter
  • Update-HoloDeckInstance for Day 2 operations (9.0.2+)

Vcf 5 2 Only:

  • Cloud Builder (replaced by VCF Installer in 9.0)
  • vSAN OSA only (no ESA support)
  • VCF deployments only (no VVF)
  • -WorkloadDomainType parameter (SharedSSO/IsolatedSSO) — 5.2.x specific
  • No Supervisor, no VCF Automation, no VCF Operations

Common Features:

  • HoloRouter with DNS/DHCP/NTP/BGP/Proxy
  • Management Domain (4 nested hosts)
  • Optional Workload Domain (3 nested hosts)
  • Optional NSX Edge Cluster
  • Additional 3-node vSphere clusters (Day 2)
  • Custom CIDR support (/20 required)
  • Custom VLAN and DNS domain (9.0.1+)
  • Online and offline depot support
  • ProvisionOnly mode

Architectural Shift: VCF 9.0 represents the convergence of vSphere into VCF. The VCF Installer replaces Cloud Builder, vSAN ESA becomes the preferred storage architecture, and Supervisor/Automation capabilities enable the platform to serve as a full K8s-ready infrastructure. For VCDX, this means design decisions must now account for whether to deploy VCF or VVF, ESA or OSA, and how Supervisor placement (mgmt vs workload domain) affects the architecture.

Final Validation

Complete Holodeck & VCF Command Reference — Ready for Lab Use

Task 1: Lifecycle Cmdlets

✓ The six documented lifecycle cmdlets (New-, Update-, Get-, Stop-, Start-, Remove-HoloDeckInstance) with full parameter documentation and examples; Sync-/Initialize-/Load- recorded as unverified (not in the command reference)

Task 2: Configuration Management

✓ Documented config cmdlets (New-HoloDeckConfig, Get-HoloDeckConfig, Import-HoloDeckConfig, Reset-HoloDeckState) with real examples; Set-HoloDeckConfig recorded as unverified (not in the command reference)

Task 3: Network Query Cmdlets

✓ 7 cmdlets (Subnet, AppNetwork, AppIpPools, OverlaySubnet, BGPConfig, DNSConfig, ServiceIPPools); all with example outputs; ServiceIPPools failure recorded as observed on one lab

Task 4: SDDC Manager API

✓ 20+ endpoints documented; authentication with the Holodeck default password, /v1/tokens, /v1/system, /v1/domains, /v1/hosts, /v1/vcenters, /v1/nsxt-clusters, /v1/network-pools, /v1/credentials, /v1/dns-configuration, /v1/ntp-configuration, /v1/tasks, /v1/backup-configurations, /v1/bundles; 4 non-working endpoints with workarounds

Task 5: vCenter REST API

✓ Session-based auth with the Holodeck default password; /api/session, /api/vcenter/datacenter, /api/vcenter/folder, /api/vcenter/host, /api/vcenter/resource-pool, /api/vcenter/datastore, /api/vcenter/vm, /api/vcenter/network; vSAN health endpoint failure documented

Task 6: NSX Manager API

✓ Basic auth with the Holodeck default password; /api/v1/transport-zones, /policy/api/v1/infra/.../transport-node-profiles, /api/v1/edge-clusters, /policy/api/v1/infra/segments, /api/v1/fabric/compute-managers

Task 7: kubectl Commands

✓ 10+ kubectl commands for pod/service inspection; dnsmasq DNS/DHCP config; FRR BGP verification; DHCP logs; VLAN interface inspection; resolv.conf verification; explicit warning: DNSMASQ is managed with kubectl, not systemctl

Task 8: PowerCLI Reference

✓ 83 available modules documented; PowerCLI 13.3.0 version; 15+ key module names (Core, VDS, Storage, NSX, HCX, Automation, Security, SddcManager, SDK.Nsx.Policy, vROps, License, ImageBuilder, VUM); common cmdlet patterns

Task 9: Working/Non-Working Matrix

✓ Comprehensive matrix: SDDC Manager (7 entries), vCenter (5 entries), NSX (2 entries), Holodeck Toolkit (4 entries), kubectl (4 entries); 5+ common error messages with root causes and resolutions

Task 10: Environment Verification

✓ 5-step verification checklist: Holodeck Toolkit connectivity, SDDC Manager auth, vCenter auth, NSX auth, kubectl access; all checks passed with expected results documented

✓ Lab is 100% self-contained: user never needs to consult external API docs, Holodeck GitHub, or PowerCLI cmdlet help during lab work

✓ Every command includes full parameter list with descriptions, default values, and valid options

✓ Every command includes 2+ real working examples with expected output

✓ All critical gotchas documented (Holodeck default password, IP vs FQDN, Import-HoloDeckConfig requirement, DNSMASQ runs as Kubernetes pods (kubectl, not systemctl), etc.)

✓ Error resolution guide covers 5+ common failures with root cause analysis and workarounds

✓ Lab suitable for quick reference: user can grep/search for any command and find full details in seconds

✓ Lab suitable for VCDX panelist review: demonstrates command mastery and troubleshooting methodology

Cleanup / Restore

Mostly read-only, but several practice steps change the lab. Afterwards: remove any test DNS records added in Task 11 (Remove-HoloDeckDNSConfig); remove the extra cluster or ESX nodes and any test instance created in Tasks 1 and 11 (Remove-HoloDeckInstance — do not add -ResetHoloRouter unless you also intend to clear this instance's HoloRouter networking, which reboots the HoloRouter); and delete any Site B network config generated for practice.

Design Reflection (VCDX)

A VCDX panelist might probe: 'You joined a team managing production VCF. What's your day-one checklist to understand the environment? What commands would you run?' This lab builds exactly that. By mastering these 70+ commands across 6 API/tool categories, you become the person who can script environment discovery, troubleshoot connectivity, and validate deployments without consulting manuals. You know the gotchas (Holodeck default password, Import-HoloDeckConfig, DNSMASQ as Kubernetes pods), the error patterns, and the workarounds. In a panel, you can confidently say: 'I'd start by querying SDDC Manager /v1/system for overall health, then enumerate all domains/clusters/hosts, validate vCenter and NSX connectivity, extract DNS records, and build a deployment topology map. Here's the exact sequence of commands I'd run and what to look for in each response.'

Requirements

  • Active Holodeck VCF lab environment (5.2.2 or 9.0.x)
  • PowerShell 7.x with the Holodeck module (pre-installed on HoloRouter)
  • kubectl access to HoloRouter
  • SSH access to HoloRouter (root credentials)
  • REST client capabilities (PowerShell Invoke-RestMethod or curl)

Constraints

  • Holodeck Toolkit cmdlets require Import-HoloDeckConfig before queries (non-obvious dependency)
  • PowerShell DNS resolver issues force use of IP addresses instead of FQDNs in API calls
  • Nested lab environment: some enterprise features (HA failover, production auth) behave differently
  • Get-HoloDeckServiceIPPools failed on one Holodeck 9.0.2.19 lab (missing Get-NetworkConfigFilePath); not confirmed in the release notes
  • HoloRouter is a Photon OS (systemd) appliance, but DNSMASQ runs as Kubernetes pods — manage it with kubectl, not systemctl

Assumptions

  • Lab uses the default Holodeck password (see the password_default entry) on all nested components
  • Network is isolated (no production firewall rules, rate limiting, or DLP)
  • Holodeck instance is fully deployed and running (not in middle of provisioning)
  • User has admin-level access to all components (not restricted by RBAC)

Risks

  • Credential rotation in production VCF would require updating scripts (master password changes)
  • API versions change between VCF releases; scripts may fail on 9.0.2 vs 5.2.2 without version checks
  • Large response payloads (100+ hosts, 1000+ VMs, 160+ DNS records) require pagination/filtering to avoid timeout
  • HoloRouter SSH access grants full K8s cluster control; potential for accidental data loss via kubectl delete

Self-Assessment Discussion Prompts

  1. Which of these 70+ commands would you run first when inheriting a VCF environment, and in what order?
  2. How would you automate environment discovery using these cmdlets and APIs?
  3. What security risks exist if these commands/APIs are exposed in production? How would you mitigate?
  4. How would you adapt this reference guide for VCF 9.0.x, accounting for new features (VCF Automation, Supervisor domains)?
  5. If Get-HoloDeckServiceIPPools fails (as observed on one 9.0.2.19 lab), how would you debug the root cause using the tools in this lab?
  6. What's the difference between Holodeck lab state and production VCF state? Which commands behave differently?
  7. How would you use these APIs to build a self-service dashboard or chatbot for team discovery/troubleshooting?

References

Was this page useful?
Type to search. ↑ ↓ to move, Enter to open, Esc to close.