How to use the vME Microweb
Overview
For casual use that doesn't require automation, vME has a web frontend.
Pools
A pool is a combination of one or many disk drives. A pool can have one or more sources. Sources created within the pool see all the pool's capacity and can grow up to the available space for the whole pool.
Creating a Pool
Navigate to the Pool screen.
To create a new pool, click on the “+ Pool” button.

On click a new popup form will be shown which has the following inputs.

| Field Name | Description |
|---|---|
| Pool Name | Name of the pool. |
| Pool Size | Size of the pool drive to be allocated (In MBs). |
| Device Path | The volume path of the disk(s) to be utilised by the pool. |
Disk Details
Navigate to the Pool screen and below the Manage Pool table, the details of the disks listed on the vME server are present.

Sources
A source is created in the boundaries of a pool. A source file can only belong to one pool, but pool can contain more than one source.
The Sources list
Navigate to the Source screen. The list shows every source; Filter By Pool narrows it to one pool.

| Column | Description |
|---|---|
| Tick box | Picks the row for Delete selected. The box in the header picks every row that matches the search. See Deleting sources, snapshots and clones. |
| Name | Name of the source. |
| Source Type | How the source is served, for example Container or Network - iSCSI. |
| DB Type | Database type of the source. |
| Created On | When the source was created. |
| Attached to | Where the source is in use, and which unfinished workflows use it. See Attached to and Used by. |
| Refer | The amount of data the source holds. |
| Avail | The space the source can still grow into. |
| Used | The space the source takes up in the pool, its snapshots included. |
| Status | Whether the source is available. |
| Snapshots | View opens the Snapshots screen filtered to this source. |
| Action | Copy the source's mountpoint, rename the source, or delete it. Network sources also have their network settings here. |
Attached to and Used by
The Attached to column on the Sources and Clones lists says who has each object and where:
- A badge for the transport (iSCSI, Container or NFS), then the host or container that has the object.
- Its state, then where it is mounted on that host. A source or clone that the onboarding wizard mounted on a SQL Server host shows its folder under the host's vME folder, for example
C:\vME\sources\<id>. - Used by, then the unfinished onboarding workflows that use the object. Each name links to its workflow. Two are named, followed by "and N more" when there are others.
| Transport | State | Meaning |
|---|---|---|
| iSCSI | connected | A host is connected to the object's iSCSI target at this moment. |
| iSCSI | not connected | A workflow put the object on a host, but no host is connected to its target at this moment. |
| iSCSI | not attached | No host has the object. |
| Container | running | A running container mounts the object. |
| Container | stopped | A stopped container mounts the object. |
| Container | not attached | No container mounts the object. |
| NFS | exported | The object is exported to the clients named. |
| NFS | not attached | The object is not exported. |
A dash means nothing has the object and no workflow is using it.
A workflow counts as unfinished until it is completed or cancelled. An object that an unfinished workflow uses is not deleted from the lists; see Deleting sources, snapshots and clones.
Creating a Source
Navigate to the Source screen.
To create a new source, click on the “+ Source” button at the top right of the screen.
On click a new popup form will be shown which has the following inputs.

| Field Name | Description |
|---|---|
| Pool Name | Name of the pool. |
| Database Method | Choose container (default), network_iscsi (Network - iSCSI), or network_nfs (NFS). |
| Database Type | Database type, select from dropdown. For iSCSI sources, Database Type is set to Microsoft SQL automatically. |
| Source Name* | Enter your Source Name. |
When selecting the iSCSI method for source creation, the below fields will have to be configured.

| Field Name | Description |
|---|---|
| iSCSI volume size (GB) | Optional. Leave blank for auto-grow (thin provisioned iSCSI LUN). Enter a value only to set a fixed maximum size. |
By default, the database type is set to "Microsoft SQL". An iSCSI source asks for no network settings: on Save, vME exports it as an iSCSI target on the appliance's iSCSI portal, which listens on all vME interfaces.
Network Settings
Each network source and clone in the list has a Network Settings (cog) button. What the dialog shows depends on how the source or clone is exported.
For an iSCSI export, the dialog shows the export's Target: the iSCSI target name (IQN) a host connects to. There is no client address, anonuid or anongid to set. Delete removes the iSCSI target, and a host connected to it loses the volume.
For an NFS export, the dialog holds the three fields that decide who may mount it:
| Field Name | Default | Description |
|---|---|---|
| Client Address* | 0.0.0.0 | The IPv4 address(es) allowed to mount the export, separated by commas. Use 0.0.0.0 to allow any host. |
| anonuid* | 65534 | The user ID that anonymous NFS access is mapped to. |
| anongid* | 65534 | The group ID that anonymous NFS access is mapped to. |
Load Default fills in the defaults shown above. Saved settings open read-only; click Edit to change them.
iSCSI Source Form Instructions
When creating an iSCSI source from the Source form, fill the fields as follows:
- Set
Database Methodtonetwork_iscsi. - Select
Pool Name,Database Type, and enterSource Name. - In
iSCSI volume size (GB), leave blank for auto-grow (thin provisioning), or enter a fixed GB value for a hard cap. - Click
Saveto create the source and export it as an iSCSI target. - To see the target name, open
Network Settings(cog icon) on the source's row.
Auto-Grow Behavior
When vsize is blank, vME creates thin-provisioned iSCSI storage:
- Logical capacity is capped by platform policy.
- Physical usage grows only as data is written.
- Pool free space must still be monitored.
For network_iscsi sources, continue with the iSCSI connector workflow:
iSCSI (SQL Server) Connector.
For network_nfs sources, ensure your NFS client access is configured for the vME export before use.
Snapshots
Snapshots are point-in-time snaps of the source's state. Creating a snapshot means recording source vnodes and keeping track of them. Once the data on that inode is updated, the old block of data is retained. You can access the old data view by using said snapshot, and only use as much space as has been changed between the snapshot time and the current time.
For network_iscsi sources, you still create snapshots in vME, but you will export clones as iSCSI
targets and mount them on a SQL Server via the connector workflow.
For network_nfs sources, snapshots and clones are consumed via NFS mounts.
The Snapshots list
Navigate to the Snapshots screen. The list shows every snapshot; Filter By Source narrows it to the snapshots of one source.

| Column | Description |
|---|---|
| Tick box | Picks the row for Delete selected. The box in the header picks every row that matches the search. See Deleting sources, snapshots and clones. |
| Name | Name of the snapshot. |
| Source Name | The source the snapshot was taken of. |
| Pool Name | The pool the source is in. |
| Created On | When the snapshot was taken. |
| Refer | The amount of data the snapshot holds. |
| Used | The space the snapshot takes up: the data that has changed on the source since it was taken. |
| Clone | View opens the Clones screen filtered to the clones of this snapshot. |
| Action | Rename the snapshot, or delete it. |
Creating a Snapshot
Navigate to the Snapshots screen.
To create a new snapshot, click on the “+ Snapshot" button at the top right of the screen.
On click a new popup form will be shown which has the following inputs.

| Field Name | Description |
|---|---|
| Source | Source to create snapshot from. |
| Snapshot Name | Name of snapshot to be created. |
Bookmarks and rollback of a mounted source or clone
Taking a snapshot of a source, or bookmarking or rolling back a clone, that a SQL Server host has mounted is done through that host: its agent takes the databases on the volume offline, the snapshot or rollback is made, and the databases come back online. A dialog shows each of the three steps as the host reports it. See Bookmark or roll back an attached volume.
If the host cannot be reached, the dialog Cannot reach the host explains what to do by hand and offers Proceed without the host, which asks you to confirm that you have taken the databases offline yourself.
Clones
Snapshots are read-only. If you want to mount a snapshot and make changes to it, you'll need to create a clone.
Each clone works just like a normal database, but takes only a few seconds to create.
For network_iscsi sources, clones are consumed via iSCSI targets rather than container mounts.
See the connector workflow: iSCSI (SQL Server) Connector.
For network_nfs sources, clones are consumed via NFS mounts rather than container mounts.
The Clones list
Navigate to the Clones screen. The list shows every clone; Filter By Snapshot narrows it to the clones of one snapshot.

| Column | Description |
|---|---|
| Tick box | Picks the row for Delete selected. The box in the header picks every row that matches the search. See Deleting sources, snapshots and clones. |
| Name | Name of the clone. |
| Source | The source the clone's snapshot was taken of. Hover for the full name. |
| Snapshot | The snapshot the clone was made from. Hover for the full name. |
| DB Type | Database type of the clone. |
| Created On | When the clone was created. |
| Attached to | Where the clone is in use, and which unfinished workflows use it. See Attached to and Used by. |
| Refer | The amount of data the clone holds. |
| Avail | The space the clone can still grow into. |
| Used | The space the clone takes up: the data written to it since it was made. |
| Status | Whether the clone is available. |
| Action | Copy the clone's mountpoint, create a bookmark, roll back to a bookmark, rename the clone, or delete it. Network clones also have their network settings here. |
Creating a Clone
Navigate to the Clones screen.
To create a new clone, click on the “+ Clone" button at the top right of the screen.
On click a new popup form will be shown which has the following inputs.

| Field Name | Description |
|---|---|
| Source | Source to create clone from. |
| Snapshot | Snapshot to create clone from. |
| Clone Name | Name of clone to be created. |
Deleting sources, snapshots and clones
The bin button in a row's Action column deletes that one object. To delete several at once:
- Tick the rows to delete on the Sources, Snapshots or Clones list. The tick box in the header picks every row that matches the search, on every page of the list.
- Click Delete selected, beside the csv and Refresh buttons. It shows how many rows are ticked.
- Check the objects listed in the confirmation, and click Yes.

vME deletes the objects in a selection in a fixed order: clones first, then snapshots, then sources. A snapshot that still has clones, or a source that still has snapshots, is not deleted, so to remove a source and everything made from it, delete its clones on the Clones screen, then its snapshots, then the source.
When every object is deleted, a message says how many were. Deleting a source or clone can take a few moments to finish; one that is still going is counted as "still being removed".
When an object is not deleted
When anything in the selection is not deleted, a report opens titled Deleted N of M, with one line per object and the reason in plain words. The rest of the selection is still deleted. A single delete from the bin button is reported the same way.

| Reason shown | What to do |
|---|---|
| in use by an unfinished onboarding workflow (name), so it was not destroyed | The line offers two buttons. Open name opens the workflow, so you can finish it. Cancel name and delete cancels the workflow and deletes the object: the workflow stops where it is and keeps everything else it made. |
| has N snapshot(s) (names); delete them first, or select them with it | Delete the source's snapshots on the Snapshots screen, then delete the source. |
| has N clone(s) (names); delete them first, or select them with it | Delete the snapshot's clones on the Clones screen, then delete the snapshot. |
| ... (the clone(s) in this selection are still being destroyed; run it again once they have gone) | Objects deleted earlier in the same selection had not finished going. Wait a moment and delete this one again. |
A snapshot counts as in use only when a workflow uses that snapshot itself. A workflow that uses a source does not hold the source's other snapshots.
A SQL Server host that had a deleted source or clone mounted can still know its iSCSI target. Clear such targets from the host with Host maintenance in Agent Manager.
Deleting a workflow
Workflows are deleted from the Recent Workflows list on the Onboard Application screen. The Delete workflow dialog lists the objects that workflow made, each marked with the appliance it is on (this VME or target VME). Tick Also destroy the workflow's associated objects (best-effort) to delete the ticked objects with the workflow. Only objects that workflow made are listed: a source or snapshot it started from is left alone.
If the workflow mounted its clone on a SQL Server host, the dialog says so in a warning. A clone that is still attached to a host, or that has a bookmark, cannot be destroyed. Either:
- open the workflow and use Tear down on its Complete step first, then delete the workflow with its objects; or
- delete the workflow without its objects, and delete the clone from the Clones list later.

Container Images
Container Images are the docker database images for serving the source or clone databases.
Pull Image
Navigate to the Containers screen.
To pull a new container image, click on the “+ Pull Image" button.

On click a new popup form will be shown which has the following inputs.

| Field Name | Description |
|---|---|
| Database Type | Type of database, image is for. |
| Repository URL | Repository URL to pull image from. Note: URL must be accessible from the VME Server. |
| Tag | Image Tag. Default is latest. |
| Repository Username | Username for repository to authenticate if required. |
| Repository Password | Password for repository to authenticate if required. |
Container
Run a container
Navigate to the Containers screen.
To run a new container, click on the “+ Container" button.

On click a new popup form will be shown which has the following inputs.

| Field Name | Description |
|---|---|
| Database Type | Type of database container to create. |
| Container Name | Name of the container to create. |
| HostPort:ContainerPort | Ports to bind inside the container. It is a string in the format "host_port:container_port" where the container port is an exposed port. For example: "12345:3306" for MySQL. Several host and container port pairs can be assigned by seperateing with a comma. |
| Image | Container Image to use. |
| Source Directory | Source or Clone volume which will be mounted on the container. |
| Environment Variables | Environment variables to be used for the database inside the container. |
| Data Directory | Path of the data directory. |
Onboard Application (Beta)
The Onboard Application wizard puts a copy of a SQL Server database onto a SQL Server host. It runs the same iSCSI snapshot, clone, and attach steps as the iSCSI connector, sequenced for you and driven through the Windows iSCSI agents.
You choose how much of that work each run does, so the same wizard covers a first-time onboarding and a routine "give me another copy of last night's snapshot on this other server".
This wizard is Beta.
What a workflow does
A workflow is a chain of five stages, and each one uses what the stage before it produced:
Ingest → Snapshot → Send → Clone → Mount
| Stage | What it does |
|---|---|
| Ingest | Creates the source on this appliance and loads the database into it. |
| Snapshot | Takes a point-in-time snapshot of the source. |
| Send | Replicates the snapshot to a second appliance. |
| Clone | Creates a writable clone from the snapshot. |
| Mount | Attaches the clone to a SQL Server host. |
All five are ticked by default, which is the full onboarding: ingest a database here, snapshot it, send it to a second appliance, clone it there and attach it to a host, in ten steps across two appliances.
Untick a stage and the run starts from something that already exists. The chain shows the gap and names what fills it, and the steps that stage would have taken drop out of the wizard. So:
- Untick Ingest and the run starts from a source already on this appliance; you choose which.
- Untick Snapshot as well and it starts from a snapshot that already exists; you choose which, or take one there and then.
- Untick Send and the clone is made on this appliance, with no transfer and no second appliance needed.
- Untick Mount and the run finishes once the clone exists.
The most common short run is Clone + Mount: seven steps, no ingest, no transfer. Repeat it for each server you want a copy on.
Some combinations cannot run, and the wizard says so before you start, with Create & start held until the ticks make sense:
- Nothing ticked: Tick at least one thing for this workflow to do.
- Mount without Clone: Mount needs a clone. Tick Clone as well, or untick Mount.
- Clone or Send with Ingest but without Snapshot: the source does not exist yet, so there is no snapshot to start from either. Tick Snapshot, or untick Ingest and start from a snapshot that already exists.
Before you start
- A pool on this appliance.
- An enrolled Windows iSCSI agent on each SQL host the run touches: the source host if you are ingesting, the host you are mounting on if you are mounting. See the iSCSI connector guide to install and enroll agents.
- A vME folder set on each of those hosts, in the agent's tray Settings. Every volume the wizard mounts goes into a folder of its own under it; see Edit Agent Settings in the iSCSI connector guide.
- If the run sends to a second appliance: that appliance registered under vME Appliances, with a pool on it to receive into.
Start a workflow
Navigate to the Onboard Application screen and click New Onboarding. Name the run, choose the Database (SQL Server) and the Flow (To a DB host), then tick the stages you want in What this workflow does. The line underneath tells you how many steps the run will have and what they are.
Oracle is shown under Database but is not yet available: it is tagged soon and cannot be picked. The same goes for To a container under Flow.

Untick a stage and the chain marks what the run starts from. Here only Clone and Mount are ticked, so the chain asks you to pick a source and pick a snapshot, and the run has seven steps:

Click Create & start.
Work through the steps
The stepper down the left lists only the steps this run has, numbered from one, each showing its own status. Any step is clickable, and you can leave at any point and resume later from the Recent Workflows list.

Every step has a green button that does its work and a blue Continue. Continue on a step that has not finished asks you to confirm. While a step's job is running its button is held, with a spinner, until the job answers.
| Step | Appears when | What happens |
|---|---|---|
| Workflow basics | Always | Name the run, review the stages, add optional notes. |
| Choose the source | Ingest is off | Pick a source already on this appliance. |
| Provision source | Ingest is on | Create the source in a pool, exported over iSCSI. |
| Source SQL host | Ingest is on | Select the agent on the source SQL host, or enroll one, then Discover this host. The agent reports its SQL instances, databases, vME folder and iSCSI state. |
| Ingest data | Ingest is on | The agent mounts the source at <vME folder>\sources\<id> and loads the data onto it: backup and restore, restore from existing .bak files, or a raw copy of .mdf/.ldf files. |
| Choose the snapshot | Snapshot is off | Pick an existing snapshot of that source, or take one on the spot. |
| Snapshot source | Snapshot is on | Take a snapshot of the source. See Snapshots of a mounted source. |
| Send to target VME | Send is on | Choose a registered appliance, a pool on it and a name, then send. |
| Create clone | Clone is on | Create a writable clone, on the target appliance if the run sends, otherwise on this one. |
| Target SQL host | Mount is on | Select the agent on the host you are mounting onto, then Discover this host. |
| Mount + attach clone | Mount is on | Queue a CloneMount job: the agent connects to the clone's iSCSI target, mounts it at <vME folder>\clones\<id>, and attaches the databases it finds. |
| Complete | Always | Review what the run created, where it is mounted, and its audit trail, then mark the run complete. Tear-down buttons are offered for the hosts this run mounted something on. |
Choosing a source or a snapshot
Both picker steps are searchable, sortable and paged, so they stay usable on an appliance holding hundreds of sources. Each row has its own Use this source / Use this snapshot button.

The snapshot step then lists that source's snapshots, newest first. The newest is tagged latest, and the one this run uses is tagged chosen. If none of them is recent enough, give a name under Take a snapshot now and click Take a snapshot: the source is snapshotted there and then, and that snapshot is used for this run. See Snapshots of a mounted source for Don't stop/start the host databases.

A source or snapshot you chose is not something the run created, so deleting the workflow afterwards leaves it alone.
Snapshots of a mounted source
A source that a SQL host has mounted is snapshotted through that host, so the snapshot catches the databases in a consistent state. The step shows each part as the host reports it:
- Quiesce databases on the host: the databases with files on that volume are taken offline and the volume is flushed.
- Snapshot: the snapshot is taken.
- Resume databases on the host: the databases come back online.
A source that no host has mounted is snapshotted directly, with no host steps.
If the host cannot be told (its agent is offline, or another coordinated operation is already running on it), the snapshot is not taken and the step says why, with Retry without stopping the host databases. Tick Don't stop/start the host databases yourself only when you have already taken those databases offline: the snapshot then goes ahead without them being taken offline first.
Sending to a second appliance
The Send step asks only for the appliance, a pool on it and the name the source will have there. It uses the address and credentials stored when the appliance was registered. The transfer's progress is shown on the step until it completes.
- Overwrite if it already exists replaces a source of the same name on the target. If that source has clones on the target, the send is refused and names them, and nothing on the target is changed; delete the clones there first, or choose another name.
- Keep temporary snapshot after send keeps the snapshot a send takes for itself on this appliance once the transfer is done.
Mounting on the host
The mount step shows where the clone will go before you run it: the clone, its iSCSI target, the folder it will be mounted at, and the host. It waits, with the button held, while a clone that was only just created finishes exporting. If the clone did not export, or has been deleted, the step says so and points you back to the clone step.
Databases is ALL, or a comma-separated list of the databases on the clone to attach. They attach under the prefix the ingest used (ISCSI_ unless you chose another).
A host whose last discovery reported no vME folder is not offered a mount: set the folder in the agent's tray Settings, or update the agent, then discover the host again.
Recent Workflows
The Recent Workflows list shows every run with its technology, state, who started it and its stages. It is searchable (by name, host, snapshot or clone) and sortable. The state filter beside the search box starts on In flight (the runs still waiting on you), with All states, Finished, Failed and Cancelled a click away. You can also narrow the list by date, snapshot, host or source, and group it by any of those, by technology or by day created. The count reads "8 of 35 Workflows" while a filter is narrowing the list.

The Stages column shows each stage the run has as a chip, with a dot per step. Click a row's stages to open its stepper: every step under its stage, with the times recorded for it (when it started, finished or failed, and how long it took) and since when the run has been on its current step.

Use Open to reopen a workflow: an unfinished one opens at its saved step, a finished or cancelled one opens for you to look through. The bin button beside it deletes the workflow. Delete offers to also destroy what the workflow created, and lists each object and the appliance it is on before you confirm:
- Only objects the run made are offered. A source or snapshot it started from is left alone, because other runs may use it.
- A clone is looked for where the run made it: on the target appliance if the run sent, otherwise on this one.
- Objects are destroyed in order (clones, then snapshots, then sources), and the list shows each result. If any cannot be destroyed, the workflow record is kept so you can try again, with Force delete record to remove the record anyway.
A cancelled workflow is finished with: its steps cannot be run again, and it opens read-only. You can still look through what it did, step by step, and tear down anything it left on a host. Everything it made is kept, and is not counted as in use by it, so the lists can delete it. To run those steps again, create a new workflow.
