pyvergeos

User Guide

  • Quick Start
    • Installation
    • Basic Usage
      • Connect to VergeOS
      • Using Context Manager (Recommended)
    • Working with Virtual Machines
      • List VMs
      • Get a Specific VM
      • Create a VM
      • Power Operations
      • Snapshots
    • Working with Networks
    • Working with Tenants
    • Next Steps
  • Authentication
    • Username and Password
    • API Token
    • Environment Variables
    • SSL Certificate Verification
    • Connection Options
    • Checking Connection Status
    • Disconnecting
  • Filtering and Pagination
    • Keyword Arguments
    • OData Filter Strings
    • Filter Builder
    • Field Selection
    • Pagination
    • Iterating All Results
    • Sorting
    • Combining Options
  • Error Handling
    • Exception Hierarchy
    • Basic Error Handling
    • Connection Errors
    • API Errors
    • Task Errors
    • Catching All Errors
    • Retry Configuration
    • Exception Attributes
  • Tutorials
    • VM Import and Export
      • Importing VMs from Files
      • Exporting VMs to NAS
    • Recipe-Based Provisioning
      • Deploying a VM from a Recipe
      • Managing Recipe Instances
    • Task Scheduling and Automation
      • Creating Scheduled Tasks
      • Working with Task Triggers
    • Routing Protocol Configuration
      • BGP Configuration
      • OSPF Configuration
    • GPU Passthrough
      • Setting Up GPU Passthrough
      • Monitoring GPU Usage
    • Multi-Tenant Monitoring
      • Tenant Dashboard
      • Tenant-Specific Monitoring
      • Billing Reports
    • Site Sync and DR
      • Setting Up Site Sync

API Reference

  • Client
    • VergeClient
      • VergeClient
        • VergeClient.__init__()
        • VergeClient.from_env()
        • VergeClient.connect()
        • VergeClient.disconnect()
        • VergeClient.is_connected
        • VergeClient.version
        • VergeClient.os_version
        • VergeClient.cloud_name
        • VergeClient.alarms
        • VergeClient.auth_sources
        • VergeClient.auth_source_states
        • VergeClient.logs
        • VergeClient.vms
        • VergeClient.networks
        • VergeClient.tenants
        • VergeClient.tenant_dashboard
        • VergeClient.billing
        • VergeClient.network_dashboard
        • VergeClient.users
        • VergeClient.api_keys
        • VergeClient.groups
        • VergeClient.permissions
        • VergeClient.clusters
        • VergeClient.nodes
        • VergeClient.tasks
        • VergeClient.files
        • VergeClient.storage_tiers
        • VergeClient.nas_services
        • VergeClient.nas_volumes
        • VergeClient.nas_volume_snapshots
        • VergeClient.cifs_shares
        • VergeClient.nfs_shares
        • VergeClient.nas_users
        • VergeClient.volume_syncs
        • VergeClient.shared_objects
        • VergeClient.system
        • VergeClient.sites
        • VergeClient.site_syncs
        • VergeClient.site_syncs_incoming
        • VergeClient.site_sync_schedules
        • VergeClient.snapshot_profiles
        • VergeClient.cloud_snapshots
        • VergeClient.resource_groups
        • VergeClient.webhooks
        • VergeClient.cloudinit_files
        • VergeClient.certificates
        • VergeClient.tags
        • VergeClient.tag_categories
        • VergeClient.vm_imports
        • VergeClient.vm_import_logs
        • VergeClient.volume_vm_exports
        • VergeClient.volume_vm_export_stats
        • VergeClient.vm_recipes
        • VergeClient.vm_recipe_instances
        • VergeClient.vm_recipe_logs
        • VergeClient.tenant_recipes
        • VergeClient.tenant_recipe_instances
        • VergeClient.tenant_recipe_logs
        • VergeClient.recipe_questions
        • VergeClient.recipe_sections
        • VergeClient.task_schedules
        • VergeClient.task_schedule_triggers
        • VergeClient.task_events
        • VergeClient.task_scripts
        • VergeClient.catalog_repositories
        • VergeClient.catalogs
        • VergeClient.catalog_logs
        • VergeClient.catalog_repository_logs
        • VergeClient.catalog_repository_status
        • VergeClient.vgpu_profiles
        • VergeClient.oidc_applications
        • VergeClient.oidc_application_users
        • VergeClient.oidc_application_groups
        • VergeClient.oidc_application_logs
        • VergeClient.update_settings
        • VergeClient.update_sources
        • VergeClient.update_branches
        • VergeClient.update_packages
        • VergeClient.update_source_packages
        • VergeClient.update_source_status
        • VergeClient.update_logs
        • VergeClient.update_dashboard
    • Connection
  • Resources
    • Virtual Machines
      • Core VM Management
        • VM
        • VMManager
      • VM Drives
        • Drive
        • DriveManager
      • VM NICs
        • NIC
        • NICManager
      • VM Snapshots
        • VMSnapshot
        • VMSnapshotManager
      • VM Import/Export
        • VmImport
        • VmImportLog
        • VmImportManager
        • VmImportLogManager
        • VolumeVmExport
        • VolumeVmExportStat
        • VolumeVmExportManager
        • VolumeVmExportStatManager
      • Machine Stats & Monitoring
        • MachineStats
        • MachineStatsHistory
        • MachineStatsManager
        • MachineStatus
        • MachineStatusManager
        • MachineLog
        • MachineLogManager
    • Networks
      • Core Network Management
        • Network
        • NetworkManager
      • Firewall Rules
        • NetworkRule
        • NetworkRuleManager
      • DNS
        • DNSRecord
        • DNSRecordManager
        • DNSZone
        • DNSZoneManager
      • IP Aliases
        • NetworkAlias
        • NetworkAliasManager
      • DHCP Hosts
        • NetworkHost
        • NetworkHostManager
      • Network Statistics
        • NetworkMonitorStats
        • NetworkMonitorStatsHistory
        • NetworkMonitorStatsManager
        • NetworkDashboard
        • NetworkDashboardManager
        • IPSecActiveConnection
        • IPSecActiveConnectionManager
        • WireGuardPeerStatus
        • WireGuardPeerStatusManager
      • Routing Protocols
        • BGPRouterCommand
        • BGPRouterCommandManager
        • BGPRouter
        • BGPRouterManager
        • BGPInterfaceCommand
        • BGPInterfaceCommandManager
        • BGPInterface
        • BGPInterfaceManager
        • BGPRouteMapCommand
        • BGPRouteMapCommandManager
        • BGPRouteMap
        • BGPRouteMapManager
        • BGPIPCommand
        • BGPIPCommandManager
        • OSPFCommand
        • OSPFCommandManager
        • EIGRPRouterCommand
        • EIGRPRouterCommandManager
        • EIGRPRouter
        • EIGRPRouterManager
        • NetworkRoutingManager
      • IPSec VPN
        • IPSecConnection
        • IPSecPolicy
        • IPSecConnectionManager
        • IPSecPolicyManager
      • WireGuard VPN
        • WireGuardInterface
        • WireGuardPeer
        • WireGuardManager
        • WireGuardPeerManager
      • Tenant Proxy
        • VnetProxyTenant
        • VnetProxyTenantManager
        • VnetProxy
        • VnetProxyManager
    • Tenants
      • Tenant Management
        • Tenant
        • TenantManager
      • Tenant Stats & Monitoring
        • TenantStats
        • TenantStatsHistory
        • TenantStatsManager
        • TenantLog
        • TenantLogManager
        • TenantDashboard
        • TenantDashboardManager
      • Tenant Storage
        • TenantStorage
        • TenantStorageManager
      • Tenant Network Blocks
        • TenantNetworkBlock
        • TenantNetworkBlockManager
      • Tenant External IPs
        • TenantExternalIP
        • TenantExternalIPManager
      • Tenant Snapshots
        • TenantSnapshot
        • TenantSnapshotManager
      • Tenant Layer 2 Networks
        • TenantLayer2Network
        • TenantLayer2Manager
      • Tenant Nodes
        • TenantNode
        • TenantNodeManager
    • Storage
      • NAS Services
        • NASService
        • CIFSSettings
        • NFSSettings
        • NASServiceManager
      • NAS Volumes
        • NASVolume
        • NASVolumeSnapshot
        • NASVolumeManager
        • NASVolumeSnapshotManager
      • NAS Volume Browser
        • NASVolumeFile
        • NASVolumeFileManager
      • NAS Volume Syncs
        • NASVolumeSync
        • NASVolumeSyncManager
      • CIFS Shares
        • NASCIFSShare
        • NASCIFSShareManager
      • NFS Shares
        • NASNFSShare
        • NASNFSShareManager
      • NAS Users
        • NASUser
        • NASUserManager
      • Storage Tiers
        • StorageTier
        • StorageTierManager
    • Recipes & Catalogs
      • VM Recipes
        • VmRecipe
        • VmRecipeInstance
        • VmRecipeLog
        • VmRecipeManager
        • VmRecipeInstanceManager
        • VmRecipeLogManager
      • Tenant Recipes
        • TenantRecipe
        • TenantRecipeInstance
        • TenantRecipeLog
        • TenantRecipeManager
        • TenantRecipeInstanceManager
        • TenantRecipeLogManager
      • Recipe Components
        • RecipeQuestion
        • RecipeSection
        • RecipeQuestionManager
        • RecipeSectionManager
      • Catalogs
        • CatalogRepositoryStatus
        • CatalogRepositoryStatusManager
        • CatalogRepositoryLog
        • CatalogRepositoryLogManager
        • CatalogLog
        • CatalogLogManager
        • Catalog
        • CatalogManager
        • CatalogRepository
        • CatalogRepositoryManager
    • Task Scheduling
      • Tasks
        • Task
        • TaskManager
      • Task Schedules
        • TaskSchedule
        • TaskScheduleManager
      • Task Schedule Triggers
        • TaskScheduleTrigger
        • TaskScheduleTriggerManager
      • Task Events
        • TaskEvent
        • TaskEventManager
      • Task Scripts
        • TaskScript
        • TaskScriptManager
    • Users and Groups
      • Users
        • User
        • UserManager
      • Groups
        • GroupMember
        • GroupMemberManager
        • Group
        • GroupManager
      • API Keys
        • APIKeyCreated
        • APIKey
        • APIKeyManager
      • Permissions
        • Permission
        • PermissionManager
    • Authentication & Security
      • Authentication Sources
        • AuthSourceState
        • AuthSourceStateManager
        • AuthSource
        • AuthSourceManager
      • OIDC Applications
        • OidcApplicationUser
        • OidcApplicationUserManager
        • OidcApplicationGroup
        • OidcApplicationGroupManager
        • OidcApplicationLog
        • OidcApplicationLogManager
        • OidcApplication
        • OidcApplicationManager
      • Certificates
        • Certificate
        • CertificateManager
    • System
      • System Management
        • SystemSetting
        • SettingsManager
        • License
        • LicenseManager
        • SystemStatistics
        • InventoryVM
        • InventoryNetwork
        • InventoryStorageTier
        • InventoryNode
        • InventoryCluster
        • InventoryTenant
        • SystemInventory
        • SystemDiagnostic
        • SystemDiagnosticManager
        • RootCertificate
        • RootCertificateManager
        • SystemManager
      • Clusters
        • Cluster
        • VSANStatus
        • ClusterManager
      • Cluster Tiers
        • ClusterTierStatsHistoryLong
        • ClusterTierStatsHistoryShort
        • ClusterTierStats
        • ClusterTierStatus
        • ClusterTier
        • ClusterTierManager
      • Nodes
        • Node
        • NodeDriver
        • NodePCIDevice
        • NodeUSBDevice
        • NodeSriovNicDevice
        • NodeDriverManager
        • NodePCIDeviceManager
        • NodeUSBDeviceManager
        • NodeSriovNicDeviceManager
        • NodeManager
      • GPU/vGPU Management
        • NvidiaVgpuProfile
        • NvidiaVgpuProfileManager
        • NodeGpu
        • NodeGpuManager
        • NodeGpuStats
        • NodeGpuStatsHistory
        • NodeGpuStatsManager
        • NodeGpuInstance
        • NodeGpuInstanceManager
        • NodeVgpuDevice
        • NodeVgpuDeviceManager
        • NodeHostGpuDevice
        • NodeHostGpuDeviceManager
        • NodeVgpuProfile
        • NodeVgpuProfileManager
      • Devices
        • Device
        • DeviceManager
      • Logs
        • Log
        • LogManager
      • Alarms
        • Alarm
        • AlarmHistory
        • AlarmManager
      • Update Management
        • UpdateLog
        • UpdateLogManager
        • UpdateBranch
        • UpdateBranchManager
        • UpdateSourceStatus
        • UpdateSourceStatusManager
        • UpdateSourcePackage
        • UpdateSourcePackageManager
        • UpdateSource
        • UpdateSourceManager
        • UpdatePackage
        • UpdatePackageManager
        • UpdateSettings
        • UpdateSettingsManager
        • UpdateDashboard
        • UpdateDashboardManager
      • Billing
        • BillingRecord
        • BillingManager
    • Backup & DR
      • Cloud Snapshots
        • CloudSnapshotVM
        • CloudSnapshotTenant
        • CloudSnapshotVMManager
        • CloudSnapshotTenantManager
        • CloudSnapshot
        • CloudSnapshotManager
      • Snapshot Profiles
        • SnapshotProfilePeriod
        • SnapshotProfile
        • SnapshotProfilePeriodManager
        • SnapshotProfileManager
      • Sites
        • Site
        • SiteManager
      • Site Syncs
        • SiteSyncOutgoing
        • SiteSyncIncoming
        • SiteSyncSchedule
        • SiteSyncOutgoingManager
        • SiteSyncIncomingManager
        • SiteSyncScheduleManager
        • SiteSyncStats
        • SiteSyncStatsHistory
        • SiteSyncStatsManager
        • SiteSyncQueueItem
        • SiteSyncQueueManager
        • SiteSyncRemoteSnap
        • SiteSyncRemoteSnapManager
        • SiteSyncIncomingVerified
        • SiteSyncIncomingVerifiedManager
        • SiteSyncLog
        • SiteSyncOutgoingLogManager
        • SiteSyncIncomingLogManager
    • Organization
      • Tags
        • TagMember
        • TagMemberManager
        • Tag
        • TagManager
        • TagCategory
        • TagCategoryManager
      • Resource Groups
        • ResourceGroup
        • ResourceGroupManager
        • ResourceRule
        • ResourceRuleManager
      • Shared Objects
        • SharedObject
        • SharedObjectManager
      • Cloud-Init Files
        • CloudInitFile
        • CloudInitFileManager
        • VMCloudInitFileManager
      • Files
        • File
        • FileManager
      • Webhooks
        • Webhook
        • WebhookHistory
        • WebhookManager
    • Base Classes
      • ResourceObject
        • ResourceObject.__init__()
        • ResourceObject.key
        • ResourceObject.refresh()
        • ResourceObject.save()
        • ResourceObject.delete()
      • ResourceManager
        • ResourceManager.__init__()
        • ResourceManager.list()
        • ResourceManager.get()
        • ResourceManager.create()
        • ResourceManager.update()
        • ResourceManager.delete()
        • ResourceManager.action()
        • ResourceManager.iter_all()
        • ResourceManager.__iter__()
  • Exceptions
    • Exception Classes
      • VergeError
      • VergeConnectionError
      • NotConnectedError
      • VergeTimeoutError
      • APIError
        • APIError.__init__()
      • AuthenticationError
      • NotFoundError
      • ConflictError
      • ValidationError
      • TaskError
        • TaskError.__init__()
      • TaskTimeoutError
    • Filters
      • FilterOperator
        • FilterOperator.EQ
        • FilterOperator.NE
        • FilterOperator.LT
        • FilterOperator.GT
        • FilterOperator.LE
        • FilterOperator.GE
        • FilterOperator.LIKE
        • FilterOperator.IN
      • Filter
        • Filter.__init__()
        • Filter.eq()
        • Filter.ne()
        • Filter.lt()
        • Filter.gt()
        • Filter.le()
        • Filter.ge()
        • Filter.like()
        • Filter.in_()
        • Filter.and_()
        • Filter.or_()
      • build_filter()

Additional Resources

  • Migration Guide
    • Why Migrate to pyvergeos?
    • Before and After
      • Authentication
      • Listing Resources
      • Getting a Resource
      • Creating Resources
      • Performing Actions
      • Error Handling
      • Filtering
    • Common Migration Patterns
      • Nested Resources
      • Task Waiting
      • Environment Variables
    • Checklist
  • Troubleshooting
    • Connection Issues
      • SSL Certificate Errors
      • Connection Timeout
      • Connection Refused
    • Authentication Errors
      • Invalid Credentials
      • API Token Issues
      • Permission Denied
    • Resource Errors
      • Resource Not Found
      • Conflict Errors
      • Validation Errors
    • Task and Operation Errors
      • Task Timeout
      • Task Failed
    • Performance Issues
      • Slow Responses
      • Memory Usage
    • Retry Behavior
      • Configuring Retries
    • Debugging
      • Enable Debug Logging
      • Inspect Request/Response
    • Getting Help
  • Changelog
    • [1.0.0] - 2026-02-01
      • Added
      • Changed
      • Fixed
    • [0.1.1] - 2026-01-29
      • Added
    • [0.1.0] - 2026-01-15
      • Added
  • Contributing
    • Development Setup
    • Code Style
    • Guidelines
    • Running Tests
    • Pull Request Process
    • Commit Messages
pyvergeos
  • Search

© Copyright 2024-2026, Verge.io.

Built with Sphinx using a theme provided by Read the Docs.