Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.xloud.tech/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Before XMS can discover or migrate workloads, you must register the source vSphere environment as an environment in the Migration panel. An environment stores the endpoint URL, credentials, and optional scope (datacenter) used for every subsequent discovery and migration job against that source.
In the Dashboard, source VMware endpoints are called Environments. In the CLI, the same objects are called sources (xms source create, xms source list). Both refer to the same registered endpoints.
Prerequisites
  • An active Xloud account with permission to use the Migration panel
  • A reachable vCenter Server or standalone ESXi host
  • A vSphere account with at least read permission for inventory discovery and snapshot, disk read, and Changed Block Tracking permissions for migration (see the Required Permissions table below)
  • The fingerprint or CA chain of the source if you choose to verify TLS

​
Register from the Dashboard

Open the Migration panel

Sign in to the Xloud Dashboard and navigate to Migration → Environments. Click Add Environment and choose VMware vSphere as the platform.

Enter connection details

FieldDescription
Environment NameFriendly name for the source (e.g., prod-vcenter, edge-esxi-01)
HostHostname or IP of the vCenter Server or standalone ESXi host
Port443 (default)
UsernamevSphere account (e.g., administrator@vsphere.local for vCenter, root for standalone ESXi)
PasswordvSphere account password
DatacenterOptional — restrict discovery to a single datacenter
Verify TLSEnable for production; disable only for lab or self-signed certificates

Test the connection

Click Test Connection. XMS opens a vSphere API session, fetches the product name and build number, and closes the session. A green check confirms the endpoint, credentials, and TLS options are valid.
Connection test returns the remote product name and build.

Save the environment

Click Save. The environment appears in the Environments list with status Connected and the detected vSphere version.

​
Required Permissions

XMS needs the following vSphere privileges on the target inventory objects. Create a dedicated role and assign it to the XMS service account at the datacenter level for the cleanest setup.
CategoryPrivilegeUsed By
SystemSystem.Anonymous, System.Read, System.ViewSession establishment and inventory read
VirtualMachine.ConfigDiskLease, ChangeTracking, SettingsEnabling CBT and reading disk configuration
VirtualMachine.InteractPowerOff, PowerOn, ResetCold migration source power control
VirtualMachine.StateCreateSnapshot, RemoveSnapshot, RevertSnapshotWarm migration CBT anchor snapshots
VirtualMachine.ProvisioningDiskRandomAccess, DiskRandomReadDisk export over vSphere API
ResourceAssignVMToPool (target moves only)Optional — only required for cross-cluster preparation
GlobalDisableMethods, EnableMethodsOptional — only required to guard against concurrent changes during cutover
A read-only account is enough to register the source and run discovery. You can assign the higher-privilege role closer to the migration window to limit blast radius.

​
Standalone ESXi vs vCenter

vCenter

Preferred for production — one environment entry covers all clusters and hosts, role-based access control is centralized, and vMotion and snapshots are coordinated through vCenter.

Standalone ESXi

Supported for smaller sites and edge deployments. Use the host IP or FQDN as the endpoint and root (or a local ESXi account) as the username. Datacenter is auto-detected as ha-datacenter.

​
Editing and Deleting Environments

From Migration → Environments, select a row to see the details drawer. Available actions:
  • Edit — update endpoint, credentials, or TLS verification
  • Test Connection — re-run the connectivity check at any time
  • Delete — remove the environment (only permitted when no active migration jobs reference it)
Changing the username or password of an active source invalidates any in-flight discovery. Re-run discovery after updating credentials so the inventory cache refreshes.

​
Next Steps

Discover Workloads

Inventory VMs and disks from the newly registered source

Preflight Assessment

Validate compatibility before submitting a migration

Admin — Source Credentials

Credential storage, rotation, and least-privilege setup