# VergeOS Docs

## Overview

- [Welcome to VergeOS Docs](https://docs.verge.io/readme.md): Plan, deploy, operate, and automate VergeOS — documentation organized by what you're trying to do.
- [Key terms](https://docs.verge.io/glossary.md): Definitions of key terms and concepts used throughout VergeOS documentation, including networking, storage, virtualization, and multi-tenancy terminology.
- [Migration and evaluation paths](https://docs.verge.io/migration-and-evaluation-paths.md): Pick a starting path through VergeOS — VMware migration, a fresh deployment, or automation and Private AI.
- [Support and services](https://docs.verge.io/support-and-services.md): Documentation to lean on before and after you go live — architecture validation, hardening, and day-two operations.
- [VergeOS agent skills](https://docs.verge.io/work-with-ai-tools/agent-skills.md): Install the VergeOS agent skills to give Claude Code and Codex task-focused workflows for troubleshooting, training, and managing VergeOS.
- [Connect via MCP](https://docs.verge.io/work-with-ai-tools/connect-via-mcp.md): Connect VergeOS Docs to Claude, Cursor, VS Code, and other AI tools through the hosted GitBook MCP server.

## Plan and deploy

- [Plan and deploy](https://docs.verge.io/plan-and-deploy/readme.md): The deployment path for VergeOS, from concepts and sizing through installation and architecture selection.
- [Introduction](https://docs.verge.io/plan-and-deploy/implementation-guide/intro.md): Introduction to the VergeOS implementation guide covering deployment, configuration, and optimization of VergeOS systems from small edge deployments to large-scale enterprise environments.
- [Core concepts](https://docs.verge.io/plan-and-deploy/implementation-guide/concepts.md): Overview of key VergeOS concepts including physical infrastructure, node types, clusters, network architecture, vSAN, tenants, and virtual networking fundamentals.
- [Node sizing](https://docs.verge.io/plan-and-deploy/implementation-guide/sizing.md): Minimum and recommended hardware requirements for VergeOS nodes including CPU, RAM, storage, and networking specifications for controller, storage, and compute-only nodes.
- [Network design](https://docs.verge.io/plan-and-deploy/implementation-guide/network-design.md): Reference network design models for VergeOS deployments including Layer 2 static, Layer 3 dynamic, Layer 3 static, and 2-port configurations with core fabric and external network requirements.
- [Pre-installation checklist](https://docs.verge.io/plan-and-deploy/implementation-guide/pre-installation.md): Checklist of prerequisites, hardware BIOS settings, and network configurations to verify before beginning a VergeOS installation.
- [Creating bootable installation media](https://docs.verge.io/plan-and-deploy/implementation-guide/install-media.md): Step-by-step instructions for creating a bootable USB drive with the VergeOS ISO on Windows, macOS, and Linux using Rufus, BalenaEtcher, or native tools.
- [Installation guide](https://docs.verge.io/plan-and-deploy/implementation-guide/installation-guide.md): Complete VergeOS installation guide covering primary and secondary controller node setup, physical network configuration, vSAN initialization, drive tier assignments, and encryption settings.
- [Post-installation configuration](https://docs.verge.io/plan-and-deploy/implementation-guide/post-installation.md): Essential post-installation steps for VergeOS including system health verification, core network redundancy testing, external connectivity validation, and initial system configuration.
- [Scale-out node installation guide](https://docs.verge.io/plan-and-deploy/implementation-guide/scale-out-nodes.md): Step-by-step instructions for installing scale-out nodes with matching hardware specifications to expand both compute and storage capacity in a VergeOS cluster.
- [Compute only node installation guide](https://docs.verge.io/plan-and-deploy/implementation-guide/compute-nodes.md): Step-by-step instructions for installing compute-only nodes in VergeOS to expand processing capacity without impacting existing storage infrastructure.
- [Storage node installation guide](https://docs.verge.io/plan-and-deploy/implementation-guide/storage-nodes.md): Step-by-step instructions for installing storage-only nodes in VergeOS to expand vSAN storage capacity without adding compute resources.
- [Switch configuration guide](https://docs.verge.io/plan-and-deploy/implementation-guide/switch-configuration.md): Switch port configuration for VergeOS covering core fabric access ports with jumbo frames, external VLAN trunk ports with LACP, and verification for Cisco, Dell, and HPE/Aruba switches.
- [Edge cluster deployments](https://docs.verge.io/plan-and-deploy/reference-architectures/edge.md): Reference architecture for deploying VergeOS edge clusters at branch offices and remote locations using low-power, small form factor hardware.
- [Multi-tenant deployments](https://docs.verge.io/plan-and-deploy/reference-architectures/csp.md): Reference architecture for Cloud Service Providers deploying VergeOS as a multi-tenant IaaS platform with tenant isolation, resource allocation, and scalable infrastructure.
- [High-performance cluster deployments](https://docs.verge.io/plan-and-deploy/reference-architectures/data-science.md): Reference architecture for deploying VergeOS high-performance clusters for data science, machine learning, and analytics workloads with GPU acceleration and scalable storage.
- [VergeOS homelab reference architecture](https://docs.verge.io/plan-and-deploy/reference-architectures/homelab.md): Reference architecture for deploying VergeOS in homelab environments, covering single-node, two-node cluster, and production-grade configurations with multi-tiered storage.

## Run the platform

- [Run the platform](https://docs.verge.io/run-the-platform/readme.md): The day-2 operating surface for VergeOS across storage, networking, system administration, and virtual machine management.
- [New System Configuration](https://docs.verge.io/run-the-platform/platform-overview/new-system-configuration.md): Post-installation checklist for preparing a new VergeOS system for production, covering cluster settings, licensing, SMTP, certificates, alerting, snapshots, and authentication configuration.
- [VergeOS Platform Capabilities](https://docs.verge.io/run-the-platform/platform-overview/platform-capabilities.md): Catalog of VergeOS platform features including distributed storage, backup/DR, compute virtualization, multi-tenancy, software-defined networking, monitoring, automation, and integrations.
- [Transitioning from VMware to VergeOS](https://docs.verge.io/run-the-platform/platform-overview/transition-from-vmware.md): Guide for VMware administrators migrating to VergeOS, covering architecture differences, terminology mapping, networking and storage comparisons, and step-by-step VM migration instructions.
- [What is VergeOS](https://docs.verge.io/run-the-platform/platform-overview/what-is-vergeos.md): Introduction to VergeOS, an ultraconverged infrastructure OS that unifies compute, storage, networking, and multi-tenancy into one platform. Covers core architecture, key features, and use cases.
- [Getting Started with the VergeOS 26 UI](https://docs.verge.io/run-the-platform/platform-overview/ui-overview.md): An introduction to the VergeOS 26 user interface, covering dashboard navigation, menus, themes, auto-refresh, and help access for new and transitioning administrators.
- [External Storage Integration](https://docs.verge.io/run-the-platform/storage/external-storage-integration.md): Guide to integrating external SAN, NAS, and iSCSI storage with VergeOS, covering Fibre Channel LUNs as vSAN tiers, NFS/CIFS remote volumes, and in-guest storage passthrough options.
- [Using Fibre Channel Storage with vSAN](https://docs.verge.io/run-the-platform/storage/fibre-channel.md): How to configure Fibre Channel LUNs as storage devices within VergeOS vSAN tiers, including hardware requirements, multipath configuration, fabric setup, and best practices.
- [Storage Overview](https://docs.verge.io/run-the-platform/storage/overview.md): Overview of VergeOS integrated storage capabilities including vSAN (VergeFS), data protection with snapshots and replication, and file-level storage with NAS services.
- [Preferred Tier](https://docs.verge.io/run-the-platform/storage/preferred-tiers.md): Explains the Preferred Tier setting in VergeOS vSAN, which determines the first-choice storage tier for data placement with automatic fallback to alternative tiers when unavailable.
- [Removing ISO Files with References](https://docs.verge.io/run-the-platform/storage/removing-iso-refs.md): How to view and remove references to ISO files loaded on VM CD-ROM drives so the ISO files can be deleted from the VergeOS vSAN.
- [Storage Tiers in VergeOS vSAN](https://docs.verge.io/run-the-platform/storage/storage-tiers.md): Comprehensive guide to the VergeOS vSAN tiered storage system covering Tier 0 through Tier 5, including hardware specifications, workload recommendations, best practices, and scaling considerations.
- [Storage Units and Capacity Reporting](https://docs.verge.io/run-the-platform/storage/storage-units.md): How VergeOS represents storage capacity in the GUI and usage reports, including the TB-vs-TiB labeling behavior, a worked example, and a comparison to manufacturer-advertised disk capacity.
- [Uploading Files to the vSAN](https://docs.verge.io/run-the-platform/storage/uploading-files-to-vsan.md): How to upload ISO images, drive images, and other files to the VergeOS vSAN from a local computer or URL, and how to create public download links for shared access.
- [VergeOS vSAN Block-Level Architecture and Data Distribution](https://docs.verge.io/run-the-platform/storage/vsan-architecture.md): Technical overview of the VergeOS vSAN block-level architecture, covering hash-based data distribution, redundancy management, deduplication, cross-node distribution, and scaling strategies.
- [VergeOS vSAN Deletion Process](https://docs.verge.io/run-the-platform/storage/vsan-deletion-process.md): Explains how VergeOS vSAN handles deletion of VMs, drives, and tenants through reference counting, deduplication-aware block cleanup, and background garbage collection.
- [vSAN Diagnostics Guide](https://docs.verge.io/run-the-platform/storage/vsan-diagnostics.md): Comprehensive reference for VergeOS vSAN diagnostic commands, covering storage performance monitoring, integrity checking, device health, cluster analysis, and troubleshooting workflows.
- [Understanding vSAN Redundancy Levels](https://docs.verge.io/run-the-platform/storage/vsan-redundancy-levels.md): Learn about VergeOS vSAN N+1 and N+2 redundancy levels, their requirements, use cases, and considerations
- [Aliases](https://docs.verge.io/run-the-platform/networking/aliases.md): Manage reusable IP address sets (aliases) for use across multiple network rules, simplifying administration of complex firewall and routing configurations.
- [Assigning External IP Addresses to Internal Networks](https://docs.verge.io/run-the-platform/networking/assign-external-ip.md): Assign public external IP addresses to internal VergeOS networks with automatic routing rule creation for inbound connectivity.
- [VergeOS Authoritative DNS](https://docs.verge.io/run-the-platform/networking/authoritative-dns.md): Comprehensive guide to VergeOS authoritative DNS service built on BIND, covering zone management, DNS views, split-horizon configurations, zone transfers, and security best practices.
- [Bonded VLAN-tagged Networks](https://docs.verge.io/run-the-platform/networking/bonded-vlans.md): Create active-backup bonded network interfaces with VLAN tagging on external or maintenance networks for network redundancy and failover.
- [Connect VergeOS to an Existing LAN/WAN](https://docs.verge.io/run-the-platform/networking/connect-lan-wan.md): Create and configure external networks to connect VergeOS to existing LAN, WAN, or other physical network infrastructure with full Layer 2 and Layer 3 options.
- [Configuring VLANs](https://docs.verge.io/run-the-platform/networking/create-vlan.md): Step-by-step instructions for creating VLAN-tagged external networks in VergeOS, including host-level and tenant configurations.
- [Create a DHCP Static Lease](https://docs.verge.io/run-the-platform/networking/dhcp-static-lease.md): Reserve a fixed IP address for a virtual machine by creating a DHCP static lease entry tied to its MAC address.
- [Creating an Internal Network with External Access](https://docs.verge.io/run-the-platform/networking/internal-external-access.md): Give an internal network internet or LAN/WAN access by configuring the default gateway to route through an external network.
- [Creating an Internal Layer 2 Network](https://docs.verge.io/run-the-platform/networking/internal-layer2.md): Create a Layer 2 internal network in VergeOS where IP-level administration is handled by third-party software rather than the built-in network stack.
- [Creating an Internal Network managed within VergeOS (layer3)](https://docs.verge.io/run-the-platform/networking/internal-layer3.md): Create a Layer 3 internal network with built-in DHCP, DNS, firewall, and routing managed entirely within the VergeOS platform.
- [Internal Networks (General Instructions)](https://docs.verge.io/run-the-platform/networking/internal-networks.md): Guide to creating and configuring internal virtual networks in VergeOS, including Layer 2/Layer 3 options, DHCP, DNS, clustering, port mirroring, rate limiting, and high availability.
- [Configuring NAT 1-to-1 Translation](https://docs.verge.io/run-the-platform/networking/nat-1to1.md): Create a NAT 1-to-1 translate rule to map an external public IP address to an internal private IP address for full bidirectional traffic forwarding.
- [Network Troubleshooting](https://docs.verge.io/run-the-platform/networking/net-troubleshooting.md): Common network troubleshooting procedures for VergeOS, including ping tests, IP address verification, NIC driver checks, DNS diagnostics, and default gateway rule configuration.
- [Networking Concepts](https://docs.verge.io/run-the-platform/networking/network-concepts.md): Foundational introduction to VergeOS networking concepts including physical, core, DMZ, internal, and external network types, tenant networking, Layer 2/3 support, network rules, and monitoring tools.
- [Network Dashboards](https://docs.verge.io/run-the-platform/networking/network-dashboards.md): Navigate and interpret VergeOS network dashboards for real-time monitoring, traffic statistics, status indicators, and historical network performance data.
- [Network Diagnostics Guide](https://docs.verge.io/run-the-platform/networking/network-diagnostics.md): Reference guide for built-in VergeOS network diagnostic tools including ping, traceroute, DNS lookup, ARP scan, TCP dump, NMAP, firewall debugging, and BGP/OSPF troubleshooting.
- [Networking (VergeFabric)](https://docs.verge.io/run-the-platform/networking/network-overview.md): Overview of VergeFabric software-defined networking in VergeOS, covering SDN features, network types, security, automation, multi-cloud support, and use cases for providers and enterprises.
- [Quick Start Links](https://docs.verge.io/run-the-platform/networking/network-quickstart.md): Quick reference links to common VergeOS networking tasks including connecting to LANs, creating internal networks, configuring DHCP, assigning external IPs, and setting up NAT.
- [Network Rules](https://docs.verge.io/run-the-platform/networking/network-rules.md): Create and manage VergeOS network rules for firewall filtering, NAT/PAT translation, and static routing, including rule ordering, modification, and copying.
- [Port Mirroring](https://docs.verge.io/run-the-platform/networking/port-mirroring.md): Enable port mirroring on a VergeOS network to replicate traffic to a VM NIC for packet analysis, monitoring, and diagnostics using North/South or East/West modes.
- [Tracking Network Statistics](https://docs.verge.io/run-the-platform/networking/tracking-net-statistics.md): Enable and view per-rule traffic statistics tracking for network rules in VergeOS, including packets and bytes counters for firewall, NAT, and translate rules.
- [IPsec Configuration](https://docs.verge.io/run-the-platform/vpn/ipsec.md): Step-by-step instructions for configuring an IPsec VPN tunnel between a VergeOS network and a third-party IPsec peer, including Phase 1, Phase 2, and firewall rule setup.
- [VPN](https://docs.verge.io/run-the-platform/vpn/vpn-overview.md): Overview of VergeOS VPN capabilities including WireGuard and IPsec for secure site-to-site connections and remote user access.
- [WireGuard](https://docs.verge.io/run-the-platform/vpn/wireguard-config.md): Guide for configuring WireGuard VPN in VergeOS, including interface creation, peer definitions, auto-generated configurations, and firewall rule setup for site-to-site and remote access.
- [WireGuard Configuration Examples](https://docs.verge.io/run-the-platform/vpn/wireguard-examples.md): Example WireGuard VPN configurations for VergeOS, including site-to-site tunnels between two VergeOS systems and remote access setup for Windows clients.
- [Authorization Sources - Overview](https://docs.verge.io/run-the-platform/authentication/auth-sources-general.md): General instructions for configuring third-party OAuth2 identity providers such as Okta, GitLab, Azure AD, and Google for user authentication in VergeOS.
- [Using Entra ID (Azure AD) for Authentication](https://docs.verge.io/run-the-platform/authentication/azure-auth.md): Step-by-step guide for configuring Microsoft Entra ID (Azure AD) as an OAuth2 authorization source in VergeOS, including app registration, group integration, and user provisioning.
- [Using Google for Authentication](https://docs.verge.io/run-the-platform/authentication/google-auth.md): Step-by-step guide for configuring Google as an OAuth2 authorization source in VergeOS, including obtaining credentials and creating users.
- [Two-Factor Authentication (MFA)](https://docs.verge.io/run-the-platform/authentication/multifactor-auth.md): Configure and manage two-factor authentication in VergeOS using TOTP authenticator apps or email-based verification codes, including system-wide and per-user settings.
- [VergeOS OIDC Applications Overview](https://docs.verge.io/run-the-platform/authentication/oidc-apps-overview.md): Overview of VergeOS OpenID Connect (OIDC) functionality for centralized identity management, single sign-on across VergeOS systems and tenants, and upstream provider integration.
- [Advanced System Settings](https://docs.verge.io/run-the-platform/system-administration/advanced-system-settings.md): Reference for all advanced system settings in VergeOS, including NTP, SMART thresholds, session timeouts, MAC prefix, migration controls, two-factor authentication, and vSAN configuration.
- [API Keys](https://docs.verge.io/run-the-platform/system-administration/api-keys.md): How to create, manage, and use API keys for programmatic access to the VergeOS REST API, including authentication, IP access controls, expiration settings, and security best practices.
- [Server Certificates](https://docs.verge.io/run-the-platform/system-administration/certificates.md): How to manage TLS/SSL certificates in VergeOS, including requesting Let's Encrypt certificates, installing manual certificates, configuring listeners, and registering custom root CAs.
- [Cluster Settings](https://docs.verge.io/run-the-platform/system-administration/cluster-settings.md): Reference for all VergeOS cluster configuration settings, including CPU type, RAM allocation, security mitigations, compute resource policies, swap, and node temperature monitoring.
- [VergeOS Clusters Overview](https://docs.verge.io/run-the-platform/system-administration/clusters-overview.md): Overview of VergeOS clusters, including cluster types (HCI, compute-only, storage-only), cluster requirements, scalability design, and best practices for workload organization.
- [Core Fabric Status Guide](https://docs.verge.io/run-the-platform/system-administration/core-fabric-status.md): How to read, interpret, and troubleshoot core fabric status in VergeOS, including score values, healthy vs. unhealthy fabric examples, and pre-maintenance verification.
- [Device Passthrough Overview](https://docs.verge.io/run-the-platform/system-administration/device-pass-overview.md): Overview of device passthrough in VergeOS, including PCI passthrough risks, IOMMU grouping, resource groups, resource rules, and supported passthrough types (PCI, USB, vGPU, SR-IOV).
- [System Diagnostics](https://docs.verge.io/run-the-platform/system-administration/diagnostics.md): How to generate, download, and send VergeOS system diagnostics files for troubleshooting, including file contents, layout, and usage guidance.
- [Drive Replacement](https://docs.verge.io/run-the-platform/system-administration/drive-replacement.md): Redirect page pointing to the centralized drive replacement standard operating procedure in VergeOS.
- [One-to-One PCI Passthrough](https://docs.verge.io/run-the-platform/system-administration/generic-pci-passthrough.md): How to configure one-to-one PCI passthrough in VergeOS, including host setup, VM guest configuration, resource group creation, and passing PCI devices to tenants.
- [IPMI](https://docs.verge.io/run-the-platform/system-administration/ipmi.md): How to configure and use IPMI integration in VergeOS for remote server power control, connectivity testing, credential management, and accessing the IPMI web interface.
- [Verify Licensing and Update Server Configuration](https://docs.verge.io/run-the-platform/system-administration/license-updates-verify.md): How to verify connectivity to the VergeOS update server and troubleshoot licensing configuration issues, including credentials and update source selection.
- [Licensing and Software Updates](https://docs.verge.io/run-the-platform/system-administration/licensing-and-updates.md): How to manage VergeOS software updates and licensing, including the update process, update settings, automatic updates, snapshot settings, and air-gap licensing.
- [Licensing Overview](https://docs.verge.io/run-the-platform/system-administration/licensing-overview.md): Overview of VergeOS licensing, including System IDs, license types (production and trial/NFR), license details, reinstallation reactivation, and air-gap licensing.
- [Node Diagnostics Guide](https://docs.verge.io/run-the-platform/system-administration/node-diagnostics.md): Comprehensive reference for VergeOS node diagnostic tools, including IPMI commands, SMART tests, network diagnostics, fabric configuration, and hardware troubleshooting.
- [Nodes Overview](https://docs.verge.io/run-the-platform/system-administration/nodes-overview.md): Overview of VergeOS node management, including node status, hardware configuration, resource metrics, drives, NICs, fabric status, running machines, and management operations.
- [NVIDIA vGPU Configuration](https://docs.verge.io/run-the-platform/system-administration/nvidia-vgpu-configuration.md): Step-by-step guide to configuring NVIDIA vGPU in VergeOS, including traditional vGPU profiles, MIG partitioning, heterogeneous profiles, resource group setup, and tenant sharing.
- [Permissions](https://docs.verge.io/run-the-platform/system-administration/permissions.md): How to configure and manage user and group permissions in VergeOS, including permission levels, scopes, effective permissions, and assigning permissions to specific objects.
- [Licensing and Software Updates](https://docs.verge.io/run-the-platform/system-administration/running-updates.md): Step-by-step guide for running VergeOS software updates, including the download-install-reboot process, update settings, automatic updates, and air-gap licensing.
- [The System Event Log (SEL)](https://docs.verge.io/run-the-platform/system-administration/sel.md): How to view and clear the IPMI System Event Log (SEL) on VergeOS nodes, including capacity monitoring and log management.
- [Service Containers](https://docs.verge.io/run-the-platform/system-administration/service-containers.md): Overview of VergeOS service containers, lightweight environments used to run internal system services such as AI modules, providing modularity, isolation, and efficient resource usage.
- [System Settings](https://docs.verge.io/run-the-platform/system-administration/settings-overview.md): Overview of VergeOS system settings, including general configuration, version information, license details, location settings, connection details, and how to modify settings.
- [Configuring the Sites Dashboard (Adding Sites)](https://docs.verge.io/run-the-platform/system-administration/site-dashboard-add-sites.md): How to add remote VergeOS systems to the Sites Dashboard, including configuring sync, statistics monitoring, machine management, and repair server options.
- [Sites Dashboard](https://docs.verge.io/run-the-platform/system-administration/sites-overview.md): Overview of the VergeOS Sites Dashboard for centralized monitoring and administration of multiple VergeOS systems, including site statistics, VM management, and sync access.
- [SMTP](https://docs.verge.io/run-the-platform/system-administration/smtp.md): How to configure, test, and troubleshoot SMTP email settings in VergeOS, including relay configuration, TLS, queue management, mail logs, and troubleshooting delivery issues.
- [SR-IOV NICs](https://docs.verge.io/run-the-platform/system-administration/sriov-nics.md): How to configure SR-IOV NIC passthrough in VergeOS, including creating resource groups, configuring virtual functions, VM guest setup, and sharing SR-IOV devices to tenants.
- [Subscription Profiles](https://docs.verge.io/run-the-platform/system-administration/subscription-profiles.md): Overview of VergeOS subscription profiles, which define the information included in subscription notification emails for alerts and scheduled reports.
- [Viewing and Accessing Subscriptions](https://docs.verge.io/run-the-platform/system-administration/subscriptions-accessing.md): How to view and access your own subscriptions and all system subscriptions in VergeOS, including navigation paths and permission considerations.
- [Creating Subscriptions](https://docs.verge.io/run-the-platform/system-administration/subscriptions-overview.md): How to create on-demand alert and scheduled report subscriptions in VergeOS, including subscription types, configuration options, throttling, reminders, and practical examples.
- [Tags](https://docs.verge.io/run-the-platform/system-administration/tags.md): How to create, manage, and assign tags and tag categories in VergeOS to organize and classify system objects such as VMs, tenants, and nodes.
- [VergeOS Theme Functionality](https://docs.verge.io/run-the-platform/system-administration/themes.md): How to create and manage custom UI themes in VergeOS, including color customization for graphs, navigation, headers, loader elements, custom logos, favicons, and theme hierarchy.
- [Licensing and Software Updates](https://docs.verge.io/run-the-platform/system-administration/update-settings.md): Reference for VergeOS update settings, including update source, authentication, automatic updates, warm reboot, multi-cluster updates, snapshot policies, and privacy settings.
- [USB Passthrough](https://docs.verge.io/run-the-platform/system-administration/usb-passthrough.md): How to configure USB device passthrough in VergeOS, including host setup, resource group creation, VM guest configuration, and passing USB devices to tenants.
- [Users and Groups](https://docs.verge.io/run-the-platform/system-administration/users-groups.md): How to create and manage users and groups in VergeOS, including user types, password policies, two-factor authentication, SSH keys, physical access, and group membership.
- [NAS Diagnostics Guide](https://docs.verge.io/run-the-platform/nas/nas-diagnostics.md): Comprehensive reference for NAS diagnostic commands in VergeOS, covering network troubleshooting, file sharing protocol analysis, and performance monitoring for SMB/CIFS and NFS services.
- [Joining a NAS to a Windows AD Network](https://docs.verge.io/run-the-platform/nas/nas-join-ad-domain.md): How to join a VergeOS NAS service to a Windows Active Directory domain for AD-integrated file sharing, including CIFS settings configuration and troubleshooting.
- [Local Volumes](https://docs.verge.io/run-the-platform/nas/nas-local-volumes.md): How to create and configure local NAS volumes in VergeOS, including encryption, storage tiering, snapshot profiles, and size management on the vSAN.
- [Remote Volumes](https://docs.verge.io/run-the-platform/nas/nas-remote-volumes.md): How to create remote NAS volumes in VergeOS by mounting external CIFS and NFS file systems for data import, backup, and integration with external storage.
- [Add a NAS Service](https://docs.verge.io/run-the-platform/nas/nas-service.md): How to deploy and configure a NAS service in VergeOS by implementing the NAS VM recipe, including network, IP, hostname, and domain settings.
- [Shares](https://docs.verge.io/run-the-platform/nas/nas-shares.md): How to create NFS and CIFS shares on NAS volumes in VergeOS, including host access controls, user permissions, and advanced sharing options.
- [NAS Overview](https://docs.verge.io/run-the-platform/nas/overview.md): Overview of the VergeOS NAS feature for file-level storage, including benefits, setup steps, local and remote volumes, Active Directory integration, and share creation.
- [NAS Volume Snapshots and Restores](https://docs.verge.io/run-the-platform/nas/volume-snapshots-restores.md): How to create, schedule, and restore NAS volume snapshots in VergeOS, including quiesced snapshots, snapshot profiles, and restore-to-new or restore-over-source options.
- [Volume Syncs](https://docs.verge.io/run-the-platform/nas/volume-syncs.md): How to create and configure volume syncs in VergeOS to synchronize data between local and remote NAS volumes, including scheduling, advanced sync options, and destination delete policies.
- [VergeOS Diagnostics Overview](https://docs.verge.io/run-the-platform/maintenance-and-monitoring/diagnostics-overview.md): Overview of diagnostic tools in VergeOS, including component-specific diagnostics for networks, nodes, vSAN, and NAS, plus system-wide tools like subscriptions and Prometheus integration.
- [Alarms](https://docs.verge.io/run-the-platform/operations/alarms.md): Understanding and managing the VergeOS alarm system for proactive monitoring, including viewing, resolving, and snoozing alarms for hardware failures, configuration issues, and security concerns.
- [Replacing a Defective or End-of-life Drive](https://docs.verge.io/run-the-platform/operations/drive-replacement.md): Procedures for replacing failed, degraded, or end-of-life vSAN drives in VergeOS, including identifying defective drives, LED activation, and both reactive and proactive replacement scenarios.
- [Maintenance Mode](https://docs.verge.io/run-the-platform/operations/maintenance-mode.md): How to put a VergeOS node into and out of maintenance mode, including workload migration, monitoring progress, and handling non-migratable VMs.
- [Replacing a Node Using the ISO Installer](https://docs.verge.io/run-the-platform/operations/node-replacement.md): How to replace a physical VergeOS node by moving drives to new hardware and using the ISO installer's Replace Node option.
- [Standard Operating Procedures Overview](https://docs.verge.io/run-the-platform/operations/sop-overview.md): Overview of standardized operating procedures (SOPs) for critical VergeOS system operations, including installation, scaling, updates, and storage expansion.
- [VergeOS vSAN Scale Out Guide](https://docs.verge.io/run-the-platform/operations/sop-scale-out.md): Standard operating procedure for scaling out a VergeOS system by adding a new node, including preparation, pre-checks, execution, post-verification, and rollback procedures.
- [VergeOS Version Update Guide](https://docs.verge.io/run-the-platform/operations/sop-update.md): Standard operating procedure for safely updating a VergeOS system to a new point release, including preparation, staging, execution, post-update verification, and rollback guidance.
- [VergeOS Installation Guide](https://docs.verge.io/run-the-platform/operations/sop-verge-install.md): Standard operating procedure for an initial VergeOS installation, covering hardware preparation, network configuration, primary and secondary controller setup, and post-installation verification.
- [VergeOS vSAN Scale Up Guide](https://docs.verge.io/run-the-platform/operations/vsan-scale-up-sop.md): Standard operating procedure for scaling up vSAN storage capacity by adding drives to existing VergeOS nodes, including preparation, verification, execution, and post-scale-up checks.
- [Increasing a Tenant's Resources](https://docs.verge.io/run-the-platform/tenants/add-tenant-resources.md): Instructions for adding compute and storage resources to a tenant, including scaling existing tenant nodes, adding new nodes, and provisioning additional storage tiers.
- [Assigning External IP Addresses to a Tenant](https://docs.verge.io/run-the-platform/tenants/assign-ip-to-tenant.md): Instructions for assigning external IP addresses to a tenant, including creating virtual IPs and applying network rules for tenant external access.
- [Creating Tenants](https://docs.verge.io/run-the-platform/tenants/create-tenants.md): Step-by-step instructions for creating new tenants in VergeOS using the Tenant Wizard, cloning an existing tenant, or deploying from a tenant recipe.
- [Configure Tenant Layer 2 Networks](https://docs.verge.io/run-the-platform/tenants/layer-2-networks.md): How to configure Tenant Layer 2 Networks in VergeOS to pass VLANs directly to tenant environments, including creation, verification, VM attachment, and removal procedures.
- [Tenants (Virtual Data Centers)](https://docs.verge.io/run-the-platform/tenants/overview.md): Overview of VergeOS multi-tenancy, providing secure, encapsulated virtual data centers with full network isolation, nested tenancy, resource tracking, and portable self-contained environments.
- [Providing Files to a Tenant](https://docs.verge.io/run-the-platform/tenants/provide-files-to-tenant.md): How to share files from the parent vSAN with a tenant, including ISO images, VM disk images, and other uploaded files.
- [Reducing a Tenant's Resources](https://docs.verge.io/run-the-platform/tenants/reduce-tenant-resources.md): Instructions for reducing tenant compute resources by deleting tenant nodes or decreasing cores and RAM allocated to existing nodes.
- [Share a VM Snapshot between Provider and Tenant](https://docs.verge.io/run-the-platform/tenants/share-vm-snapshot.md): How to use the Shared Objects feature to share VM snapshots between a service provider and tenant, enabling snapshot-based VM transfers in both directions.
- [Modifying Tenants](https://docs.verge.io/run-the-platform/tenants/tenant-modifications.md): Reference for editing tenant properties including name, URL, admin password, theme access, OIDC authentication, UI address, and snapshot exposure settings.
- [Monitoring Tenants](https://docs.verge.io/run-the-platform/tenants/tenant-monitoring.md): Guide to monitoring tenants using dashboards, usage statistics, logs, and email subscriptions for alerts and scheduled reports.
- [Tenant Restores](https://docs.verge.io/run-the-platform/tenants/tenant-restores.md): Instructions for restoring an existing or deleted tenant from system snapshots, including provider-initiated and tenant self-service restore workflows.
- [Tenant Snapshots](https://docs.verge.io/run-the-platform/tenants/tenant-snapshots.md): How to manage tenant snapshots including exposing provider snapshots to tenants, restoring tenants from snapshots, and tenant self-service snapshot access and VM recovery.
- [Tenant Usage Reports](https://docs.verge.io/run-the-platform/tenants/tenant-usagereports.md): How to run tenant usage history reports for 95th percentile billing, view average and maximum statistics, export CSV data, and configure subscription-based usage report emails.
- [Creating Virtual Machines (VMs)](https://docs.verge.io/run-the-platform/virtual-machines/creating-vms.md): Guide to creating virtual machines in VergeOS, including custom VMs, recipe-based deployments, imports, and cloning existing VMs.
- [VergeOS Guest OS Compatibility](https://docs.verge.io/run-the-platform/virtual-machines/guest-os-compatibility.md): Reference guide for supported guest operating systems on VergeOS, including Windows, Linux, and FreeBSD versions with recommended interfaces and minimum requirements.
- [Importing VMs from a NAS Volume](https://docs.verge.io/run-the-platform/virtual-machines/import-from-nas.md): Instructions for bulk importing virtual machines from NFS or CIFS network shares into VergeOS using the NAS volume import method.
- [Importing VMs from Uploaded Media Images](https://docs.verge.io/run-the-platform/virtual-machines/import-from-upload.md): Guide to importing virtual machines by uploading disk image and configuration files (VMX, VMDK, OVF, VHD, QCOW) to the vSAN for individual VM import.
- [Importing VMs from VMware Service Backup Jobs](https://docs.verge.io/run-the-platform/virtual-machines/import-from-vmware.md): Guide to importing VMware virtual machines into VergeOS using the VMware service backup connector with incremental backup and minimal downtime migration.
- [Live Migrations](https://docs.verge.io/run-the-platform/virtual-machines/live-migrations.md): Guide to performing live migrations of running VMs between nodes and virtual disks between storage tiers in VergeOS without service interruption.
- [Virtual Machine Management (VergeHV)](https://docs.verge.io/run-the-platform/virtual-machines/overview.md): Overview of VergeOS virtual machine management capabilities powered by the VergeHV hypervisor, covering enterprise-grade compute, storage, networking, and automation features.
- [Sharing Disks Between Virtual Machines](https://docs.verge.io/run-the-platform/virtual-machines/sharing-disks-between-vms.md): Overview of the supported methods for sharing disks and data between virtual machines in VergeOS, including Clone Disk and NAS-based file sharing, with guidance on when to use each.
- [VDI Administrator Instructions](https://docs.verge.io/run-the-platform/virtual-machines/vdi-administrator.md): Administrator guide for configuring VDI user access, assigning VM console permissions, managing VM favorites, and setting VM ownership in VergeOS.
- [Virtual Desktop Infrastructure (VDI)](https://docs.verge.io/run-the-platform/virtual-machines/vdi-overview.md): Overview of VergeOS VDI functionality for hosting virtual desktops with individualized user dashboards for desktop access.
- [VDI User Instructions](https://docs.verge.io/run-the-platform/virtual-machines/vdi-user.md): End-user guide for accessing virtual desktops via the VDI dashboard, using the VM console, changing passwords, and managing two-factor authentication.
- [Viewing Import Jobs](https://docs.verge.io/run-the-platform/virtual-machines/view-import-jobs.md): Instructions for viewing and monitoring VM import job status, child jobs, and imported VM listings in VergeOS.
- [Virtual Machine Best Practices](https://docs.verge.io/run-the-platform/virtual-machines/vm-best-practices.md): Comprehensive best practices for VergeOS virtual machines covering RAM allocation, CPU selection, networking, storage, security, guest OS configuration, and data protection.
- [Virtual Machine Drives](https://docs.verge.io/run-the-platform/virtual-machines/vm-drives.md): Guide to adding, modifying, erasing, and removing virtual machine drives in VergeOS, including disk types, interfaces, media options, and storage tier selection.
- [VM Export Volume](https://docs.verge.io/run-the-platform/virtual-machines/vm-export-volume.md): Overview of the VergeOS NAS VM Export volume type for creating exportable VM snapshots accessible to external systems and third-party backup software.
- [Virtual Machine Fields](https://docs.verge.io/run-the-platform/virtual-machines/vm-field-descriptions.md): Complete reference for all VergeOS virtual machine configuration fields including name, RAM, CPU, boot order, machine type, console type, UEFI, and power settings.
- [VM Guest Agent](https://docs.verge.io/run-the-platform/virtual-machines/vm-guest-agent.md): Guide to enabling and installing the QEMU guest agent on VergeOS VMs for consistent snapshots, graceful shutdown, and enhanced host-guest communication.
- [Manual VM Migration](https://docs.verge.io/run-the-platform/virtual-machines/vm-manual-migration.md): Instructions for manually migrating running VMs between host nodes in VergeOS, including single VM and bulk migration procedures.
- [Migrating Workloads into VergeOS](https://docs.verge.io/run-the-platform/virtual-machines/vm-migration-overview.md): Comprehensive overview of VM migration methods for importing workloads into VergeOS from VMware, Hyper-V, KVM, and physical servers, including planning guidance and supported file formats.
- [Virtual Machine Network Interfaces (NICs)](https://docs.verge.io/run-the-platform/virtual-machines/vm-nics.md): Guide to adding, modifying, deleting, and disabling virtual network interfaces on VergeOS VMs, including interface types, MAC address management, and network assignment.
- [Using the Virtual Machine Remote Console](https://docs.verge.io/run-the-platform/virtual-machines/vm-remote-console.md): Guide to using the VergeOS VM remote console for direct keyboard and mouse interaction, including toolbar features, clipboard, power controls, and extra keys.
- [Working With Virtual Machines (VMs)](https://docs.verge.io/run-the-platform/virtual-machines/working-with-vms.md): Day-to-day VM management operations in VergeOS including console access, cloning, deleting, and power operations like restart, reset, and kill.

## Automate, protect, and extend

- [Automate, protect, and extend](https://docs.verge.io/automate-protect-and-extend/readme.md): The built-in automation, resilience, integration, and Private AI surface of VergeOS.
- [Immutable Snapshots](https://docs.verge.io/automate-protect-and-extend/backup-and-dr/immutable-snapshots.md): How to enable, manage, and understand immutable snapshots in VergeOS, which prevent deletion of system snapshots for ransomware protection with a mandatory seven-day unlock delay.
- [Manual Site Sync](https://docs.verge.io/automate-protect-and-extend/backup-and-dr/manual-site-syncs.md): How to manually add system snapshots to the site sync queue for on-demand replication to a remote VergeOS system outside of the automatic sync schedule.
- [Monitoring Site Syncs](https://docs.verge.io/automate-protect-and-extend/backup-and-dr/monitoring-site-syncs.md): How to monitor site sync operations using outgoing and incoming sync dashboards, sync statistics, logs, and email subscriptions for ongoing replication oversight.
- [Backup & Disaster Recovery (BC/DR)](https://docs.verge.io/automate-protect-and-extend/backup-and-dr/overview.md): Overview of VergeOS built-in data protection and business continuity capabilities including snapshots, site syncs, and repair servers for comprehensive BC/DR.
- [Repair Server (ioGuardian)](https://docs.verge.io/automate-protect-and-extend/backup-and-dr/repair-server.md): How to create and configure a repair server (ioGuardian) that automatically recovers corrupted or missing data blocks from a synchronized remote VergeOS system.
- [Snapshot Profiles (Snapshot Scheduling)](https://docs.verge.io/automate-protect-and-extend/backup-and-dr/snapshot-profiles.md): How to create and manage snapshot profiles in VergeOS for automated snapshot scheduling, including profile periods, retention settings, quiescing, immutable options, and compliance templates.
- [Snapshots](https://docs.verge.io/automate-protect-and-extend/backup-and-dr/snapshots-overview.md): Overview of VergeOS snapshot capabilities including system, partial, VM, tenant, and NAS volume snapshots with instant recovery, application-consistent capture, and flexible restore options.
- [Retrieving a Snapshot back (Sync Back)](https://docs.verge.io/automate-protect-and-extend/backup-and-dr/sync-back.md): How to configure sync-back and retrieve a copy of a snapshot from the remote sync destination back to the source VergeOS system for local restore operations.
- [Configuring a Site Sync](https://docs.verge.io/automate-protect-and-extend/backup-and-dr/sync-configuration.md): Complete guide to configuring site sync replication between VergeOS systems, including network rules, incoming/outgoing sync setup, auto sync scheduling, throttling, and repair server creation.
- [Site Syncs](https://docs.verge.io/automate-protect-and-extend/backup-and-dr/syncs-overview.md): Overview of VergeOS site sync capabilities for offsite backup, disaster recovery, and system migration through block-level snapshot replication with encryption and compression.
- [Restores from System Snapshots](https://docs.verge.io/automate-protect-and-extend/backup-and-dr/system-snapshot-restores.md): Instructions for restoring from system snapshots including full system restore, selective tenant recovery, selective VM recovery, and accessing provider snapshots as a tenant.
- [System Snapshots](https://docs.verge.io/automate-protect-and-extend/backup-and-dr/system-snapshots.md): How to manage system snapshots in VergeOS including full and partial snapshots with custom tagging, automated scheduling via profiles, manual snapshot creation, and storage best practices.
- [VM Snapshots and Restores](https://docs.verge.io/automate-protect-and-extend/backup-and-dr/vm-snapshots-restores.md): Complete guide to VM snapshot and restore operations in VergeOS including scheduled and manual snapshots, quiesced capture, restoring from system snapshots, overwrite restores, and clone restores.
- [Creating Automated Tasks](https://docs.verge.io/automate-protect-and-extend/automation/create-tasks.md): Step-by-step instructions for creating automated tasks in VergeOS, including how to configure event-based and schedule-based triggers for system automation.
- [VergeOS Marketplace Catalog: VM Recipes](https://docs.verge.io/automate-protect-and-extend/automation/marketplace-vm-recipes.md): Explore the pre-configured virtual machine recipes available in the VergeOS Marketplace Catalog for rapid, self-service VM deployment across Linux, Windows, and application stacks.
- [Recipe Organization](https://docs.verge.io/automate-protect-and-extend/automation/recipes-organization.md): How to organize recipes using repositories and catalogs in VergeOS, including instructions for sharing recipes with tenants and remote systems.
- [Recipes](https://docs.verge.io/automate-protect-and-extend/automation/recipes-overview.md): Overview of VergeOS recipes for automating VM and tenant deployments, including key features, use cases for service providers, enterprises, and development teams.
- [Schedules](https://docs.verge.io/automate-protect-and-extend/automation/schedules.md): How to create and manage custom schedules in the VergeOS Task Engine for one-time or recurring task automation.
- [Scripts](https://docs.verge.io/automate-protect-and-extend/automation/scripts.md): Overview of the Scripts feature in VergeOS, currently reserved for internal system operations with planned extensibility for administrator-defined automation workflows.
- [Task Engine](https://docs.verge.io/automate-protect-and-extend/automation/task-engine.md): Overview of the VergeOS Task Engine for automating operations with event-based and schedule-based triggers, including modular architecture for tasks, schedules, events, and webhooks.
- [Tenant Recipes](https://docs.verge.io/automate-protect-and-extend/automation/tenant-recipes.md): How to create and use tenant recipes in VergeOS for automating complete tenant deployments including networking, VMs, settings, and custom configuration questions.
- [VM Recipes](https://docs.verge.io/automate-protect-and-extend/automation/vm-recipes.md): How to create, configure, and use VM recipes in VergeOS for rapid deployment of standardized virtual machines with customizable questions and cloud-init integration.
- [Webhooks](https://docs.verge.io/automate-protect-and-extend/automation/webhooks.md): How to configure webhooks in VergeOS for push-based messaging to external systems, including webhook creation, task payload setup, and event trigger configuration.
- [Cirrus Data Integration with VergeOS](https://docs.verge.io/automate-protect-and-extend/integrations-and-apis/cirrus-data.md): Cirrus Data integration provides advanced data mobility and migration solutions for VergeOS, enabling zero-downtime workload migration between hypervisors, cloud platforms, and storage systems.
- [External Monitoring](https://docs.verge.io/automate-protect-and-extend/integrations-and-apis/external-monitoring.md): VergeOS does not support SNMP. This guide covers the supported paths for external monitoring — the Prometheus Exporter (ioMetrics), the REST API, and IPMI — plus SNMP-first tools like SolarWinds.
- [VergeOS Go SDK (govergeos)](https://docs.verge.io/automate-protect-and-extend/integrations-and-apis/go-sdk.md): govergeos is a Go client library for managing VergeOS infrastructure through the REST API, providing type-safe interfaces for automating VMs, networking, storage, tenants, and disaster recovery.
- [Inuvika Integration with VergeOS](https://docs.verge.io/automate-protect-and-extend/integrations-and-apis/inuvika.md): Inuvika OVD Enterprise integration with VergeOS delivers virtual desktop infrastructure (VDI) and application delivery, enabling secure remote access to Windows and Linux desktops and applications.
- [Kubernetes Integration](https://docs.verge.io/automate-protect-and-extend/integrations-and-apis/kubernetes-integration.md): VergeOS provides native Kubernetes integration via a CSI storage driver and Cloud Controller Manager, giving clusters on VergeOS VMs persistent storage, node lifecycle management, and load balancers.
- [Leostream Integration with VergeOS](https://docs.verge.io/automate-protect-and-extend/integrations-and-apis/leostream.md): Leostream Connection Broker integrates with VergeOS to deliver multi-protocol VDI and remote desktop access for compliant, mixed-platform, and GPU-accelerated workloads.
- [NVIDIA GPU Virtualization](https://docs.verge.io/automate-protect-and-extend/integrations-and-apis/nvidia-gpu-virtualization.md): NVIDIA integration with VergeOS enables GPU acceleration for VMs through vGPU and Multi-Instance GPU (MIG) technologies, letting multiple VMs share physical GPU resources with performance isolation.
- [VergeOS PowerShell Module (PSVergeOS)](https://docs.verge.io/automate-protect-and-extend/integrations-and-apis/powershell-module.md): PSVergeOS is a PowerShell module providing over 200 cmdlets for managing VergeOS infrastructure through the REST API, enabling automation of VMs, networking, storage, tenants, and disaster recovery.
- [VergeOS Prometheus Exporter (ioMetrics)](https://docs.verge.io/automate-protect-and-extend/integrations-and-apis/prometheus-exporter.md): The VergeOS Prometheus Exporter collects metrics from VergeOS environments and exposes them in Prometheus format for monitoring vSAN tiers, clusters, and nodes.
- [VergeOS Python SDK (pyvergeos)](https://docs.verge.io/automate-protect-and-extend/integrations-and-apis/python-sdk.md): pyvergeos is a Python SDK for managing VergeOS through the REST API, providing a Pythonic, type-annotated interface for automating VMs, networking, storage, tenants, and disaster recovery.
- [Rancher Integration](https://docs.verge.io/automate-protect-and-extend/integrations-and-apis/rancher-integration.md): VergeOS integrates with Rancher through a Docker Machine node driver and UI extension, enabling provisioning and management of RKE2/K3s clusters on VergeOS from the Rancher interface.
- [Storware Integration with VergeOS](https://docs.verge.io/automate-protect-and-extend/integrations-and-apis/storware-backup-recovery.md): Storware integration provides enterprise-grade backup and recovery for VergeOS virtual machines, offering policy-based protection with automated scheduling, granular recovery, and deduplication.
- [VergeOS Terraform Provider](https://docs.verge.io/automate-protect-and-extend/integrations-and-apis/terraform-provider.md): The VergeOS Terraform Provider enables infrastructure-as-code management of VergeOS resources including VMs, networks, and users through Terraform and OpenTofu configurations.
- [VergeOS TypeScript SDK (tsvergeos)](https://docs.verge.io/automate-protect-and-extend/integrations-and-apis/typescript-sdk.md): tsvergeos is a TypeScript SDK for managing VergeOS through the REST API, offering a zero-dependency, tree-shakeable, typed interface for automating VMs, networking, storage, tenants, and multi-site.
- [Veeam Integration with VergeOS](https://docs.verge.io/automate-protect-and-extend/integrations-and-apis/veeam.md): Veeam Backup & Replication protects VergeOS workloads through the VergeOS oVirt-engine package: add systems and tenants to Veeam as VergeOS Managers and deploy workers to move backup data.
- [VergeOS CLI (vrg)](https://docs.verge.io/automate-protect-and-extend/integrations-and-apis/vrg-cli.md): vrg is the official command-line interface for VergeOS, providing 200+ commands for managing virtual machines, networks, tenants, NAS, and more from a terminal or automation pipeline.
- [Interactive Chat Sessions](https://docs.verge.io/automate-protect-and-extend/private-ai/chat-sessions.md): Guide for conducting interactive chat sessions with AI assistants in the VergeOS UI, including file attachments, token metrics, and chat history management.
- [AI Configuration](https://docs.verge.io/automate-protect-and-extend/private-ai/configuration.md): Step-by-step guide for configuring AI models, assistants, and workspace files in VergeOS Private AI, including resource allocation, system prompts, and troubleshooting.
- [VergeOS OpenAI-Compatible API](https://docs.verge.io/automate-protect-and-extend/private-ai/open-ai-router.md): Documentation for the VergeOS OpenAI-compatible API endpoint, enabling applications to interact with locally-hosted LLMs using standard OpenAI API format with Python, JavaScript, and cURL.
- [Private AI Overview](https://docs.verge.io/automate-protect-and-extend/private-ai/overview.md): Overview of VergeOS Private AI, which enables deploying and running large language models locally within your infrastructure with no external API calls or data transmission.
- [API Keys](https://docs.verge.io/automate-protect-and-extend/shared-admin-surfaces/api-keys.md): How to create, manage, and use API keys for programmatic access to the VergeOS REST API, including authentication, IP access controls, expiration settings, and security best practices.

## Learn the platform

- [Learn the platform](https://docs.verge.io/learn-the-platform/readme.md): Hands-on training for architecting, deploying, and operating VergeOS infrastructure.
- [Overview](https://docs.verge.io/learn-the-platform/module-1-architecture-fundamentals/01-architecture.md): Understand the VergeOS platform architecture, deployment models, storage, networking, and cluster concepts.
- [What is VergeOS?](https://docs.verge.io/learn-the-platform/module-1-architecture-fundamentals/01-vergeos-overview.md): An overview of the VergeOS ultraconverged operating system, its core components, differentiators, and common use cases.
- [HCI vs UCI: Deployment Models](https://docs.verge.io/learn-the-platform/module-1-architecture-fundamentals/02-hci-vs-uci.md): Understand the two VergeOS deployment architectures -- Hyperconverged Infrastructure (HCI) and Ultra Converged Infrastructure (UCI) -- and when to recommend each.
- [vSAN / VergeFS: Software-Defined Storage](https://docs.verge.io/learn-the-platform/module-1-architecture-fundamentals/03-vsan-vergefs.md): Understand how VergeOS vSAN (VergeFS) provides distributed, software-defined storage with tiered architecture, hash-based data distribution, and self-healing redundancy.
- [Core Fabric & Networking](https://docs.verge.io/learn-the-platform/module-1-architecture-fundamentals/04-core-fabric.md): Understand the VergeOS core fabric — the private inter-node mesh that carries vSAN replication, VM migration, and control-plane traffic — along with the external network separation model.
- [Clusters & Node Types](https://docs.verge.io/learn-the-platform/module-1-architecture-fundamentals/05-clusters-nodes.md): Learn how VergeOS organizes physical servers into clusters, understand the different node types (controller, scale-out, storage-only, compute-only), and how systems scale.
- [Lab: Explore the Architecture](https://docs.verge.io/learn-the-platform/module-1-architecture-fundamentals/lab.md): Hands-on exploration of VergeOS deployment topologies using the Terraform playground. Trace infrastructure-as-code patterns, compare scenarios, and design a topology for a customer use case.
- [Overview](https://docs.verge.io/learn-the-platform/module-2-sizing-and-design/02-sizing-design.md): Hardware requirements, reference architectures, and customer scoping exercises for VergeOS deployments.
- [Hardware Requirements](https://docs.verge.io/learn-the-platform/module-2-sizing-and-design/01-hardware-requirements.md): Minimum and recommended hardware specifications for VergeOS controller nodes, storage nodes, and compute-only nodes, plus maximum supported limits.
- [Lab: Sizing & Design Exercise](https://docs.verge.io/learn-the-platform/module-2-sizing-and-design/lab.md): Design a VergeOS deployment for a customer scenario, including topology selection and hardware sizing.
- [Reference Architectures](https://docs.verge.io/learn-the-platform/module-2-sizing-and-design/02-reference-architectures.md): Three VergeOS deployment models -- HCI, HCI + Dedicated Compute, and UCI -- with a decision framework, topology diagrams, and guidance for edge and CSP scenarios.
- [Customer Scoping](https://docs.verge.io/learn-the-platform/module-2-sizing-and-design/03-customer-scoping.md): Requirements gathering methodology, workload-to-resource translation, tenant node planning, topology selection framework, and documentation deliverables for VergeOS deployments.
- [Overview](https://docs.verge.io/learn-the-platform/module-3-installation/03-installation.md): Bare-metal preparation, VergeOS installation walkthrough, and post-install verification for production deployments.
- [Pre-Installation Checklist](https://docs.verge.io/learn-the-platform/module-3-installation/01-pre-installation.md): Hardware readiness, BIOS configuration, boot media creation, network preparation, and planning decisions required before a VergeOS installation.
- [Lab: 2-Node VergeOS Installation](https://docs.verge.io/learn-the-platform/module-3-installation/lab.md): Install VergeOS on a 2-node cluster, configure core fabric networking, and verify system health.
- [Controller Installation](https://docs.verge.io/learn-the-platform/module-3-installation/02-controller-installation.md): Step-by-step walkthrough of installing the primary controller (Node 1) and secondary controller (Node 2) to form a redundant VergeOS system.
- [Adding Nodes](https://docs.verge.io/learn-the-platform/module-3-installation/03-adding-nodes.md): Learn how to expand a VergeOS system by adding scale-out, storage-only, and compute-only nodes to your cluster using the USB installer.
- [Post-Installation Verification](https://docs.verge.io/learn-the-platform/module-3-installation/04-post-install-verification.md): Confirming system health, verifying storage and networking, completing initial configuration, and validating your VergeOS deployment with functional testing.
- [Overview](https://docs.verge.io/learn-the-platform/module-4-networking/04-networking.md): Configure external and internal networks, VLANs, firewall rules, and dynamic routing in VergeOS.
- [Network Concepts & Types](https://docs.verge.io/learn-the-platform/module-4-networking/01-network-concepts.md): Understand VergeFabric SDN architecture, the five VergeOS network types, built-in networking services, and how traffic flows through the system.
- [Lab: Network Configuration](https://docs.verge.io/learn-the-platform/module-4-networking/lab.md): Build a multi-network VergeOS environment with external access, internal segmentation, VLANs, and firewall rules.
- [External Networks](https://docs.verge.io/learn-the-platform/module-4-networking/02-external-networks.md): Learn how to create and configure VergeOS external networks — connecting your environment to upstream LAN, WAN, and Internet infrastructure with VLANs, bonding, static IPs, and high availability.
- [Internal Networks & DHCP/DNS](https://docs.verge.io/learn-the-platform/module-4-networking/03-internal-networks.md): Create and manage isolated virtual networks in VergeOS with built-in DHCP, DNS, inter-network routing via the DMZ, and tenant self-service networking.
- [Firewall Rules, NAT & VLANs](https://docs.verge.io/learn-the-platform/module-4-networking/04-firewall-nat-vlans.md): Master VergeOS network rules — firewall policies, NAT/PAT translation, static routes, VLAN trunking, VPN connectivity, and micro-segmentation strategies.
- [Overview](https://docs.verge.io/learn-the-platform/module-5-storage/05-storage.md): Configure vSAN storage tiers, provision NAS shares, and apply storage best practices for performance and redundancy in VergeOS.
- [vSAN Architecture & VergeFS](https://docs.verge.io/learn-the-platform/module-5-storage/01-vsan-architecture.md): Deep dive into VergeOS vSAN block-level architecture, hash-based data distribution, inline deduplication, encryption, self-healing redundancy, and space-efficient snapshots.
- [Lab: Storage Configuration](https://docs.verge.io/learn-the-platform/module-5-storage/lab.md): Configure vSAN storage tiers, provision NAS shares, and validate storage performance and redundancy in VergeOS.
- [Storage Tiers](https://docs.verge.io/learn-the-platform/module-5-storage/02-storage-tiers.md): The VergeOS storage tier model: 5 workload tiers plus the Tier 0 metadata tier, drive assignment rules, and capacity planning.
- [NAS Service & Shares](https://docs.verge.io/learn-the-platform/module-5-storage/03-nas-shares.md): Learn how VergeOS delivers file-level storage access via CIFS/SMB and NFS through its VM-based NAS service, including local volumes, remote volumes, VM exports, and Active Directory integration.
- [Snapshots & Data Protection](https://docs.verge.io/learn-the-platform/module-5-storage/04-snapshots-data-protection.md): Understand VergeOS snapshot architecture, quiesced snapshots, snapshot profiles, clones, site sync replication, and disaster recovery strategies.
- [Storage Monitoring & Troubleshooting](https://docs.verge.io/learn-the-platform/module-5-storage/05-storage-monitoring.md): Master vSAN diagnostics, Fibre Channel integration, NAS troubleshooting, and preventive maintenance strategies in VergeOS.
- [Overview](https://docs.verge.io/learn-the-platform/module-6-virtual-machines/06-virtual-machines.md): Create and manage VMs in VergeOS, deploy from recipes and templates, configure GPU passthrough, and import VMs from VMware and other platforms.
- [VM Creation & Lifecycle](https://docs.verge.io/learn-the-platform/module-6-virtual-machines/01-vm-creation-lifecycle.md): Create and manage virtual machines in VergeOS -- from blank custom VMs and clones to drives, NICs, hot-plug operations, and day-to-day lifecycle management.
- [Lab: Virtual Machine Operations](https://docs.verge.io/learn-the-platform/module-6-virtual-machines/lab.md): Create VMs, deploy from recipes, configure GPU passthrough, and import a VM from an external format in VergeOS.
- [Recipes & the Marketplace](https://docs.verge.io/learn-the-platform/module-6-virtual-machines/02-recipes-marketplace.md): Standardized VM provisioning with golden-image templates, the Marketplace catalog, cloud-init/Cloudbase-init integration, and custom recipe creation in VergeOS.
- [GPU & Device Passthrough](https://docs.verge.io/learn-the-platform/module-6-virtual-machines/03-gpu-passthrough.md): Configure PCI, GPU, vGPU, SR-IOV NIC, and USB device passthrough in VergeOS -- from BIOS prerequisites and resource groups to tenant-level device sharing.
- [VM Migration & Import](https://docs.verge.io/learn-the-platform/module-6-virtual-machines/04-vm-migration-import.md): Migrate workloads from VMware, Hyper-V, KVM, and physical machines into VergeOS using the VMware Connector, file uploads, NAS volume imports, and the Clone Utility -- plus export VMs back out.
- [Overview](https://docs.verge.io/learn-the-platform/module-7-multi-tenancy/07-multi-tenancy.md): Design multi-tenant environments with proper isolation, create tenants, allocate resources, and configure tenant recipes for standardized provisioning.
- [Virtual Data Center Concepts](https://docs.verge.io/learn-the-platform/module-7-multi-tenancy/01-vdc-concepts.md): Understanding VergeOS tenants as fully isolated virtual data centers, tenant hierarchy, key features, and multi-tenancy use cases for service providers, enterprises, and education.
- [Lab: Multi-Tenant Environment](https://docs.verge.io/learn-the-platform/module-7-multi-tenancy/lab.md): Create tenants, allocate resources, deploy from a tenant recipe, and verify tenant isolation in VergeOS.
- [Creating & Configuring Tenants](https://docs.verge.io/learn-the-platform/module-7-multi-tenancy/02-creating-tenants.md): Step-by-step guide to creating tenants using the wizard, cloning, and recipes, plus assigning external IPs, sharing files, and sharing VM snapshots.
- [Tenant Recipes](https://docs.verge.io/learn-the-platform/module-7-multi-tenancy/03-tenant-recipes.md): Automating full VDC deployment with reusable tenant recipe templates, including system questions, custom questions, recipe exchange, and real-world CSP examples.
- [Resource Allocation & Scaling](https://docs.verge.io/learn-the-platform/module-7-multi-tenancy/04-resource-allocation.md): Plan, assign, and scale tenant compute, memory, and storage resources using VergeOS tenant nodes — from single-node simplicity to multi-node distributed deployments.
- [Tenant Isolation & Security](https://docs.verge.io/learn-the-platform/module-7-multi-tenancy/05-isolation-security.md): Security boundaries, network encapsulation, storage isolation, user management, Layer 2 pass-through, micro-segmentation, and tenant monitoring in VergeOS multi-tenant deployments.
- [Overview](https://docs.verge.io/learn-the-platform/module-8-developer-and-devops/08-developer-devops.md): Automate VergeOS infrastructure using the REST API and vrg CLI, pyvergeos, the PSVergeOS PowerShell module, the Terraform provider, Ansible, the Task Engine, and Kubernetes/Rancher.
- [REST API & CLI Tools](https://docs.verge.io/learn-the-platform/module-8-developer-and-devops/01-api-cli.md): Master the VergeOS REST API, yb-api helper script, and vrg CLI for programmatic infrastructure management and automation.
- [Lab: Infrastructure Automation](https://docs.verge.io/learn-the-platform/module-8-developer-and-devops/lab.md): Use the VergeOS REST API, Terraform provider, and scripting tools to automate VM and tenant provisioning end-to-end.
- [Python SDK (pyvergeos)](https://docs.verge.io/learn-the-platform/module-8-developer-and-devops/02-python-sdk.md): Automate VergeOS infrastructure with the pyvergeos Python SDK — VM lifecycle, networking, multi-tenancy, storage, and disaster recovery from Python scripts.
- [PowerShell Module (PSVergeOS)](https://docs.verge.io/learn-the-platform/module-8-developer-and-devops/03-powershell-module.md): Manage VergeOS infrastructure with the PSVergeOS PowerShell module — over 200 cmdlets for VM lifecycle, networking, storage, multi-tenancy, VPN, and disaster recovery automation.
- [Terraform & Packer](https://docs.verge.io/learn-the-platform/module-8-developer-and-devops/04-terraform-packer.md): Declarative infrastructure-as-code for VergeOS using the Terraform provider, OpenTofu, and the Packer plugin for automated golden image creation.
- [Ansible Collection](https://docs.verge.io/learn-the-platform/module-8-developer-and-devops/05-ansible.md): Automate VergeOS infrastructure with the vergeio.vergeos Ansible collection — modules for VM snapshots, tagging, and imports, plus a dynamic inventory plugin for multi-site environments.
- [Task Engine & Webhooks](https://docs.verge.io/learn-the-platform/module-8-developer-and-devops/06-task-engine.md): Automate VergeOS operations with the built-in Task Engine — event-driven triggers, scheduled tasks, webhooks to external systems, and modular automation workflows.
- [Kubernetes & Rancher Integration](https://docs.verge.io/learn-the-platform/module-8-developer-and-devops/07-kubernetes-rancher.md): Deploy and manage Kubernetes clusters on VergeOS with the Docker Machine Driver, Cloud Controller Manager, CSI Driver, Rancher UI Extension, and Helm Charts.
- [Overview](https://docs.verge.io/learn-the-platform/module-9-monitoring-and-troubleshooting/09-monitoring-troubleshooting.md): Monitor VergeOS system health, configure alerts and log forwarding, diagnose common issues, and know when to escalate to Verge support.
- [Dashboard & System Health](https://docs.verge.io/learn-the-platform/module-9-monitoring-and-troubleshooting/01-dashboard-health.md): Real-time system visibility from the VergeOS UI -- node dashboards, hardware resources, fabric status, event logs, and cluster-level monitoring.
- [Lab: Monitoring & Troubleshooting](https://docs.verge.io/learn-the-platform/module-9-monitoring-and-troubleshooting/lab.md): Explore the VergeOS dashboard, configure alerts, analyze system logs, and practice diagnosing common issues.
- [Subscriptions & Alerts](https://docs.verge.io/learn-the-platform/module-9-monitoring-and-troubleshooting/02-alerts.md): Proactive notification configuration in VergeOS -- on-demand alerts, scheduled reports, subscription profiles, throttle controls, and SMTP prerequisites.
- [Log Management & Forwarding](https://docs.verge.io/learn-the-platform/module-9-monitoring-and-troubleshooting/03-log-management.md): VergeOS log types, 45-day in-UI retention, context-specific logs, remote syslog forwarding configuration, SEL management, and SMTP activity reports.
- [Prometheus & Grafana Integration](https://docs.verge.io/learn-the-platform/module-9-monitoring-and-troubleshooting/04-prometheus-grafana.md): Deploy the vergeos-exporter to collect vSAN, cluster, and node metrics in Prometheus format, configure Grafana dashboards, and integrate with AlertManager for proactive monitoring.
- [Diagnostics Toolkit](https://docs.verge.io/learn-the-platform/module-9-monitoring-and-troubleshooting/05-diagnostics-toolkit.md): Master the four component-specific diagnostic tools built into VergeOS — network, node, vSAN, and NAS diagnostics — and learn when to use each for efficient troubleshooting.
- [Common Issues & Resolutions](https://docs.verge.io/learn-the-platform/module-9-monitoring-and-troubleshooting/06-common-issues.md): Troubleshooting patterns for the most frequently encountered VergeOS problems — VM networking, guest memory reporting, SEL noise, NAS shares, installation issues, and storage degradation.
- [Support Escalation](https://docs.verge.io/learn-the-platform/module-9-monitoring-and-troubleshooting/07-support-escalation.md): When and how to engage VergeOS support — System Diagnostics bundles, contact options, ticket best practices, and standard operating procedures for escalation-worthy operations.
- [Overview](https://docs.verge.io/learn-the-platform/module-10-scenario-labs/10-scenario-labs.md): Capstone scenario labs deploying multiple VergeOS topologies with the Terraform playground, performing VMware-to-VergeOS migrations, and making architecture decisions based on customer requirements.
- [Lab: HCI Deployment](https://docs.verge.io/learn-the-platform/module-10-scenario-labs/lab-hci.md): Deploy 2-node and 4-node HCI topologies using the Terraform playground and validate cluster health, storage, and networking.
- [Lab: UCI Deployment](https://docs.verge.io/learn-the-platform/module-10-scenario-labs/lab-uci.md): Deploy a UCI 3-cluster topology with separate compute and storage clusters using the Terraform playground.
- [Lab: HCI + Compute Deployment](https://docs.verge.io/learn-the-platform/module-10-scenario-labs/lab-hci-compute.md): Deploy an HCI foundation cluster with a dedicated compute-only cluster using the Terraform playground, configure workload placement, and validate independent compute scaling.
- [Lab: VMware Migration](https://docs.verge.io/learn-the-platform/module-10-scenario-labs/lab-migration.md): Plan and execute a VMware-to-VergeOS migration end-to-end, including VM import, network reconfiguration, and validation.
- [Lab: Multi-Tenancy / MSP Deployment](https://docs.verge.io/learn-the-platform/module-10-scenario-labs/lab-multi-tenancy.md): Build a multi-tenant MSP environment — create tenants via wizard and recipe, configure resource quotas and networking, verify isolation, and review audit logs and usage reports.

## Knowledge base

- [Knowledge base](https://docs.verge.io/knowledge-base/readme.md): Troubleshooting articles, how-tos, and field guidance for VergeOS operators.
- [Getting Started & Installation](https://docs.verge.io/knowledge-base/getting-started.md): Articles to help you plan, install, license, and update VergeOS.
- [Pre-installation Checklist](https://docs.verge.io/knowledge-base/getting-started/preinstallation-checklist.md): Comprehensive checklist of hardware, network, and site requirements to complete before installing VergeOS on physical nodes.
- [Secure Boot and Boot Integrity for Physical Nodes](https://docs.verge.io/knowledge-base/getting-started/node-secure-boot.md): Understanding VergeOS boot integrity protection and why traditional UEFI Secure Boot is not used for physical nodes.
- [Virtual Machines](https://docs.verge.io/knowledge-base/virtual-machines.md): How-to guides for creating, importing, configuring, and managing virtual machines.
- [Changing Resolution on a UEFI VM](https://docs.verge.io/knowledge-base/virtual-machines/changing-resolution-on-a-uefi-vm.md): Steps to change the screen resolution on a UEFI-based VM by modifying the OVMF Platform Configuration display settings.
- [Emulate a USB Device](https://docs.verge.io/knowledge-base/virtual-machines/emulate-usb.md): Instructions for creating and attaching an emulated USB device to a VM in VergeOS, including hotplug configuration and VirtIO driver requirements.
- [How to Add a TPM Device to a Virtual Machine](https://docs.verge.io/knowledge-base/virtual-machines/add-tpm-device-to-vm.md): Step-by-step instructions for adding a Trusted Platform Module (TPM) device to a virtual machine in VergeOS, including UEFI configuration, guest OS setup, and BitLocker enablement.
- [How to Import a Linux VM (RHEL, CentOS, SUSE, Debian, Ubuntu)](https://docs.verge.io/knowledge-base/virtual-machines/import-rhel-centos-vm.md): Importing Linux VMs from other hypervisors into VergeOS and configuring virtio drivers by rebuilding initramfs for proper booting across RHEL, CentOS, SUSE, Debian, and Ubuntu.
- [Importing Physical Machines and Individual VMs into VergeOS](https://docs.verge.io/knowledge-base/virtual-machines/importing-a-physicalvirtual-machine-into-vergeio.md): Learn how to use the VergeOS Clone Utility to import physical or virtual machines into VergeOS, including PtoV and VtoV migrations with HTTPS and vSAN-direct transfer methods.
- [Importing VMs from Files](https://docs.verge.io/knowledge-base/virtual-machines/import-vms-from-files.md): Learn how to import VMs into VergeOS from uploaded files including VMX, VMDK, OVF, VHD/X, and QCOW2 formats, with troubleshooting steps for boot failures.
- [Importing Windows Server with UEFI into VergeOS](https://docs.verge.io/knowledge-base/virtual-machines/importing-windows-server-with-uefi-into-vergeos.md): Guide to migrating a UEFI-enabled Windows Server VM from VMware into VergeOS, including disk interface changes, Virtio driver installation, and QEMU guest agent configuration.
- [Isolating a VM](https://docs.verge.io/knowledge-base/virtual-machines/isolating-a-vm.md): Methods for isolating a virtual machine in VergeOS, including removing network connections and creating a dedicated internal network for restricted access.
- [Loading Virtio Drivers in Windows Recovery Console](https://docs.verge.io/knowledge-base/virtual-machines/loading-virtio-drivers-in-windows-recovery-console.md): How to load Virtio SCSI and storage drivers in Windows Recovery Console so that Virtio-SCSI disks become visible for recovery operations.
- [Making a Non-Persistent VM](https://docs.verge.io/knowledge-base/virtual-machines/making-a-nonpersistent-vm.md): How to create a non-persistent virtual machine in VergeOS that reverts to its original state after each reboot, ideal for VDI environments.
- [Managing Files](https://docs.verge.io/knowledge-base/virtual-machines/managing-files.md): How to upload, manage, and share files in VergeOS including ISOs, VM disk images, and creating public links for file sharing between sites and tenants.
- [Reasons a Windows VM Restarted Unexpectedly](https://docs.verge.io/knowledge-base/virtual-machines/reasons-a-windows-vm-restarted-unexpectedly.md): How to diagnose why a Windows VM restarted unexpectedly by reviewing VergeOS log messages including kill, poweroff, shutdown, and reset events.
- [Resizing a Virtual Disk Drive](https://docs.verge.io/knowledge-base/virtual-machines/resizing-a-virtual-disk-drive.md): Step-by-step instructions for increasing the size of a virtual disk drive in VergeOS, including notes on hot-plug support and guest OS requirements.
- [Secure Boot Certificate Expiry - Microsoft Guest VMs (June 2026)](https://docs.verge.io/knowledge-base/virtual-machines/secure-boot-certificate-expiry-2026.md): How to resolve the expiring Microsoft Secure Boot certificate on Windows guest VMs using the one-click fix introduced in VergeOS 26.1.5.
- [SonicWall NSv 7.1.1+ Will Not Boot on VergeOS](https://docs.verge.io/knowledge-base/virtual-machines/sonicwall-nsv-boot-failure-signed-firmware.md): SonicWall NSv firewalls on SonicOS 7.1.1+ fail to boot after import into VergeOS because the appliance requires SonicWall's signed OVMF firmware. Custom EFI firmware support is coming in Q3 2026.
- [UEFI Tweaks for Imported VMs](https://docs.verge.io/knowledge-base/virtual-machines/uefi-tweaks-for-imported-vms.md): How to resolve boot issues with imported VMs that use UEFI boot devices, including boot order and secure boot adjustments.
- [Understanding VergeOS VM Memory Management](https://docs.verge.io/knowledge-base/virtual-machines/guest-memory-management.md): Explains why VergeOS shows allocated memory rather than active usage, the benefits of no memory ballooning, and best practices for memory monitoring and capacity planning.
- [VirtIO-Win Driver Compatibility with MS SQL Server Workloads](https://docs.verge.io/knowledge-base/virtual-machines/virtio-win-mssql-compatibility.md): Known virtio-win driver compatibility issue affecting Windows VMs running MS SQL Server under heavy I/O, including the recommended version, verification steps, and a clean downgrade procedure.
- [Virtual Drive TRIM](https://docs.verge.io/knowledge-base/virtual-machines/virtual-drive-trim.md): How to perform TRIM/UNMAP operations on virtual drives in Windows and Linux to reclaim unused vSAN space, especially after importing thick-provisioned VMs.
- [VM Advanced Options](https://docs.verge.io/knowledge-base/virtual-machines/vm-advanced-options.md): Guide to configuring advanced VM options for fine-tuning performance, hardware emulation, and device behavior in VergeOS, including CPU threading, SMBIOS, NIC tuning, and QEMU machine parameters.
- [VM Disk Discard](https://docs.verge.io/knowledge-base/virtual-machines/vm-disk-discard.md): Managing disk discard settings for virtual machines in VergeOS to optimize storage usage and reclaim unused vSAN space through TRIM/DISCARD commands.
- [Windows - Slow to Format a New Disk](https://docs.verge.io/knowledge-base/virtual-machines/windows--slow-to-format-a-new-disk.md): How to fix slow virtual disk formatting in Windows Server 2012 and later by temporarily disabling SCSI TRIM and Unmap commands using fsutil.
- [Windows - Time Shift](https://docs.verge.io/knowledge-base/virtual-machines/windows-time-shift.md): How to resolve time drift in Windows VMs on VergeOS by configuring the RTC Base setting and the RealTimeIsUniversal registry key for proper UTC time handling.
- [Windows Disks Showing Offline After Restarting](https://docs.verge.io/knowledge-base/virtual-machines/windows-disks-showing-offline-after-restarting.md): How to fix secondary virtual disks that show as offline after restarting a Windows VM imported into VergeOS, using the Set-StorageSetting PowerShell command.
- [Windows is Unable to Detect a Virtual Disk Drive](https://docs.verge.io/knowledge-base/virtual-machines/windows-is-unable-to-detect-a-virtual-disk-drive.md): How to resolve Windows not detecting a virtual disk drive by loading virtIO drivers during installation or changing the disk interface type to SATA.
- [Windows Restored VM Not Bootable](https://docs.verge.io/knowledge-base/virtual-machines/windows-restored-vm-not-bootable.md): Troubleshooting steps for a Windows VM that is not booting after being restored from a snapshot, including fixes for non-quiesced snapshots, pending updates, driver issues, and corrupted boot loaders.
- [Workloads Failing to Migrate](https://docs.verge.io/knowledge-base/virtual-machines/workloads-failing-to-migrate.md): Common reasons why workloads fail to migrate between nodes, including insufficient resources, pinned VM configurations, and tenant node issues.
- [Networking](https://docs.verge.io/knowledge-base/networking.md): Guides for VergeOS networking — networks, rules, routing, VPNs, and firewalls.
- [Accessing the User Interface from an Internal Network](https://docs.verge.io/knowledge-base/networking/accessing-the-user-interface-from-an-internal-network.md): Learn how to set up an internal UI route to access the VergeOS User Interface from a virtual machine within your environment.
- [Accessing the VergeOS UI from a VM](https://docs.verge.io/knowledge-base/networking/accessing-the-ui-from-a-vm.md): Learn how to set up hair-pinning to access the VergeOS UI from a virtual machine within your environment using a translate network rule.
- [Adjusting BGP Timers](https://docs.verge.io/knowledge-base/networking/adjusting-bgp-timers.md): Learn how to configure BGP hold down timers for keepalive interval and hold time in VergeOS using FRR routing commands.
- [Best Practices - Running a pfSense Virtual Firewall](https://docs.verge.io/knowledge-base/networking/running-a-pfsense-virtual-firewall.md): Best practices for deploying and managing pfSense as a virtual firewall within VergeOS.
- [Change External Network to VLAN Bonded](https://docs.verge.io/knowledge-base/networking/change-external-vlan-to-bonded.md): Instructions to change an existing external network to a VLAN bonded configuration across physical networks for active-backup redundancy.
- [Configure Authoritative DNS in VergeOS](https://docs.verge.io/knowledge-base/networking/configure-authoritative-dns-vergeos.md): Complete guide to setting up authoritative DNS services in VergeOS using BIND, including DNS views, zones, records, and firewall configuration.
- [Configuring VMware Service VM NIC IPv4 Settings](https://docs.verge.io/knowledge-base/networking/vmware-service-vm-nic-ipv4-configuration.md): How to configure static IPv4 settings for VMware service VM NICs in VergeOS, including IP address, DNS, and routing.
- [Connection Tracking State in Firewall Rules](https://docs.verge.io/knowledge-base/networking/firewall-connection-tracking-state.md): How to use the Connection Tracking State field on VergeOS firewall rules to block new inbound connections without dropping return traffic for outbound connections.
- [Egress Firewall Requirements for VergeOS](https://docs.verge.io/knowledge-base/networking/egress-firewall-requirements.md): Outbound firewall allow-list for VergeOS systems — ports and destinations required to reach the Update Server and Marketplace.
- [Enabling System SSH Access](https://docs.verge.io/knowledge-base/networking/enabling-system-ssh.md): Instructions for temporarily enabling SSH access to a VergeOS system by configuring core and external network rules with source-controlled access restrictions.
- [How to Achieve Network Micro-Segmentation on VergeOS](https://docs.verge.io/knowledge-base/networking/how-to-achieve-network-micro-segmentation-on-vergeos.md): A comprehensive guide on implementing network micro-segmentation using VergeOS features including internal networks, firewall rules, VPNs, tenant isolation, and network aliases.
- [How to Create an External Network](https://docs.verge.io/knowledge-base/networking/create-external-network.md): Step-by-step guide to creating an external network in VergeOS with VLAN, static IP, and default routing rule configuration.
- [How to Use External IPs in Tenants](https://docs.verge.io/knowledge-base/networking/how-to-use-external-ips-in-tenants.md): Examples of route-based and translation-based methods for using public/external IP addresses inside VergeOS tenants, including network blocks, virtual switch ports, and address translation.
- [IPsec Configuration Example - Tenant/NAT](https://docs.verge.io/knowledge-base/networking/ipsec-example-tenant-nat-ui-ip.md): IPsec tunnel configuration example within a VergeOS tenant using the dedicated UI IP address with NAT rules for directing tunnel traffic.
- [IPsec Example - Dedicated Public IP](https://docs.verge.io/knowledge-base/networking/ipsec-example-dedicated-ip.md): IPsec tunnel configuration example using a dedicated public IP address with a bridged internal network for workload connectivity.
- [Network Blocks](https://docs.verge.io/knowledge-base/networking/network-blocks.md): How to create and assign network blocks in VergeOS for delivering IP address ranges to tenants or networks using Layer 3 connectivity.
- [Routing Between Internal VergeOS Networks](https://docs.verge.io/knowledge-base/networking/routing-between-internal-vergeio-networks.md): Step-by-step instructions for establishing routing between two internal networks in VergeOS by creating route and accept rules on each network.
- [Routing Layer 2 Networks with VergeOS](https://docs.verge.io/knowledge-base/networking/routing-l2-networks.md): Guide to routing Layer 3 IP traffic for Layer 2 physical networks in VergeOS, enabling communication between physical devices and internal VM workloads on different subnets.
- [Understanding Traffic Flow](https://docs.verge.io/knowledge-base/networking/understanding-traffic-flow.md): Visual diagrams illustrating VergeOS network traffic flow, including external VLAN wiring, internal network connectivity, and core network configuration.
- [VM Network Connectivity Issues](https://docs.verge.io/knowledge-base/networking/vm-network-connectivity-issues.md): Troubleshooting guide for common VM network connectivity problems including missing NIC configuration, incorrect network assignment, improper IP settings, and missing Virtio drivers.
- [Wireguard - Adding Nameserver entries to Client Configs](https://docs.verge.io/knowledge-base/networking/wireguard--adding-nameserver-entries-to-client-configs.md): How to add PostUp and PostDown scripts to WireGuard client configurations for DNS nameserver resolution on Windows and Linux.
- [Wireguard - Setup Remote Access VPN](https://docs.verge.io/knowledge-base/networking/wireguard--setup-remote-access-vpn.md): Complete guide to setting up a WireGuard remote access VPN in VergeOS, including interface creation, PAT rules, SNAT configuration, and client peer setup.
- [Storage & vSAN](https://docs.verge.io/knowledge-base/storage-vsan.md): Articles covering vSAN architecture, storage tiers, scaling, encryption, and NAS.
- [Adding Tier 0 to an Existing System](https://docs.verge.io/knowledge-base/storage-vsan/adding-tier-zero.md): Step-by-step guide for adding Tier 0 metadata storage to an existing VergeOS system that was not configured with Tier 0 during initial installation.
- [NAS Volume Browser API Reference](https://docs.verge.io/knowledge-base/storage-vsan/nas-volume-browser-api.md): How to use the VergeOS volume\_browser API to browse NAS volume contents programmatically, including the asynchronous job workflow, polling for results, and troubleshooting common issues.
- [Preferred Tier Usage](https://docs.verge.io/knowledge-base/storage-vsan/preferred-tier-usage.md): Explains how VergeOS determines which vSAN storage tier to use when a VM disk's preferred tier is set to a non-existent tier, including fallback behavior.
- [Scaling Down a vSAN (Removing Drives)](https://docs.verge.io/knowledge-base/storage-vsan/scaling-down-a-vsan.md): How to request a vSAN scale-down (drive removal) through VergeOS Support, including what to prepare before opening a ticket.
- [Scaling Up a vSAN](https://docs.verge.io/knowledge-base/storage-vsan/scaling-up-a-vsan.md): Step-by-step procedure for scaling up a VergeOS vSAN by adding new drives or Fibre Channel LUNs to existing nodes, including capacity requirements and verification steps.
- [Troubleshooting NAS Shares](https://docs.verge.io/knowledge-base/storage-vsan/troubleshooting-nas-shares.md): Troubleshooting guide for common NAS CIFS share issues including connectivity errors, permission denied errors, slow performance, and MacOS compatibility.
- [Understanding and Explaining Unexpected vSAN Growth](https://docs.verge.io/knowledge-base/storage-vsan/understanding-and-explaining-unexpected-vsan-growth.md): Troubleshooting guide for diagnosing unexpected vSAN storage growth, including how to review tier history and identify common causes like snapshots, backups, and tenant storage.
- [Understanding vSAN Tier Status/Journal Walks](https://docs.verge.io/knowledge-base/storage-vsan/understanding-journal-walks-and-vsan-tier-status.md): Understanding vSAN Tier Dashboard status metrics including Journal Walk types, progress tracking, redundancy checks, and repair counts for storage integrity monitoring.
- [vSAN Encryption Information](https://docs.verge.io/knowledge-base/storage-vsan/vsan-encryption-information.md): Overview of vSAN encryption in VergeOS, including AES256 encryption verification, USB key boot configuration, password-based startup, and site sync encryption defaults.
- [Tenants](https://docs.verge.io/knowledge-base/tenants.md): Guides for creating and operating tenants in multi-tenant VergeOS environments.
- [Allow Root to Tenant Site Connection](https://docs.verge.io/knowledge-base/tenants/allow-root-to-tenant-site-connection.md): How to configure a network rule on the root system's external network to allow site-to-site connectivity between the root system and a tenant.
- [Configuring Proxy](https://docs.verge.io/knowledge-base/tenants/configuring-proxy.md): How to configure a proxy connection to serve multiple tenant environments using a single IP address mapped to FQDN hostnames.
- [Device Passthrough Advanced Configuration](https://docs.verge.io/knowledge-base/tenants/dev-passthrough-advanced.md): Advanced configuration information for device passthrough including manual creation and editing of resource rules for PCI, USB, SR-IOV, and NVIDIA vGPU devices.
- [Provide Layer 2 Access to a Tenant - LEGACY](https://docs.verge.io/knowledge-base/tenants/provide-layer2-to-tenant.md): Instructions for using Virtual Switch Ports (formerly Virtual Wires) to provide VLAN-based Layer 2 network access to a tenant, including 1:1 and trunk mode configurations.
- [Reset a Tenant's Administrative Password](https://docs.verge.io/knowledge-base/tenants/reset-a-tenants-administrative-password.md): Step-by-step instructions for resetting the administrative password for a tenant environment in VergeOS.
- [Sharing a VM into a Tenant](https://docs.verge.io/knowledge-base/tenants/sharing-a-vm-into-a-tenant.md): How to share a virtual machine image from a parent environment into a tenant using snapshots and shared objects in VergeOS.
- [Sharing Files to Tenants](https://docs.verge.io/knowledge-base/tenants/sharing-files-to-tenants.md): How to share files such as media images from a Service Provider to Tenants using the VergeOS branch command feature.
- [Tenant Crash Cart Guide](https://docs.verge.io/knowledge-base/tenants/tenant-crash-cart-guide.md): How to deploy and use the Tenant Crash Cart utility VM to gain emergency access to a tenant's VergeOS UI when normal network access is unavailable.
- [Tenant External IP Quick Start Guide](https://docs.verge.io/knowledge-base/tenants/configuring-tenant-external-ips.md): Step-by-step guide to configuring external and public IP addresses for tenant VMs, covering single IP, IP block, and NAT-only scenarios.
- [Tenant Node Planning Guide](https://docs.verge.io/knowledge-base/tenants/tenant-node-planning-guide.md): Guide for determining the optimal number of tenant nodes, compute resource allocation, and physical placement strategies for VergeOS tenant deployments.
- [Viewing Tenant Consumption Statistics](https://docs.verge.io/knowledge-base/tenants/viewing-tenant-consumption-statistics.md): How to view tenant RAM and storage consumption statistics using the tenant history dashboard, including 95th percentile calculations.
- [VM and Tenant Hot-Plug Capabilities](https://docs.verge.io/knowledge-base/tenants/vm-hotplug-capabilities.md): Understanding which resources can be modified on running VMs and tenants without requiring a restart, including drives, NICs, RAM, and CPU cores.
- [Backup & DR](https://docs.verge.io/knowledge-base/backup-dr.md): Snapshots, sync jobs, restores, and disaster recovery guidance.
- [Configuring a Volume for Exporting VMs](https://docs.verge.io/knowledge-base/backup-dr/configuring-a-vm-export-volume.md): How to configure the VergeOS NAS VM Export Volume for backup purposes, including CIFS/NFS sharing, scheduled exports, and synchronization to external storage.
- [Configuring Network Access for Veeam Backup & Replication Workers](https://docs.verge.io/knowledge-base/backup-dr/veeam-worker-networking.md): Place the VBR server and workers on the provider's flat External network and extend it into tenants at Layer 2, giving every Veeam component direct communication with no manual firewall rules.
- [Exporting a Virtual Machine](https://docs.verge.io/knowledge-base/backup-dr/exporting-a-virtual-machine.md): Learn how to export a virtual machine from VergeOS and download its disk as a .raw file for use in other hypervisor environments.
- [Recovering a Single VM from a Remote System Snapshot](https://docs.verge.io/knowledge-base/backup-dr/recovering-a-single-vm-from-a-remote-cloud-snapshot.md): Step-by-step instructions for recovering a single virtual machine from a remote system snapshot using VergeOS site sync and sync-back functionality.
- [Restoring a VergeOS System from the Boot Menu](https://docs.verge.io/knowledge-base/backup-dr/restore-system-from-boot-menu.md): How to restore a complete VergeOS system from the boot menu when the UI is inaccessible.
- [RHEL 9 Family VMs Failing to Boot After Clone or Snapshot Restore](https://docs.verge.io/knowledge-base/backup-dr/rhel9-boot-failure-clone-snapshot-restore.md): How to fix boot failures in RHEL 9 family VMs (AlmaLinux, Rocky, CentOS Stream) after cloning or restoring a snapshot in VergeOS, caused by the LVM system.devices file pinning original disk serials.
- [Setting Up Storware on VergeOS](https://docs.verge.io/knowledge-base/backup-dr/setup-storware-vergeos.md): Guide to setting up Storware for virtual machine protection on VergeOS, including NAS service configuration and NFS setup.
- [Snapshot Synchronization Errors Explained](https://docs.verge.io/knowledge-base/backup-dr/snapshot-synchronization-errors-explained.md): Reference guide explaining common VergeOS site sync error messages, their causes, and recommended resolutions for snapshot synchronization issues.
- [VMware Import Scans Succeed but File Downloads Fail](https://docs.verge.io/knowledge-base/backup-dr/vmware-import-downloads-fail-server-refused.md): A VMware Service connects to vCenter and scans VMs, but backup or import jobs fail with "server refused connection" when pulling files. Usually DNS or port 902 reachability to the ESXi hosts.
- [VMware-Backup-DR-Guide](https://docs.verge.io/knowledge-base/backup-dr/vmwarebackupdrguide.md): Comprehensive guide for setting up VMware backup and disaster recovery in VergeOS, including creating VMware services, configuring backup schedules, and performing restores from vSphere environments.
- [Automation & API](https://docs.verge.io/knowledge-base/automation-api.md): Working with the VergeOS API, automation tasks, Terraform, and integration tooling.
- [API Guide](https://docs.verge.io/knowledge-base/automation-api/verge-api-guide.md): A comprehensive guide to using the VergeOS API, covering authentication, HTTP methods, endpoint conventions, filtering, sorting, error handling, and example requests for VMs and virtual networks.
- [API Helper Script](https://docs.verge.io/knowledge-base/automation-api/api-helper-script.md): A guide to using the VergeOS yb-api helper script for simplified API interactions, including listing, creating, cloning, and managing virtual machines from the command line.
- [API Tables Description](https://docs.verge.io/knowledge-base/automation-api/api-tables-description.md): A reference of all VergeOS API tables with brief descriptions, covering resources such as billing, catalogs, clusters, certificates, machines, drives, NICs, snapshots, and more.
- [Automated Task Example - Power on/off VMs Automatically as Needed](https://docs.verge.io/knowledge-base/automation-api/automated-task-example-1.md): Configuration example of automated tasks that conserve resources by powering VMs on when a designated user logs in, and off on logout or at a scheduled time such as end of business hours.
- [Automated Task Example - Send Slack Channel and Email Alerts Upon a Sync Error](https://docs.verge.io/knowledge-base/automation-api/automated-task-example-webhook.md): Automation example showing specific configuration to send an email alert and a Slack channel notification if a sync error is encountered.
- [Force Power Off a VM Using the API](https://docs.verge.io/knowledge-base/automation-api/force-power-off-vm-using-api.md): Step-by-step instructions for force powering off a non-responsive VM using the VergeOS API and Swagger interface, including how to locate the VM ID, verify status, and issue the power-off command.
- [Settings that Influence VM Node Selection](https://docs.verge.io/knowledge-base/automation-api/determine-node-where-vm-runs.md): Explains VM options that control which node a VM runs on, including HA group affinity and anti-affinity, preferred node, preferred cluster, and failover cluster settings.
- [Terraform VergeIO Provider](https://docs.verge.io/knowledge-base/automation-api/terraform-vergeio-provider.md): Learn how to use the VergeIO Terraform Provider to manage VergeOS resources programmatically.
- [VM Advanced Operations API](https://docs.verge.io/knowledge-base/automation-api/vm-advanced-operations.md): Complete guide to advanced VM operations in VergeOS, including cloning, snapshots, deletion, and troubleshooting
- [VM Configuration API](https://docs.verge.io/knowledge-base/automation-api/vm-configuration.md): Complete guide to modifying VM configurations in VergeOS, including CPU/RAM updates, notes, drive management, and network interface management
- [VM Creation API](https://docs.verge.io/knowledge-base/automation-api/vm-creation-api.md): Complete guide to creating virtual machines in VergeOS, including basic creation, recipe-based configurations, drives, devices, and network interfaces
- [VM Lifecycle Management API Overview](https://docs.verge.io/knowledge-base/automation-api/vm-lifecycle-management.md): Complete REST API guide for virtual machine lifecycle management in VergeOS - create, manage, configure, and delete VMs programmatically
- [VM Power Management API](https://docs.verge.io/knowledge-base/automation-api/vm-power-management.md): Complete guide to managing VM power states in VergeOS, including starting, stopping, rebooting, and monitoring power status
- [System Administration](https://docs.verge.io/knowledge-base/system-administration.md): Platform administration topics — updates, security, authentication, branding, and performance.
- [Cluster Recovery After Full Power Outage](https://docs.verge.io/knowledge-base/system-administration/cluster-recovery-after-power-outage.md): Recovery procedure and best practices for VergeOS clusters after an unplanned full power loss - including power-on order, vSAN integrity verification, and prevention guidance.
- [Configuring VergeOS as an OIDC Client](https://docs.verge.io/knowledge-base/system-administration/configuring-vergeos-as-oidc-client.md): Step-by-step guide on setting up a VergeOS system or tenant to use OIDC authentication with another VergeOS identity provider.
- [CPU Overprovisioning and Resource Planning](https://docs.verge.io/knowledge-base/system-administration/cpu-overprovisioning-guide.md): Understanding CPU allocation, overcommit ratios, and performance implications in VergeOS, including recommended ratios by workload type and capacity planning calculations.
- [Customizing the User Interface](https://docs.verge.io/knowledge-base/system-administration/customizing-the-user-interface.md): Guide on how to customize branding, logos, colors, and themes in the VergeOS UI, including light and dark mode support and multi-tenant branding.
- [Database Best Practices](https://docs.verge.io/knowledge-base/system-administration/database-best-practices.md): Best practices for optimizing database performance on Microsoft Windows in VergeOS, covering backup location, defrag, Defender exclusions, core allocation, and VirtIO drivers.
- [Max RAM per machine](https://docs.verge.io/knowledge-base/system-administration/max-ram-per-machine.md): How to adjust the Max RAM per machine cluster setting in VergeOS to allow virtual machines that require more than the default 64GB of RAM.
- [Proper Power Sequence](https://docs.verge.io/knowledge-base/system-administration/proper-power-sequence-for-vergeos.md): Correct shutdown and power-on sequence for a VergeOS environment, including multi-cluster considerations and the order for controller nodes.
- [Proper VergeOS System Shutdown Procedure](https://docs.verge.io/knowledge-base/system-administration/proper-vergeos-system-shutdown-procedure.md): Complete step-by-step guide for safely shutting down VergeOS systems and clusters, including tenant workload shutdown, multi-cluster sequencing, and proper power-on procedures.
- [Removing a Node from a VergeOS Cluster](https://docs.verge.io/knowledge-base/system-administration/removing-a-node-from-cluster.md): How to safely remove a physical node from a VergeOS system, including maintenance mode, drive removal, and vSAN repair procedures.
- [Requesting an Airgap License](https://docs.verge.io/knowledge-base/system-administration/requesting-an-airgap-license.md): How to request an airgap license for VergeOS systems with no outbound Internet access, and how to upload the license file you receive from Verge.io.
- [Setting Up VergeOS as an Identity Provider with OIDC](https://docs.verge.io/knowledge-base/system-administration/setting-up-vergeos-as-identity-provider-oidc.md): Guide on configuring VergeOS as an OpenID Connect (OIDC) identity provider for centralized authentication across multiple systems and tenants.
- [Updating a VergeOS System with Airgap License](https://docs.verge.io/knowledge-base/system-administration/updating-vergeos-system-with-airgap-license.md): Step-by-step guide on how to perform a software update on an air-gapped VergeOS system using an ISO file, including downloading, uploading, configuring update settings, and applying the update.
- [Updating the VergeOS System](https://docs.verge.io/knowledge-base/system-administration/updating-vergeos-system.md): Comprehensive guide on performing on-demand and scheduled system updates in VergeOS, including zero-downtime update procedures and automatic tenant updates.
- [Utilizing an iGPU for AI Acceleration](https://docs.verge.io/knowledge-base/system-administration/using-igpu-ai-acceleration.md): Instructions for configuring an iGPU (integrated GPU) for AI acceleration in VergeOS, including resource group setup and model assignment.
- [Vulnerability Scanning Best Practices](https://docs.verge.io/knowledge-base/system-administration/vulnerability-scanning-best-practices.md): Best practices for running vulnerability scans against VergeOS environments, including recommended scan targets, architecture considerations, and compliance guidance.
- [Troubleshooting](https://docs.verge.io/knowledge-base/troubleshooting.md): Diagnostic procedures and fixes for common VergeOS issues.
- [Configuring Remote Log Forwarding (Syslog)](https://docs.verge.io/knowledge-base/troubleshooting/configuring-remote-log-forwarding.md): How to configure VergeOS to forward system logs to a remote syslog server for centralized log management, archival, and compliance.
- [Generating System Diagnostics](https://docs.verge.io/knowledge-base/troubleshooting/generating-system-diagnostics.md): How to generate and submit a system diagnostics report in VergeOS, which packages detailed logs from all nodes into a compressed file for support analysis.
- [System Logs](https://docs.verge.io/knowledge-base/troubleshooting/system-logs.md): Guide to reviewing system logs, sync logs, and the System Event Log (SEL) in VergeOS, including log retention, third-party log forwarding, and best practices.
- [VergeOS Update Instructions](https://docs.verge.io/knowledge-base/troubleshooting/vergeos-update-instructions.md): Step-by-step instructions for updating a VergeOS environment with zero downtime, including troubleshooting common update issues.

## Release notes

- [Release notes](https://docs.verge.io/release-notes/readme.md): Overview of all VergeOS release versions, version numbering conventions, update process guidance, and links to detailed release notes for each version.
- [26.1](https://docs.verge.io/release-notes/2026/26-1-release-notes.md): Release notes for VergeOS 26.1: partial snapshots with tag-based filtering, oVirt API compatibility for third-party backups, N+2 (RF3) vSAN redundancy, and disk repair and sync performance gains.
- [26.0](https://docs.verge.io/release-notes/2026/26-0-release-notes.md): Release notes for VergeOS 26.0: AI services integration, new theme engine, immutable snapshots, API key authentication, task automation engine, and storage, networking, and security enhancements.
- [4.13](https://docs.verge.io/release-notes/2025-or-earlier/4-13-release-notes.md): Release notes for the VergeOS 4.13 series: hardware passthrough (USB/PCI/SRIOV), experimental vGPU live migration, enhanced bonding with split brain detection, multipath vSAN, and HA improvements.
- [4.12](https://docs.verge.io/release-notes/2025-or-earlier/4-12-release-notes.md): Release notes for the VergeOS 4.12 series: dark mode UI, TOTP two-factor authentication, nested virtualization with live migration, offline licensing, faster network migrations, and vSAN meta cache.
- [4.11](https://docs.verge.io/release-notes/2025-or-earlier/4-11-release-notes.md): Release notes for the VergeOS 4.11 series: Site Manager for global administration, Recipe Marketplace, OIDC authentication, VM Export, TPM support, and network and vSAN performance improvements.
- [4.10](https://docs.verge.io/release-notes/2025-or-earlier/4-10-release-notes.md): Release notes for the VergeOS 4.10 series: NVIDIA vGPU support, CPU C-States management, enhanced vSAN performance, CPU pinning, and improved GPU passthrough and live migration.
- [4.9](https://docs.verge.io/release-notes/2025-or-earlier/4-9-release-notes.md): Release notes for the 4.9 series of VergeOS, featuring a complete UI revamp, email-based two-factor authentication, GPU pass-through, port mirroring, and enhanced snapshot and NAS management.


---

# 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, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://docs.verge.io/readme.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.