User Guide
API Reference
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
VM
VMManager
Drive
DriveManager
NIC
NICManager
VMSnapshot
VMSnapshotManager
VmImport
VmImportLog
VmImportManager
VmImportLogManager
VolumeVmExport
VolumeVmExportStat
VolumeVmExportManager
VolumeVmExportStatManager
MachineStats
MachineStatsHistory
MachineStatsManager
MachineStatus
MachineStatusManager
MachineLog
MachineLogManager
Network
NetworkManager
NetworkRule
NetworkRuleManager
DNSRecord
DNSRecordManager
DNSZone
DNSZoneManager
NetworkAlias
NetworkAliasManager
NetworkHost
NetworkHostManager
NetworkMonitorStats
NetworkMonitorStatsHistory
NetworkMonitorStatsManager
NetworkDashboard
NetworkDashboardManager
IPSecActiveConnection
IPSecActiveConnectionManager
WireGuardPeerStatus
WireGuardPeerStatusManager
BGPRouterCommand
BGPRouterCommandManager
BGPRouter
BGPRouterManager
BGPInterfaceCommand
BGPInterfaceCommandManager
BGPInterface
BGPInterfaceManager
BGPRouteMapCommand
BGPRouteMapCommandManager
BGPRouteMap
BGPRouteMapManager
BGPIPCommand
BGPIPCommandManager
OSPFCommand
OSPFCommandManager
EIGRPRouterCommand
EIGRPRouterCommandManager
EIGRPRouter
EIGRPRouterManager
NetworkRoutingManager
IPSecConnection
IPSecPolicy
IPSecConnectionManager
IPSecPolicyManager
WireGuardInterface
WireGuardPeer
WireGuardManager
WireGuardPeerManager
VnetProxyTenant
VnetProxyTenantManager
VnetProxy
VnetProxyManager
Tenant
TenantManager
TenantStats
TenantStatsHistory
TenantStatsManager
TenantLog
TenantLogManager
TenantDashboard
TenantDashboardManager
TenantStorage
TenantStorageManager
TenantNetworkBlock
TenantNetworkBlockManager
TenantExternalIP
TenantExternalIPManager
TenantSnapshot
TenantSnapshotManager
TenantLayer2Network
TenantLayer2Manager
TenantNode
TenantNodeManager
NASService
CIFSSettings
NFSSettings
NASServiceManager
NASVolume
NASVolumeSnapshot
NASVolumeManager
NASVolumeSnapshotManager
NASVolumeFile
NASVolumeFileManager
NASVolumeSync
NASVolumeSyncManager
NASCIFSShare
NASCIFSShareManager
NASNFSShare
NASNFSShareManager
NASUser
NASUserManager
StorageTier
StorageTierManager
VmRecipe
VmRecipeInstance
VmRecipeLog
VmRecipeManager
VmRecipeInstanceManager
VmRecipeLogManager
TenantRecipe
TenantRecipeInstance
TenantRecipeLog
TenantRecipeManager
TenantRecipeInstanceManager
TenantRecipeLogManager
RecipeQuestion
RecipeSection
RecipeQuestionManager
RecipeSectionManager
CatalogRepositoryStatus
CatalogRepositoryStatusManager
CatalogRepositoryLog
CatalogRepositoryLogManager
CatalogLog
CatalogLogManager
Catalog
CatalogManager
CatalogRepository
CatalogRepositoryManager
Task
TaskManager
TaskSchedule
TaskScheduleManager
TaskScheduleTrigger
TaskScheduleTriggerManager
TaskEvent
TaskEventManager
TaskScript
TaskScriptManager
User
UserManager
GroupMember
GroupMemberManager
Group
GroupManager
APIKeyCreated
APIKey
APIKeyManager
Permission
PermissionManager
AuthSourceState
AuthSourceStateManager
AuthSource
AuthSourceManager
OidcApplicationUser
OidcApplicationUserManager
OidcApplicationGroup
OidcApplicationGroupManager
OidcApplicationLog
OidcApplicationLogManager
OidcApplication
OidcApplicationManager
Certificate
CertificateManager
SystemSetting
SettingsManager
License
LicenseManager
SystemStatistics
InventoryVM
InventoryNetwork
InventoryStorageTier
InventoryNode
InventoryCluster
InventoryTenant
SystemInventory
SystemDiagnostic
SystemDiagnosticManager
RootCertificate
RootCertificateManager
SystemManager
Cluster
VSANStatus
ClusterManager
ClusterTierStatsHistoryLong
ClusterTierStatsHistoryShort
ClusterTierStats
ClusterTierStatus
ClusterTier
ClusterTierManager
Node
NodeDriver
NodePCIDevice
NodeUSBDevice
NodeSriovNicDevice
NodeDriverManager
NodePCIDeviceManager
NodeUSBDeviceManager
NodeSriovNicDeviceManager
NodeManager
NvidiaVgpuProfile
NvidiaVgpuProfileManager
NodeGpu
NodeGpuManager
NodeGpuStats
NodeGpuStatsHistory
NodeGpuStatsManager
NodeGpuInstance
NodeGpuInstanceManager
NodeVgpuDevice
NodeVgpuDeviceManager
NodeHostGpuDevice
NodeHostGpuDeviceManager
NodeVgpuProfile
NodeVgpuProfileManager
Device
DeviceManager
Log
LogManager
Alarm
AlarmHistory
AlarmManager
UpdateLog
UpdateLogManager
UpdateBranch
UpdateBranchManager
UpdateSourceStatus
UpdateSourceStatusManager
UpdateSourcePackage
UpdateSourcePackageManager
UpdateSource
UpdateSourceManager
UpdatePackage
UpdatePackageManager
UpdateSettings
UpdateSettingsManager
UpdateDashboard
UpdateDashboardManager
BillingRecord
BillingManager
CloudSnapshotVM
CloudSnapshotTenant
CloudSnapshotVMManager
CloudSnapshotTenantManager
CloudSnapshot
CloudSnapshotManager
SnapshotProfilePeriod
SnapshotProfile
SnapshotProfilePeriodManager
SnapshotProfileManager
Site
SiteManager
SiteSyncOutgoing
SiteSyncIncoming
SiteSyncSchedule
SiteSyncOutgoingManager
SiteSyncIncomingManager
SiteSyncScheduleManager
SiteSyncStats
SiteSyncStatsHistory
SiteSyncStatsManager
SiteSyncQueueItem
SiteSyncQueueManager
SiteSyncRemoteSnap
SiteSyncRemoteSnapManager
SiteSyncIncomingVerified
SiteSyncIncomingVerifiedManager
SiteSyncLog
SiteSyncOutgoingLogManager
SiteSyncIncomingLogManager
TagMember
TagMemberManager
Tag
TagManager
TagCategory
TagCategoryManager
ResourceGroup
ResourceGroupManager
ResourceRule
ResourceRuleManager
SharedObject
SharedObjectManager
CloudInitFile
CloudInitFileManager
VMCloudInitFileManager
File
FileManager
Webhook
WebhookHistory
WebhookManager
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__()
VergeError
VergeConnectionError
NotConnectedError
VergeTimeoutError
APIError
APIError.__init__()
AuthenticationError
NotFoundError
ConflictError
ValidationError
TaskError
TaskError.__init__()
TaskTimeoutError
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