Skip to content

NAS Service & Shares

The VergeOS NAS (Network Attached Storage) service provides file-level storage and access within a VergeOS environment. Unlike traditional NAS appliances that require dedicated hardware, the VergeOS NAS runs as a VM-based service — a purpose-built virtual machine deployed from a standard recipe. This architecture means file services inherit all the benefits of the VergeOS platform: vSAN deduplication, snapshots, high availability, and multi-tenancy.

Each VergeOS system or tenant can run its own NAS service instance, providing isolated file storage with independent configuration, security policies, and share definitions.

Local Volumes

Store files directly on vSAN, benefiting from inline deduplication and tiered storage placement

Remote Volumes

Mount external NFS or CIFS file systems and present them as local resources within VergeOS

CIFS/SMB & NFS Shares

Expose volumes to clients via industry-standard file sharing protocols with granular access controls

VM Export Volumes

Export VM snapshots in portable formats for third-party backup or compliance workflows

The NAS service is not a kernel-level feature — it runs as a dedicated virtual machine provisioned from the built-in NAS VM Recipe. This VM hosts the Samba (CIFS/SMB) and NFS daemons, manages volume mounts, and handles authentication.

Key architectural points:

  • Each system/tenant can run one or more NAS service instances — each instance is an independent VM with its own IP address and network placement
  • Resource allocation — default 4 cores / 4 GB RAM, adjustable for heavier workloads (antivirus scanning, frequent syncs)
  • Network placement — the NAS VM connects to an internal or external network, making shares accessible to clients on that network
  • Volumes are independent — each volume has its own settings for encryption, max size, snapshot profile, preferred storage tier, and sharing configuration

Setting up a NAS follows a clear sequence:

  1. Add a NAS Service — deploy the NAS VM Recipe from NAS → NAS Services → New
  2. (Optional) Integrate with Active Directory — join the NAS to a Windows AD domain for centralized authentication
  3. Create Volumes — local volumes for vSAN-backed storage, remote volumes for external mounts, or VM export volumes
  4. Create Shares — expose volumes via CIFS and/or NFS with per-share access controls
  5. (Optional) Configure Volume Snapshots — set up snapshot profiles for automated point-in-time protection

When creating a NAS service, you configure:

SettingDescription
NameMust be unique among all VMs in this VergeOS cloud
Cores / RAMDefault 4 cores / 4 GB — increase for heavy antivirus or sync workloads
NetworkInternal or external network the NAS will be accessible on
IP Address TypeDHCP (recommended with static reservation) or Static
HostnameComputer name (appears in AD if domain-joined); best to match the VM name
DomainRequired for CIFS/Samba — defaults to “workgroup” if left blank
Timezone / NTPDefaults to system settings; critical for AD Kerberos authentication

After submitting, power on the NAS service and verify it reaches Online status on the NAS Service dashboard.

Local volumes are EXT4 file systems stored within the VergeOS vSAN. They consume vSAN storage and benefit from inline deduplication, encryption (if enabled at the vSAN level), and tiered placement.

Navigate to NAS → Volumes → New and configure:

  • NAS Service — select which NAS instance hosts this volume
  • Name — no spaces permitted
  • Filesystem Type — select Local Volume (EXT4)
  • Encrypt Volume — optional AES-XTS encryption (set at creation; cannot be changed later). Requires an encryption key that must be provided each time the volume comes online
  • Max Size — hard capacity limit; volume becomes read-only when reached
  • Discard — enabled by default; reclaims deleted space back to vSAN
  • Read Only — prevents writes to the volume
  • Automatically Mount Snapshots — makes snapshots browsable for self-service file restores
  • Owner / Group — volume directory ownership
  • Snapshot Profile — automated snapshot schedule
  • Preferred Tier — which vSAN tier this volume’s data targets

Once created, the volume appears on the NAS Service dashboard. Files can be browsed via the Browse option, and the volume must be exposed through shares for client access.

CIFS (Common Internet File System) shares provide file access for Windows, macOS, and Linux clients using the SMB protocol. Multiple shares can be created on a single volume with different security settings.

Navigate to NAS → Volumes, select a volume, then CIFS Shares → New:

SettingDescription
NameShare name visible to clients
Share PathSubdirectory within the volume (blank = entire volume)
Valid UsersRestrict access to specific users (one per line)
Valid GroupsRestrict access to specific groups (one per line)
Allowed HostsIP, hostname, domain, netgroup, or subnet (one per line)
Denied HostsExplicitly block specific hosts
Read OnlyDeny write operations
BrowseableShow in network share listings (disabled by default)
Admin UsersUsers with full administrative access to the share
Force User / Force GroupOverride connecting user identity for all file operations
Advanced Configuration OptionsRaw Samba parameters for special-case scenarios

NFS (Network File System) shares provide file access primarily for Linux and Unix clients. NFS shares are configured per-volume and offer fine-grained control over host access and identity mapping.

Navigate to NAS → Volumes, select a volume, then NFS Shares → New:

SettingDescription
NameShare identifier
Share PathSubdirectory within the volume (blank = entire volume)
Allow EveryoneGrant access to all hosts
Allowed HostsIP, FQDN, or wildcard (e.g., *.companyabc.com)
Data AccessRead Only or Read and Write
User/Group SquashingNo Squashing (default), Squash Root (map root to anonymous), Squash All (map all users to anonymous)
Anonymous User ID / Group IDUID/GID assigned to anonymous connections
AsynchronousImproves performance but risks data loss on unclean server restart
No ACLsDisable access control lists

Remote volumes mount external NFS or CIFS file systems into the VergeOS NAS, making them accessible as if they were local. This is useful for:

  • Data migration — syncing data from legacy storage into VergeOS
  • Backup ingestion — one-time or recurring imports from external systems
  • Hybrid access — presenting external storage to VergeOS VMs alongside local volumes
  • Filesystem Type — Remote CIFS
  • Remote Mount Target — UNC path (e.g., //10.10.2.2/fshare or //file-01/corp)
  • Username / Password — credentials for the remote share
  • SMB Protocol Version — auto-detect (default) or explicit version selection
  • Mount Options — advanced CIFS parameters
  • Read Only — mount as read-only
  • Filesystem Type — Remote NFS
  • Remote Mount Target — NFS path (e.g., server01:/export/svrdata)
  • NFS Protocol Version — auto-detect (default) or explicit version
  • Mount Options — advanced NFS parameters
  • Read Only — mount as read-only

After creation, verify the volume status shows Online on the volume dashboard. If mounting fails, check the Logs section at the bottom of the dashboard for error details.

The Verge.io VM Export volume type provides a controlled way to export VM snapshots for third-party backup, compliance, or portability purposes.

  1. Enable export on each VM — edit VM settings and check Allow Export
  2. Create a VM Export volume — select Verge.io VM Export as the filesystem type
  3. Run the export — manually trigger or automate with Tasks and Schedule Triggers
  4. Access the exports — share the export volume via CIFS or NFS, or sync it to external storage via a remote volume

Each export produces timestamped folders containing VM snapshots. Export formats include:

  • .ybvm — VergeOS-native JSON-based format
  • .ovf — Open Virtualization Format for broad compatibility

For application-consistent exports, VMs must have the VergeOS Guest Agent installed. The guest agent coordinates with the operating system (VSS on Windows) to flush buffers and freeze the filesystem before the snapshot is taken.

VM exports are commonly automated using:

  • Tasks — define the export action
  • Schedule Triggers — set the recurring schedule (daily, weekly, etc.)
  • Volume Syncs — replicate export data to an external NAS appliance via a mounted remote volume

For environments with Windows Active Directory, the NAS service can join an AD domain using Winbind. This enables AD users and groups to authenticate against CIFS shares without maintaining separate credentials on the NAS.

  1. Navigate to the NAS Service dashboard
  2. Select Edit CIFS Settings
  3. Configure the following:
SettingDescription
Guest User MappingHow to handle invalid credentials (reject, treat as guest)
WorkgroupShort-form domain name (e.g., COMPANYNAME)
RealmLong-form domain name (e.g., companyname.local)
Server TypeSet to Member
AD Username / PasswordDomain admin with object creation rights
  1. Wait for the join to complete — the AD Status will show Joined on the NAS Service dashboard

After joining, verify with the Winbind diagnostic tool (NAS dashboard → DiagnosticsWinbind):

  • wbinfo -t — test trust relationship with the domain
  • wbinfo -u — list domain users
  • wbinfo -g — list domain groups

Common causes of join failures:

  • Network connectivity — the NAS VM must be able to reach the domain controller (verify with Ping diagnostic)
  • DNS resolution — the NAS must resolve the domain name (verify with DNS Lookup diagnostic)
  • Time synchronization — Kerberos requires clocks within 5 minutes (verify with Date/Time diagnostic)
  • Incorrect Workgroup/Realm — use whoami on a domain member to confirm the short-form, and systeminfo for the full domain
  • Permissions — the AD account must have rights to create computer objects in the target OU
  • OU existence — if specified, the Organizational Unit must already exist in AD

For a new VergeOS deployment requiring file-level storage:

  1. Deploy the NAS service from the NAS VM Recipe — configure network, IP, and hostname
  2. Join Active Directory if your environment uses Windows AD for identity management
  3. Create local volumes for vSAN-backed file storage — set max size, preferred tier, and snapshot profile
  4. Create CIFS and/or NFS shares on each volume with appropriate access controls
  5. Test client connectivity — mount shares from Windows (net use) and Linux (mount -t nfs / mount -t cifs)
  6. (Optional) Set up remote volumes to integrate with external storage systems
  7. (Optional) Configure VM export volumes for third-party backup compliance

The VergeOS NAS service transforms file-level storage from a separate infrastructure concern into an integrated platform feature. By running as a VM recipe on the same vSAN that hosts all other workloads, the NAS benefits from deduplication, snapshots, and the full VergeOS operational model — while providing the CIFS/SMB and NFS interfaces that clients and applications expect.

Volume TypeStorage LocationUse Case
Local (EXT4)VergeOS vSANGeneral file storage, home directories, application data
Remote CIFSExternal SMB shareData migration, backup ingestion, hybrid access
Remote NFSExternal NFS exportData migration, legacy integration
VM ExportVergeOS vSANThird-party backup, compliance, VM portability