> For the complete documentation index, see [llms.txt](https://docs.vergeos-demo.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vergeos-demo.com/knowledge-base/backup-dr/configuring-a-vm-export-volume.md).

# Configuring a Volume for Exporting VMs

The VergeOS NAS supports a volume type specifically for exporting selected virtual machines (VMs). The *VM Export volume* provides a controlled way to export selected VMs to a NAS volume that can then be synchronized to a remote storage system (e.g. existing NAS appliance) or shared via CIFS or NFS for access by external backup tools or other applications.

{% hint style="success" %}
**This export mechanism can be useful for customers who want to synchronize VergeOS VM snapshots to storage hardware they already own, rather than deploying an additional VergeOS system for backup purposes. While VergeOS recommends using its native replication features for the most efficient and fully integrated protection workflow, the VM Export Volume offers flexibility for environments that need to meet compliance requirements or maintain external portability of their VM data.**
{% endhint %}

The following steps describe how to configure and use a NAS-hosted VM export volume.

## Preparing the VMs for Export

1. **Edit each VM** you want to export:
   * Navigate to the VM settings and enable the option for **Allow Export**.

## Setting Up the NAS Service

To host the VM export volume, you will need a NAS service. Use an existing NAS service or create a new service using the following instructions:

1. Navigate to **NAS > List**.

{% hint style="info" %}
**A listing of current NAS services is displayed. You can select an existing service or continue the following instructions to create a new service.**
{% endhint %}

2. Click **New**.
3. Provide **Name, Hostname, TimeZone, and Networking** for the NAS service.
4. Click **Submit** to initialize the NAS service.

## Starting the NAS Service

1. Select the NAS service from the list.
2. Click **Power On** to bring the NAS online and prepare it to host the export volume.

## Creating a NAS User

You’ll need to create a user to access the NAS:

1. Navigate to **NAS > List > double-click the NAS Service to be used**.
2. Click **NAS Users > New**.
3. Provide a username and password.
4. Click **Submit** to save the new NAS user.

## Creating a New Volume for VM Export

1. Select **NAS > + New Volume** from the top menu.
2. Configure the volume:
   * **NAS Service**: Select the NAS service from above
   * **Name**: Provide a name for the volume, e.g. "VM-export"
   * **Filesystem Type**: ***Verge.io VM Export***
   * **VM configuration output file format**: Select the format used for the exported VM configuration file.
     * ***Verge.io Virtual Machine (.ybvm)*** — A human‑readable, JSON‑based format that is non‑binary and non‑proprietary. This format is ideal for portability, transparency, and interoperability with external tools or workflows that prefer open, inspectable configuration data.
     * ***Open Virtualization Format (.ovf)*** — A widely supported industry-standard format used by many third‑party virtualization platforms and import utilities.
   * **Quiesced**: Typically should be selected to provide application-consistent VM snapshots. ⚠️ [**VM Guest Agent**](/run-the-platform/virtual-machines/vm-guest-agent.md) **must be installed and registered to provide a quiesced VM snapshot.**
   * **Max exports to store**: default=3; determines the maximum number of export instances that will be stored at a time
   * **Enable current folder**: default=enabled; Exports are contained in folders named according to date/time of the export. With this option enabled, an additional folder named "current" is created to continually contain a branch of the most recent export. This is often helpful to provide an absolute path to retrieve the latest VM snapshots.
3. Click **Submit**.

{% hint style="success" %}
**After you click Submit, the export volume’s dashboard opens where you can run operations on it. To access this dashboard later, navigate to NAS > Volumes in the top menu, then double-click the volume in the list.**
{% endhint %}

## Running the VM Export (manual start)

1. Under **Export VMs** (mid-page), click the **Start** button to initiate the VM export process.
2. Confirm by clicking **Yes** at the prompt.

## Accessing the Exported Data

{% hint style="success" %}
**You can quickly view the contents of the export volume using the&#x20;*****Browse*****&#x20;option on the left menu.**
{% endhint %}

To access the exported VM snapshots, set up a **CIFS or NFS share** for the NAS volume:

### Setting up a CIFS Share for the Exported Data

1. **Create a CIFS Share**:
   * Navigate to **NAS > CIFS Shares > New**.
   * Select the export volume as the target volume.
   * Provide a **Share Name** and assign the NAS user you created in step 4 to access the share.
2. **Access the Share**:
   * Browse to `\\IPorDNSnameoftheNAS\CIFSShareYouCreated`.
   * Use the NAS user credentials when prompted.

{% hint style="info" %}
**For Windows Users**

You may need to edit the Group Policy (GPO) or modify the Windows Registry to connect using the Guest account if Guest mode is enabled.
{% endhint %}

### Setting up an NFS Share for the Exported Data

Instructions for creating an NFS share can be found [here](/run-the-platform/nas/nas-shares.md#create-an-nfs-share).

### Synchronizing Exported Data to an External System

Exported VM data can be pushed to an external system using a NAS volume sync.

1. Create a [Remote Volume](/run-the-platform/nas/nas-remote-volumes.md) to mount the external volume to the VergeOS NAS (requires standard NFS or CIFS access)
2. Create a [Volume Sync](/run-the-platform/nas/volume-syncs.md) to synchronize data to the Remote Volume. Volume syncs can be started on-demand manually and can also be scheduled using the Start Profile setting.

## Automating the VM Export

You can schedule regular exports by configuring a task and a schedule trigger.

{% hint style="success" %}
**Available Schedules**

VergeOS includes multiple pre-installed schedules (e.g., "Daily at midnight"). Refer to the [Schedules Guide](/automate-protect-and-extend/automation/schedules.md) for instructions on creating custom schedules.
{% endhint %}

### Creating a Scheduled Export Task

1. Navigate to the VM Export Volume: **NAS** > **Volumes** > double-click the export volume.
2. Scroll down to the **Export VMs** section and click the **Tasks** button.
3. Click **New** on the left menu to create a new export task.
4. Configure the new task fields:
   * **Name**: provide a descriptive name, e.g. *start-vm-export*
   * **Object Type**: ***VM Export*** (pre-selected when accessed from the volume)
   * **Object**: select the export volume (pre-selected when accessed from the volume)
   * **Action**: ***Start Export***
5. Click **Submit** to save the new task.

### Assigning a Schedule to the Task

1. After submitting, the task detail page opens. Click **Schedule Triggers** in the left menu.
2. Click **New** on the left menu.
3. Select the desired **Schedule** from the dropdown list (e.g., "Daily at midnight").
4. Click **Submit** to activate the scheduled export.

{% hint style="success" %}
**Configuring Export Settings**

Use the **Settings** button in the Export VMs section to modify export options such as the quiesce setting and maximum exports to store.
{% endhint %}

By completing these steps, you will have a VM export volume configured to generate exportable snapshots of selected VMs and make them available to third‑party backup solutions or external storage systems.

For most environments, VergeOS’s built‑in snapshot and replication features remain the most efficient and integrated method for protecting and synchronizing VM data between VergeOS systems. The VM Export volume workflow is intended for scenarios where compliance policies, existing storage investments, or portability requirements call for VM data to be maintained outside the primary VergeOS infrastructure. This provides organizations with flexibility and assurance that their VM data can be integrated into broader backup strategies or external storage ecosystems when needed.

***

{% hint style="info" %}
**Document Information**

* Last Updated: 2026-02-11
* vergeOS Version: 26.1
  {% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.vergeos-demo.com/knowledge-base/backup-dr/configuring-a-vm-export-volume.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
