API Reference

Role is the Hypershift NodePool role label value to apply to discovered Agents. For worker pools this is normally “worker”.

Labels are required on a discovered Agent before the Agent CAPI provider can bind it to an AgentMachine. These should match the NodePool spec.platform.agent.agentLabelSelector labels.

Approve controls whether matching discovered Agents are automatically patched with spec.approved=true.

Path is the datastore path to the ISO object.

SHA256 is the ISO content digest.

SizeBytes is the downloaded ISO size.

UploadedAt is when this ISO object was uploaded.

CheckInterval controls how often the operator downloads and hashes the InfraEnv ISO to detect content changes when the URL remains stable.

RetainVersions controls how many content-addressed ISO objects are kept in the datastore. The current ISO is always retained.

PathPrefix is the datastore directory used for content-addressed ISO objects. When empty, the operator uses agent-forge//.

URL is the InfraEnv status.isoDownloadURL used for the last check.

Path is the datastore path inserted into newly created VMs.

SHA256 is the content digest of the active ISO.

SizeBytes is the downloaded ISO size.

CheckedAt is when the operator last downloaded and hashed the ISO.

UploadedAt is when the active ISO object was uploaded.

ForceRefreshToken stores the last processed force refresh annotation value.

History records retained content-addressed ISO objects, newest first.

Name is the referenced object’s metadata.name.

Name is the vSphere VM name.

BIOSUUID is the VM BIOS UUID when known.

MACAddress is the primary NIC MAC address normalized with hyphens.

AgentRef points to the discovered Assisted Installer Agent, when matched.

MachineRef points to the CAPI Machine, when bound.

Phase is the current bridge view of the VM lifecycle, such as Provisioning, Available, Bound, Released, or Orphaned.

Reason provides a short machine-readable explanation for Phase.

LastTransitionTime is updated when Phase changes.

Type is the action type, such as CreateVM, DeleteVM, DeleteAgent, PatchAgent, or Noop.

Name is the target VM or Agent name when known.

Reason explains why the action is needed.

Name is the Secret metadata.name.

Namespace is the Secret metadata.namespace. Leave empty to use the VsphereAgentPool namespace.

NamePrefix prefixes operator-created VM names. When empty, the operator uses -.

NumCPUs is the VM vCPU count.

MemoryMiB is the VM memory size in MiB.

DiskGiB is the primary disk size in GiB.

HostedClusterRef references the Hypershift HostedCluster this pool serves.

NodePoolRef references the Hypershift NodePool this bridge follows.

InfraEnvRef references the Assisted Installer InfraEnv that exposes the discovery ISO and labels newly discovered Agents.

ControlPlaneNamespace is the hosted control plane namespace that contains the CAPI AgentMachine and Machine objects rendered by Hypershift, for example demo-demo.

VSphere configures placement and VM platform settings.

Template configures the worker VM hardware profile.

Agent configures Agent labels, hostname assignment, and approval.

ISO configures content-addressed caching of the InfraEnv discovery ISO.

CleanupPolicy controls whether stale vSphere VMs and unbound Assisted Installer Agents are deleted by the operator. Use Retain for conservative production rollouts where external inventory cleanup is handled manually.

ObservedGeneration is the most recent metadata.generation reconciled by the controller.

DesiredReplicas is the observed AgentMachine count.

AgentMachines is the number of non-deleting AgentMachines observed for spec.nodePoolRef in spec.controlPlaneNamespace.

WaitingAgentMachines is the number of AgentMachines reporting Ready=False with reason NoSuitableAgents.

UnreadyAgentMachines is the number of observed AgentMachines whose Ready condition is not True. This includes AgentMachines waiting for suitable Agents and AgentMachines still installing.

AgentMachinesWithoutAgent is the number of unready AgentMachines that do not yet have an assigned Agent. Surplus available Agents are retained while this is non-zero.

MatchingAgents is the number of Agents matching spec.agent.labels.

BoundAgents is the number of matching Agents already bound to CAPI.

AvailableAgents is the number of matching Agents not yet bound to CAPI.

OwnedVMs records VMs created or tracked by this bridge.

PlannedActions records the most recent actions planned or executed.

ISO records the active cached InfraEnv discovery ISO.

Conditions summarizes readiness, discovery, and errors.

PoolRef references the VsphereAgentPool whose configuration is used to create and manage this VM.

ObservedGeneration is the most recent metadata.generation reconciled by the controller.

VM records the vSphere VM created for this VsphereAgent.

Conditions summarizes readiness and provider errors.

CredentialsSecretRef references a Secret containing vSphere credentials. The Secret must contain server, username, and password keys. It may also contain an insecure key with “true” when the vCenter certificate should not be verified.

Datacenter is the target vSphere datacenter name.

DatastoreCluster is the datastore cluster used for VM disks. It maps to the static module’s vsphere_datastore_cluster input.

ISODatastore is the datastore that contains the uploaded discovery ISO. It maps to the static module’s vsphere_iso_datastore input.

ResourcePool is the vSphere resource pool path, for example cluster/Resources.

Folder is the VM folder path. When empty, the operator uses the hosted cluster name.

Network is the vSphere network name attached to the VM NIC.

VMTags contains optional vSphere tag IDs to attach to each VM.

GuestID is the vSphere guest OS identifier used for from-scratch VMs.

SCSIType is the SCSI controller type used for from-scratch VMs.

Firmware is the VM firmware type.

NetworkAdapterType is the vSphere NIC adapter type.

DiskEagerlyScrub controls eager scrubbing for the primary disk.