VMware Components

Reference for every VMware vSphere offer in the Fractal Cloud catalogue. Parameters and their required flags are sourced from the agent param contract (FRA-2955); each offer includes a fully-parameterized JSON example.

NetworkAndCompute

NetworkAndCompute.IaaS.VspherePortGroup

A distributed virtual switch (dvSwitch) port group representing a network segment on vSphere. Created directly against the dvSwitch with a configured VLAN ID and port binding mode.

Parameter	Description	Example / possible values	Required
name	Port group name	app-portgroup	Yes
dvSwitchName	Name of the distributed virtual switch that hosts the port group	dvs-prod	Yes
datacenter	vSphere datacenter name	DC1	Yes
vlanId	VLAN ID carried by the port group	100	Yes
numPorts	Number of ports (omit or 0 for an elastic port group)	0	No
portBinding	Port binding mode	static or ephemeral (default: ephemeral)	No

Example (fully parameterized):

{
  "type": "NetworkAndCompute.IaaS.VspherePortGroup",
  "parameters": {
    "name": "app-portgroup",
    "dvSwitchName": "dvs-prod",
    "datacenter": "DC1",
    "vlanId": 100,
    "numPorts": 0,
    "portBinding": "ephemeral"
  }
}

NetworkAndCompute.IaaS.VsphereVlan

A VLAN configuration on a distributed virtual switch, representing the subnet/IP-addressing layer in vSphere. The agent validates the VLAN ID against its dependency port group and stores the CIDR and gateway as metadata for dependent components; no additional vSphere object is created.

Parameter	Description	Example / possible values	Required
name	VLAN display name	app-vlan	Yes
vlanId	VLAN ID (1-4094)	100	Yes
cidrBlock	IP address range for this VLAN	10.0.100.0/24	Yes
gateway	Default gateway IP	10.0.100.1	Yes
dvSwitchName	Name of the distributed virtual switch that carries this VLAN	dvs-prod	Yes
datacenter	vSphere datacenter name	DC1	Yes

Example (fully parameterized):

{
  "type": "NetworkAndCompute.IaaS.VsphereVlan",
  "parameters": {
    "name": "app-vlan",
    "vlanId": 100,
    "cidrBlock": "10.0.100.0/24",
    "gateway": "10.0.100.1",
    "dvSwitchName": "dvs-prod",
    "datacenter": "DC1"
  }
}

NetworkAndCompute.IaaS.VsphereVm

A virtual machine on VMware vSphere, provisioned by cloning a template. Supports CPU, memory, and disk sizing, guest OS customisation (hostname, SSH key, cloud-init), storage policy placement, and resource pool selection.

Parameter	Description	Example / possible values	Required
template	Name or path of the VM template to clone	ubuntu-22.04-template	Yes
datacenter	vSphere datacenter name	DC1	Yes
cluster	vSphere compute cluster name	Cluster01	Yes
datastore	Datastore or datastore cluster for VM placement	vsan-default	Yes
folder	VM folder path (defaults to datacenter root)	/DC1/vm/fractal	No
numCpus	Number of vCPUs (defaults to the template value)	4	No
memoryMb	Memory in MB (defaults to the template value)	8192	No
diskSizeGb	Primary disk size in GB (defaults to the template value)	100	No
guestId	Guest OS identifier (defaults to the template value)	ubuntu64Guest	No
hostname	Guest hostname applied via the customisation spec	web-vm-01	No
sshPublicKey	SSH public key injected via cloud-init	ssh-ed25519 AAAA...	No
cloudInitUserData	Base64-encoded cloud-init user-data	I2Nsb3VkLWNvbmZpZw==	No
storagePolicy	vSAN storage policy name	vSAN Default Storage Policy	No
resourcePool	Resource pool path (defaults to the cluster root)	/DC1/host/Cluster01/Resources/fractal	No

Example (fully parameterized):

{
  "type": "NetworkAndCompute.IaaS.VsphereVm",
  "parameters": {
    "template": "ubuntu-22.04-template",
    "datacenter": "DC1",
    "cluster": "Cluster01",
    "datastore": "vsan-default",
    "folder": "/DC1/vm/fractal",
    "numCpus": 4,
    "memoryMb": 8192,
    "diskSizeGb": 100,
    "guestId": "ubuntu64Guest",
    "hostname": "web-vm-01",
    "sshPublicKey": "ssh-ed25519 AAAA...",
    "cloudInitUserData": "I2Nsb3VkLWNvbmZpZw==",
    "storagePolicy": "vSAN Default Storage Policy",
    "resourcePool": "/DC1/host/Cluster01/Resources/fractal"
  }
}