From 7f06e55f909039f5f61a11e13492d4ae0c9f0850 Mon Sep 17 00:00:00 2001 From: "daniele.corsini@corisnvest.it" Date: Tue, 24 Sep 2024 21:28:33 +0200 Subject: [PATCH] Bump version --- .../Corsinvest.ProxmoxVE.Api.psd1 | 626 +- Tools.psm1 | 2 + doc/index.html | 15602 +++++++++++----- 3 files changed, 10883 insertions(+), 5347 deletions(-) diff --git a/Corsinvest.ProxmoxVE.Api/Corsinvest.ProxmoxVE.Api.psd1 b/Corsinvest.ProxmoxVE.Api/Corsinvest.ProxmoxVE.Api.psd1 index b3a9176..4e11685 100644 --- a/Corsinvest.ProxmoxVE.Api/Corsinvest.ProxmoxVE.Api.psd1 +++ b/Corsinvest.ProxmoxVE.Api/Corsinvest.ProxmoxVE.Api.psd1 @@ -3,7 +3,7 @@ # # Generated by: Daniele Corsini # -# Generated on: 12/08/2024 +# Generated on: 24/09/2024 # @{ @@ -12,7 +12,7 @@ RootModule = 'Corsinvest.ProxmoxVE.Api.psm1' # Version number of this module. -ModuleVersion = '8.2.2' +ModuleVersion = '8.2.3' # Supported PSEditions # CompatiblePSEditions = @() @@ -69,308 +69,307 @@ PowerShellVersion = '6.0' # NestedModules = @() # Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export. -FunctionsToExport = 'Build-PveDocumentation', 'Connect-PveCluster', - 'ConvertFrom-PveUnixTime', 'ConvertTo-PveUnixTime', 'Enter-PveSpice', - 'Get-PveAccess', 'Get-PveAccessAcl', 'Get-PveAccessDomains', - 'Get-PveAccessDomainsIdx', 'Get-PveAccessGroups', - 'Get-PveAccessGroupsIdx', 'Get-PveAccessOpenid', - 'Get-PveAccessPermissions', 'Get-PveAccessRoles', - 'Get-PveAccessRolesIdx', 'Get-PveAccessTfa', 'Get-PveAccessTfaIdx', - 'Get-PveAccessTicket', 'Get-PveAccessUsers', 'Get-PveAccessUsersIdx', - 'Get-PveAccessUsersTfa', 'Get-PveAccessUsersToken', - 'Get-PveAccessUsersTokenIdx', 'Get-PveCluster', 'Get-PveClusterAcme', - 'Get-PveClusterAcmeAccount', 'Get-PveClusterAcmeAccountIdx', - 'Get-PveClusterAcmeChallengeSchema', - 'Get-PveClusterAcmeDirectories', 'Get-PveClusterAcmeMeta', - 'Get-PveClusterAcmePlugins', 'Get-PveClusterAcmePluginsIdx', - 'Get-PveClusterAcmeTos', 'Get-PveClusterBackup', - 'Get-PveClusterBackupIdx', 'Get-PveClusterBackupIncludedVolumes', - 'Get-PveClusterBackupInfo', 'Get-PveClusterBackupInfoNotBackedUp', - 'Get-PveClusterCeph', 'Get-PveClusterCephFlags', - 'Get-PveClusterCephFlagsIdx', 'Get-PveClusterCephMetadata', - 'Get-PveClusterCephStatus', 'Get-PveClusterConfig', - 'Get-PveClusterConfigApiversion', 'Get-PveClusterConfigJoin', - 'Get-PveClusterConfigNodes', 'Get-PveClusterConfigQdevice', - 'Get-PveClusterConfigTotem', 'Get-PveClusterFirewall', - 'Get-PveClusterFirewallAliases', 'Get-PveClusterFirewallAliasesIdx', - 'Get-PveClusterFirewallGroups', 'Get-PveClusterFirewallGroupsIdx', - 'Get-PveClusterFirewallIpset', 'Get-PveClusterFirewallIpsetIdx', - 'Get-PveClusterFirewallMacros', 'Get-PveClusterFirewallOptions', - 'Get-PveClusterFirewallRefs', 'Get-PveClusterFirewallRules', - 'Get-PveClusterFirewallRulesIdx', 'Get-PveClusterHa', - 'Get-PveClusterHaGroups', 'Get-PveClusterHaGroupsIdx', - 'Get-PveClusterHaResources', 'Get-PveClusterHaResourcesIdx', - 'Get-PveClusterHaStatus', 'Get-PveClusterHaStatusCurrent', - 'Get-PveClusterHaStatusManagerStatus', 'Get-PveClusterJobs', - 'Get-PveClusterJobsRealmSync', 'Get-PveClusterJobsRealmSyncIdx', - 'Get-PveClusterJobsScheduleAnalyze', 'Get-PveClusterLog', - 'Get-PveClusterMapping', 'Get-PveClusterMappingPci', - 'Get-PveClusterMappingPciIdx', 'Get-PveClusterMappingUsb', - 'Get-PveClusterMappingUsbIdx', 'Get-PveClusterMetrics', - 'Get-PveClusterMetricsServer', 'Get-PveClusterMetricsServerIdx', - 'Get-PveClusterNextid', 'Get-PveClusterNotifications', - 'Get-PveClusterNotificationsEndpoints', - 'Get-PveClusterNotificationsEndpointsGotify', - 'Get-PveClusterNotificationsEndpointsGotifyIdx', - 'Get-PveClusterNotificationsEndpointsSendmail', - 'Get-PveClusterNotificationsEndpointsSendmailIdx', - 'Get-PveClusterNotificationsEndpointsSmtp', - 'Get-PveClusterNotificationsEndpointsSmtpIdx', - 'Get-PveClusterNotificationsMatchers', - 'Get-PveClusterNotificationsMatchersIdx', - 'Get-PveClusterNotificationsTargets', 'Get-PveClusterOptions', - 'Get-PveClusterReplication', 'Get-PveClusterReplicationIdx', - 'Get-PveClusterResources', 'Get-PveClusterSdn', - 'Get-PveClusterSdnControllers', 'Get-PveClusterSdnControllersIdx', - 'Get-PveClusterSdnDns', 'Get-PveClusterSdnDnsIdx', - 'Get-PveClusterSdnIpams', 'Get-PveClusterSdnIpamsIdx', - 'Get-PveClusterSdnIpamsStatus', 'Get-PveClusterSdnVnets', - 'Get-PveClusterSdnVnetsIdx', 'Get-PveClusterSdnVnetsSubnets', - 'Get-PveClusterSdnVnetsSubnetsIdx', 'Get-PveClusterSdnZones', - 'Get-PveClusterSdnZonesIdx', 'Get-PveClusterStatus', - 'Get-PveClusterTasks', 'Get-PveNode', 'Get-PveNodes', - 'Get-PveNodesAplinfo', 'Get-PveNodesApt', 'Get-PveNodesAptChangelog', - 'Get-PveNodesAptRepositories', 'Get-PveNodesAptUpdate', - 'Get-PveNodesAptVersions', 'Get-PveNodesCapabilities', - 'Get-PveNodesCapabilitiesQemu', 'Get-PveNodesCapabilitiesQemuCpu', - 'Get-PveNodesCapabilitiesQemuMachines', 'Get-PveNodesCeph', - 'Get-PveNodesCephCfg', 'Get-PveNodesCephCfgDb', - 'Get-PveNodesCephCfgRaw', 'Get-PveNodesCephCfgValue', - 'Get-PveNodesCephCmdSafety', 'Get-PveNodesCephCrush', - 'Get-PveNodesCephFs', 'Get-PveNodesCephLog', 'Get-PveNodesCephMds', - 'Get-PveNodesCephMgr', 'Get-PveNodesCephMon', 'Get-PveNodesCephOsd', - 'Get-PveNodesCephOsdIdx', 'Get-PveNodesCephOsdLvInfo', - 'Get-PveNodesCephOsdMetadata', 'Get-PveNodesCephPool', - 'Get-PveNodesCephPoolIdx', 'Get-PveNodesCephPoolStatus', - 'Get-PveNodesCephRules', 'Get-PveNodesCephStatus', - 'Get-PveNodesCertificates', 'Get-PveNodesCertificatesAcme', - 'Get-PveNodesCertificatesInfo', 'Get-PveNodesConfig', - 'Get-PveNodesDisks', 'Get-PveNodesDisksDirectory', - 'Get-PveNodesDisksList', 'Get-PveNodesDisksLvm', - 'Get-PveNodesDisksLvmthin', 'Get-PveNodesDisksSmart', - 'Get-PveNodesDisksZfs', 'Get-PveNodesDisksZfsIdx', 'Get-PveNodesDns', - 'Get-PveNodesFirewall', 'Get-PveNodesFirewallLog', - 'Get-PveNodesFirewallOptions', 'Get-PveNodesFirewallRules', - 'Get-PveNodesFirewallRulesIdx', 'Get-PveNodesHardware', - 'Get-PveNodesHardwarePci', 'Get-PveNodesHardwarePciIdx', - 'Get-PveNodesHardwarePciMdev', 'Get-PveNodesHardwareUsb', - 'Get-PveNodesHosts', 'Get-PveNodesIdx', 'Get-PveNodesJournal', - 'Get-PveNodesLxc', 'Get-PveNodesLxcConfig', 'Get-PveNodesLxcFeature', - 'Get-PveNodesLxcFirewall', 'Get-PveNodesLxcFirewallAliases', - 'Get-PveNodesLxcFirewallAliasesIdx', 'Get-PveNodesLxcFirewallIpset', - 'Get-PveNodesLxcFirewallIpsetIdx', 'Get-PveNodesLxcFirewallLog', - 'Get-PveNodesLxcFirewallOptions', 'Get-PveNodesLxcFirewallRefs', - 'Get-PveNodesLxcFirewallRules', 'Get-PveNodesLxcFirewallRulesIdx', - 'Get-PveNodesLxcIdx', 'Get-PveNodesLxcInterfaces', - 'Get-PveNodesLxcMtunnelwebsocket', 'Get-PveNodesLxcPending', - 'Get-PveNodesLxcRrd', 'Get-PveNodesLxcRrddata', - 'Get-PveNodesLxcSnapshot', 'Get-PveNodesLxcSnapshotConfig', - 'Get-PveNodesLxcSnapshotIdx', 'Get-PveNodesLxcStatus', - 'Get-PveNodesLxcStatusCurrent', 'Get-PveNodesLxcVncwebsocket', - 'Get-PveNodesNetstat', 'Get-PveNodesNetwork', - 'Get-PveNodesNetworkIdx', 'Get-PveNodesQemu', 'Get-PveNodesQemuAgent', - 'Get-PveNodesQemuAgentExecStatus', 'Get-PveNodesQemuAgentFileRead', - 'Get-PveNodesQemuAgentGetFsinfo', - 'Get-PveNodesQemuAgentGetHostName', - 'Get-PveNodesQemuAgentGetMemoryBlockInfo', - 'Get-PveNodesQemuAgentGetMemoryBlocks', - 'Get-PveNodesQemuAgentGetOsinfo', 'Get-PveNodesQemuAgentGetTime', - 'Get-PveNodesQemuAgentGetTimezone', 'Get-PveNodesQemuAgentGetUsers', - 'Get-PveNodesQemuAgentGetVcpus', 'Get-PveNodesQemuAgentInfo', - 'Get-PveNodesQemuAgentNetworkGetInterfaces', - 'Get-PveNodesQemuCloudinit', 'Get-PveNodesQemuCloudinitDump', - 'Get-PveNodesQemuConfig', 'Get-PveNodesQemuFeature', - 'Get-PveNodesQemuFirewall', 'Get-PveNodesQemuFirewallAliases', - 'Get-PveNodesQemuFirewallAliasesIdx', - 'Get-PveNodesQemuFirewallIpset', 'Get-PveNodesQemuFirewallIpsetIdx', - 'Get-PveNodesQemuFirewallLog', 'Get-PveNodesQemuFirewallOptions', - 'Get-PveNodesQemuFirewallRefs', 'Get-PveNodesQemuFirewallRules', - 'Get-PveNodesQemuFirewallRulesIdx', 'Get-PveNodesQemuIdx', - 'Get-PveNodesQemuMigrate', 'Get-PveNodesQemuMtunnelwebsocket', - 'Get-PveNodesQemuPending', 'Get-PveNodesQemuRrd', - 'Get-PveNodesQemuRrddata', 'Get-PveNodesQemuSnapshot', - 'Get-PveNodesQemuSnapshotConfig', 'Get-PveNodesQemuSnapshotIdx', - 'Get-PveNodesQemuStatus', 'Get-PveNodesQemuStatusCurrent', - 'Get-PveNodesQemuVncwebsocket', 'Get-PveNodesQueryUrlMetadata', - 'Get-PveNodesReplication', 'Get-PveNodesReplicationIdx', - 'Get-PveNodesReplicationLog', 'Get-PveNodesReplicationStatus', - 'Get-PveNodesReport', 'Get-PveNodesRrd', 'Get-PveNodesRrddata', - 'Get-PveNodesScan', 'Get-PveNodesScanCifs', - 'Get-PveNodesScanGlusterfs', 'Get-PveNodesScanIscsi', - 'Get-PveNodesScanLvm', 'Get-PveNodesScanLvmthin', - 'Get-PveNodesScanNfs', 'Get-PveNodesScanPbs', 'Get-PveNodesScanZfs', - 'Get-PveNodesSdn', 'Get-PveNodesSdnZones', - 'Get-PveNodesSdnZonesContent', 'Get-PveNodesSdnZonesIdx', - 'Get-PveNodesServices', 'Get-PveNodesServicesIdx', - 'Get-PveNodesServicesState', 'Get-PveNodesStatus', - 'Get-PveNodesStorage', 'Get-PveNodesStorageContent', - 'Get-PveNodesStorageContentIdx', 'Get-PveNodesStorageIdx', - 'Get-PveNodesStorageImportMetadata', - 'Get-PveNodesStoragePrunebackups', 'Get-PveNodesStorageRrd', - 'Get-PveNodesStorageRrddata', 'Get-PveNodesStorageStatus', - 'Get-PveNodesSubscription', 'Get-PveNodesSyslog', 'Get-PveNodesTasks', - 'Get-PveNodesTasksIdx', 'Get-PveNodesTasksLog', - 'Get-PveNodesTasksStatus', 'Get-PveNodesTime', 'Get-PveNodesVersion', - 'Get-PveNodesVncwebsocket', 'Get-PveNodesVzdumpDefaults', - 'Get-PveNodesVzdumpExtractconfig', 'Get-PvePools', 'Get-PvePoolsIdx', - 'Get-PveStorage', 'Get-PveStorageIdx', 'Get-PveTaskIsRunning', - 'Get-PveVersion', 'Get-PveVm', 'Get-PveVmSnapshot', 'Invoke-PveRestApi', - 'Invoke-PveSpice', 'New-PveAccessDomains', 'New-PveAccessDomainsSync', - 'New-PveAccessGroups', 'New-PveAccessOpenidAuthUrl', - 'New-PveAccessOpenidLogin', 'New-PveAccessRoles', 'New-PveAccessTfa', - 'New-PveAccessTicket', 'New-PveAccessUsers', - 'New-PveAccessUsersToken', 'New-PveClusterAcmeAccount', - 'New-PveClusterAcmePlugins', 'New-PveClusterBackup', - 'New-PveClusterConfig', 'New-PveClusterConfigJoin', - 'New-PveClusterConfigNodes', 'New-PveClusterFirewallAliases', - 'New-PveClusterFirewallGroups', 'New-PveClusterFirewallGroupsIdx', - 'New-PveClusterFirewallIpset', 'New-PveClusterFirewallIpsetIdx', - 'New-PveClusterFirewallRules', 'New-PveClusterHaGroups', - 'New-PveClusterHaResources', 'New-PveClusterHaResourcesMigrate', - 'New-PveClusterHaResourcesRelocate', 'New-PveClusterJobsRealmSync', - 'New-PveClusterMappingPci', 'New-PveClusterMappingUsb', - 'New-PveClusterMetricsServer', - 'New-PveClusterNotificationsEndpointsGotify', - 'New-PveClusterNotificationsEndpointsSendmail', - 'New-PveClusterNotificationsEndpointsSmtp', - 'New-PveClusterNotificationsMatchers', 'New-PveClusterReplication', - 'New-PveClusterSdnControllers', 'New-PveClusterSdnDns', - 'New-PveClusterSdnIpams', 'New-PveClusterSdnVnets', - 'New-PveClusterSdnVnetsIps', 'New-PveClusterSdnVnetsSubnets', - 'New-PveClusterSdnZones', 'New-PveNodesAplinfo', - 'New-PveNodesAptRepositories', 'New-PveNodesAptUpdate', - 'New-PveNodesCephFs', 'New-PveNodesCephInit', 'New-PveNodesCephMds', - 'New-PveNodesCephMgr', 'New-PveNodesCephMon', 'New-PveNodesCephOsd', - 'New-PveNodesCephOsdIn', 'New-PveNodesCephOsdOut', - 'New-PveNodesCephOsdScrub', 'New-PveNodesCephPool', - 'New-PveNodesCephRestart', 'New-PveNodesCephStart', - 'New-PveNodesCephStop', 'New-PveNodesCertificatesAcmeCertificate', - 'New-PveNodesCertificatesCustom', 'New-PveNodesDisksDirectory', - 'New-PveNodesDisksInitgpt', 'New-PveNodesDisksLvm', - 'New-PveNodesDisksLvmthin', 'New-PveNodesDisksZfs', - 'New-PveNodesExecute', 'New-PveNodesFirewallRules', - 'New-PveNodesHosts', 'New-PveNodesLxc', 'New-PveNodesLxcClone', - 'New-PveNodesLxcFirewallAliases', 'New-PveNodesLxcFirewallIpset', - 'New-PveNodesLxcFirewallIpsetIdx', 'New-PveNodesLxcFirewallRules', - 'New-PveNodesLxcMigrate', 'New-PveNodesLxcMoveVolume', - 'New-PveNodesLxcMtunnel', 'New-PveNodesLxcRemoteMigrate', - 'New-PveNodesLxcSnapshot', 'New-PveNodesLxcSnapshotRollback', - 'New-PveNodesLxcSpiceproxy', 'New-PveNodesLxcStatusReboot', - 'New-PveNodesLxcStatusResume', 'New-PveNodesLxcStatusShutdown', - 'New-PveNodesLxcStatusStart', 'New-PveNodesLxcStatusStop', - 'New-PveNodesLxcStatusSuspend', 'New-PveNodesLxcTemplate', - 'New-PveNodesLxcTermproxy', 'New-PveNodesLxcVncproxy', - 'New-PveNodesMigrateall', 'New-PveNodesNetwork', 'New-PveNodesQemu', - 'New-PveNodesQemuAgent', 'New-PveNodesQemuAgentExec', - 'New-PveNodesQemuAgentFileWrite', - 'New-PveNodesQemuAgentFsfreezeFreeze', - 'New-PveNodesQemuAgentFsfreezeStatus', - 'New-PveNodesQemuAgentFsfreezeThaw', 'New-PveNodesQemuAgentFstrim', - 'New-PveNodesQemuAgentPing', 'New-PveNodesQemuAgentSetUserPassword', - 'New-PveNodesQemuAgentShutdown', 'New-PveNodesQemuAgentSuspendDisk', - 'New-PveNodesQemuAgentSuspendHybrid', - 'New-PveNodesQemuAgentSuspendRam', 'New-PveNodesQemuClone', - 'New-PveNodesQemuConfig', 'New-PveNodesQemuFirewallAliases', - 'New-PveNodesQemuFirewallIpset', 'New-PveNodesQemuFirewallIpsetIdx', - 'New-PveNodesQemuFirewallRules', 'New-PveNodesQemuMigrate', - 'New-PveNodesQemuMonitor', 'New-PveNodesQemuMoveDisk', - 'New-PveNodesQemuMtunnel', 'New-PveNodesQemuRemoteMigrate', - 'New-PveNodesQemuSnapshot', 'New-PveNodesQemuSnapshotRollback', - 'New-PveNodesQemuSpiceproxy', 'New-PveNodesQemuStatusReboot', - 'New-PveNodesQemuStatusReset', 'New-PveNodesQemuStatusResume', - 'New-PveNodesQemuStatusShutdown', 'New-PveNodesQemuStatusStart', - 'New-PveNodesQemuStatusStop', 'New-PveNodesQemuStatusSuspend', - 'New-PveNodesQemuTemplate', 'New-PveNodesQemuTermproxy', - 'New-PveNodesQemuVncproxy', 'New-PveNodesReplicationScheduleNow', - 'New-PveNodesServicesReload', 'New-PveNodesServicesRestart', - 'New-PveNodesServicesStart', 'New-PveNodesServicesStop', - 'New-PveNodesSpiceshell', 'New-PveNodesStartall', - 'New-PveNodesStatus', 'New-PveNodesStopall', - 'New-PveNodesStorageContent', 'New-PveNodesStorageContentIdx', - 'New-PveNodesStorageDownloadUrl', 'New-PveNodesStorageUpload', - 'New-PveNodesSubscription', 'New-PveNodesSuspendall', - 'New-PveNodesTermproxy', 'New-PveNodesVncshell', 'New-PveNodesVzdump', - 'New-PveNodesWakeonlan', 'New-PvePools', 'New-PveStorage', - 'New-PveVmSnapshot', 'Remove-PveAccessDomains', - 'Remove-PveAccessGroups', 'Remove-PveAccessRoles', - 'Remove-PveAccessTfa', 'Remove-PveAccessUsers', - 'Remove-PveAccessUsersToken', 'Remove-PveClusterAcmeAccount', - 'Remove-PveClusterAcmePlugins', 'Remove-PveClusterBackup', - 'Remove-PveClusterConfigNodes', 'Remove-PveClusterFirewallAliases', - 'Remove-PveClusterFirewallGroups', - 'Remove-PveClusterFirewallGroupsIdx', - 'Remove-PveClusterFirewallIpset', - 'Remove-PveClusterFirewallIpsetIdx', - 'Remove-PveClusterFirewallRules', 'Remove-PveClusterHaGroups', - 'Remove-PveClusterHaResources', 'Remove-PveClusterJobsRealmSync', - 'Remove-PveClusterMappingPci', 'Remove-PveClusterMappingUsb', - 'Remove-PveClusterMetricsServer', - 'Remove-PveClusterNotificationsEndpointsGotify', - 'Remove-PveClusterNotificationsEndpointsSendmail', - 'Remove-PveClusterNotificationsEndpointsSmtp', - 'Remove-PveClusterNotificationsMatchers', - 'Remove-PveClusterReplication', 'Remove-PveClusterSdnControllers', - 'Remove-PveClusterSdnDns', 'Remove-PveClusterSdnIpams', - 'Remove-PveClusterSdnVnets', 'Remove-PveClusterSdnVnetsIps', - 'Remove-PveClusterSdnVnetsSubnets', 'Remove-PveClusterSdnZones', - 'Remove-PveNodesCephMds', 'Remove-PveNodesCephMgr', - 'Remove-PveNodesCephMon', 'Remove-PveNodesCephOsd', - 'Remove-PveNodesCephPool', - 'Remove-PveNodesCertificatesAcmeCertificate', - 'Remove-PveNodesCertificatesCustom', - 'Remove-PveNodesDisksDirectory', 'Remove-PveNodesDisksLvm', - 'Remove-PveNodesDisksLvmthin', 'Remove-PveNodesDisksZfs', - 'Remove-PveNodesFirewallRules', 'Remove-PveNodesLxc', - 'Remove-PveNodesLxcFirewallAliases', - 'Remove-PveNodesLxcFirewallIpset', - 'Remove-PveNodesLxcFirewallIpsetIdx', - 'Remove-PveNodesLxcFirewallRules', 'Remove-PveNodesLxcSnapshot', - 'Remove-PveNodesNetwork', 'Remove-PveNodesNetworkIdx', - 'Remove-PveNodesQemu', 'Remove-PveNodesQemuFirewallAliases', - 'Remove-PveNodesQemuFirewallIpset', - 'Remove-PveNodesQemuFirewallIpsetIdx', - 'Remove-PveNodesQemuFirewallRules', 'Remove-PveNodesQemuSnapshot', - 'Remove-PveNodesStorageContent', - 'Remove-PveNodesStoragePrunebackups', 'Remove-PveNodesSubscription', - 'Remove-PveNodesTasks', 'Remove-PvePools', 'Remove-PvePoolsIdx', - 'Remove-PveStorage', 'Remove-PveVmSnapshot', 'Reset-PveVm', - 'Resume-PveVm', 'Set-PveAccessAcl', 'Set-PveAccessDomains', - 'Set-PveAccessGroups', 'Set-PveAccessPassword', 'Set-PveAccessRoles', - 'Set-PveAccessTfa', 'Set-PveAccessUsers', 'Set-PveAccessUsersToken', - 'Set-PveAccessUsersUnlockTfa', 'Set-PveClusterAcmeAccount', - 'Set-PveClusterAcmePlugins', 'Set-PveClusterBackup', - 'Set-PveClusterCephFlags', 'Set-PveClusterCephFlagsIdx', - 'Set-PveClusterFirewallAliases', 'Set-PveClusterFirewallGroups', - 'Set-PveClusterFirewallIpset', 'Set-PveClusterFirewallOptions', - 'Set-PveClusterFirewallRules', 'Set-PveClusterHaGroups', - 'Set-PveClusterHaResources', 'Set-PveClusterJobsRealmSync', - 'Set-PveClusterMappingPci', 'Set-PveClusterMappingUsb', - 'Set-PveClusterMetricsServer', - 'Set-PveClusterNotificationsEndpointsGotify', - 'Set-PveClusterNotificationsEndpointsSendmail', - 'Set-PveClusterNotificationsEndpointsSmtp', - 'Set-PveClusterNotificationsMatchers', 'Set-PveClusterOptions', - 'Set-PveClusterReplication', 'Set-PveClusterSdn', - 'Set-PveClusterSdnControllers', 'Set-PveClusterSdnDns', - 'Set-PveClusterSdnIpams', 'Set-PveClusterSdnVnets', - 'Set-PveClusterSdnVnetsIps', 'Set-PveClusterSdnVnetsSubnets', - 'Set-PveClusterSdnZones', 'Set-PveNodesAptRepositories', - 'Set-PveNodesCephPool', 'Set-PveNodesCertificatesAcmeCertificate', - 'Set-PveNodesConfig', 'Set-PveNodesDisksWipedisk', 'Set-PveNodesDns', - 'Set-PveNodesFirewallOptions', 'Set-PveNodesFirewallRules', - 'Set-PveNodesLxcConfig', 'Set-PveNodesLxcFirewallAliases', - 'Set-PveNodesLxcFirewallIpset', 'Set-PveNodesLxcFirewallOptions', - 'Set-PveNodesLxcFirewallRules', 'Set-PveNodesLxcResize', - 'Set-PveNodesLxcSnapshotConfig', 'Set-PveNodesNetwork', - 'Set-PveNodesNetworkIdx', 'Set-PveNodesQemuCloudinit', - 'Set-PveNodesQemuConfig', 'Set-PveNodesQemuFirewallAliases', - 'Set-PveNodesQemuFirewallIpset', 'Set-PveNodesQemuFirewallOptions', - 'Set-PveNodesQemuFirewallRules', 'Set-PveNodesQemuResize', - 'Set-PveNodesQemuSendkey', 'Set-PveNodesQemuSnapshotConfig', - 'Set-PveNodesQemuUnlink', 'Set-PveNodesStorageContent', - 'Set-PveNodesSubscription', 'Set-PveNodesTime', 'Set-PvePools', - 'Set-PvePoolsIdx', 'Set-PveStorage', 'Start-PveVm', 'Stop-PveVm', - 'Suspend-PveVm', 'Undo-PveVmSnapshot', 'Unlock-PveVm', +FunctionsToExport = 'Build-PveDocumentation', 'Connect-PveCluster', + 'ConvertFrom-PveUnixTime', 'ConvertTo-PveUnixTime', 'Get-PveAccess', + 'Get-PveAccessAcl', 'Get-PveAccessDomains', 'Get-PveAccessDomainsIdx', + 'Get-PveAccessGroups', 'Get-PveAccessGroupsIdx', + 'Get-PveAccessOpenid', 'Get-PveAccessPermissions', + 'Get-PveAccessRoles', 'Get-PveAccessRolesIdx', 'Get-PveAccessTfa', + 'Get-PveAccessTfaIdx', 'Get-PveAccessTicket', 'Get-PveAccessUsers', + 'Get-PveAccessUsersIdx', 'Get-PveAccessUsersTfa', + 'Get-PveAccessUsersToken', 'Get-PveAccessUsersTokenIdx', + 'Get-PveCluster', 'Get-PveClusterAcme', 'Get-PveClusterAcmeAccount', + 'Get-PveClusterAcmeAccountIdx', 'Get-PveClusterAcmeChallengeSchema', + 'Get-PveClusterAcmeDirectories', 'Get-PveClusterAcmeMeta', + 'Get-PveClusterAcmePlugins', 'Get-PveClusterAcmePluginsIdx', + 'Get-PveClusterAcmeTos', 'Get-PveClusterBackup', + 'Get-PveClusterBackupIdx', 'Get-PveClusterBackupIncludedVolumes', + 'Get-PveClusterBackupInfo', 'Get-PveClusterBackupInfoNotBackedUp', + 'Get-PveClusterCeph', 'Get-PveClusterCephFlags', + 'Get-PveClusterCephFlagsIdx', 'Get-PveClusterCephMetadata', + 'Get-PveClusterCephStatus', 'Get-PveClusterConfig', + 'Get-PveClusterConfigApiversion', 'Get-PveClusterConfigJoin', + 'Get-PveClusterConfigNodes', 'Get-PveClusterConfigQdevice', + 'Get-PveClusterConfigTotem', 'Get-PveClusterFirewall', + 'Get-PveClusterFirewallAliases', 'Get-PveClusterFirewallAliasesIdx', + 'Get-PveClusterFirewallGroups', 'Get-PveClusterFirewallGroupsIdx', + 'Get-PveClusterFirewallIpset', 'Get-PveClusterFirewallIpsetIdx', + 'Get-PveClusterFirewallMacros', 'Get-PveClusterFirewallOptions', + 'Get-PveClusterFirewallRefs', 'Get-PveClusterFirewallRules', + 'Get-PveClusterFirewallRulesIdx', 'Get-PveClusterHa', + 'Get-PveClusterHaGroups', 'Get-PveClusterHaGroupsIdx', + 'Get-PveClusterHaResources', 'Get-PveClusterHaResourcesIdx', + 'Get-PveClusterHaStatus', 'Get-PveClusterHaStatusCurrent', + 'Get-PveClusterHaStatusManagerStatus', 'Get-PveClusterJobs', + 'Get-PveClusterJobsRealmSync', 'Get-PveClusterJobsRealmSyncIdx', + 'Get-PveClusterJobsScheduleAnalyze', 'Get-PveClusterLog', + 'Get-PveClusterMapping', 'Get-PveClusterMappingPci', + 'Get-PveClusterMappingPciIdx', 'Get-PveClusterMappingUsb', + 'Get-PveClusterMappingUsbIdx', 'Get-PveClusterMetrics', + 'Get-PveClusterMetricsServer', 'Get-PveClusterMetricsServerIdx', + 'Get-PveClusterNextid', 'Get-PveClusterNotifications', + 'Get-PveClusterNotificationsEndpoints', + 'Get-PveClusterNotificationsEndpointsGotify', + 'Get-PveClusterNotificationsEndpointsGotifyIdx', + 'Get-PveClusterNotificationsEndpointsSendmail', + 'Get-PveClusterNotificationsEndpointsSendmailIdx', + 'Get-PveClusterNotificationsEndpointsSmtp', + 'Get-PveClusterNotificationsEndpointsSmtpIdx', + 'Get-PveClusterNotificationsMatchers', + 'Get-PveClusterNotificationsMatchersIdx', + 'Get-PveClusterNotificationsTargets', 'Get-PveClusterOptions', + 'Get-PveClusterReplication', 'Get-PveClusterReplicationIdx', + 'Get-PveClusterResources', 'Get-PveClusterSdn', + 'Get-PveClusterSdnControllers', 'Get-PveClusterSdnControllersIdx', + 'Get-PveClusterSdnDns', 'Get-PveClusterSdnDnsIdx', + 'Get-PveClusterSdnIpams', 'Get-PveClusterSdnIpamsIdx', + 'Get-PveClusterSdnIpamsStatus', 'Get-PveClusterSdnVnets', + 'Get-PveClusterSdnVnetsIdx', 'Get-PveClusterSdnVnetsSubnets', + 'Get-PveClusterSdnVnetsSubnetsIdx', 'Get-PveClusterSdnZones', + 'Get-PveClusterSdnZonesIdx', 'Get-PveClusterStatus', + 'Get-PveClusterTasks', 'Get-PveNode', 'Get-PveNodes', + 'Get-PveNodesAplinfo', 'Get-PveNodesApt', 'Get-PveNodesAptChangelog', + 'Get-PveNodesAptRepositories', 'Get-PveNodesAptUpdate', + 'Get-PveNodesAptVersions', 'Get-PveNodesCapabilities', + 'Get-PveNodesCapabilitiesQemu', 'Get-PveNodesCapabilitiesQemuCpu', + 'Get-PveNodesCapabilitiesQemuMachines', 'Get-PveNodesCeph', + 'Get-PveNodesCephCfg', 'Get-PveNodesCephCfgDb', + 'Get-PveNodesCephCfgRaw', 'Get-PveNodesCephCfgValue', + 'Get-PveNodesCephCmdSafety', 'Get-PveNodesCephCrush', + 'Get-PveNodesCephFs', 'Get-PveNodesCephLog', 'Get-PveNodesCephMds', + 'Get-PveNodesCephMgr', 'Get-PveNodesCephMon', 'Get-PveNodesCephOsd', + 'Get-PveNodesCephOsdIdx', 'Get-PveNodesCephOsdLvInfo', + 'Get-PveNodesCephOsdMetadata', 'Get-PveNodesCephPool', + 'Get-PveNodesCephPoolIdx', 'Get-PveNodesCephPoolStatus', + 'Get-PveNodesCephRules', 'Get-PveNodesCephStatus', + 'Get-PveNodesCertificates', 'Get-PveNodesCertificatesAcme', + 'Get-PveNodesCertificatesInfo', 'Get-PveNodesConfig', + 'Get-PveNodesDisks', 'Get-PveNodesDisksDirectory', + 'Get-PveNodesDisksList', 'Get-PveNodesDisksLvm', + 'Get-PveNodesDisksLvmthin', 'Get-PveNodesDisksSmart', + 'Get-PveNodesDisksZfs', 'Get-PveNodesDisksZfsIdx', 'Get-PveNodesDns', + 'Get-PveNodesFirewall', 'Get-PveNodesFirewallLog', + 'Get-PveNodesFirewallOptions', 'Get-PveNodesFirewallRules', + 'Get-PveNodesFirewallRulesIdx', 'Get-PveNodesHardware', + 'Get-PveNodesHardwarePci', 'Get-PveNodesHardwarePciIdx', + 'Get-PveNodesHardwarePciMdev', 'Get-PveNodesHardwareUsb', + 'Get-PveNodesHosts', 'Get-PveNodesIdx', 'Get-PveNodesJournal', + 'Get-PveNodesLxc', 'Get-PveNodesLxcConfig', 'Get-PveNodesLxcFeature', + 'Get-PveNodesLxcFirewall', 'Get-PveNodesLxcFirewallAliases', + 'Get-PveNodesLxcFirewallAliasesIdx', 'Get-PveNodesLxcFirewallIpset', + 'Get-PveNodesLxcFirewallIpsetIdx', 'Get-PveNodesLxcFirewallLog', + 'Get-PveNodesLxcFirewallOptions', 'Get-PveNodesLxcFirewallRefs', + 'Get-PveNodesLxcFirewallRules', 'Get-PveNodesLxcFirewallRulesIdx', + 'Get-PveNodesLxcIdx', 'Get-PveNodesLxcInterfaces', + 'Get-PveNodesLxcMtunnelwebsocket', 'Get-PveNodesLxcPending', + 'Get-PveNodesLxcRrd', 'Get-PveNodesLxcRrddata', + 'Get-PveNodesLxcSnapshot', 'Get-PveNodesLxcSnapshotConfig', + 'Get-PveNodesLxcSnapshotIdx', 'Get-PveNodesLxcStatus', + 'Get-PveNodesLxcStatusCurrent', 'Get-PveNodesLxcVncwebsocket', + 'Get-PveNodesNetstat', 'Get-PveNodesNetwork', + 'Get-PveNodesNetworkIdx', 'Get-PveNodesQemu', 'Get-PveNodesQemuAgent', + 'Get-PveNodesQemuAgentExecStatus', 'Get-PveNodesQemuAgentFileRead', + 'Get-PveNodesQemuAgentGetFsinfo', + 'Get-PveNodesQemuAgentGetHostName', + 'Get-PveNodesQemuAgentGetMemoryBlockInfo', + 'Get-PveNodesQemuAgentGetMemoryBlocks', + 'Get-PveNodesQemuAgentGetOsinfo', 'Get-PveNodesQemuAgentGetTime', + 'Get-PveNodesQemuAgentGetTimezone', 'Get-PveNodesQemuAgentGetUsers', + 'Get-PveNodesQemuAgentGetVcpus', 'Get-PveNodesQemuAgentInfo', + 'Get-PveNodesQemuAgentNetworkGetInterfaces', + 'Get-PveNodesQemuCloudinit', 'Get-PveNodesQemuCloudinitDump', + 'Get-PveNodesQemuConfig', 'Get-PveNodesQemuFeature', + 'Get-PveNodesQemuFirewall', 'Get-PveNodesQemuFirewallAliases', + 'Get-PveNodesQemuFirewallAliasesIdx', + 'Get-PveNodesQemuFirewallIpset', 'Get-PveNodesQemuFirewallIpsetIdx', + 'Get-PveNodesQemuFirewallLog', 'Get-PveNodesQemuFirewallOptions', + 'Get-PveNodesQemuFirewallRefs', 'Get-PveNodesQemuFirewallRules', + 'Get-PveNodesQemuFirewallRulesIdx', 'Get-PveNodesQemuIdx', + 'Get-PveNodesQemuMigrate', 'Get-PveNodesQemuMtunnelwebsocket', + 'Get-PveNodesQemuPending', 'Get-PveNodesQemuRrd', + 'Get-PveNodesQemuRrddata', 'Get-PveNodesQemuSnapshot', + 'Get-PveNodesQemuSnapshotConfig', 'Get-PveNodesQemuSnapshotIdx', + 'Get-PveNodesQemuStatus', 'Get-PveNodesQemuStatusCurrent', + 'Get-PveNodesQemuVncwebsocket', 'Get-PveNodesQueryUrlMetadata', + 'Get-PveNodesReplication', 'Get-PveNodesReplicationIdx', + 'Get-PveNodesReplicationLog', 'Get-PveNodesReplicationStatus', + 'Get-PveNodesReport', 'Get-PveNodesRrd', 'Get-PveNodesRrddata', + 'Get-PveNodesScan', 'Get-PveNodesScanCifs', + 'Get-PveNodesScanGlusterfs', 'Get-PveNodesScanIscsi', + 'Get-PveNodesScanLvm', 'Get-PveNodesScanLvmthin', + 'Get-PveNodesScanNfs', 'Get-PveNodesScanPbs', 'Get-PveNodesScanZfs', + 'Get-PveNodesSdn', 'Get-PveNodesSdnZones', + 'Get-PveNodesSdnZonesContent', 'Get-PveNodesSdnZonesIdx', + 'Get-PveNodesServices', 'Get-PveNodesServicesIdx', + 'Get-PveNodesServicesState', 'Get-PveNodesStatus', + 'Get-PveNodesStorage', 'Get-PveNodesStorageContent', + 'Get-PveNodesStorageContentIdx', 'Get-PveNodesStorageIdx', + 'Get-PveNodesStorageImportMetadata', + 'Get-PveNodesStoragePrunebackups', 'Get-PveNodesStorageRrd', + 'Get-PveNodesStorageRrddata', 'Get-PveNodesStorageStatus', + 'Get-PveNodesSubscription', 'Get-PveNodesSyslog', 'Get-PveNodesTasks', + 'Get-PveNodesTasksIdx', 'Get-PveNodesTasksLog', + 'Get-PveNodesTasksStatus', 'Get-PveNodesTime', 'Get-PveNodesVersion', + 'Get-PveNodesVncwebsocket', 'Get-PveNodesVzdumpDefaults', + 'Get-PveNodesVzdumpExtractconfig', 'Get-PvePools', 'Get-PvePoolsIdx', + 'Get-PveStorage', 'Get-PveStorageIdx', 'Get-PveTaskIsRunning', + 'Get-PveVersion', 'Get-PveVm', 'Get-PveVmSnapshot', 'Invoke-PveRestApi', + 'Invoke-PveSpice', 'New-PveAccessDomains', 'New-PveAccessDomainsSync', + 'New-PveAccessGroups', 'New-PveAccessOpenidAuthUrl', + 'New-PveAccessOpenidLogin', 'New-PveAccessRoles', 'New-PveAccessTfa', + 'New-PveAccessTicket', 'New-PveAccessUsers', + 'New-PveAccessUsersToken', 'New-PveClusterAcmeAccount', + 'New-PveClusterAcmePlugins', 'New-PveClusterBackup', + 'New-PveClusterConfig', 'New-PveClusterConfigJoin', + 'New-PveClusterConfigNodes', 'New-PveClusterFirewallAliases', + 'New-PveClusterFirewallGroups', 'New-PveClusterFirewallGroupsIdx', + 'New-PveClusterFirewallIpset', 'New-PveClusterFirewallIpsetIdx', + 'New-PveClusterFirewallRules', 'New-PveClusterHaGroups', + 'New-PveClusterHaResources', 'New-PveClusterHaResourcesMigrate', + 'New-PveClusterHaResourcesRelocate', 'New-PveClusterJobsRealmSync', + 'New-PveClusterMappingPci', 'New-PveClusterMappingUsb', + 'New-PveClusterMetricsServer', + 'New-PveClusterNotificationsEndpointsGotify', + 'New-PveClusterNotificationsEndpointsSendmail', + 'New-PveClusterNotificationsEndpointsSmtp', + 'New-PveClusterNotificationsMatchers', 'New-PveClusterReplication', + 'New-PveClusterSdnControllers', 'New-PveClusterSdnDns', + 'New-PveClusterSdnIpams', 'New-PveClusterSdnVnets', + 'New-PveClusterSdnVnetsIps', 'New-PveClusterSdnVnetsSubnets', + 'New-PveClusterSdnZones', 'New-PveNodesAplinfo', + 'New-PveNodesAptRepositories', 'New-PveNodesAptUpdate', + 'New-PveNodesCephFs', 'New-PveNodesCephInit', 'New-PveNodesCephMds', + 'New-PveNodesCephMgr', 'New-PveNodesCephMon', 'New-PveNodesCephOsd', + 'New-PveNodesCephOsdIn', 'New-PveNodesCephOsdOut', + 'New-PveNodesCephOsdScrub', 'New-PveNodesCephPool', + 'New-PveNodesCephRestart', 'New-PveNodesCephStart', + 'New-PveNodesCephStop', 'New-PveNodesCertificatesAcmeCertificate', + 'New-PveNodesCertificatesCustom', 'New-PveNodesDisksDirectory', + 'New-PveNodesDisksInitgpt', 'New-PveNodesDisksLvm', + 'New-PveNodesDisksLvmthin', 'New-PveNodesDisksZfs', + 'New-PveNodesExecute', 'New-PveNodesFirewallRules', + 'New-PveNodesHosts', 'New-PveNodesLxc', 'New-PveNodesLxcClone', + 'New-PveNodesLxcFirewallAliases', 'New-PveNodesLxcFirewallIpset', + 'New-PveNodesLxcFirewallIpsetIdx', 'New-PveNodesLxcFirewallRules', + 'New-PveNodesLxcMigrate', 'New-PveNodesLxcMoveVolume', + 'New-PveNodesLxcMtunnel', 'New-PveNodesLxcRemoteMigrate', + 'New-PveNodesLxcSnapshot', 'New-PveNodesLxcSnapshotRollback', + 'New-PveNodesLxcSpiceproxy', 'New-PveNodesLxcStatusReboot', + 'New-PveNodesLxcStatusResume', 'New-PveNodesLxcStatusShutdown', + 'New-PveNodesLxcStatusStart', 'New-PveNodesLxcStatusStop', + 'New-PveNodesLxcStatusSuspend', 'New-PveNodesLxcTemplate', + 'New-PveNodesLxcTermproxy', 'New-PveNodesLxcVncproxy', + 'New-PveNodesMigrateall', 'New-PveNodesNetwork', 'New-PveNodesQemu', + 'New-PveNodesQemuAgent', 'New-PveNodesQemuAgentExec', + 'New-PveNodesQemuAgentFileWrite', + 'New-PveNodesQemuAgentFsfreezeFreeze', + 'New-PveNodesQemuAgentFsfreezeStatus', + 'New-PveNodesQemuAgentFsfreezeThaw', 'New-PveNodesQemuAgentFstrim', + 'New-PveNodesQemuAgentPing', 'New-PveNodesQemuAgentSetUserPassword', + 'New-PveNodesQemuAgentShutdown', 'New-PveNodesQemuAgentSuspendDisk', + 'New-PveNodesQemuAgentSuspendHybrid', + 'New-PveNodesQemuAgentSuspendRam', 'New-PveNodesQemuClone', + 'New-PveNodesQemuConfig', 'New-PveNodesQemuFirewallAliases', + 'New-PveNodesQemuFirewallIpset', 'New-PveNodesQemuFirewallIpsetIdx', + 'New-PveNodesQemuFirewallRules', 'New-PveNodesQemuMigrate', + 'New-PveNodesQemuMonitor', 'New-PveNodesQemuMoveDisk', + 'New-PveNodesQemuMtunnel', 'New-PveNodesQemuRemoteMigrate', + 'New-PveNodesQemuSnapshot', 'New-PveNodesQemuSnapshotRollback', + 'New-PveNodesQemuSpiceproxy', 'New-PveNodesQemuStatusReboot', + 'New-PveNodesQemuStatusReset', 'New-PveNodesQemuStatusResume', + 'New-PveNodesQemuStatusShutdown', 'New-PveNodesQemuStatusStart', + 'New-PveNodesQemuStatusStop', 'New-PveNodesQemuStatusSuspend', + 'New-PveNodesQemuTemplate', 'New-PveNodesQemuTermproxy', + 'New-PveNodesQemuVncproxy', 'New-PveNodesReplicationScheduleNow', + 'New-PveNodesServicesReload', 'New-PveNodesServicesRestart', + 'New-PveNodesServicesStart', 'New-PveNodesServicesStop', + 'New-PveNodesSpiceshell', 'New-PveNodesStartall', + 'New-PveNodesStatus', 'New-PveNodesStopall', + 'New-PveNodesStorageContent', 'New-PveNodesStorageContentIdx', + 'New-PveNodesStorageDownloadUrl', 'New-PveNodesStorageUpload', + 'New-PveNodesSubscription', 'New-PveNodesSuspendall', + 'New-PveNodesTermproxy', 'New-PveNodesVncshell', 'New-PveNodesVzdump', + 'New-PveNodesWakeonlan', 'New-PvePools', 'New-PveStorage', + 'New-PveVmSnapshot', 'Remove-PveAccessDomains', + 'Remove-PveAccessGroups', 'Remove-PveAccessRoles', + 'Remove-PveAccessTfa', 'Remove-PveAccessUsers', + 'Remove-PveAccessUsersToken', 'Remove-PveClusterAcmeAccount', + 'Remove-PveClusterAcmePlugins', 'Remove-PveClusterBackup', + 'Remove-PveClusterConfigNodes', 'Remove-PveClusterFirewallAliases', + 'Remove-PveClusterFirewallGroups', + 'Remove-PveClusterFirewallGroupsIdx', + 'Remove-PveClusterFirewallIpset', + 'Remove-PveClusterFirewallIpsetIdx', + 'Remove-PveClusterFirewallRules', 'Remove-PveClusterHaGroups', + 'Remove-PveClusterHaResources', 'Remove-PveClusterJobsRealmSync', + 'Remove-PveClusterMappingPci', 'Remove-PveClusterMappingUsb', + 'Remove-PveClusterMetricsServer', + 'Remove-PveClusterNotificationsEndpointsGotify', + 'Remove-PveClusterNotificationsEndpointsSendmail', + 'Remove-PveClusterNotificationsEndpointsSmtp', + 'Remove-PveClusterNotificationsMatchers', + 'Remove-PveClusterReplication', 'Remove-PveClusterSdnControllers', + 'Remove-PveClusterSdnDns', 'Remove-PveClusterSdnIpams', + 'Remove-PveClusterSdnVnets', 'Remove-PveClusterSdnVnetsIps', + 'Remove-PveClusterSdnVnetsSubnets', 'Remove-PveClusterSdnZones', + 'Remove-PveNodesCephMds', 'Remove-PveNodesCephMgr', + 'Remove-PveNodesCephMon', 'Remove-PveNodesCephOsd', + 'Remove-PveNodesCephPool', + 'Remove-PveNodesCertificatesAcmeCertificate', + 'Remove-PveNodesCertificatesCustom', + 'Remove-PveNodesDisksDirectory', 'Remove-PveNodesDisksLvm', + 'Remove-PveNodesDisksLvmthin', 'Remove-PveNodesDisksZfs', + 'Remove-PveNodesFirewallRules', 'Remove-PveNodesLxc', + 'Remove-PveNodesLxcFirewallAliases', + 'Remove-PveNodesLxcFirewallIpset', + 'Remove-PveNodesLxcFirewallIpsetIdx', + 'Remove-PveNodesLxcFirewallRules', 'Remove-PveNodesLxcSnapshot', + 'Remove-PveNodesNetwork', 'Remove-PveNodesNetworkIdx', + 'Remove-PveNodesQemu', 'Remove-PveNodesQemuFirewallAliases', + 'Remove-PveNodesQemuFirewallIpset', + 'Remove-PveNodesQemuFirewallIpsetIdx', + 'Remove-PveNodesQemuFirewallRules', 'Remove-PveNodesQemuSnapshot', + 'Remove-PveNodesStorageContent', + 'Remove-PveNodesStoragePrunebackups', 'Remove-PveNodesSubscription', + 'Remove-PveNodesTasks', 'Remove-PvePools', 'Remove-PvePoolsIdx', + 'Remove-PveStorage', 'Remove-PveVmSnapshot', 'Reset-PveVm', + 'Resume-PveVm', 'Set-PveAccessAcl', 'Set-PveAccessDomains', + 'Set-PveAccessGroups', 'Set-PveAccessPassword', 'Set-PveAccessRoles', + 'Set-PveAccessTfa', 'Set-PveAccessUsers', 'Set-PveAccessUsersToken', + 'Set-PveAccessUsersUnlockTfa', 'Set-PveClusterAcmeAccount', + 'Set-PveClusterAcmePlugins', 'Set-PveClusterBackup', + 'Set-PveClusterCephFlags', 'Set-PveClusterCephFlagsIdx', + 'Set-PveClusterFirewallAliases', 'Set-PveClusterFirewallGroups', + 'Set-PveClusterFirewallIpset', 'Set-PveClusterFirewallOptions', + 'Set-PveClusterFirewallRules', 'Set-PveClusterHaGroups', + 'Set-PveClusterHaResources', 'Set-PveClusterJobsRealmSync', + 'Set-PveClusterMappingPci', 'Set-PveClusterMappingUsb', + 'Set-PveClusterMetricsServer', + 'Set-PveClusterNotificationsEndpointsGotify', + 'Set-PveClusterNotificationsEndpointsSendmail', + 'Set-PveClusterNotificationsEndpointsSmtp', + 'Set-PveClusterNotificationsMatchers', 'Set-PveClusterOptions', + 'Set-PveClusterReplication', 'Set-PveClusterSdn', + 'Set-PveClusterSdnControllers', 'Set-PveClusterSdnDns', + 'Set-PveClusterSdnIpams', 'Set-PveClusterSdnVnets', + 'Set-PveClusterSdnVnetsIps', 'Set-PveClusterSdnVnetsSubnets', + 'Set-PveClusterSdnZones', 'Set-PveNodesAptRepositories', + 'Set-PveNodesCephPool', 'Set-PveNodesCertificatesAcmeCertificate', + 'Set-PveNodesConfig', 'Set-PveNodesDisksWipedisk', 'Set-PveNodesDns', + 'Set-PveNodesFirewallOptions', 'Set-PveNodesFirewallRules', + 'Set-PveNodesLxcConfig', 'Set-PveNodesLxcFirewallAliases', + 'Set-PveNodesLxcFirewallIpset', 'Set-PveNodesLxcFirewallOptions', + 'Set-PveNodesLxcFirewallRules', 'Set-PveNodesLxcResize', + 'Set-PveNodesLxcSnapshotConfig', 'Set-PveNodesNetwork', + 'Set-PveNodesNetworkIdx', 'Set-PveNodesQemuCloudinit', + 'Set-PveNodesQemuConfig', 'Set-PveNodesQemuFirewallAliases', + 'Set-PveNodesQemuFirewallIpset', 'Set-PveNodesQemuFirewallOptions', + 'Set-PveNodesQemuFirewallRules', 'Set-PveNodesQemuResize', + 'Set-PveNodesQemuSendkey', 'Set-PveNodesQemuSnapshotConfig', + 'Set-PveNodesQemuUnlink', 'Set-PveNodesStorageContent', + 'Set-PveNodesSubscription', 'Set-PveNodesTime', 'Set-PvePools', + 'Set-PvePoolsIdx', 'Set-PveStorage', 'Start-PveVm', 'Stop-PveVm', + 'Suspend-PveVm', 'Undo-PveVmSnapshot', 'Unlock-PveVm', 'VmCheckIdOrName', 'Wait-PveTaskIsFinish' # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export. @@ -380,12 +379,19 @@ CmdletsToExport = '*' VariablesToExport = '*' # Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export. -AliasesToExport = 'Backup-PveVzdump', 'Copy-PveLxc', 'Copy-PveQemu', 'Get-PveTasksStatus', - 'Move-PveLxc', 'Move-PveQemu', 'New-PveQemu', 'Reset-PveQemu', - 'Restart-PveLxc', 'Restart-PveQemu', 'Resume-PveLxc', 'Resume-PveQemu', - 'Show-PveSpice', 'Shutdown-PveLxc', 'Shutdown-PveQemu', 'Start-PveLxc', - 'Start-PveQemu', 'Stop-PveLxc', 'Stop-PveQemu', 'Suspend-PveLxc', - 'Suspend-PveQemu', 'Update-PveNode' +AliasesToExport = 'Backup-PveVzdump', 'Copy-PveLxc', 'Copy-PveQemu', + 'Create-PveLxcSnapshot', 'Create-PveQemuSnapshot', 'Get-PveLxcConfig', + 'Get-PveLxcSnapshot', 'Get-PveLxcSnapshotConfig', 'Get-PveQemuConfig', + 'Get-PveQemuSnapshot', 'Get-PveQemuSnapshotConfig', + 'Get-PveTasksStatus', 'Move-PveLxc', 'Move-PveQemu', 'New-PveLxc', + 'New-PveQemu', 'Remove-PveLxc', 'Remove-PveLxcSnapshot', + 'Remove-PveQemu', 'Remove-PveQemuSnapshot', 'Reset-PveQemu', + 'Restart-PveLxc', 'Restart-PveQemu', 'Resume-PveLxc', 'Resume-PveQemu', + 'Set-PveLxcConfig', 'Set-PveLxcSnapshot', 'Set-PveQemuConfig', + 'Set-PveQemuSnapshot', 'Show-PveSpice', 'Shutdown-PveLxc', + 'Shutdown-PveQemu', 'Start-PveLxc', 'Start-PveQemu', 'Stop-PveLxc', + 'Stop-PveQemu', 'Suspend-PveLxc', 'Suspend-PveQemu', + 'Undo-PveLxcSnapshot', 'Undo-PveQemuSnapshot', 'Update-PveNode' # DSC resources to export from this module # DscResourcesToExport = @() diff --git a/Tools.psm1 b/Tools.psm1 index a25ef1d..58952b7 100644 --- a/Tools.psm1 +++ b/Tools.psm1 @@ -33,6 +33,8 @@ function Invoke-PveAction { Build-AsciinemaFromPs1 -InputFile .\doc\video-commands.ps1 -OutputFile .\doc\video.cast } elseif ($Action -eq 'publish') { + $env:DOTNET_CLI_UI_LANGUAGE='en-us' + $publishModuleSplat = @{ Path = ".\Corsinvest.ProxmoxVE.Api" #Name = "Corsinvest.ProxmoxVE.Api" diff --git a/doc/index.html b/doc/index.html index 7135e42..e680723 100644 --- a/doc/index.html +++ b/doc/index.html @@ -110,11 +110,15 @@
@@ -942,6 +982,323 @@

Build documentation

The default file.

+
+
+

New-PveNodesVzdump

+

+

Create backup.

+
+
+

Syntax

+
+
+
+ New-PveNodesVzdump [[-PveTicket] <PveTicket>] [-All] [[-Bwlimit] <Int32>] [[-Compress] <String>] [[-Dumpdir] <String>] [[-Exclude] <String>] [[-ExcludePath] <Array>] [[-Fleecing] <String>] [[-Ionice] <Int32>] [[-Lockwait] <Int32>] [[-Mailnotification] <String>] [[-Mailto] <String>] [[-Maxfiles] <Int32>] [[-Mode] <String>] [[-Node] <String>] [[-NotesTemplate] <String>] [[-NotificationMode] <String>] [[-NotificationPolicy] <String>] [[-NotificationTarget] <String>] [[-Performance] <String>] [[-Pigz] <Int32>] [[-Pool] <String>] [-Protected] [[-PruneBackups] <String>] [-Quiet] [-Remove] [[-Script] <String>] [-Stdexcludes] [-Stdout] [-Stop] [[-Stopwait] <Int32>] [[-Storage] <String>] [[-Tmpdir] <String>] [[-Vmid] <String>] [[-Zstd] <Int32>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-AllBackup all known guest systems on this host.falsetrue (ByPropertyName)False
-BwlimitLimit I/O bandwidth (in KiB/s).falsetrue (ByPropertyName)0
-CompressCompress dump file. Enum: 0,1,gzip,lzo,zstdfalsetrue (ByPropertyName)
-DumpdirStore resulting files to specified directory.falsetrue (ByPropertyName)
-ExcludeExclude specified guest systems (assumes --all)falsetrue (ByPropertyName)
-ExcludePathExclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory.falsetrue (ByPropertyName)
-FleecingOptions for backup fleecing (VM only).falsetrue (ByPropertyName)
-IoniceSet IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value.falsetrue (ByPropertyName)0
-LockwaitMaximal time to wait for the global lock (minutes).falsetrue (ByPropertyName)0
-MailnotificationDeprecated':' use notification targets/matchers instead. Specify when to send a notification mail Enum: always,failurefalsetrue (ByPropertyName)
-MailtoDeprecated':' Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications.falsetrue (ByPropertyName)
-MaxfilesDeprecated':' use 'prune-backups' instead. Maximal number of backup files per guest system.falsetrue (ByPropertyName)0
-ModeBackup mode. Enum: snapshot,suspend,stopfalsetrue (ByPropertyName)
-NodeOnly run if executed on this node.falsetrue (ByPropertyName)
-NotesTemplateTemplate string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively.falsetrue (ByPropertyName)
-NotificationModeDetermine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not. Enum: auto,legacy-sendmail,notification-systemfalsetrue (ByPropertyName)
-NotificationPolicyDeprecated':' Do not use Enum: always,failure,neverfalsetrue (ByPropertyName)
-NotificationTargetDeprecated':' Do not usefalsetrue (ByPropertyName)
-PerformanceOther performance-related settings.falsetrue (ByPropertyName)
-PigzUse pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.falsetrue (ByPropertyName)0
-PoolBackup all known guest systems included in the specified pool.falsetrue (ByPropertyName)
-ProtectedIf true, mark backup(s) as protected.falsetrue (ByPropertyName)False
-PruneBackupsUse these retention options instead of those from the storage configuration.falsetrue (ByPropertyName)
-QuietBe quiet.falsetrue (ByPropertyName)False
-RemovePrune older backups according to 'prune-backups'.falsetrue (ByPropertyName)False
-ScriptUse specified hook script.falsetrue (ByPropertyName)
-StdexcludesExclude temporary files and logs.falsetrue (ByPropertyName)False
-StdoutWrite tar to stdout, not to a file.falsetrue (ByPropertyName)False
-StopStop running backup jobs on this host.falsetrue (ByPropertyName)False
-StopwaitMaximal time to wait until a guest system is stopped (minutes).falsetrue (ByPropertyName)0
-StorageStore resulting file to this storage.falsetrue (ByPropertyName)
-TmpdirStore temporary files to specified directory.falsetrue (ByPropertyName)
-VmidThe ID of the guest system you want to backup.falsetrue (ByPropertyName)
-ZstdZstd threads. N=0 uses half of the available cores, if N is set to a value bigger than 0, N is used as thread count.falsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+

Build-PveDocumentation

@@ -1180,18 +1537,18 @@

Outputs

  • [Int32]. Return Unix Time.
-
+
-

Enter-PveSpice

+

New-PveNodesLxcClone

-

Enter Spice VM.

+

Create a container clone/copy

Syntax

- Enter-PveSpice [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [-Viewer] <String> [<CommonParameters>] + New-PveNodesLxcClone [[-PveTicket] <PveTicket>] [[-Bwlimit] <Single>] [[-Description] <String>] [-Full] [[-Hostname] <String>] [-Newid] <Int32> [-Node] <String> [[-Pool] <String>] [[-Snapname] <String>] [[-Storage] <String>] [[-Target] <String>] [-Vmid] <Int32> [<CommonParameters>]
@@ -1213,25 +1570,400 @@

Parameters

Ticket data connection. false - true (ByValue, ByPropertyName) + true (ByPropertyName) - -VmIdOrName + -Bwlimit - The (unique) ID or Name of the VM. + Override I/O bandwidth limit (in KiB/s). + false + true (ByPropertyName) + 0 + + + -Description + + Description for the new CT. + false + true (ByPropertyName) + + + + -Full + + Create a full copy of all disks. This is always done when you clone a normal CT. For CT templates, we try to create a linked clone by default. + false + true (ByPropertyName) + False + + + -Hostname + + Set a hostname for the new CT. + false + true (ByPropertyName) + + + + -Newid + + VMID for the clone. true - true (ByValue, ByPropertyName) + true (ByPropertyName) + 0 + + + -Node + + The cluster node name. + true + true (ByPropertyName) - -Viewer + -Pool - Path of Spice remove viewer.- Linux /usr/bin/remote-viewer- Windows C:\Program Files\VirtViewer v?.?-???\bin\remote-viewer.exe + Add the new CT to the specified pool. + false + true (ByPropertyName) + + + + -Snapname + + The name of the snapshot. + false + true (ByPropertyName) + + + + -Storage + + Target storage for full clone. + false + true (ByPropertyName) + + + + -Target + + Target node. Only allowed if the original VM is on shared storage. + false + true (ByPropertyName) + + + + -Vmid + + The (unique) ID of the VM. true - true (ByValue, ByPropertyName) + true (ByPropertyName) + 0 + + + +
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

New-PveNodesQemuClone

+

+

Create a copy of virtual machine/template.

+
+
+

Syntax

+
+
+
+ New-PveNodesQemuClone [[-PveTicket] <PveTicket>] [[-Bwlimit] <Int32>] [[-Description] <String>] [[-Format] <String>] [-Full] [[-Name] <String>] [-Newid] <Int32> [-Node] <String> [[-Pool] <String>] [[-Snapname] <String>] [[-Storage] <String>] [[-Target] <String>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-BwlimitOverride I/O bandwidth limit (in KiB/s).falsetrue (ByPropertyName)0
-DescriptionDescription for the new VM.falsetrue (ByPropertyName)
-FormatTarget format for file storage. Only valid for full clone. Enum: raw,qcow2,vmdkfalsetrue (ByPropertyName)
-FullCreate a full copy of all disks. This is always done when you clone a normal VM. For VM templates, we try to create a linked clone by default.falsetrue (ByPropertyName)False
-NameSet a name for the new VM.falsetrue (ByPropertyName)
-NewidVMID for the clone.truetrue (ByPropertyName)0
-NodeThe cluster node name.truetrue (ByPropertyName)
-PoolAdd the new VM to the specified pool.falsetrue (ByPropertyName)
-SnapnameThe name of the snapshot.falsetrue (ByPropertyName)
-StorageTarget storage for full clone.falsetrue (ByPropertyName)
-TargetTarget node. Only allowed if the original VM is on shared storage.falsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

New-PveNodesLxcSnapshot

+

+

Snapshot a container.

+
+
+

Syntax

+
+
+
+ New-PveNodesLxcSnapshot [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DescriptionA textual description or comment.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-SnapnameThe name of the snapshot.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

New-PveNodesQemuSnapshot

+

+

Snapshot a VM.

+
+
+

Syntax

+
+
+
+ New-PveNodesQemuSnapshot [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [-Vmstate] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DescriptionA textual description or comment.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-SnapnameThe name of the snapshot.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
-VmstateSave the vmstatefalsetrue (ByPropertyName)False
@@ -6794,18 +7526,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Get-PveNode

+

Get-PveNodesLxcConfig

-

Get nodes

+

Get container configuration.

Syntax

- Get-PveNode [[-PveTicket] <PveTicket>] [[-Node] <String>] [<CommonParameters>] + Get-PveNodesLxcConfig [[-PveTicket] <PveTicket>] [-Current] [-Node] <String> [[-Snapshot] <String>] [-Vmid] <Int32> [<CommonParameters>]
@@ -6827,62 +7559,41 @@

Parameters

Ticket data connection. false - true (ByValue, ByPropertyName) + true (ByPropertyName) - -Node + -Current - The Name of the node. + Get current values (instead of pending values). false - true (ByValue, ByPropertyName) + true (ByPropertyName) + False + + + -Node + + The cluster node name. + true + true (ByPropertyName) - - -
-
-

Outputs

-

The output type is the type of the objects that the cmdlet emits.

-
  • PSCustomObject. Return Node/s data.
-
-
-
-
-

Get-PveNodes

-

-

Cluster node index.

-
-
-

Syntax

-
-
-
- Get-PveNodes [[-PveTicket] <PveTicket>] [<CommonParameters>] -
-
-
-

Parameters

- - - - - - - - - - - - - + - + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicket-Snapshot Ticket data connection.Fetch config values from given snapshot. false true (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
@@ -6892,18 +7603,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Get-PveNodesAplinfo

+

Get-PveNodesLxcSnapshot

-

Get list of appliances.

+

List all snapshots.

Syntax

- Get-PveNodesAplinfo [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] + Get-PveNodesLxcSnapshot [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
@@ -6936,6 +7647,14 @@

Parameters

true (ByPropertyName) + + -Vmid + + The (unique) ID of the VM. + true + true (ByPropertyName) + 0 +
@@ -6945,18 +7664,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Get-PveNodesApt

+

Get-PveNodesLxcSnapshotConfig

-

Directory index for apt (Advanced Package Tool).

+

Get snapshot configuration

Syntax

- Get-PveNodesApt [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] + Get-PveNodesLxcSnapshotConfig [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
@@ -6989,6 +7708,22 @@

Parameters

true (ByPropertyName) + + -Snapname + + The name of the snapshot. + true + true (ByPropertyName) + + + + -Vmid + + The (unique) ID of the VM. + true + true (ByPropertyName) + 0 +
@@ -6998,18 +7733,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Get-PveNodesAptChangelog

+

Get-PveNode

-

Get package changelogs.

+

Get nodes

Syntax

- Get-PveNodesAptChangelog [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [[-Version] <String>] [<CommonParameters>] + Get-PveNode [[-PveTicket] <PveTicket>] [[-Node] <String>] [<CommonParameters>]
@@ -7031,31 +7766,15 @@

Parameters

Ticket data connection. false - true (ByPropertyName) - - - - -Name - - Package name. - true - true (ByPropertyName) + true (ByValue, ByPropertyName) -Node - The cluster node name. - true - true (ByPropertyName) - - - - -Version - - Package version. + The Name of the node. false - true (ByPropertyName) + true (ByValue, ByPropertyName) @@ -7064,21 +7783,21 @@

Parameters

Outputs

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
+
  • PSCustomObject. Return Node/s data.
-
+
-

Get-PveNodesAptRepositories

+

Get-PveNodes

-

Get APT repository information.

+

Cluster node index.

Syntax

- Get-PveNodesAptRepositories [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] + Get-PveNodes [[-PveTicket] <PveTicket>] [<CommonParameters>]
@@ -7103,14 +7822,6 @@

Parameters

true (ByPropertyName) - - -Node - - The cluster node name. - true - true (ByPropertyName) - -
@@ -7120,18 +7831,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Get-PveNodesAptUpdate

+

Get-PveNodesAplinfo

-

List available updates.

+

Get list of appliances.

Syntax

- Get-PveNodesAptUpdate [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] + Get-PveNodesAplinfo [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
@@ -7173,18 +7884,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Get-PveNodesAptVersions

+

Get-PveNodesApt

-

Get package information for important Proxmox packages.

+

Directory index for apt (Advanced Package Tool).

Syntax

- Get-PveNodesAptVersions [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] + Get-PveNodesApt [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
@@ -7226,18 +7937,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Get-PveNodesCapabilities

+

Get-PveNodesAptChangelog

-

Node capabilities index.

+

Get package changelogs.

Syntax

- Get-PveNodesCapabilities [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] + Get-PveNodesAptChangelog [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [[-Version] <String>] [<CommonParameters>]
@@ -7262,6 +7973,14 @@

Parameters

true (ByPropertyName) + + -Name + + Package name. + true + true (ByPropertyName) + + -Node @@ -7270,6 +7989,14 @@

Parameters

true (ByPropertyName) + + -Version + + Package version. + false + true (ByPropertyName) + +
@@ -7279,18 +8006,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Get-PveNodesCapabilitiesQemu

+

Get-PveNodesAptRepositories

-

QEMU capabilities index.

+

Get APT repository information.

Syntax

- Get-PveNodesCapabilitiesQemu [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] + Get-PveNodesAptRepositories [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
@@ -7332,18 +8059,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Get-PveNodesCapabilitiesQemuCpu

+

Get-PveNodesAptUpdate

-

List all custom and default CPU models.

+

List available updates.

Syntax

- Get-PveNodesCapabilitiesQemuCpu [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] + Get-PveNodesAptUpdate [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
@@ -7385,18 +8112,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Get-PveNodesCapabilitiesQemuMachines

+

Get-PveNodesAptVersions

-

Get available QEMU/KVM machine types.

+

Get package information for important Proxmox packages.

Syntax

- Get-PveNodesCapabilitiesQemuMachines [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] + Get-PveNodesAptVersions [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
@@ -7438,18 +8165,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Get-PveNodesCeph

+

Get-PveNodesCapabilities

-

Directory index.

+

Node capabilities index.

Syntax

- Get-PveNodesCeph [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] + Get-PveNodesCapabilities [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
@@ -7491,18 +8218,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Get-PveNodesCephCfg

+

Get-PveNodesCapabilitiesQemu

-

Directory index.

+

QEMU capabilities index.

Syntax

- Get-PveNodesCephCfg [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] + Get-PveNodesCapabilitiesQemu [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
@@ -7544,18 +8271,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Get-PveNodesCephCfgDb

+

Get-PveNodesCapabilitiesQemuCpu

-

Get the Ceph configuration database.

+

List all custom and default CPU models.

Syntax

- Get-PveNodesCephCfgDb [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] + Get-PveNodesCapabilitiesQemuCpu [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
@@ -7597,18 +8324,230 @@

Outputs

  • PveResponse. Return response.
-
+
-

Get-PveNodesCephCfgRaw

+

Get-PveNodesCapabilitiesQemuMachines

-

Get the Ceph configuration file.

+

Get available QEMU/KVM machine types.

Syntax

- Get-PveNodesCephCfgRaw [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] + Get-PveNodesCapabilitiesQemuMachines [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Get-PveNodesCeph

+

+

Directory index.

+
+
+

Syntax

+
+
+
+ Get-PveNodesCeph [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Get-PveNodesCephCfg

+

+

Directory index.

+
+
+

Syntax

+
+
+
+ Get-PveNodesCephCfg [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Get-PveNodesCephCfgDb

+

+

Get the Ceph configuration database.

+
+
+

Syntax

+
+
+
+ Get-PveNodesCephCfgDb [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Get-PveNodesCephCfgRaw

+

+

Get the Ceph configuration file.

+
+
+

Syntax

+
+
+
+ Get-PveNodesCephCfgRaw [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
@@ -10260,6 +11199,16 @@

Get-PveNodesLxcConfig

Get container configuration.

+
+
+

Aliases

+
+
+
    +
  • Get-PveLxcConfig
    • +
+
+

Syntax

@@ -11518,6 +12467,16 @@

Get-PveNodesLxcSnapshot

List all snapshots.

+
+
+

Aliases

+
+
+
    +
  • Get-PveLxcSnapshot
    • +
+
+

Syntax

@@ -11579,6 +12538,16 @@

Get-PveNodesLxcSnapshotConfig

Get snapshot configuration

+
+
+

Aliases

+
+
+
    +
  • Get-PveLxcSnapshotConfig
    • +
+
+

Syntax

@@ -13152,6 +14121,16 @@

Get-PveNodesQemuConfig

Get the virtual machine configuration with pending configuration changes applied. Set the 'current' parameter to get the current configuration instead.

+
+
+

Aliases

+
+
+
    +
  • Get-PveQemuConfig
    • +
+
+

Syntax

@@ -14418,6 +15397,16 @@

Get-PveNodesQemuSnapshot

List all snapshots.

+
+
+

Aliases

+
+
+
    +
  • Get-PveQemuSnapshot
    • +
+
+

Syntax

@@ -14479,6 +15468,16 @@

Get-PveNodesQemuSnapshotConfig

Get snapshot configuration

+
+
+

Aliases

+
+
+
    +
  • Get-PveQemuSnapshotConfig
    • +
+
+

Syntax

@@ -17967,18 +18966,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Get-PveStorage

+

Get-PveNodesQemuConfig

-

Storage index.

+

Get the virtual machine configuration with pending configuration changes applied. Set the 'current' parameter to get the current configuration instead.

Syntax

- Get-PveStorage [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>] + Get-PveNodesQemuConfig [[-PveTicket] <PveTicket>] [-Current] [-Node] <String> [[-Snapshot] <String>] [-Vmid] <Int32> [<CommonParameters>]
@@ -18004,13 +19003,37 @@

Parameters

- -Type + -Current - Only list storage of specific type Enum: btrfs,cephfs,cifs,dir,esxi,glusterfs,iscsi,iscsidirect,lvm,lvmthin,nfs,pbs,rbd,zfs,zfspool + Get current values (instead of pending values). false true (ByPropertyName) + False + + + -Node + + The cluster node name. + true + true (ByPropertyName) + + -Snapshot + + Fetch config values from given snapshot. + false + true (ByPropertyName) + + + + -Vmid + + The (unique) ID of the VM. + true + true (ByPropertyName) + 0 +
@@ -18020,18 +19043,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Get-PveStorageIdx

+

Get-PveNodesQemuSnapshot

-

Read storage configuration.

+

List all snapshots.

Syntax

- Get-PveStorageIdx [[-PveTicket] <PveTicket>] [-Storage] <String> [<CommonParameters>] + Get-PveNodesQemuSnapshot [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
@@ -18057,13 +19080,21 @@

Parameters

- -Storage + -Node - The storage identifier. + The cluster node name. true true (ByPropertyName) + + -Vmid + + The (unique) ID of the VM. + true + true (ByPropertyName) + 0 +
@@ -18073,18 +19104,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Get-PveTaskIsRunning

+

Get-PveNodesQemuSnapshotConfig

-

Get task is running.

+

Get snapshot configuration

Syntax

- Get-PveTaskIsRunning [[-PveTicket] <PveTicket>] [-Upid] <String> [<CommonParameters>] + Get-PveNodesQemuSnapshotConfig [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
@@ -18106,38 +19137,54 @@

Parameters

Ticket data connection. false - true (ByValue, ByPropertyName) + true (ByPropertyName) - -Upid + -Node - Upid task e.g UPID:pve1:00004A1A:0964214C:5EECEF11:vzdump:134:root@pam: + The cluster node name. true - true (ByValue, ByPropertyName) + true (ByPropertyName) + + -Snapname + + The name of the snapshot. + true + true (ByPropertyName) + + + + -Vmid + + The (unique) ID of the VM. + true + true (ByPropertyName) + 0 +

Outputs

The output type is the type of the objects that the cmdlet emits.

-
  • Bool. Return tas is running.
+
  • PveResponse. Return response.
-
+
-

Get-PveVersion

+

Get-PveStorage

-

API version details, including some parts of the global datacenter config.

+

Storage index.

Syntax

- Get-PveVersion [[-PveTicket] <PveTicket>] [<CommonParameters>] + Get-PveStorage [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>]
@@ -18162,6 +19209,14 @@

Parameters

true (ByPropertyName) + + -Type + + Only list storage of specific type Enum: btrfs,cephfs,cifs,dir,esxi,glusterfs,iscsi,iscsidirect,lvm,lvmthin,nfs,pbs,rbd,zfs,zfspool + false + true (ByPropertyName) + +
@@ -18171,18 +19226,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Get-PveVm

+

Get-PveStorageIdx

-

Get VMs/CTs from id or name.

+

Read storage configuration.

Syntax

- Get-PveVm [[-PveTicket] <PveTicket>] [[-VmIdOrName] <String>] [<CommonParameters>] + Get-PveStorageIdx [[-PveTicket] <PveTicket>] [-Storage] <String> [<CommonParameters>]
@@ -18204,15 +19259,15 @@

Parameters

Ticket data connection. false - true (ByValue, ByPropertyName) + true (ByPropertyName) - -VmIdOrName + -Storage - The id or name VM/CT comma separated (eg. 100,101,102,TestDebian)-vmid or -name exclude (e.g. -200,-TestUbuntu)range 100:107,-105,200:204'@pool-???' for all VM/CT in specific pool (e.g. @pool-customer1),'@tag-???' for all VM/CT in specific tags (e.g. @tag-customerA),'@node-???' for all VM/CT in specific node (e.g. @node-pve1, @node-\$(hostname)),'@all-???' for all VM/CT in specific host (e.g. @all-pve1, @all-\$(hostname)),'@all' for all VM/CT in cluster"; - false - true (ByValue, ByPropertyName) + The storage identifier. + true + true (ByPropertyName) @@ -18221,21 +19276,21 @@

Parameters

Outputs

The output type is the type of the objects that the cmdlet emits.

-
  • PSCustomObject. Return Vm/s data.
+
  • PveResponse. Return response.
-
+
-

Get-PveVmSnapshot

+

Get-PveTaskIsRunning

-

Get snapshots VM.

+

Get task is running.

Syntax

- Get-PveVmSnapshot [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>] + Get-PveTaskIsRunning [[-PveTicket] <PveTicket>] [-Upid] <String> [<CommonParameters>]
@@ -18261,9 +19316,9 @@

Parameters

- -VmIdOrName + -Upid - The (unique) ID or Name of the VM. + Upid task e.g UPID:pve1:00004A1A:0964214C:5EECEF11:vzdump:134:root@pam: true true (ByValue, ByPropertyName) @@ -18274,21 +19329,21 @@

Parameters

Outputs

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
+
  • Bool. Return tas is running.
-
+
-

Invoke-PveRestApi

+

Get-PveNodesTasksStatus

-

Invoke Proxmox VE Rest API

+

Read task status.

Syntax

- Invoke-PveRestApi [[-PveTicket] <PveTicket>] [-Resource] <String> [[-Method] <String>] [[-ResponseType] <String>] [[-Parameters] <Hashtable>] [<CommonParameters>] + Get-PveNodesTasksStatus [[-PveTicket] <PveTicket>] [-Node] <String> [-Upid] <String> [<CommonParameters>]
@@ -18308,41 +19363,25 @@

Parameters

-PveTicket - Ticket data + Ticket data connection. false - true (ByValue, ByPropertyName) + true (ByPropertyName) - -Resource + -Node - Resource Request + The cluster node name. true - false + true (ByPropertyName) - -Method - - Method request - false - false - Get - - - -ResponseType - - Type request - false - false - json - - - -Parameters + -Upid - Parameters request - false - false + The task's unique ID. + true + true (ByPropertyName) @@ -18351,48 +19390,276 @@

Parameters

Outputs

The output type is the type of the objects that the cmdlet emits.

-
  • Return object request
+
  • PveResponse. Return response.
-
-
-

Note

+
+
+
+

Get-PveVersion

+

+

API version details, including some parts of the global datacenter config.

-
This must be used before any other cmdlets are used
+
+

Syntax

-
-

Examples

+
+
+ Get-PveVersion [[-PveTicket] <PveTicket>] [<CommonParameters>]
-
-
-EXAMPLE 1 - $PveTicket = Connect-PveCluster -HostsAndPorts '192.168.128.115' -Credentials (Get-Credential -Username 'root'). -(Invoke-PveRestApi -PveTicket $PveTicket -Method Get -Resource '/version').Resonse.data -
data----@{version=5.4; release=15; repoid=d0ec33c6; keyboard=it}
-
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
-
+
-

Invoke-PveSpice

+

Get-PveVm

-

Enter Spice VM.

-
-
-
-

Aliases

-
-
-
    -
  • Show-PveSpice
    • -
-
+

Get VMs/CTs from id or name.

Syntax

- Invoke-PveSpice [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [-Viewer] <String> [<CommonParameters>] + Get-PveVm [[-PveTicket] <PveTicket>] [[-VmIdOrName] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByValue, ByPropertyName)
-VmIdOrNameThe id or name VM/CT comma separated (eg. 100,101,102,TestDebian)-vmid or -name exclude (e.g. -200,-TestUbuntu)range 100:107,-105,200:204'@pool-???' for all VM/CT in specific pool (e.g. @pool-customer1),'@tag-???' for all VM/CT in specific tags (e.g. @tag-customerA),'@node-???' for all VM/CT in specific node (e.g. @node-pve1, @node-\$(hostname)),'@all-???' for all VM/CT in specific host (e.g. @all-pve1, @all-\$(hostname)),'@all' for all VM/CT in cluster";falsetrue (ByValue, ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PSCustomObject. Return Vm/s data.
+
+
+
+
+

Get-PveVmSnapshot

+

+

Get snapshots VM.

+
+
+

Syntax

+
+
+
+ Get-PveVmSnapshot [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByValue, ByPropertyName)
-VmIdOrNameThe (unique) ID or Name of the VM.truetrue (ByValue, ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Invoke-PveRestApi

+

+

Invoke Proxmox VE Rest API

+
+
+

Syntax

+
+
+
+ Invoke-PveRestApi [[-PveTicket] <PveTicket>] [-Resource] <String> [[-Method] <String>] [[-ResponseType] <String>] [[-Parameters] <Hashtable>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket datafalsetrue (ByValue, ByPropertyName)
-ResourceResource Requesttruefalse
-MethodMethod requestfalsefalseGet
-ResponseTypeType requestfalsefalsejson
-ParametersParameters requestfalsefalse
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • Return object request
+
+
+
+

Note

+
+
This must be used before any other cmdlets are used
+
+
+

Examples

+
+
+
+EXAMPLE 1 + $PveTicket = Connect-PveCluster -HostsAndPorts '192.168.128.115' -Credentials (Get-Credential -Username 'root'). +(Invoke-PveRestApi -PveTicket $PveTicket -Method Get -Resource '/version').Resonse.data +
data----@{version=5.4; release=15; repoid=d0ec33c6; keyboard=it}
+
+
+
+
+
+

Invoke-PveSpice

+

+

Enter Spice VM.

+
+
+
+

Aliases

+
+
+
    +
  • Show-PveSpice
    • +
+
+
+
+

Syntax

+
+
+
+ Invoke-PveSpice [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [-Viewer] <String> [<CommonParameters>]
@@ -18471,6 +19738,240 @@

Parameters

+
+
+
+

New-PveNodesLxcMigrate

+

+

Migrate the container to another node. Creates a new migration task.

+
+
+

Syntax

+
+
+
+ New-PveNodesLxcMigrate [[-PveTicket] <PveTicket>] [[-Bwlimit] <Single>] [-Node] <String> [-Online] [-Restart] [-Target] <String> [[-TargetStorage] <String>] [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-BwlimitOverride I/O bandwidth limit (in KiB/s).falsetrue (ByPropertyName)0
-NodeThe cluster node name.truetrue (ByPropertyName)
-OnlineUse online/live migration.falsetrue (ByPropertyName)False
-RestartUse restart migrationfalsetrue (ByPropertyName)False
-TargetTarget node.truetrue (ByPropertyName)
-TargetStorageMapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself.falsetrue (ByPropertyName)
-TimeoutTimeout in seconds for shutdown for restart migrationfalsetrue (ByPropertyName)0
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

New-PveNodesQemuMigrate

+

+

Migrate virtual machine. Creates a new migration task.

+
+
+

Syntax

+
+
+
+ New-PveNodesQemuMigrate [[-PveTicket] <PveTicket>] [[-Bwlimit] <Int32>] [-Force] [[-MigrationNetwork] <String>] [[-MigrationType] <String>] [-Node] <String> [-Online] [-Target] <String> [[-Targetstorage] <String>] [-Vmid] <Int32> [-WithLocalDisks] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-BwlimitOverride I/O bandwidth limit (in KiB/s).falsetrue (ByPropertyName)0
-ForceAllow to migrate VMs which use local devices. Only root may use this option.falsetrue (ByPropertyName)False
-MigrationNetworkCIDR of the (sub) network that is used for migration.falsetrue (ByPropertyName)
-MigrationTypeMigration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. Enum: secure,insecurefalsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-OnlineUse online/live migration if VM is running. Ignored if VM is stopped.falsetrue (ByPropertyName)False
-TargetTarget node.truetrue (ByPropertyName)
-TargetstorageMapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself.falsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
-WithLocalDisksEnable live storage migration for local diskfalsetrue (ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
@@ -23220,6 +24721,395 @@

Parameters

+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

New-PveNodesLxc

+

+

Create or restore a container.

+
+
+

Syntax

+
+
+
+ New-PveNodesLxc [[-PveTicket] <PveTicket>] [[-Arch] <String>] [[-Bwlimit] <Single>] [[-Cmode] <String>] [-Console] [[-Cores] <Int32>] [[-Cpulimit] <Single>] [[-Cpuunits] <Int32>] [-Debug_] [[-Description] <String>] [[-DevN] <Hashtable>] [[-Features] <String>] [-Force] [[-Hookscript] <String>] [[-Hostname] <String>] [-IgnoreUnpackErrors] [[-Lock] <String>] [[-Memory] <Int32>] [[-MpN] <Hashtable>] [[-Nameserver] <String>] [[-NetN] <Hashtable>] [-Node] <String> [-Onboot] [-Ostemplate] <String> [[-Ostype] <String>] [[-Password] <SecureString>] [[-Pool] <String>] [-Protection] [-Restore] [[-Rootfs] <String>] [[-Searchdomain] <String>] [[-SshPublicKeys] <String>] [-Start] [[-Startup] <String>] [[-Storage] <String>] [[-Swap] <Int32>] [[-Tags] <String>] [-Template] [[-Timezone] <String>] [[-Tty] <Int32>] [-Unique] [-Unprivileged] [[-UnusedN] <Hashtable>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ArchOS architecture type. Enum: amd64,i386,arm64,armhf,riscv32,riscv64falsetrue (ByPropertyName)
-BwlimitOverride I/O bandwidth limit (in KiB/s).falsetrue (ByPropertyName)0
-CmodeConsole mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login). Enum: shell,console,ttyfalsetrue (ByPropertyName)
-ConsoleAttach a console device (/dev/console) to the container.falsetrue (ByPropertyName)False
-CoresThe number of cores assigned to the container. A container can use all available cores by default.falsetrue (ByPropertyName)0
-CpulimitLimit of CPU usage.NOTE':' If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.falsetrue (ByPropertyName)0
-CpuunitsCPU weight for a container, will be clamped to \[1, 10000] in cgroup v2.falsetrue (ByPropertyName)0
-Debug_Try to be more verbose. For now this only enables debug log-level on start.falsetrue (ByPropertyName)False
-DescriptionDescription for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.falsetrue (ByPropertyName)
-DevNDevice to pass through to the containerfalsetrue (ByPropertyName)
-FeaturesAllow containers access to advanced features.falsetrue (ByPropertyName)
-ForceAllow to overwrite existing container.falsetrue (ByPropertyName)False
-HookscriptScript that will be exectued during various steps in the containers lifetime.falsetrue (ByPropertyName)
-HostnameSet a host name for the container.falsetrue (ByPropertyName)
-IgnoreUnpackErrorsIgnore errors when extracting the template.falsetrue (ByPropertyName)False
-LockLock/unlock the container. Enum: backup,create,destroyed,disk,fstrim,migrate,mounted,rollback,snapshot,snapshot-deletefalsetrue (ByPropertyName)
-MemoryAmount of RAM for the container in MB.falsetrue (ByPropertyName)0
-MpNUse volume as container mount point. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume.falsetrue (ByPropertyName)
-NameserverSets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.falsetrue (ByPropertyName)
-NetNSpecifies network interfaces for the container.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-OnbootSpecifies whether a container will be started during system bootup.falsetrue (ByPropertyName)False
-OstemplateThe OS template or backup file.truetrue (ByPropertyName)
-OstypeOS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. Enum: debian,devuan,ubuntu,centos,fedora,opensuse,archlinux,alpine,gentoo,nixos,unmanagedfalsetrue (ByPropertyName)
-PasswordSets root password inside container.falsetrue (ByPropertyName)
-PoolAdd the VM to the specified pool.falsetrue (ByPropertyName)
-ProtectionSets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.falsetrue (ByPropertyName)False
-RestoreMark this as restore task.falsetrue (ByPropertyName)False
-RootfsUse volume as container root.falsetrue (ByPropertyName)
-SearchdomainSets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.falsetrue (ByPropertyName)
-SshPublicKeysSetup public SSH keys (one key per line, OpenSSH format).falsetrue (ByPropertyName)
-StartStart the CT after its creation finished successfully.falsetrue (ByPropertyName)False
-StartupStartup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.falsetrue (ByPropertyName)
-StorageDefault Storage.falsetrue (ByPropertyName)
-SwapAmount of SWAP for the container in MB.falsetrue (ByPropertyName)0
-TagsTags of the Container. This is only meta information.falsetrue (ByPropertyName)
-TemplateEnable/disable Template.falsetrue (ByPropertyName)False
-TimezoneTime zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tabfalsetrue (ByPropertyName)
-TtySpecify the number of tty available to the containerfalsetrue (ByPropertyName)0
-UniqueAssign a unique random ethernet address.falsetrue (ByPropertyName)False
-UnprivilegedMakes the container run as unprivileged user. (Should not be modified manually.)falsetrue (ByPropertyName)False
-UnusedNReference to unused volumes. This is used internally, and should not be modified manually.falsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+

Outputs

The output type is the type of the objects that the cmdlet emits.

@@ -25348,6 +27238,16 @@

New-PveNodesLxc

Create or restore a container.

+
+
+

Aliases

+
+
+
    +
  • New-PveLxc
    • +
+
+

Syntax

@@ -26786,6 +28686,16 @@

New-PveNodesLxcSnapshot

Snapshot a container.

+
+
+

Aliases

+
+
+
    +
  • Create-PveLxcSnapshot
    • +
+
+

Syntax

@@ -26863,6 +28773,16 @@

New-PveNodesLxcSnapshotRollback

Rollback LXC state to specified snapshot.

+
+
+

Aliases

+
+
+
    +
  • Undo-PveLxcSnapshot
    • +
+
+

Syntax

@@ -31527,244 +33447,13 @@

New-PveNodesQemuSnapshot

Snapshot a VM.

-
-

Syntax

-
-
-
- New-PveNodesQemuSnapshot [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [-Vmstate] [<CommonParameters>] -
-
-
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DescriptionA textual description or comment.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-SnapnameThe name of the snapshot.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
-VmstateSave the vmstatefalsetrue (ByPropertyName)False
-
-
-

Outputs

-

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
-
-
-
-
-

New-PveNodesQemuSnapshotRollback

-

-

Rollback VM state to specified snapshot.

-
-
-

Syntax

-
-
-
- New-PveNodesQemuSnapshotRollback [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Start] [-Vmid] <Int32> [<CommonParameters>] -
-
-
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-SnapnameThe name of the snapshot.truetrue (ByPropertyName)
-StartWhether the VM should get started after rolling back successfully. (Note':' VMs will be automatically started if the snapshot includes RAM.)falsetrue (ByPropertyName)False
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
-
-
-

Outputs

-

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
-
-
-
-
-

New-PveNodesQemuSpiceproxy

-

-

Returns a SPICE configuration to connect to the VM.

-
-
-

Syntax

-
-
-
- New-PveNodesQemuSpiceproxy [[-PveTicket] <PveTicket>] [-Node] <String> [[-Proxy] <String>] [-Vmid] <Int32> [<CommonParameters>] -
-
-
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-ProxySPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As reasonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI).falsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
-
-
-

Outputs

-

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
-
-
-
-
-

New-PveNodesQemuStatusReboot

-

-

Reboot the VM by shutting it down, and starting it again. Applies pending changes.

-

Aliases

    -
  • Restart-PveQemu
    • +
  • Create-PveQemuSnapshot
@@ -31773,7 +33462,258 @@

Syntax

- New-PveNodesQemuStatusReboot [[-PveTicket] <PveTicket>] [-Node] <String> [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>] + New-PveNodesQemuSnapshot [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [-Vmstate] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DescriptionA textual description or comment.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-SnapnameThe name of the snapshot.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
-VmstateSave the vmstatefalsetrue (ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

New-PveNodesQemuSnapshotRollback

+

+

Rollback VM state to specified snapshot.

+
+
+
+

Aliases

+
+
+
    +
  • Undo-PveQemuSnapshot
    • +
+
+
+
+

Syntax

+
+
+
+ New-PveNodesQemuSnapshotRollback [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Start] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-SnapnameThe name of the snapshot.truetrue (ByPropertyName)
-StartWhether the VM should get started after rolling back successfully. (Note':' VMs will be automatically started if the snapshot includes RAM.)falsetrue (ByPropertyName)False
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

New-PveNodesQemuSpiceproxy

+

+

Returns a SPICE configuration to connect to the VM.

+
+
+

Syntax

+
+
+
+ New-PveNodesQemuSpiceproxy [[-PveTicket] <PveTicket>] [-Node] <String> [[-Proxy] <String>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-ProxySPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As reasonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI).falsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

New-PveNodesQemuStatusReboot

+

+

Reboot the VM by shutting it down, and starting it again. Applies pending changes.

+
+
+
+

Aliases

+
+
+
    +
  • Restart-PveQemu
    • +
+
+
+
+

Syntax

+
+
+
+ New-PveNodesQemuStatusReboot [[-PveTicket] <PveTicket>] [-Node] <String> [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
@@ -34364,18 +36304,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

New-PveStorage

+

New-PveNodesQemu

-

Create a new storage.

+

Create or restore a virtual machine.

Syntax

- New-PveStorage [[-PveTicket] <PveTicket>] [[-Authsupported] <String>] [[-Base] <String>] [[-Blocksize] <String>] [[-Bwlimit] <String>] [[-ComstarHg] <String>] [[-ComstarTg] <String>] [[-Content] <String>] [[-ContentDirs] <String>] [-CreateBasePath] [-CreateSubdirs] [[-DataPool] <String>] [[-Datastore] <String>] [-Disable] [[-Domain] <String>] [[-EncryptionKey] <String>] [[-Export] <String>] [[-Fingerprint] <String>] [[-Format] <String>] [[-FsName] <String>] [-Fuse] [[-IsMountpoint] <String>] [[-Iscsiprovider] <String>] [[-Keyring] <String>] [-Krbd] [[-LioTpg] <String>] [[-MasterPubkey] <String>] [[-MaxProtectedBackups] <Int32>] [[-Maxfiles] <Int32>] [-Mkdir] [[-Monhost] <String>] [[-Mountpoint] <String>] [[-Namespace] <String>] [-Nocow] [[-Nodes] <String>] [-Nowritecache] [[-Options] <String>] [[-Password] <SecureString>] [[-Path] <String>] [[-Pool] <String>] [[-Port] <Int32>] [[-Portal] <String>] [[-Preallocation] <String>] [[-PruneBackups] <String>] [-Saferemove] [[-SaferemoveThroughput] <String>] [[-Server] <String>] [[-Server2] <String>] [[-Share] <String>] [-Shared] [-SkipCertVerification] [[-Smbversion] <String>] [-Sparse] [-Storage] <String> [[-Subdir] <String>] [-TaggedOnly] [[-Target] <String>] [[-Thinpool] <String>] [[-Transport] <String>] [-Type] <String> [[-Username] <String>] [[-Vgname] <String>] [[-Volume] <String>] [<CommonParameters>] + New-PveNodesQemu [[-PveTicket] <PveTicket>] [-Acpi] [[-Affinity] <String>] [[-Agent] <String>] [[-Arch] <String>] [[-Archive] <String>] [[-Args_] <String>] [[-Audio0] <String>] [-Autostart] [[-Balloon] <Int32>] [[-Bios] <String>] [[-Boot] <String>] [[-Bootdisk] <String>] [[-Bwlimit] <Int32>] [[-Cdrom] <String>] [[-Cicustom] <String>] [[-Cipassword] <SecureString>] [[-Citype] <String>] [-Ciupgrade] [[-Ciuser] <String>] [[-Cores] <Int32>] [[-Cpu] <String>] [[-Cpulimit] <Single>] [[-Cpuunits] <Int32>] [[-Description] <String>] [[-Efidisk0] <String>] [-Force] [-Freeze] [[-Hookscript] <String>] [[-HostpciN] <Hashtable>] [[-Hotplug] <String>] [[-Hugepages] <String>] [[-IdeN] <Hashtable>] [[-IpconfigN] <Hashtable>] [[-Ivshmem] <String>] [-Keephugepages] [[-Keyboard] <String>] [-Kvm] [-LiveRestore] [-Localtime] [[-Lock] <String>] [[-Machine] <String>] [[-Memory] <String>] [[-MigrateDowntime] <Single>] [[-MigrateSpeed] <Int32>] [[-Name] <String>] [[-Nameserver] <String>] [[-NetN] <Hashtable>] [-Node] <String> [-Numa] [[-NumaN] <Hashtable>] [-Onboot] [[-Ostype] <String>] [[-ParallelN] <Hashtable>] [[-Pool] <String>] [-Protection] [-Reboot] [[-Rng0] <String>] [[-SataN] <Hashtable>] [[-ScsiN] <Hashtable>] [[-Scsihw] <String>] [[-Searchdomain] <String>] [[-SerialN] <Hashtable>] [[-Shares] <Int32>] [[-Smbios1] <String>] [[-Smp] <Int32>] [[-Sockets] <Int32>] [[-SpiceEnhancements] <String>] [[-Sshkeys] <String>] [-Start] [[-Startdate] <String>] [[-Startup] <String>] [[-Storage] <String>] [-Tablet] [[-Tags] <String>] [-Tdf] [-Template] [[-Tpmstate0] <String>] [-Unique] [[-UnusedN] <Hashtable>] [[-UsbN] <Hashtable>] [[-Vcpus] <Int32>] [[-Vga] <String>] [[-VirtioN] <Hashtable>] [[-Vmgenid] <String>] [-Vmid] <Int32> [[-Vmstatestorage] <String>] [[-Watchdog] <String>] [<CommonParameters>]
@@ -34401,497 +36341,697 @@

Parameters

- -Authsupported + -Acpi - Authsupported. + Enable/disable ACPI. + false + true (ByPropertyName) + False + + + -Affinity + + List of host cores used to execute guest processes, for example':' 0,5,8-11 false true (ByPropertyName) - -Base + -Agent - Base volume. This volume is automatically activated. + Enable/disable communication with the QEMU Guest Agent and its properties. false true (ByPropertyName) - -Blocksize + -Arch - block size + Virtual processor architecture. Defaults to the host. Enum: x86_64,aarch64 false true (ByPropertyName) - -Bwlimit + -Archive - Set I/O bandwidth limit for various operations (in KiB/s). + The backup archive. Either the file system path to a .tar or .vma file (use '-' to pipe data from stdin) or a proxmox storage backup volume identifier. false true (ByPropertyName) - -ComstarHg + -Args_ - host group for comstar views + Arbitrary arguments passed to kvm. false true (ByPropertyName) - -ComstarTg + -Audio0 - target group for comstar views + Configure a audio device, useful in combination with QXL/Spice. false true (ByPropertyName) - -Content + -Autostart - Allowed content types.NOTE':' the value 'rootdir' is used for Containers, and value 'images' for VMs. + Automatic restart after crash (currently ignored). + false + true (ByPropertyName) + False + + + -Balloon + + Amount of target RAM for the VM in MiB. Using zero disables the ballon driver. + false + true (ByPropertyName) + 0 + + + -Bios + + Select BIOS implementation. Enum: seabios,ovmf false true (ByPropertyName) - -ContentDirs + -Boot - Overrides for default content type directories. + Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. false true (ByPropertyName) - -CreateBasePath + -Bootdisk - Create the base directory if it doesn't exist. + Enable booting from specified disk. Deprecated':' Use 'boot':' order=foo;bar' instead. false true (ByPropertyName) - False + - -CreateSubdirs + -Bwlimit - Populate the directory with the default structure. + Override I/O bandwidth limit (in KiB/s). false true (ByPropertyName) - False + 0 - -DataPool + -Cdrom - Data Pool (for erasure coding only) + This is an alias for option -ide2 false true (ByPropertyName) - -Datastore + -Cicustom - Proxmox Backup Server datastore name. + cloud-init':' Specify custom files to replace the automatically generated ones at start. false true (ByPropertyName) - -Disable + -Cipassword - Flag to disable the storage. + cloud-init':' Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords. + false + true (ByPropertyName) + + + + -Citype + + Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows. Enum: configdrive2,nocloud,opennebula + false + true (ByPropertyName) + + + + -Ciupgrade + + cloud-init':' do an automatic package upgrade after the first boot. false true (ByPropertyName) False - -Domain + -Ciuser - CIFS domain. + cloud-init':' User name to change ssh keys and password for instead of the image's configured default user. false true (ByPropertyName) - -EncryptionKey + -Cores - Encryption key. Use 'autogen' to generate one automatically without passphrase. + The number of cores per socket. + false + true (ByPropertyName) + 0 + + + -Cpu + + Emulated CPU type. false true (ByPropertyName) - -Export + -Cpulimit - NFS export path. + Limit of CPU usage. + false + true (ByPropertyName) + 0 + + + -Cpuunits + + CPU weight for a VM, will be clamped to \[1, 10000] in cgroup v2. + false + true (ByPropertyName) + 0 + + + -Description + + Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. false true (ByPropertyName) - -Fingerprint + -Efidisk0 - Certificate SHA 256 fingerprint. + Configure a disk for storing EFI vars. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume. false true (ByPropertyName) - -Format + -Force - Default image format. + Allow to overwrite existing VM. + false + true (ByPropertyName) + False + + + -Freeze + + Freeze CPU at startup (use 'c' monitor command to start execution). + false + true (ByPropertyName) + False + + + -Hookscript + + Script that will be executed during various steps in the vms lifetime. false true (ByPropertyName) - -FsName + -HostpciN - The Ceph filesystem name. + Map host PCI devices into guest. false true (ByPropertyName) - -Fuse + -Hotplug - Mount CephFS through FUSE. + Selectively enable hotplug features. This is a comma separated list of hotplug features':' 'network', 'disk', 'cpu', 'memory', 'usb' and 'cloudinit'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7. false true (ByPropertyName) - False + - -IsMountpoint + -Hugepages - Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field. + Enable/disable hugepages memory. Enum: any,2,1024 false true (ByPropertyName) - -Iscsiprovider + -IdeN - iscsi provider + Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume. false true (ByPropertyName) - -Keyring + -IpconfigN - Client keyring contents (for external clusters). + cloud-init':' Specify IP addresses and gateways for the corresponding interface.IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicitgateway should be provided.For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requirescloud-init 19.4 or newer.If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to usingdhcp on IPv4. false true (ByPropertyName) - -Krbd + -Ivshmem - Always access rbd through krbd kernel module. + Inter-VM shared memory. Useful for direct communication between VMs, or to the host. + false + true (ByPropertyName) + + + + -Keephugepages + + Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. false true (ByPropertyName) False - -LioTpg + -Keyboard - target portal group for Linux LIO targets + Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. Enum: de,de-ch,da,en-gb,en-us,es,fi,fr,fr-be,fr-ca,fr-ch,hu,is,it,ja,lt,mk,nl,no,pl,pt,pt-br,sv,sl,tr false true (ByPropertyName) - -MasterPubkey + -Kvm - Base64-encoded, PEM-formatted public RSA key. Used to encrypt a copy of the encryption-key which will be added to each encrypted backup. + Enable/disable KVM hardware virtualization. + false + true (ByPropertyName) + False + + + -LiveRestore + + Start the VM immediately while importing or restoring in the background. + false + true (ByPropertyName) + False + + + -Localtime + + Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. + false + true (ByPropertyName) + False + + + -Lock + + Lock/unlock the VM. Enum: backup,clone,create,migrate,rollback,snapshot,snapshot-delete,suspending,suspended false true (ByPropertyName) - -MaxProtectedBackups + -Machine - Maximal number of protected backups per guest. Use '-1' for unlimited. + Specify the QEMU machine. false true (ByPropertyName) - 0 + - -Maxfiles + -Memory - Deprecated':' use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimited. + Memory properties. + false + true (ByPropertyName) + + + + -MigrateDowntime + + Set maximum tolerated downtime (in seconds) for migrations. false true (ByPropertyName) 0 - -Mkdir + -MigrateSpeed - Create the directory if it doesn't exist and populate it with default sub-dirs. NOTE':' Deprecated, use the 'create-base-path' and 'create-subdirs' options instead. + Set maximum speed (in MB/s) for migrations. Value 0 is no limit. false true (ByPropertyName) - False + 0 - -Monhost + -Name - IP addresses of monitors (for external clusters). + Set a name for the VM. Only used on the configuration web interface. false true (ByPropertyName) - -Mountpoint + -Nameserver - mount point + cloud-init':' Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. false true (ByPropertyName) - -Namespace + -NetN - Namespace. + Specify network devices. false true (ByPropertyName) - -Nocow + -Node - Set the NOCOW flag on files. Disables data checksumming and causes data errors to be unrecoverable from while allowing direct I/O. Only use this if data does not need to be any more safe than on a single ext4 formatted disk with no underlying raid system. + The cluster node name. + true + true (ByPropertyName) + + + + -Numa + + Enable/disable NUMA. false true (ByPropertyName) False - -Nodes + -NumaN - List of nodes for which the storage configuration applies. + NUMA topology. false true (ByPropertyName) - -Nowritecache + -Onboot - disable write caching on the target + Specifies whether a VM will be started during system bootup. false true (ByPropertyName) False - -Options + -Ostype - NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs') + Specify guest operating system. Enum: other,wxp,w2k,w2k3,w2k8,wvista,win7,win8,win10,win11,l24,l26,solaris false true (ByPropertyName) - -Password + -ParallelN - Password for accessing the share/datastore. + Map host parallel devices (n is 0 to 2). false true (ByPropertyName) - -Path + -Pool - File system path. + Add the VM to the specified pool. false true (ByPropertyName) - -Pool + -Protection - Pool. + Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. false true (ByPropertyName) - + False - -Port + -Reboot - For non default port. + Allow reboot. If set to '0' the VM exit on reboot. false true (ByPropertyName) - 0 + False - -Portal + -Rng0 - iSCSI portal (IP or DNS name with optional port). + Configure a VirtIO-based Random Number Generator. false true (ByPropertyName) - -Preallocation + -SataN - Preallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off. Enum: off,metadata,falloc,full + Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume. false true (ByPropertyName) - -PruneBackups + -ScsiN - The retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups. + Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume. false true (ByPropertyName) - -Saferemove + -Scsihw - Zero-out data when removing LVs. + SCSI controller model Enum: lsi,lsi53c810,virtio-scsi-pci,virtio-scsi-single,megasas,pvscsi false true (ByPropertyName) - False + - -SaferemoveThroughput + -Searchdomain - Wipe throughput (cstream -t parameter value). + cloud-init':' Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. false true (ByPropertyName) - -Server + -SerialN - Server IP or DNS name. + Create a serial device inside the VM (n is 0 to 3) false true (ByPropertyName) - -Server2 + -Shares - Backup volfile server IP or DNS name. + Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd. + false + true (ByPropertyName) + 0 + + + -Smbios1 + + Specify SMBIOS type 1 fields. false true (ByPropertyName) - -Share + -Smp - CIFS share. + The number of CPUs. Please use option -sockets instead. + false + true (ByPropertyName) + 0 + + + -Sockets + + The number of CPU sockets. + false + true (ByPropertyName) + 0 + + + -SpiceEnhancements + + Configure additional enhancements for SPICE. false true (ByPropertyName) - -Shared + -Sshkeys - Indicate that this is a single storage with the same contents on all nodes (or all listed in the 'nodes' option). It will not make the contents of a local storage automatically accessible to other nodes, it just marks an already shared storage as such! + cloud-init':' Setup public SSH keys (one key per line, OpenSSH format). false true (ByPropertyName) - False + - -SkipCertVerification + -Start - Disable TLS certificate verification, only enable on fully trusted networks! + Start VM after it was created successfully. false true (ByPropertyName) False - -Smbversion + -Startdate - SMB protocol version. 'default' if not set, negotiates the highest SMB2+ version supported by both the client and server. Enum: default,2.0,2.1,3,3.0,3.11 + Set the initial date of the real time clock. Valid format for date are':''now' or '2006-06-17T16':'01':'21' or '2006-06-17'. false true (ByPropertyName) - -Sparse + -Startup - use sparse volumes + Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. false true (ByPropertyName) - False + -Storage - The storage identifier. - true + Default storage. + false true (ByPropertyName) - -Subdir + -Tablet - Subdir to mount. + Enable/disable the USB tablet device. + false + true (ByPropertyName) + False + + + -Tags + + Tags of the VM. This is only meta information. false true (ByPropertyName) - -TaggedOnly + -Tdf - Only use logical volumes tagged with 'pve-vm-ID'. + Enable/disable time drift fix. false true (ByPropertyName) False - -Target + -Template - iSCSI target. + Enable/disable Template. + false + true (ByPropertyName) + False + + + -Tpmstate0 + + Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume. false true (ByPropertyName) - -Thinpool + -Unique - LVM thin pool LV name. + Assign a unique random ethernet address. + false + true (ByPropertyName) + False + + + -UnusedN + + Reference to unused volumes. This is used internally, and should not be modified manually. false true (ByPropertyName) - -Transport + -UsbN - Gluster transport':' tcp or rdma Enum: tcp,rdma,unix + Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). false true (ByPropertyName) - -Type + -Vcpus - Storage type. Enum: btrfs,cephfs,cifs,dir,esxi,glusterfs,iscsi,iscsidirect,lvm,lvmthin,nfs,pbs,rbd,zfs,zfspool - true + Number of hotplugged vcpus. + false + true (ByPropertyName) + 0 + + + -Vga + + Configure the VGA hardware. + false true (ByPropertyName) - -Username + -VirtioN - RBD Id. + Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume. false true (ByPropertyName) - -Vgname + -Vmgenid - Volume group name. + Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. false true (ByPropertyName) - -Volume + -Vmid - Glusterfs Volume. + The (unique) ID of the VM. + true + true (ByPropertyName) + 0 + + + -Vmstatestorage + + Default storage for VM state volumes/files. + false + true (ByPropertyName) + + + + -Watchdog + + Create a virtual hardware watchdog device. false true (ByPropertyName) @@ -34905,18 +37045,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

New-PveVmSnapshot

+

New-PveStorage

-

Create snapshot VM.

+

Create a new storage.

Syntax

- New-PveVmSnapshot [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [[-Description] <String>] [-Snapname] <String> [-Vmstate] [<CommonParameters>] + New-PveStorage [[-PveTicket] <PveTicket>] [[-Authsupported] <String>] [[-Base] <String>] [[-Blocksize] <String>] [[-Bwlimit] <String>] [[-ComstarHg] <String>] [[-ComstarTg] <String>] [[-Content] <String>] [[-ContentDirs] <String>] [-CreateBasePath] [-CreateSubdirs] [[-DataPool] <String>] [[-Datastore] <String>] [-Disable] [[-Domain] <String>] [[-EncryptionKey] <String>] [[-Export] <String>] [[-Fingerprint] <String>] [[-Format] <String>] [[-FsName] <String>] [-Fuse] [[-IsMountpoint] <String>] [[-Iscsiprovider] <String>] [[-Keyring] <String>] [-Krbd] [[-LioTpg] <String>] [[-MasterPubkey] <String>] [[-MaxProtectedBackups] <Int32>] [[-Maxfiles] <Int32>] [-Mkdir] [[-Monhost] <String>] [[-Mountpoint] <String>] [[-Namespace] <String>] [-Nocow] [[-Nodes] <String>] [-Nowritecache] [[-Options] <String>] [[-Password] <SecureString>] [[-Path] <String>] [[-Pool] <String>] [[-Port] <Int32>] [[-Portal] <String>] [[-Preallocation] <String>] [[-PruneBackups] <String>] [-Saferemove] [[-SaferemoveThroughput] <String>] [[-Server] <String>] [[-Server2] <String>] [[-Share] <String>] [-Shared] [-SkipCertVerification] [[-Smbversion] <String>] [-Sparse] [-Storage] <String> [[-Subdir] <String>] [-TaggedOnly] [[-Target] <String>] [[-Thinpool] <String>] [[-Transport] <String>] [-Type] <String> [[-Username] <String>] [[-Vgname] <String>] [[-Volume] <String>] [<CommonParameters>]
@@ -34938,43 +37078,2599 @@

Parameters

Ticket data connection. false - true (ByValue, ByPropertyName) + true (ByPropertyName) - -VmIdOrName + -Authsupported - The (unique) ID or Name of the VM. - true - true (ByValue, ByPropertyName) + Authsupported. + false + true (ByPropertyName) - -Description + -Base - A textual description or comment. + Base volume. This volume is automatically activated. false - true (ByValue, ByPropertyName) + true (ByPropertyName) - -Snapname + -Blocksize - The name of the snapshot. - true - true (ByValue, ByPropertyName) + block size + false + true (ByPropertyName) - -Vmstate + -Bwlimit - Save the vmstate + Set I/O bandwidth limit for various operations (in KiB/s). false - true (ByValue, ByPropertyName) - False + true (ByPropertyName) + - - + + -ComstarHg + + host group for comstar views + false + true (ByPropertyName) + + + + -ComstarTg + + target group for comstar views + false + true (ByPropertyName) + + + + -Content + + Allowed content types.NOTE':' the value 'rootdir' is used for Containers, and value 'images' for VMs. + false + true (ByPropertyName) + + + + -ContentDirs + + Overrides for default content type directories. + false + true (ByPropertyName) + + + + -CreateBasePath + + Create the base directory if it doesn't exist. + false + true (ByPropertyName) + False + + + -CreateSubdirs + + Populate the directory with the default structure. + false + true (ByPropertyName) + False + + + -DataPool + + Data Pool (for erasure coding only) + false + true (ByPropertyName) + + + + -Datastore + + Proxmox Backup Server datastore name. + false + true (ByPropertyName) + + + + -Disable + + Flag to disable the storage. + false + true (ByPropertyName) + False + + + -Domain + + CIFS domain. + false + true (ByPropertyName) + + + + -EncryptionKey + + Encryption key. Use 'autogen' to generate one automatically without passphrase. + false + true (ByPropertyName) + + + + -Export + + NFS export path. + false + true (ByPropertyName) + + + + -Fingerprint + + Certificate SHA 256 fingerprint. + false + true (ByPropertyName) + + + + -Format + + Default image format. + false + true (ByPropertyName) + + + + -FsName + + The Ceph filesystem name. + false + true (ByPropertyName) + + + + -Fuse + + Mount CephFS through FUSE. + false + true (ByPropertyName) + False + + + -IsMountpoint + + Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field. + false + true (ByPropertyName) + + + + -Iscsiprovider + + iscsi provider + false + true (ByPropertyName) + + + + -Keyring + + Client keyring contents (for external clusters). + false + true (ByPropertyName) + + + + -Krbd + + Always access rbd through krbd kernel module. + false + true (ByPropertyName) + False + + + -LioTpg + + target portal group for Linux LIO targets + false + true (ByPropertyName) + + + + -MasterPubkey + + Base64-encoded, PEM-formatted public RSA key. Used to encrypt a copy of the encryption-key which will be added to each encrypted backup. + false + true (ByPropertyName) + + + + -MaxProtectedBackups + + Maximal number of protected backups per guest. Use '-1' for unlimited. + false + true (ByPropertyName) + 0 + + + -Maxfiles + + Deprecated':' use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimited. + false + true (ByPropertyName) + 0 + + + -Mkdir + + Create the directory if it doesn't exist and populate it with default sub-dirs. NOTE':' Deprecated, use the 'create-base-path' and 'create-subdirs' options instead. + false + true (ByPropertyName) + False + + + -Monhost + + IP addresses of monitors (for external clusters). + false + true (ByPropertyName) + + + + -Mountpoint + + mount point + false + true (ByPropertyName) + + + + -Namespace + + Namespace. + false + true (ByPropertyName) + + + + -Nocow + + Set the NOCOW flag on files. Disables data checksumming and causes data errors to be unrecoverable from while allowing direct I/O. Only use this if data does not need to be any more safe than on a single ext4 formatted disk with no underlying raid system. + false + true (ByPropertyName) + False + + + -Nodes + + List of nodes for which the storage configuration applies. + false + true (ByPropertyName) + + + + -Nowritecache + + disable write caching on the target + false + true (ByPropertyName) + False + + + -Options + + NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs') + false + true (ByPropertyName) + + + + -Password + + Password for accessing the share/datastore. + false + true (ByPropertyName) + + + + -Path + + File system path. + false + true (ByPropertyName) + + + + -Pool + + Pool. + false + true (ByPropertyName) + + + + -Port + + For non default port. + false + true (ByPropertyName) + 0 + + + -Portal + + iSCSI portal (IP or DNS name with optional port). + false + true (ByPropertyName) + + + + -Preallocation + + Preallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off. Enum: off,metadata,falloc,full + false + true (ByPropertyName) + + + + -PruneBackups + + The retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups. + false + true (ByPropertyName) + + + + -Saferemove + + Zero-out data when removing LVs. + false + true (ByPropertyName) + False + + + -SaferemoveThroughput + + Wipe throughput (cstream -t parameter value). + false + true (ByPropertyName) + + + + -Server + + Server IP or DNS name. + false + true (ByPropertyName) + + + + -Server2 + + Backup volfile server IP or DNS name. + false + true (ByPropertyName) + + + + -Share + + CIFS share. + false + true (ByPropertyName) + + + + -Shared + + Indicate that this is a single storage with the same contents on all nodes (or all listed in the 'nodes' option). It will not make the contents of a local storage automatically accessible to other nodes, it just marks an already shared storage as such! + false + true (ByPropertyName) + False + + + -SkipCertVerification + + Disable TLS certificate verification, only enable on fully trusted networks! + false + true (ByPropertyName) + False + + + -Smbversion + + SMB protocol version. 'default' if not set, negotiates the highest SMB2+ version supported by both the client and server. Enum: default,2.0,2.1,3,3.0,3.11 + false + true (ByPropertyName) + + + + -Sparse + + use sparse volumes + false + true (ByPropertyName) + False + + + -Storage + + The storage identifier. + true + true (ByPropertyName) + + + + -Subdir + + Subdir to mount. + false + true (ByPropertyName) + + + + -TaggedOnly + + Only use logical volumes tagged with 'pve-vm-ID'. + false + true (ByPropertyName) + False + + + -Target + + iSCSI target. + false + true (ByPropertyName) + + + + -Thinpool + + LVM thin pool LV name. + false + true (ByPropertyName) + + + + -Transport + + Gluster transport':' tcp or rdma Enum: tcp,rdma,unix + false + true (ByPropertyName) + + + + -Type + + Storage type. Enum: btrfs,cephfs,cifs,dir,esxi,glusterfs,iscsi,iscsidirect,lvm,lvmthin,nfs,pbs,rbd,zfs,zfspool + true + true (ByPropertyName) + + + + -Username + + RBD Id. + false + true (ByPropertyName) + + + + -Vgname + + Volume group name. + false + true (ByPropertyName) + + + + -Volume + + Glusterfs Volume. + false + true (ByPropertyName) + + + + +
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

New-PveVmSnapshot

+

+

Create snapshot VM.

+
+
+

Syntax

+
+
+
+ New-PveVmSnapshot [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [[-Description] <String>] [-Snapname] <String> [-Vmstate] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByValue, ByPropertyName)
-VmIdOrNameThe (unique) ID or Name of the VM.truetrue (ByValue, ByPropertyName)
-DescriptionA textual description or comment.falsetrue (ByValue, ByPropertyName)
-SnapnameThe name of the snapshot.truetrue (ByValue, ByPropertyName)
-VmstateSave the vmstatefalsetrue (ByValue, ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveAccessDomains

+

+

Delete an authentication server.

+
+
+

Syntax

+
+
+
+ Remove-PveAccessDomains [[-PveTicket] <PveTicket>] [-Realm] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-RealmAuthentication domain IDtruetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveAccessGroups

+

+

Delete group.

+
+
+

Syntax

+
+
+
+ Remove-PveAccessGroups [[-PveTicket] <PveTicket>] [-Groupid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Groupid--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveAccessRoles

+

+

Delete role.

+
+
+

Syntax

+
+
+
+ Remove-PveAccessRoles [[-PveTicket] <PveTicket>] [-Roleid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Roleid--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveAccessTfa

+

+

Delete a TFA entry by ID.

+
+
+

Syntax

+
+
+
+ Remove-PveAccessTfa [[-PveTicket] <PveTicket>] [-Id] <String> [[-Password] <SecureString>] [-Userid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-IdA TFA entry id.truetrue (ByPropertyName)
-PasswordThe current password of the user performing the change.falsetrue (ByPropertyName)
-UseridFull User ID, in the `name@realm` format.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveAccessUsers

+

+

Delete user.

+
+
+

Syntax

+
+
+
+ Remove-PveAccessUsers [[-PveTicket] <PveTicket>] [-Userid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-UseridFull User ID, in the `name@realm` format.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveAccessUsersToken

+

+

Remove API token for a specific user.

+
+
+

Syntax

+
+
+
+ Remove-PveAccessUsersToken [[-PveTicket] <PveTicket>] [-Tokenid] <String> [-Userid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-TokenidUser-specific token identifier.truetrue (ByPropertyName)
-UseridFull User ID, in the `name@realm` format.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveClusterAcmeAccount

+

+

Deactivate existing ACME account at CA.

+
+
+

Syntax

+
+
+
+ Remove-PveClusterAcmeAccount [[-PveTicket] <PveTicket>] [[-Name] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NameACME account config file name.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveClusterAcmePlugins

+

+

Delete ACME plugin configuration.

+
+
+

Syntax

+
+
+
+ Remove-PveClusterAcmePlugins [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-IdUnique identifier for ACME plugin instance.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveClusterBackup

+

+

Delete vzdump backup job definition.

+
+
+

Syntax

+
+
+
+ Remove-PveClusterBackup [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-IdThe job ID.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveClusterConfigNodes

+

+

Removes a node from the cluster configuration.

+
+
+

Syntax

+
+
+
+ Remove-PveClusterConfigNodes [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveClusterFirewallAliases

+

+

Remove IP or Network alias.

+
+
+

Syntax

+
+
+
+ Remove-PveClusterFirewallAliases [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Name] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-NameAlias name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveClusterFirewallGroups

+

+

Delete security group.

+
+
+

Syntax

+
+
+
+ Remove-PveClusterFirewallGroups [[-PveTicket] <PveTicket>] [-Group] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-GroupSecurity Group name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveClusterFirewallGroupsIdx

+

+

Delete rule.

+
+
+

Syntax

+
+
+
+ Remove-PveClusterFirewallGroupsIdx [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Group] <String> [[-Pos] <Int32>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-GroupSecurity Group name.truetrue (ByPropertyName)
-PosUpdate rule at position <pos>.falsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveClusterFirewallIpset

+

+

Delete IPSet

+
+
+

Syntax

+
+
+
+ Remove-PveClusterFirewallIpset [[-PveTicket] <PveTicket>] [-Force] [-Name] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ForceDelete all members of the IPSet, if there are any.falsetrue (ByPropertyName)False
-NameIP set name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveClusterFirewallIpsetIdx

+

+

Remove IP or Network from IPSet.

+
+
+

Syntax

+
+
+
+ Remove-PveClusterFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Digest] <String>] [-Name] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CidrNetwork/IP specification in CIDR format.truetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-NameIP set name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveClusterFirewallRules

+

+

Delete rule.

+
+
+

Syntax

+
+
+
+ Remove-PveClusterFirewallRules [[-PveTicket] <PveTicket>] [[-Digest] <String>] [[-Pos] <Int32>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-PosUpdate rule at position <pos>.falsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveClusterHaGroups

+

+

Delete ha group configuration.

+
+
+

Syntax

+
+
+
+ Remove-PveClusterHaGroups [[-PveTicket] <PveTicket>] [-Group] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-GroupThe HA group identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveClusterHaResources

+

+

Delete resource configuration.

+
+
+

Syntax

+
+
+
+ Remove-PveClusterHaResources [[-PveTicket] <PveTicket>] [-Sid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-SidHA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example':' vm':'100 / ct':'100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example':' 100).truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveClusterJobsRealmSync

+

+

Delete realm-sync job definition.

+
+
+

Syntax

+
+
+
+ Remove-PveClusterJobsRealmSync [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Id--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveClusterMappingPci

+

+

Remove Hardware Mapping.

+
+
+

Syntax

+
+
+
+ Remove-PveClusterMappingPci [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Id--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveClusterMappingUsb

+

+

Remove Hardware Mapping.

+
+
+

Syntax

+
+
+
+ Remove-PveClusterMappingUsb [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Id--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveClusterMetricsServer

+

+

Remove Metric server.

+
+
+

Syntax

+
+
+
+ Remove-PveClusterMetricsServer [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Id--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveClusterNotificationsEndpointsGotify

+

+

Remove gotify endpoint

+
+
+

Syntax

+
+
+
+ Remove-PveClusterNotificationsEndpointsGotify [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Name--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveClusterNotificationsEndpointsSendmail

+

+

Remove sendmail endpoint

+
+
+

Syntax

+
+
+
+ Remove-PveClusterNotificationsEndpointsSendmail [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Name--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveClusterNotificationsEndpointsSmtp

+

+

Remove smtp endpoint

+
+
+

Syntax

+
+
+
+ Remove-PveClusterNotificationsEndpointsSmtp [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Name--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveClusterNotificationsMatchers

+

+

Remove matcher

+
+
+

Syntax

+
+
+
+ Remove-PveClusterNotificationsMatchers [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Name--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveClusterReplication

+

+

Mark replication job for removal.

+
+
+

Syntax

+
+
+
+ Remove-PveClusterReplication [[-PveTicket] <PveTicket>] [-Force] [-Id] <String> [-Keep] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ForceWill remove the jobconfig entry, but will not cleanup.falsetrue (ByPropertyName)False
-IdReplication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.truetrue (ByPropertyName)
-KeepKeep replicated data at target (do not remove).falsetrue (ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveClusterSdnControllers

+

+

Delete sdn controller object configuration.

+
+
+

Syntax

+
+
+
+ Remove-PveClusterSdnControllers [[-PveTicket] <PveTicket>] [-Controller] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ControllerThe SDN controller object identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveClusterSdnDns

+

+

Delete sdn dns object configuration.

+
+
+

Syntax

+
+
+
+ Remove-PveClusterSdnDns [[-PveTicket] <PveTicket>] [-Dns] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DnsThe SDN dns object identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveClusterSdnIpams

+

+

Delete sdn ipam object configuration.

+
+
+

Syntax

+
+
+
+ Remove-PveClusterSdnIpams [[-PveTicket] <PveTicket>] [-Ipam] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-IpamThe SDN ipam object identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveClusterSdnVnets

+

+

Delete sdn vnet object configuration.

+
+
+

Syntax

+
+
+
+ Remove-PveClusterSdnVnets [[-PveTicket] <PveTicket>] [-Vnet] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-VnetThe SDN vnet object identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveClusterSdnVnetsIps

+

+

Delete IP Mappings in a VNet

+
+
+

Syntax

+
+
+
+ Remove-PveClusterSdnVnetsIps [[-PveTicket] <PveTicket>] [-Ip] <String> [[-Mac] <String>] [-Vnet] <String> [-Zone] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-IpThe IP address to deletetruetrue (ByPropertyName)
-MacUnicast MAC address.falsetrue (ByPropertyName)
-VnetThe SDN vnet object identifier.truetrue (ByPropertyName)
-ZoneThe SDN zone object identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveClusterSdnVnetsSubnets

+

+

Delete sdn subnet object configuration.

+
+
+

Syntax

+
+
+
+ Remove-PveClusterSdnVnetsSubnets [[-PveTicket] <PveTicket>] [-Subnet] <String> [-Vnet] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-SubnetThe SDN subnet object identifier.truetrue (ByPropertyName)
-VnetThe SDN vnet object identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveClusterSdnZones

+

+

Delete sdn zone object configuration.

+
+
+

Syntax

+
+
+
+ Remove-PveClusterSdnZones [[-PveTicket] <PveTicket>] [-Zone] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ZoneThe SDN zone object identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveNodesLxc

+

+

Destroy the container (also delete all uses files).

+
+
+

Syntax

+
+
+
+ Remove-PveNodesLxc [[-PveTicket] <PveTicket>] [-DestroyUnreferencedDisks] [-Force] [-Node] <String> [-Purge] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DestroyUnreferencedDisksIf set, destroy additionally all disks with the VMID from all enabled storages which are not referenced in the config.falsetrue (ByPropertyName)False
-ForceForce destroy, even if running.falsetrue (ByPropertyName)False
-NodeThe cluster node name.truetrue (ByPropertyName)
-PurgeRemove container from all related configurations. For example, backup jobs, replication jobs or HA. Related ACLs and Firewall entries will *always* be removed.falsetrue (ByPropertyName)False
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0

Outputs

@@ -34982,18 +39678,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveAccessDomains

+

Remove-PveNodesLxcSnapshot

-

Delete an authentication server.

+

Delete a LXC snapshot.

Syntax

- Remove-PveAccessDomains [[-PveTicket] <PveTicket>] [-Realm] <String> [<CommonParameters>] + Remove-PveNodesLxcSnapshot [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
@@ -35019,13 +39715,37 @@

Parameters

- -Realm + -Force - Authentication domain ID + For removal from config file, even if removing disk snapshots fails. + false + true (ByPropertyName) + False + + + -Node + + The cluster node name. + true + true (ByPropertyName) + + + + -Snapname + + The name of the snapshot. true true (ByPropertyName) + + -Vmid + + The (unique) ID of the VM. + true + true (ByPropertyName) + 0 +
@@ -35035,18 +39755,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveAccessGroups

+

Remove-PveNodesCephMds

-

Delete group.

+

Destroy Ceph Metadata Server

Syntax

- Remove-PveAccessGroups [[-PveTicket] <PveTicket>] [-Groupid] <String> [<CommonParameters>] + Remove-PveNodesCephMds [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [<CommonParameters>]
@@ -35072,9 +39792,17 @@

Parameters

- -Groupid + -Name - -- + The name (ID) of the mds + true + true (ByPropertyName) + + + + -Node + + The cluster node name. true true (ByPropertyName) @@ -35088,18 +39816,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveAccessRoles

+

Remove-PveNodesCephMgr

-

Delete role.

+

Destroy Ceph Manager.

Syntax

- Remove-PveAccessRoles [[-PveTicket] <PveTicket>] [-Roleid] <String> [<CommonParameters>] + Remove-PveNodesCephMgr [[-PveTicket] <PveTicket>] [-Id] <String> [-Node] <String> [<CommonParameters>]
@@ -35125,9 +39853,17 @@

Parameters

- -Roleid + -Id - -- + The ID of the manager + true + true (ByPropertyName) + + + + -Node + + The cluster node name. true true (ByPropertyName) @@ -35141,18 +39877,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveAccessTfa

+

Remove-PveNodesCephMon

-

Delete a TFA entry by ID.

+

Destroy Ceph Monitor and Manager.

Syntax

- Remove-PveAccessTfa [[-PveTicket] <PveTicket>] [-Id] <String> [[-Password] <SecureString>] [-Userid] <String> [<CommonParameters>] + Remove-PveNodesCephMon [[-PveTicket] <PveTicket>] [-Monid] <String> [-Node] <String> [<CommonParameters>]
@@ -35178,29 +39914,90 @@

Parameters

- -Id + -Monid - A TFA entry id. + Monitor ID true true (ByPropertyName) - -Password + -Node - The current password of the user performing the change. + The cluster node name. + true + true (ByPropertyName) + + + + +
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveNodesCephOsd

+

+

Destroy OSD

+
+
+

Syntax

+
+
+
+ Remove-PveNodesCephOsd [[-PveTicket] <PveTicket>] [-Cleanup] [-Node] <String> [-Osdid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + - + - + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection. false true (ByPropertyName)
-Userid-Cleanup Full User ID, in the `name@realm` format.If set, we remove partition table entries.falsetrue (ByPropertyName)False
-NodeThe cluster node name. true true (ByPropertyName)
-OsdidOSD IDtruetrue (ByPropertyName)0
@@ -35210,18 +40007,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveAccessUsers

+

Remove-PveNodesCephPool

-

Delete user.

+

Destroy pool

Syntax

- Remove-PveAccessUsers [[-PveTicket] <PveTicket>] [-Userid] <String> [<CommonParameters>] + Remove-PveNodesCephPool [[-PveTicket] <PveTicket>] [-Force] [-Name] <String> [-Node] <String> [-RemoveEcprofile] [-RemoveStorages] [<CommonParameters>]
@@ -35247,13 +40044,45 @@

Parameters

- -Userid + -Force - Full User ID, in the `name@realm` format. + If true, destroys pool even if in use + false + true (ByPropertyName) + False + + + -Name + + The name of the pool. It must be unique. + true + true (ByPropertyName) + + + + -Node + + The cluster node name. true true (ByPropertyName) + + -RemoveEcprofile + + Remove the erasure code profile. Defaults to true, if applicable. + false + true (ByPropertyName) + False + + + -RemoveStorages + + Remove all pveceph-managed storages configured for this pool + false + true (ByPropertyName) + False +
@@ -35263,18 +40092,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveAccessUsersToken

+

Remove-PveNodesCertificatesAcmeCertificate

-

Remove API token for a specific user.

+

Revoke existing certificate from CA.

Syntax

- Remove-PveAccessUsersToken [[-PveTicket] <PveTicket>] [-Tokenid] <String> [-Userid] <String> [<CommonParameters>] + Remove-PveNodesCertificatesAcmeCertificate [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
@@ -35300,21 +40129,74 @@

Parameters

- -Tokenid + -Node - User-specific token identifier. + The cluster node name. true true (ByPropertyName) + + +
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Remove-PveNodesCertificatesCustom

+

+

DELETE custom certificate chain and key.

+
+
+

Syntax

+
+
+
+ Remove-PveNodesCertificatesCustom [[-PveTicket] <PveTicket>] [-Node] <String> [-Restart] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + - + - + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Userid-Node Full User ID, in the `name@realm` format.The cluster node name. true true (ByPropertyName)
-RestartRestart pveproxy.falsetrue (ByPropertyName)False
@@ -35324,18 +40206,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveClusterAcmeAccount

+

Remove-PveNodesDisksDirectory

-

Deactivate existing ACME account at CA.

+

Unmounts the storage and removes the mount unit.

Syntax

- Remove-PveClusterAcmeAccount [[-PveTicket] <PveTicket>] [[-Name] <String>] [<CommonParameters>] + Remove-PveNodesDisksDirectory [[-PveTicket] <PveTicket>] [-CleanupConfig] [-CleanupDisks] [-Name] <String> [-Node] <String> [<CommonParameters>]
@@ -35361,11 +40243,35 @@

Parameters

- -Name + -CleanupConfig - ACME account config file name. + Marks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only). + false + true (ByPropertyName) + False + + + -CleanupDisks + + Also wipe disk so it can be repurposed afterwards. false true (ByPropertyName) + False + + + -Name + + The storage identifier. + true + true (ByPropertyName) + + + + -Node + + The cluster node name. + true + true (ByPropertyName) @@ -35377,18 +40283,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveClusterAcmePlugins

+

Remove-PveNodesDisksLvm

-

Delete ACME plugin configuration.

+

Remove an LVM Volume Group.

Syntax

- Remove-PveClusterAcmePlugins [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>] + Remove-PveNodesDisksLvm [[-PveTicket] <PveTicket>] [-CleanupConfig] [-CleanupDisks] [-Name] <String> [-Node] <String> [<CommonParameters>]
@@ -35414,9 +40320,33 @@

Parameters

- -Id + -CleanupConfig - Unique identifier for ACME plugin instance. + Marks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only). + false + true (ByPropertyName) + False + + + -CleanupDisks + + Also wipe disks so they can be repurposed afterwards. + false + true (ByPropertyName) + False + + + -Name + + The storage identifier. + true + true (ByPropertyName) + + + + -Node + + The cluster node name. true true (ByPropertyName) @@ -35430,18 +40360,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveClusterBackup

+

Remove-PveNodesDisksLvmthin

-

Delete vzdump backup job definition.

+

Remove an LVM thin pool.

Syntax

- Remove-PveClusterBackup [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>] + Remove-PveNodesDisksLvmthin [[-PveTicket] <PveTicket>] [-CleanupConfig] [-CleanupDisks] [-Name] <String> [-Node] <String> [-VolumeGroup] <String> [<CommonParameters>]
@@ -35467,9 +40397,41 @@

Parameters

- -Id + -CleanupConfig - The job ID. + Marks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only). + false + true (ByPropertyName) + False + + + -CleanupDisks + + Also wipe disks so they can be repurposed afterwards. + false + true (ByPropertyName) + False + + + -Name + + The storage identifier. + true + true (ByPropertyName) + + + + -Node + + The cluster node name. + true + true (ByPropertyName) + + + + -VolumeGroup + + The storage identifier. true true (ByPropertyName) @@ -35483,18 +40445,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveClusterConfigNodes

+

Remove-PveNodesDisksZfs

-

Removes a node from the cluster configuration.

+

Destroy a ZFS pool.

Syntax

- Remove-PveClusterConfigNodes [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] + Remove-PveNodesDisksZfs [[-PveTicket] <PveTicket>] [-CleanupConfig] [-CleanupDisks] [-Name] <String> [-Node] <String> [<CommonParameters>]
@@ -35519,6 +40481,30 @@

Parameters

true (ByPropertyName) + + -CleanupConfig + + Marks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only). + false + true (ByPropertyName) + False + + + -CleanupDisks + + Also wipe disks so they can be repurposed afterwards. + false + true (ByPropertyName) + False + + + -Name + + The storage identifier. + true + true (ByPropertyName) + + -Node @@ -35536,18 +40522,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveClusterFirewallAliases

+

Remove-PveNodesFirewallRules

-

Remove IP or Network alias.

+

Delete rule.

Syntax

- Remove-PveClusterFirewallAliases [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Name] <String> [<CommonParameters>] + Remove-PveNodesFirewallRules [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Node] <String> [[-Pos] <Int32>] [<CommonParameters>]
@@ -35581,13 +40567,21 @@

Parameters

- -Name + -Node - Alias name. + The cluster node name. true true (ByPropertyName) + + -Pos + + Update rule at position <pos>. + false + true (ByPropertyName) + 0 +
@@ -35597,18 +40591,28 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveClusterFirewallGroups

+

Remove-PveNodesLxc

-

Delete security group.

+

Destroy the container (also delete all uses files).

+
+
+
+

Aliases

+
+
+
    +
  • Remove-PveLxc
    • +
+

Syntax

- Remove-PveClusterFirewallGroups [[-PveTicket] <PveTicket>] [-Group] <String> [<CommonParameters>] + Remove-PveNodesLxc [[-PveTicket] <PveTicket>] [-DestroyUnreferencedDisks] [-Force] [-Node] <String> [-Purge] [-Vmid] <Int32> [<CommonParameters>]
@@ -35628,18 +40632,50 @@

Parameters

-PveTicket - Ticket data connection. + Ticket data connection. + false + true (ByPropertyName) + + + + -DestroyUnreferencedDisks + + If set, destroy additionally all disks with the VMID from all enabled storages which are not referenced in the config. + false + true (ByPropertyName) + False + + + -Force + + Force destroy, even if running. + false + true (ByPropertyName) + False + + + -Node + + The cluster node name. + true + true (ByPropertyName) + + + + -Purge + + Remove container from all related configurations. For example, backup jobs, replication jobs or HA. Related ACLs and Firewall entries will *always* be removed. false true (ByPropertyName) - + False - -Group + -Vmid - Security Group name. + The (unique) ID of the VM. true true (ByPropertyName) - + 0 @@ -35650,18 +40686,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveClusterFirewallGroupsIdx

+

Remove-PveNodesLxcFirewallAliases

-

Delete rule.

+

Remove IP or Network alias.

Syntax

- Remove-PveClusterFirewallGroupsIdx [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Group] <String> [[-Pos] <Int32>] [<CommonParameters>] + Remove-PveNodesLxcFirewallAliases [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
@@ -35695,18 +40731,26 @@

Parameters

- -Group + -Name - Security Group name. + Alias name. true true (ByPropertyName) - -Pos + -Node - Update rule at position <pos>. - false + The cluster node name. + true + true (ByPropertyName) + + + + -Vmid + + The (unique) ID of the VM. + true true (ByPropertyName) 0 @@ -35719,9 +40763,9 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveClusterFirewallIpset

+

Remove-PveNodesLxcFirewallIpset

Delete IPSet

@@ -35730,7 +40774,7 @@

Syntax

- Remove-PveClusterFirewallIpset [[-PveTicket] <PveTicket>] [-Force] [-Name] <String> [<CommonParameters>] + Remove-PveNodesLxcFirewallIpset [[-PveTicket] <PveTicket>] [-Force] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
@@ -35771,6 +40815,22 @@

Parameters

true (ByPropertyName) + + -Node + + The cluster node name. + true + true (ByPropertyName) + + + + -Vmid + + The (unique) ID of the VM. + true + true (ByPropertyName) + 0 +
@@ -35780,9 +40840,9 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveClusterFirewallIpsetIdx

+

Remove-PveNodesLxcFirewallIpsetIdx

Remove IP or Network from IPSet.

@@ -35791,7 +40851,7 @@

Syntax

- Remove-PveClusterFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Digest] <String>] [-Name] <String> [<CommonParameters>] + Remove-PveNodesLxcFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
@@ -35840,6 +40900,22 @@

Parameters

true (ByPropertyName) + + -Node + + The cluster node name. + true + true (ByPropertyName) + + + + -Vmid + + The (unique) ID of the VM. + true + true (ByPropertyName) + 0 +
@@ -35849,9 +40925,9 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveClusterFirewallRules

+

Remove-PveNodesLxcFirewallRules

Delete rule.

@@ -35860,7 +40936,7 @@

Syntax

- Remove-PveClusterFirewallRules [[-PveTicket] <PveTicket>] [[-Digest] <String>] [[-Pos] <Int32>] [<CommonParameters>] + Remove-PveNodesLxcFirewallRules [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Node] <String> [[-Pos] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
@@ -35893,6 +40969,14 @@

Parameters

true (ByPropertyName) + + -Node + + The cluster node name. + true + true (ByPropertyName) + + -Pos @@ -35901,6 +40985,14 @@

Parameters

true (ByPropertyName) 0 + + -Vmid + + The (unique) ID of the VM. + true + true (ByPropertyName) + 0 +
@@ -35910,18 +41002,28 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveClusterHaGroups

+

Remove-PveNodesLxcSnapshot

-

Delete ha group configuration.

+

Delete a LXC snapshot.

+
+
+
+

Aliases

+
+
+
    +
  • Remove-PveLxcSnapshot
    • +
+

Syntax

- Remove-PveClusterHaGroups [[-PveTicket] <PveTicket>] [-Group] <String> [<CommonParameters>] + Remove-PveNodesLxcSnapshot [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
@@ -35947,13 +41049,37 @@

Parameters

- -Group + -Force - The HA group identifier. + For removal from config file, even if removing disk snapshots fails. + false + true (ByPropertyName) + False + + + -Node + + The cluster node name. + true + true (ByPropertyName) + + + + -Snapname + + The name of the snapshot. true true (ByPropertyName) + + -Vmid + + The (unique) ID of the VM. + true + true (ByPropertyName) + 0 +
@@ -35963,18 +41089,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveClusterHaResources

+

Remove-PveNodesNetwork

-

Delete resource configuration.

+

Revert network configuration changes.

Syntax

- Remove-PveClusterHaResources [[-PveTicket] <PveTicket>] [-Sid] <String> [<CommonParameters>] + Remove-PveNodesNetwork [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
@@ -36000,9 +41126,9 @@

Parameters

- -Sid + -Node - HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example':' vm':'100 / ct':'100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example':' 100). + The cluster node name. true true (ByPropertyName) @@ -36016,18 +41142,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveClusterJobsRealmSync

+

Remove-PveNodesNetworkIdx

-

Delete realm-sync job definition.

+

Delete network device configuration

Syntax

- Remove-PveClusterJobsRealmSync [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>] + Remove-PveNodesNetworkIdx [[-PveTicket] <PveTicket>] [-Iface] <String> [-Node] <String> [<CommonParameters>]
@@ -36053,9 +41179,17 @@

Parameters

- -Id + -Iface - -- + Network interface name. + true + true (ByPropertyName) + + + + -Node + + The cluster node name. true true (ByPropertyName) @@ -36069,18 +41203,28 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveClusterMappingPci

+

Remove-PveNodesQemu

-

Remove Hardware Mapping.

+

Destroy the VM and all used/owned volumes. Removes any VM specific permissions and firewall rules

+
+
+
+

Aliases

+
+
+
    +
  • Remove-PveQemu
    • +
+

Syntax

- Remove-PveClusterMappingPci [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>] + Remove-PveNodesQemu [[-PveTicket] <PveTicket>] [-DestroyUnreferencedDisks] [-Node] <String> [-Purge] [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]
@@ -36106,13 +41250,45 @@

Parameters

- -Id + -DestroyUnreferencedDisks - -- + If set, destroy additionally all disks not referenced in the config but with a matching VMID from all enabled storages. + false + true (ByPropertyName) + False + + + -Node + + The cluster node name. true true (ByPropertyName) + + -Purge + + Remove VMID from configurations, like backup & replication jobs and HA. + false + true (ByPropertyName) + False + + + -Skiplock + + Ignore locks - only root is allowed to use this option. + false + true (ByPropertyName) + False + + + -Vmid + + The (unique) ID of the VM. + true + true (ByPropertyName) + 0 +
@@ -36122,18 +41298,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveClusterMappingUsb

+

Remove-PveNodesQemuFirewallAliases

-

Remove Hardware Mapping.

+

Remove IP or Network alias.

Syntax

- Remove-PveClusterMappingUsb [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>] + Remove-PveNodesQemuFirewallAliases [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
@@ -36159,13 +41335,37 @@

Parameters

- -Id + -Digest - -- + Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. + false + true (ByPropertyName) + + + + -Name + + Alias name. + true + true (ByPropertyName) + + + + -Node + + The cluster node name. true true (ByPropertyName) + + -Vmid + + The (unique) ID of the VM. + true + true (ByPropertyName) + 0 +
@@ -36175,18 +41375,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveClusterMetricsServer

+

Remove-PveNodesQemuFirewallIpset

-

Remove Metric server.

+

Delete IPSet

Syntax

- Remove-PveClusterMetricsServer [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>] + Remove-PveNodesQemuFirewallIpset [[-PveTicket] <PveTicket>] [-Force] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
@@ -36212,13 +41412,37 @@

Parameters

- -Id + -Force - -- + Delete all members of the IPSet, if there are any. + false + true (ByPropertyName) + False + + + -Name + + IP set name. + true + true (ByPropertyName) + + + + -Node + + The cluster node name. true true (ByPropertyName) + + -Vmid + + The (unique) ID of the VM. + true + true (ByPropertyName) + 0 +
@@ -36228,18 +41452,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveClusterNotificationsEndpointsGotify

+

Remove-PveNodesQemuFirewallIpsetIdx

-

Remove gotify endpoint

+

Remove IP or Network from IPSet.

Syntax

- Remove-PveClusterNotificationsEndpointsGotify [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>] + Remove-PveNodesQemuFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
@@ -36264,14 +41488,46 @@

Parameters

true (ByPropertyName) + + -Cidr + + Network/IP specification in CIDR format. + true + true (ByPropertyName) + + + + -Digest + + Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. + false + true (ByPropertyName) + + -Name - -- + IP set name. + true + true (ByPropertyName) + + + + -Node + + The cluster node name. true true (ByPropertyName) + + -Vmid + + The (unique) ID of the VM. + true + true (ByPropertyName) + 0 +
@@ -36281,18 +41537,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveClusterNotificationsEndpointsSendmail

+

Remove-PveNodesQemuFirewallRules

-

Remove sendmail endpoint

+

Delete rule.

Syntax

- Remove-PveClusterNotificationsEndpointsSendmail [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>] + Remove-PveNodesQemuFirewallRules [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Node] <String> [[-Pos] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
@@ -36318,13 +41574,37 @@

Parameters

- -Name + -Digest - -- + Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. + false + true (ByPropertyName) + + + + -Node + + The cluster node name. true true (ByPropertyName) + + -Pos + + Update rule at position <pos>. + false + true (ByPropertyName) + 0 + + + -Vmid + + The (unique) ID of the VM. + true + true (ByPropertyName) + 0 +
@@ -36334,18 +41614,28 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveClusterNotificationsEndpointsSmtp

+

Remove-PveNodesQemuSnapshot

-

Remove smtp endpoint

+

Delete a VM snapshot.

+
+
+
+

Aliases

+
+
+
    +
  • Remove-PveQemuSnapshot
    • +
+

Syntax

- Remove-PveClusterNotificationsEndpointsSmtp [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>] + Remove-PveNodesQemuSnapshot [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
@@ -36371,13 +41661,37 @@

Parameters

- -Name + -Force - -- + For removal from config file, even if removing disk snapshots fails. + false + true (ByPropertyName) + False + + + -Node + + The cluster node name. + true + true (ByPropertyName) + + + + -Snapname + + The name of the snapshot. true true (ByPropertyName) + + -Vmid + + The (unique) ID of the VM. + true + true (ByPropertyName) + 0 +
@@ -36387,18 +41701,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveClusterNotificationsMatchers

+

Remove-PveNodesStorageContent

-

Remove matcher

+

Delete volume

Syntax

- Remove-PveClusterNotificationsMatchers [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>] + Remove-PveNodesStorageContent [[-PveTicket] <PveTicket>] [[-Delay] <Int32>] [-Node] <String> [[-Storage] <String>] [-Volume] <String> [<CommonParameters>]
@@ -36424,9 +41738,33 @@

Parameters

- -Name + -Delay - -- + Time to wait for the task to finish. We return 'null' if the task finish within that time. + false + true (ByPropertyName) + 0 + + + -Node + + The cluster node name. + true + true (ByPropertyName) + + + + -Storage + + The storage identifier. + false + true (ByPropertyName) + + + + -Volume + + Volume identifier true true (ByPropertyName) @@ -36440,18 +41778,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveClusterReplication

+

Remove-PveNodesStoragePrunebackups

-

Mark replication job for removal.

+

Prune backups. Only those using the standard naming scheme are considered.

Syntax

- Remove-PveClusterReplication [[-PveTicket] <PveTicket>] [-Force] [-Id] <String> [-Keep] [<CommonParameters>] + Remove-PveNodesStoragePrunebackups [[-PveTicket] <PveTicket>] [-Node] <String> [[-PruneBackups] <String>] [-Storage] <String> [[-Type] <String>] [[-Vmid] <Int32>] [<CommonParameters>]
@@ -36477,28 +41815,44 @@

Parameters

- -Force + -Node - Will remove the jobconfig entry, but will not cleanup. + The cluster node name. + true + true (ByPropertyName) + + + + -PruneBackups + + Use these retention options instead of those from the storage configuration. false true (ByPropertyName) - False + - -Id + -Storage - Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'. + The storage identifier. true true (ByPropertyName) - -Keep + -Type - Keep replicated data at target (do not remove). + Either 'qemu' or 'lxc'. Only consider backups for guests of this type. Enum: qemu,lxc false true (ByPropertyName) - False + + + + -Vmid + + Only prune backups for this VM. + false + true (ByPropertyName) + 0 @@ -36509,18 +41863,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveClusterSdnControllers

+

Remove-PveNodesSubscription

-

Delete sdn controller object configuration.

+

Delete subscription key of this node.

Syntax

- Remove-PveClusterSdnControllers [[-PveTicket] <PveTicket>] [-Controller] <String> [<CommonParameters>] + Remove-PveNodesSubscription [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
@@ -36546,9 +41900,9 @@

Parameters

- -Controller + -Node - The SDN controller object identifier. + The cluster node name. true true (ByPropertyName) @@ -36562,18 +41916,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveClusterSdnDns

+

Remove-PveNodesTasks

-

Delete sdn dns object configuration.

+

Stop a task.

Syntax

- Remove-PveClusterSdnDns [[-PveTicket] <PveTicket>] [-Dns] <String> [<CommonParameters>] + Remove-PveNodesTasks [[-PveTicket] <PveTicket>] [-Node] <String> [-Upid] <String> [<CommonParameters>]
@@ -36599,9 +41953,17 @@

Parameters

- -Dns + -Node - The SDN dns object identifier. + The cluster node name. + true + true (ByPropertyName) + + + + -Upid + + -- true true (ByPropertyName) @@ -36615,18 +41977,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveClusterSdnIpams

+

Remove-PvePools

-

Delete sdn ipam object configuration.

+

Delete pool.

Syntax

- Remove-PveClusterSdnIpams [[-PveTicket] <PveTicket>] [-Ipam] <String> [<CommonParameters>] + Remove-PvePools [[-PveTicket] <PveTicket>] [-Poolid] <String> [<CommonParameters>]
@@ -36652,9 +42014,9 @@

Parameters

- -Ipam + -Poolid - The SDN ipam object identifier. + -- true true (ByPropertyName) @@ -36668,18 +42030,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveClusterSdnVnets

+

Remove-PvePoolsIdx

-

Delete sdn vnet object configuration.

+

Delete pool (deprecated, no support for nested pools, use 'DELETE /pools/?poolid={poolid}').

Syntax

- Remove-PveClusterSdnVnets [[-PveTicket] <PveTicket>] [-Vnet] <String> [<CommonParameters>] + Remove-PvePoolsIdx [[-PveTicket] <PveTicket>] [-Poolid] <String> [<CommonParameters>]
@@ -36705,9 +42067,9 @@

Parameters

- -Vnet + -Poolid - The SDN vnet object identifier. + -- true true (ByPropertyName) @@ -36721,18 +42083,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveClusterSdnVnetsIps

+

Remove-PveNodesQemu

-

Delete IP Mappings in a VNet

+

Destroy the VM and all used/owned volumes. Removes any VM specific permissions and firewall rules

Syntax

- Remove-PveClusterSdnVnetsIps [[-PveTicket] <PveTicket>] [-Ip] <String> [[-Mac] <String>] [-Vnet] <String> [-Zone] <String> [<CommonParameters>] + Remove-PveNodesQemu [[-PveTicket] <PveTicket>] [-DestroyUnreferencedDisks] [-Node] <String> [-Purge] [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]
@@ -36758,36 +42120,44 @@

Parameters

- -Ip + -DestroyUnreferencedDisks - The IP address to delete + If set, destroy additionally all disks not referenced in the config but with a matching VMID from all enabled storages. + false + true (ByPropertyName) + False + + + -Node + + The cluster node name. true true (ByPropertyName) - -Mac + -Purge - Unicast MAC address. + Remove VMID from configurations, like backup & replication jobs and HA. false true (ByPropertyName) - + False - -Vnet + -Skiplock - The SDN vnet object identifier. - true + Ignore locks - only root is allowed to use this option. + false true (ByPropertyName) - + False - -Zone + -Vmid - The SDN zone object identifier. + The (unique) ID of the VM. true true (ByPropertyName) - + 0 @@ -36798,18 +42168,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveClusterSdnVnetsSubnets

+

Remove-PveNodesQemuSnapshot

-

Delete sdn subnet object configuration.

+

Delete a VM snapshot.

Syntax

- Remove-PveClusterSdnVnetsSubnets [[-PveTicket] <PveTicket>] [-Subnet] <String> [-Vnet] <String> [<CommonParameters>] + Remove-PveNodesQemuSnapshot [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
@@ -36835,73 +42205,36 @@

Parameters

- -Subnet + -Force - The SDN subnet object identifier. - true + For removal from config file, even if removing disk snapshots fails. + false true (ByPropertyName) - + False - -Vnet + -Node - The SDN vnet object identifier. + The cluster node name. true true (ByPropertyName) - - -
-
-

Outputs

-

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
-
-
-
-
-

Remove-PveClusterSdnZones

-

-

Delete sdn zone object configuration.

-
-
-

Syntax

-
-
-
- Remove-PveClusterSdnZones [[-PveTicket] <PveTicket>] [-Zone] <String> [<CommonParameters>] -
-
-
-

Parameters

- - - - - - - - - - - - - + - - + + - + - + - +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicket-Snapname Ticket data connection.falseThe name of the snapshot.true true (ByPropertyName)
-Zone-Vmid The SDN zone object identifier.The (unique) ID of the VM. true true (ByPropertyName)0
@@ -36912,18 +42245,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveNodesCephMds

+

Remove-PveStorage

-

Destroy Ceph Metadata Server

+

Delete storage configuration.

Syntax

- Remove-PveNodesCephMds [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [<CommonParameters>] + Remove-PveStorage [[-PveTicket] <PveTicket>] [-Storage] <String> [<CommonParameters>]
@@ -36949,17 +42282,9 @@

Parameters

- -Name - - The name (ID) of the mds - true - true (ByPropertyName) - - - - -Node + -Storage - The cluster node name. + The storage identifier. true true (ByPropertyName) @@ -36973,18 +42298,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveNodesCephMgr

+

Remove-PveVmSnapshot

-

Destroy Ceph Manager.

+

Delete a VM snapshot.

Syntax

- Remove-PveNodesCephMgr [[-PveTicket] <PveTicket>] [-Id] <String> [-Node] <String> [<CommonParameters>] + Remove-PveVmSnapshot [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [-Snapname] <String> [<CommonParameters>]
@@ -37006,23 +42331,23 @@

Parameters

Ticket data connection. false - true (ByPropertyName) + true (ByValue, ByPropertyName) - -Id + -VmIdOrName - The ID of the manager + The (unique) ID or Name of the VM. true - true (ByPropertyName) + true (ByValue, ByPropertyName) - -Node + -Snapname - The cluster node name. + The name of the snapshot. true - true (ByPropertyName) + true (ByValue, ByPropertyName) @@ -37034,18 +42359,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveNodesCephMon

+

New-PveNodesQemuStatusReset

-

Destroy Ceph Monitor and Manager.

+

Reset virtual machine.

Syntax

- Remove-PveNodesCephMon [[-PveTicket] <PveTicket>] [-Monid] <String> [-Node] <String> [<CommonParameters>] + New-PveNodesQemuStatusReset [[-PveTicket] <PveTicket>] [-Node] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]
@@ -37071,20 +42396,28 @@

Parameters

- -Monid + -Node - Monitor ID + The cluster node name. true true (ByPropertyName) - -Node + -Skiplock - The cluster node name. + Ignore locks - only root is allowed to use this option. + false + true (ByPropertyName) + False + + + -Vmid + + The (unique) ID of the VM. true true (ByPropertyName) - + 0 @@ -37095,18 +42428,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveNodesCephOsd

+

Reset-PveVm

-

Destroy OSD

+

Reset VM.

Syntax

- Remove-PveNodesCephOsd [[-PveTicket] <PveTicket>] [-Cleanup] [-Node] <String> [-Osdid] <Int32> [<CommonParameters>] + Reset-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]
@@ -37128,32 +42461,16 @@

Parameters

Ticket data connection. false - true (ByPropertyName) - - - - -Cleanup - - If set, we remove partition table entries. - false - true (ByPropertyName) - False - - - -Node - - The cluster node name. - true - true (ByPropertyName) + true (ByValue, ByPropertyName) - -Osdid + -VmIdOrName - OSD ID + The (unique) ID or Name of the VM. true - true (ByPropertyName) - 0 + true (ByValue, ByPropertyName) + @@ -37164,18 +42481,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveNodesCephPool

+

New-PveNodesLxcStatusReboot

-

Destroy pool

+

Reboot the container by shutting it down, and starting it again. Applies pending changes.

Syntax

- Remove-PveNodesCephPool [[-PveTicket] <PveTicket>] [-Force] [-Name] <String> [-Node] <String> [-RemoveEcprofile] [-RemoveStorages] [<CommonParameters>] + New-PveNodesLxcStatusReboot [[-PveTicket] <PveTicket>] [-Node] <String> [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
@@ -37200,22 +42517,6 @@

Parameters

true (ByPropertyName) - - -Force - - If true, destroys pool even if in use - false - true (ByPropertyName) - False - - - -Name - - The name of the pool. It must be unique. - true - true (ByPropertyName) - - -Node @@ -37225,20 +42526,20 @@

Parameters

- -RemoveEcprofile + -Timeout - Remove the erasure code profile. Defaults to true, if applicable. + Wait maximal timeout seconds for the shutdown. false true (ByPropertyName) - False + 0 - -RemoveStorages + -Vmid - Remove all pveceph-managed storages configured for this pool - false + The (unique) ID of the VM. + true true (ByPropertyName) - False + 0 @@ -37249,18 +42550,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveNodesCertificatesAcmeCertificate

+

New-PveNodesQemuStatusReboot

-

Revoke existing certificate from CA.

+

Reboot the VM by shutting it down, and starting it again. Applies pending changes.

Syntax

- Remove-PveNodesCertificatesAcmeCertificate [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] + New-PveNodesQemuStatusReboot [[-PveTicket] <PveTicket>] [-Node] <String> [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
@@ -37293,6 +42594,22 @@

Parameters

true (ByPropertyName) + + -Timeout + + Wait maximal timeout seconds for the shutdown. + false + true (ByPropertyName) + 0 + + + -Vmid + + The (unique) ID of the VM. + true + true (ByPropertyName) + 0 +
@@ -37302,18 +42619,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveNodesCertificatesCustom

+

New-PveNodesLxcStatusResume

-

DELETE custom certificate chain and key.

+

Resume the container.

Syntax

- Remove-PveNodesCertificatesCustom [[-PveTicket] <PveTicket>] [-Node] <String> [-Restart] [<CommonParameters>] + New-PveNodesLxcStatusResume [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
@@ -37347,12 +42664,12 @@

Parameters

- -Restart + -Vmid - Restart pveproxy. - false + The (unique) ID of the VM. + true true (ByPropertyName) - False + 0 @@ -37363,18 +42680,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveNodesDisksDirectory

+

New-PveNodesQemuStatusResume

-

Unmounts the storage and removes the mount unit.

+

Resume virtual machine.

Syntax

- Remove-PveNodesDisksDirectory [[-PveTicket] <PveTicket>] [-CleanupConfig] [-CleanupDisks] [-Name] <String> [-Node] <String> [<CommonParameters>] + New-PveNodesQemuStatusResume [[-PveTicket] <PveTicket>] [-Nocheck] [-Node] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]
@@ -37400,36 +42717,36 @@

Parameters

- -CleanupConfig + -Nocheck - Marks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only). + -- false true (ByPropertyName) False - -CleanupDisks + -Node - Also wipe disk so it can be repurposed afterwards. - false + The cluster node name. + true true (ByPropertyName) - False + - -Name + -Skiplock - The storage identifier. - true + Ignore locks - only root is allowed to use this option. + false true (ByPropertyName) - + False - -Node + -Vmid - The cluster node name. + The (unique) ID of the VM. true true (ByPropertyName) - + 0 @@ -37440,18 +42757,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveNodesDisksLvm

+

Resume-PveVm

-

Remove an LVM Volume Group.

+

Resume VM.

Syntax

- Remove-PveNodesDisksLvm [[-PveTicket] <PveTicket>] [-CleanupConfig] [-CleanupDisks] [-Name] <String> [-Node] <String> [<CommonParameters>] + Resume-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]
@@ -37473,39 +42790,15 @@

Parameters

Ticket data connection. false - true (ByPropertyName) - - - - -CleanupConfig - - Marks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only). - false - true (ByPropertyName) - False - - - -CleanupDisks - - Also wipe disks so they can be repurposed afterwards. - false - true (ByPropertyName) - False - - - -Name - - The storage identifier. - true - true (ByPropertyName) + true (ByValue, ByPropertyName) - -Node + -VmIdOrName - The cluster node name. + The (unique) ID or Name of the VM. true - true (ByPropertyName) + true (ByValue, ByPropertyName) @@ -37517,18 +42810,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveNodesDisksLvmthin

+

Set-PveAccessAcl

-

Remove an LVM thin pool.

+

Update Access Control List (add or remove permissions).

Syntax

- Remove-PveNodesDisksLvmthin [[-PveTicket] <PveTicket>] [-CleanupConfig] [-CleanupDisks] [-Name] <String> [-Node] <String> [-VolumeGroup] <String> [<CommonParameters>] + Set-PveAccessAcl [[-PveTicket] <PveTicket>] [-Delete] [[-Groups] <String>] [-Path] <String> [-Propagate] [-Roles] <String> [[-Tokens] <String>] [[-Users] <String>] [<CommonParameters>]
@@ -37554,42 +42847,58 @@

Parameters

- -CleanupConfig + -Delete - Marks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only). + Remove permissions (instead of adding it). false true (ByPropertyName) False - -CleanupDisks + -Groups - Also wipe disks so they can be repurposed afterwards. + List of groups. false true (ByPropertyName) - False + - -Name + -Path - The storage identifier. + Access control path true true (ByPropertyName) - -Node + -Propagate - The cluster node name. + Allow to propagate (inherit) permissions. + false + true (ByPropertyName) + False + + + -Roles + + List of roles. true true (ByPropertyName) - -VolumeGroup + -Tokens - The storage identifier. - true + List of API tokens. + false + true (ByPropertyName) + + + + -Users + + List of users. + false true (ByPropertyName) @@ -37602,18 +42911,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveNodesDisksZfs

+

Set-PveAccessDomains

-

Destroy a ZFS pool.

+

Update authentication server settings.

Syntax

- Remove-PveNodesDisksZfs [[-PveTicket] <PveTicket>] [-CleanupConfig] [-CleanupDisks] [-Name] <String> [-Node] <String> [<CommonParameters>] + Set-PveAccessDomains [[-PveTicket] <PveTicket>] [[-AcrValues] <String>] [-Autocreate] [[-BaseDn] <String>] [[-BindDn] <String>] [[-Capath] <String>] [-CaseSensitive] [[-Cert] <String>] [[-Certkey] <String>] [-CheckConnection] [[-ClientId] <String>] [[-ClientKey] <String>] [[-Comment] <String>] [-Default] [[-Delete] <String>] [[-Digest] <String>] [[-Domain] <String>] [[-Filter] <String>] [[-GroupClasses] <String>] [[-GroupDn] <String>] [[-GroupFilter] <String>] [[-GroupNameAttr] <String>] [[-IssuerUrl] <String>] [[-Mode] <String>] [[-Password] <SecureString>] [[-Port] <Int32>] [[-Prompt] <String>] [-Realm] <String> [[-Scopes] <String>] [-Secure] [[-Server1] <String>] [[-Server2] <String>] [[-Sslversion] <String>] [[-SyncDefaultsOptions] <String>] [[-SyncAttributes] <String>] [[-Tfa] <String>] [[-UserAttr] <String>] [[-UserClasses] <String>] [-Verify] [<CommonParameters>]
@@ -37639,78 +42948,113 @@

Parameters

- -CleanupConfig + -AcrValues - Marks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only). + Specifies the Authentication Context Class Reference values that theAuthorization Server is being requested to use for the Auth Request. + false + true (ByPropertyName) + + + + -Autocreate + + Automatically create users if they do not exist. false true (ByPropertyName) False - -CleanupDisks + -BaseDn - Also wipe disks so they can be repurposed afterwards. + LDAP base domain name + false + true (ByPropertyName) + + + + -BindDn + + LDAP bind domain name + false + true (ByPropertyName) + + + + -Capath + + Path to the CA certificate store + false + true (ByPropertyName) + + + + -CaseSensitive + + username is case-sensitive false true (ByPropertyName) False - -Name + -Cert - The storage identifier. - true + Path to the client certificate + false true (ByPropertyName) - -Node + -Certkey - The cluster node name. - true + Path to the client certificate key + false true (ByPropertyName) - - -
-
-

Outputs

-

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
-
-
-
-
-

Remove-PveNodesFirewallRules

-

-

Delete rule.

-
-
-

Syntax

-
-
-
- Remove-PveNodesFirewallRules [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Node] <String> [[-Pos] <Int32>] [<CommonParameters>] -
-
-
-

Parameters

- - - - - - - - - - - - - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -37724,20 +43068,188 @@

Parameters

- + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicket-CheckConnection Ticket data connection.Check bind connection to the server.falsetrue (ByPropertyName)False
-ClientIdOpenID Client IDfalsetrue (ByPropertyName)
-ClientKeyOpenID Client Keyfalsetrue (ByPropertyName)
-CommentDescription.falsetrue (ByPropertyName)
-DefaultUse this as default realmfalsetrue (ByPropertyName)False
-DeleteA list of settings you want to delete. false true (ByPropertyName)
-Node-Domain The cluster node name.AD domain namefalsetrue (ByPropertyName)
-FilterLDAP filter for user sync.falsetrue (ByPropertyName)
-GroupClassesThe objectclasses for groups.falsetrue (ByPropertyName)
-GroupDnLDAP base domain name for group sync. If not set, the base_dn will be used.falsetrue (ByPropertyName)
-GroupFilterLDAP filter for group sync.falsetrue (ByPropertyName)
-GroupNameAttrLDAP attribute representing a groups name. If not set or found, the first value of the DN will be used as name.falsetrue (ByPropertyName)
-IssuerUrlOpenID Issuer Urlfalsetrue (ByPropertyName)
-ModeLDAP protocol mode. Enum: ldap,ldaps,ldap+starttlsfalsetrue (ByPropertyName)
-PasswordLDAP bind password. Will be stored in '/etc/pve/priv/realm/<REALM>.pw'.falsetrue (ByPropertyName)
-PortServer port.falsetrue (ByPropertyName)0
-PromptSpecifies whether the Authorization Server prompts the End-User for reauthentication and consent.falsetrue (ByPropertyName)
-RealmAuthentication domain ID true true (ByPropertyName)
-Pos-ScopesSpecifies the scopes (user details) that should be authorized and returned, for example 'email' or 'profile'.falsetrue (ByPropertyName)
-SecureUse secure LDAPS protocol. DEPRECATED':' use 'mode' instead.falsetrue (ByPropertyName)False
-Server1Server IP address (or DNS name)falsetrue (ByPropertyName)
-Server2Fallback Server IP address (or DNS name)falsetrue (ByPropertyName)
-SslversionLDAPS TLS/SSL version. It's not recommended to use version older than 1.2! Enum: tlsv1,tlsv1_1,tlsv1_2,tlsv1_3falsetrue (ByPropertyName)
-SyncDefaultsOptionsThe default options for behavior of synchronizations.falsetrue (ByPropertyName)
-SyncAttributesComma separated list of key=value pairs for specifying which LDAP attributes map to which PVE user field. For example, to map the LDAP attribute 'mail' to PVEs 'email', write 'email=mail'. By default, each PVE user field is represented by an LDAP attribute of the same name.falsetrue (ByPropertyName)
-TfaUse Two-factor authentication.falsetrue (ByPropertyName)
-UserAttrLDAP user attribute namefalsetrue (ByPropertyName)
-UserClassesThe objectclasses for users.falsetrue (ByPropertyName)
-Verify Update rule at position <pos>.Verify the server's SSL certificate false true (ByPropertyName)0False
@@ -37748,18 +43260,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveNodesLxc

+

Set-PveAccessGroups

-

Destroy the container (also delete all uses files).

+

Update group data.

Syntax

- Remove-PveNodesLxc [[-PveTicket] <PveTicket>] [-DestroyUnreferencedDisks] [-Force] [-Node] <String> [-Purge] [-Vmid] <Int32> [<CommonParameters>] + Set-PveAccessGroups [[-PveTicket] <PveTicket>] [[-Comment] <String>] [-Groupid] <String> [<CommonParameters>]
@@ -37785,44 +43297,20 @@

Parameters

- -DestroyUnreferencedDisks - - If set, destroy additionally all disks with the VMID from all enabled storages which are not referenced in the config. - false - true (ByPropertyName) - False - - - -Force + -Comment - Force destroy, even if running. + -- false true (ByPropertyName) - False - - - -Node - - The cluster node name. - true - true (ByPropertyName) - -Purge - - Remove container from all related configurations. For example, backup jobs, replication jobs or HA. Related ACLs and Firewall entries will *always* be removed. - false - true (ByPropertyName) - False - - - -Vmid + -Groupid - The (unique) ID of the VM. + -- true true (ByPropertyName) - 0 + @@ -37833,18 +43321,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveNodesLxcFirewallAliases

+

Set-PveAccessPassword

-

Remove IP or Network alias.

+

Change user password.

Syntax

- Remove-PveNodesLxcFirewallAliases [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] + Set-PveAccessPassword [[-PveTicket] <PveTicket>] [[-ConfirmationPassword] <SecureString>] [-Password] <SecureString> [-Userid] <String> [<CommonParameters>]
@@ -37870,37 +43358,29 @@

Parameters

- -Digest + -ConfirmationPassword - Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. + The current password of the user performing the change. false true (ByPropertyName) - -Name + -Password - Alias name. + The new password. true true (ByPropertyName) - -Node + -Userid - The cluster node name. + Full User ID, in the `name@realm` format. true true (ByPropertyName) - - -Vmid - - The (unique) ID of the VM. - true - true (ByPropertyName) - 0 -
@@ -37910,18 +43390,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveNodesLxcFirewallIpset

+

Set-PveAccessRoles

-

Delete IPSet

+

Update an existing role.

Syntax

- Remove-PveNodesLxcFirewallIpset [[-PveTicket] <PveTicket>] [-Force] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] + Set-PveAccessRoles [[-PveTicket] <PveTicket>] [-Append] [[-Privs] <String>] [-Roleid] <String> [<CommonParameters>]
@@ -37947,37 +43427,29 @@

Parameters

- -Force + -Append - Delete all members of the IPSet, if there are any. + -- false true (ByPropertyName) False - -Name + -Privs - IP set name. - true + -- + false true (ByPropertyName) - -Node + -Roleid - The cluster node name. + -- true true (ByPropertyName) - - -Vmid - - The (unique) ID of the VM. - true - true (ByPropertyName) - 0 -
@@ -37987,18 +43459,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveNodesLxcFirewallIpsetIdx

+

Set-PveAccessTfa

-

Remove IP or Network from IPSet.

+

Add a TFA entry for a user.

Syntax

- Remove-PveNodesLxcFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] + Set-PveAccessTfa [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Enable] [-Id] <String> [[-Password] <SecureString>] [-Userid] <String> [<CommonParameters>]
@@ -38024,44 +43496,44 @@

Parameters

- -Cidr + -Description - Network/IP specification in CIDR format. - true + A description to distinguish multiple entries from one another + false true (ByPropertyName) - -Digest + -Enable - Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. + Whether the entry should be enabled for login. false true (ByPropertyName) - + False - -Name + -Id - IP set name. + A TFA entry id. true true (ByPropertyName) - -Node + -Password - The cluster node name. - true + The current password of the user performing the change. + false true (ByPropertyName) - -Vmid + -Userid - The (unique) ID of the VM. + Full User ID, in the `name@realm` format. true true (ByPropertyName) - 0 + @@ -38072,18 +43544,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveNodesLxcFirewallRules

+

Set-PveAccessUsers

-

Delete rule.

+

Update user configuration.

Syntax

- Remove-PveNodesLxcFirewallRules [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Node] <String> [[-Pos] <Int32>] [-Vmid] <Int32> [<CommonParameters>] + Set-PveAccessUsers [[-PveTicket] <PveTicket>] [-Append] [[-Comment] <String>] [[-Email] <String>] [-Enable] [[-Expire] <Int32>] [[-Firstname] <String>] [[-Groups] <String>] [[-Keys] <String>] [[-Lastname] <String>] [-Userid] <String> [<CommonParameters>]
@@ -38109,36 +43581,84 @@

Parameters

- -Digest + -Append - Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. + -- + false + true (ByPropertyName) + False + + + -Comment + + -- false true (ByPropertyName) - -Node + -Email - The cluster node name. - true + -- + false true (ByPropertyName) - -Pos + -Enable - Update rule at position <pos>. + Enable the account (default). You can set this to '0' to disable the account + false + true (ByPropertyName) + False + + + -Expire + + Account expiration date (seconds since epoch). '0' means no expiration date. false true (ByPropertyName) 0 - -Vmid + -Firstname - The (unique) ID of the VM. + -- + false + true (ByPropertyName) + + + + -Groups + + -- + false + true (ByPropertyName) + + + + -Keys + + Keys for two factor auth (yubico). + false + true (ByPropertyName) + + + + -Lastname + + -- + false + true (ByPropertyName) + + + + -Userid + + Full User ID, in the `name@realm` format. true true (ByPropertyName) - 0 + @@ -38149,18 +43669,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveNodesLxcSnapshot

+

Set-PveAccessUsersToken

-

Delete a LXC snapshot.

+

Update API token for a specific user.

Syntax

- Remove-PveNodesLxcSnapshot [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>] + Set-PveAccessUsersToken [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Expire] <Int32>] [-Privsep] [-Tokenid] <String> [-Userid] <String> [<CommonParameters>]
@@ -38186,36 +43706,44 @@

Parameters

- -Force + -Comment - For removal from config file, even if removing disk snapshots fails. + -- false true (ByPropertyName) - False + - -Node + -Expire - The cluster node name. - true + API token expiration date (seconds since epoch). '0' means no expiration date. + false true (ByPropertyName) - + 0 - -Snapname + -Privsep - The name of the snapshot. + Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. + false + true (ByPropertyName) + False + + + -Tokenid + + User-specific token identifier. true true (ByPropertyName) - -Vmid + -Userid - The (unique) ID of the VM. + Full User ID, in the `name@realm` format. true true (ByPropertyName) - 0 + @@ -38226,18 +43754,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveNodesNetwork

+

Set-PveAccessUsersUnlockTfa

-

Revert network configuration changes.

+

Unlock a user's TFA authentication.

Syntax

- Remove-PveNodesNetwork [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] + Set-PveAccessUsersUnlockTfa [[-PveTicket] <PveTicket>] [-Userid] <String> [<CommonParameters>]
@@ -38263,9 +43791,9 @@

Parameters

- -Node + -Userid - The cluster node name. + Full User ID, in the `name@realm` format. true true (ByPropertyName) @@ -38279,18 +43807,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveNodesNetworkIdx

+

Set-PveClusterAcmeAccount

-

Delete network device configuration

+

Update existing ACME account information with CA. Note':' not specifying any new account information triggers a refresh.

Syntax

- Remove-PveNodesNetworkIdx [[-PveTicket] <PveTicket>] [-Iface] <String> [-Node] <String> [<CommonParameters>] + Set-PveClusterAcmeAccount [[-PveTicket] <PveTicket>] [[-Contact] <String>] [[-Name] <String>] [<CommonParameters>]
@@ -38316,18 +43844,18 @@

Parameters

- -Iface + -Contact - Network interface name. - true + Contact email addresses. + false true (ByPropertyName) - -Node + -Name - The cluster node name. - true + ACME account config file name. + false true (ByPropertyName) @@ -38340,18 +43868,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveNodesQemu

+

Set-PveClusterAcmePlugins

-

Destroy the VM and all used/owned volumes. Removes any VM specific permissions and firewall rules

+

Update ACME plugin configuration.

Syntax

- Remove-PveNodesQemu [[-PveTicket] <PveTicket>] [-DestroyUnreferencedDisks] [-Node] <String> [-Purge] [-Skiplock] [-Vmid] <Int32> [<CommonParameters>] + Set-PveClusterAcmePlugins [[-PveTicket] <PveTicket>] [[-Api] <String>] [[-Data] <String>] [[-Delete] <String>] [[-Digest] <String>] [-Disable] [-Id] <String> [[-Nodes] <String>] [[-ValidationDelay] <Int32>] [<CommonParameters>]
@@ -38377,43 +43905,67 @@

Parameters

- -DestroyUnreferencedDisks + -Api - If set, destroy additionally all disks not referenced in the config but with a matching VMID from all enabled storages. + API plugin name Enum: 1984hosting,acmedns,acmeproxy,active24,ad,ali,anx,artfiles,arvan,aurora,autodns,aws,azion,azure,bookmyname,bunny,cf,clouddns,cloudns,cn,conoha,constellix,cpanel,curanet,cyon,da,ddnss,desec,df,dgon,dnsexit,dnshome,dnsimple,dnsservices,do,doapi,domeneshop,dp,dpi,dreamhost,duckdns,durabledns,dyn,dynu,dynv6,easydns,edgedns,euserv,exoscale,fornex,freedns,gandi_livedns,gcloud,gcore,gd,geoscaling,googledomains,he,hetzner,hexonet,hostingde,huaweicloud,infoblox,infomaniak,internetbs,inwx,ionos,ipv64,ispconfig,jd,joker,kappernet,kas,kinghost,knot,la,leaseweb,lexicon,linode,linode_v4,loopia,lua,maradns,me,miab,misaka,myapi,mydevil,mydnsjp,mythic_beasts,namecheap,namecom,namesilo,nanelo,nederhost,neodigit,netcup,netlify,nic,njalla,nm,nsd,nsone,nsupdate,nw,oci,one,online,openprovider,openstack,opnsense,ovh,pdns,pleskxml,pointhq,porkbun,rackcorp,rackspace,rage4,rcode0,regru,scaleway,schlundtech,selectel,selfhost,servercow,simply,tele3,tencent,transip,udr,ultra,unoeuro,variomedia,veesp,vercel,vscale,vultr,websupport,world4you,yandex,yc,zilore,zone,zonomi false true (ByPropertyName) - False + - -Node + -Data - The cluster node name. - true + DNS plugin data. (base64 encoded) + false true (ByPropertyName) - -Purge + -Delete - Remove VMID from configurations, like backup & replication jobs and HA. + A list of settings you want to delete. false true (ByPropertyName) - False + - -Skiplock + -Digest - Ignore locks - only root is allowed to use this option. + Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. + false + true (ByPropertyName) + + + + -Disable + + Flag to disable the config. false true (ByPropertyName) False - -Vmid + -Id - The (unique) ID of the VM. + ACME Plugin ID name true true (ByPropertyName) + + + + -Nodes + + List of cluster node names. + false + true (ByPropertyName) + + + + -ValidationDelay + + Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records. + false + true (ByPropertyName) 0 @@ -38425,18 +43977,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveNodesQemuFirewallAliases

+

Set-PveClusterBackup

-

Remove IP or Network alias.

+

Update vzdump backup job definition.

Syntax

- Remove-PveNodesQemuFirewallAliases [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] + Set-PveClusterBackup [[-PveTicket] <PveTicket>] [-All] [[-Bwlimit] <Int32>] [[-Comment] <String>] [[-Compress] <String>] [[-Delete] <String>] [[-Dow] <String>] [[-Dumpdir] <String>] [-Enabled] [[-Exclude] <String>] [[-ExcludePath] <Array>] [[-Fleecing] <String>] [-Id] <String> [[-Ionice] <Int32>] [[-Lockwait] <Int32>] [[-Mailnotification] <String>] [[-Mailto] <String>] [[-Maxfiles] <Int32>] [[-Mode] <String>] [[-Node] <String>] [[-NotesTemplate] <String>] [[-NotificationMode] <String>] [[-NotificationPolicy] <String>] [[-NotificationTarget] <String>] [[-Performance] <String>] [[-Pigz] <Int32>] [[-Pool] <String>] [-Protected] [[-PruneBackups] <String>] [-Quiet] [-Remove] [-RepeatMissed] [[-Schedule] <String>] [[-Script] <String>] [[-Starttime] <String>] [-Stdexcludes] [-Stop] [[-Stopwait] <Int32>] [[-Storage] <String>] [[-Tmpdir] <String>] [[-Vmid] <String>] [[-Zstd] <Int32>] [<CommonParameters>]
@@ -38462,511 +44014,329 @@

Parameters

- -Digest + -All - Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. + Backup all known guest systems on this host. + false + true (ByPropertyName) + False + + + -Bwlimit + + Limit I/O bandwidth (in KiB/s). + false + true (ByPropertyName) + 0 + + + -Comment + + Description for the Job. false true (ByPropertyName) - -Name + -Compress - Alias name. - true + Compress dump file. Enum: 0,1,gzip,lzo,zstd + false true (ByPropertyName) - -Node + -Delete - The cluster node name. - true + A list of settings you want to delete. + false true (ByPropertyName) - -Vmid + -Dow - The (unique) ID of the VM. - true + Day of week selection. + false true (ByPropertyName) - 0 + - - -
-
-

Outputs

-

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
-
-
-
-
-

Remove-PveNodesQemuFirewallIpset

-

-

Delete IPSet

-
-
-

Syntax

-
-
-
- Remove-PveNodesQemuFirewallIpset [[-PveTicket] <PveTicket>] [-Force] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] -
-
-
-

Parameters

- - - - - - - - - - - - - + - + - + - + - + - - + + - + - - + + - + - + + + + + + + + + - + + + + + + + + + - -
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicket-Dumpdir Ticket data connection.Store resulting files to specified directory. false true (ByPropertyName)
-Force-Enabled Delete all members of the IPSet, if there are any.Enable or disable the job. false true (ByPropertyName) False
-Name-Exclude IP set name.trueExclude specified guest systems (assumes --all)false true (ByPropertyName)
-Node-ExcludePath The cluster node name.trueExclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory.false true (ByPropertyName)
-Vmid-Fleecing The (unique) ID of the VM.Options for backup fleecing (VM only).falsetrue (ByPropertyName)
-IdThe job ID. true true (ByPropertyName)0
-IoniceSet IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value.falsetrue (ByPropertyName)0
-
-
-

Outputs

-

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
-
-
-
-
-

Remove-PveNodesQemuFirewallIpsetIdx

-

-

Remove IP or Network from IPSet.

-
-
-

Syntax

-
-
-
- Remove-PveNodesQemuFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] -
-
-
-

Parameters

- - - - - - - - - - - - - + - + - + - + - - + + - + - + - + - - + + + + + + + + + + - - + + - + - - + + - + - -
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicket-Lockwait Ticket data connection.Maximal time to wait for the global lock (minutes). false true (ByPropertyName)0
-Cidr-Mailnotification Network/IP specification in CIDR format.trueDeprecated':' use notification targets/matchers instead. Specify when to send a notification mail Enum: always,failurefalse true (ByPropertyName)
-Digest-Mailto Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.Deprecated':' Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications. false true (ByPropertyName)
-Name-Maxfiles IP set name.trueDeprecated':' use 'prune-backups' instead. Maximal number of backup files per guest system.falsetrue (ByPropertyName)0
-ModeBackup mode. Enum: snapshot,suspend,stopfalse true (ByPropertyName)
-Node The cluster node name.trueOnly run if executed on this node.false true (ByPropertyName)
-Vmid-NotesTemplate The (unique) ID of the VM.trueTemplate string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively.false true (ByPropertyName)0
-
-
-

Outputs

-

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
-
-
-
-
-

Remove-PveNodesQemuFirewallRules

-

-

Delete rule.

-
-
-

Syntax

-
-
-
- Remove-PveNodesQemuFirewallRules [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Node] <String> [[-Pos] <Int32>] [-Vmid] <Int32> [<CommonParameters>] -
-
-
-

Parameters

- - - - - - - - - - - - - + - + - + - + - + - - + + - + - + - + - + - - + + - -
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicket-NotificationMode Ticket data connection.Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not. Enum: auto,legacy-sendmail,notification-system false true (ByPropertyName)
-Digest-NotificationPolicy Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.Deprecated':' Do not use Enum: always,failure,never false true (ByPropertyName)
-Node-NotificationTarget The cluster node name.trueDeprecated':' Do not usefalse true (ByPropertyName)
-Pos-Performance Update rule at position <pos>.Other performance-related settings. false true (ByPropertyName)0
-Vmid-Pigz The (unique) ID of the VM.trueUse pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.false true (ByPropertyName) 0
-
-
-

Outputs

-

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
-
-
-
-
-

Remove-PveNodesQemuSnapshot

-

-

Delete a VM snapshot.

-
-
-

Syntax

-
-
-
- Remove-PveNodesQemuSnapshot [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>] -
-
-
-

Parameters

- - - - - - - - - - - - - + - + - + - + - + - - + + - + - - + + - + - + - - + + - + - -
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicket-Pool Ticket data connection.Backup all known guest systems included in the specified pool. false true (ByPropertyName)
-Force-Protected For removal from config file, even if removing disk snapshots fails.If true, mark backup(s) as protected. false true (ByPropertyName) False
-Node-PruneBackups The cluster node name.trueUse these retention options instead of those from the storage configuration.false true (ByPropertyName)
-Snapname-Quiet The name of the snapshot.trueBe quiet.false true (ByPropertyName)False
-Vmid-Remove The (unique) ID of the VM.truePrune older backups according to 'prune-backups'.false true (ByPropertyName)0False
-
-
-

Outputs

-

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
-
-
-
-
-

Remove-PveNodesStorageContent

-

-

Delete volume

-
-
-

Syntax

-
-
-
- Remove-PveNodesStorageContent [[-PveTicket] <PveTicket>] [[-Delay] <Int32>] [-Node] <String> [[-Storage] <String>] [-Volume] <String> [<CommonParameters>] -
-
-
-

Parameters

- - - - - - - - - - - - - + - + - + - + - + - + - + - - + + - + - + - + - - + + - + - -
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicket-RepeatMissed Ticket data connection.If true, the job will be run as soon as possible if it was missed while the scheduler was not running. false true (ByPropertyName)False
-Delay-Schedule Time to wait for the task to finish. We return 'null' if the task finish within that time.Backup schedule. The format is a subset of `systemd` calendar events. false true (ByPropertyName)0
-Node-Script The cluster node name.trueUse specified hook script.false true (ByPropertyName)
-Storage-Starttime The storage identifier.Job Start time. false true (ByPropertyName)
-Volume-Stdexcludes Volume identifiertrueExclude temporary files and logs.false true (ByPropertyName)False
-
-
-

Outputs

-

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
-
-
-
-
-

Remove-PveNodesStoragePrunebackups

-

-

Prune backups. Only those using the standard naming scheme are considered.

-
-
-

Syntax

-
-
-
- Remove-PveNodesStoragePrunebackups [[-PveTicket] <PveTicket>] [-Node] <String> [[-PruneBackups] <String>] [-Storage] <String> [[-Type] <String>] [[-Vmid] <Int32>] [<CommonParameters>] -
-
-
-

Parameters

- - - - - - - - - - - - - + - + - + - + - - + + - + - + - + - + - - + + - + - + - + - + @@ -38980,18 +44350,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveNodesSubscription

+

Set-PveClusterCephFlags

-

Delete subscription key of this node.

+

Set/Unset multiple ceph flags at once.

Syntax

- Remove-PveNodesSubscription [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] + Set-PveClusterCephFlags [[-PveTicket] <PveTicket>] [-Nobackfill] [-NodeepScrub] [-Nodown] [-Noin] [-Noout] [-Norebalance] [-Norecover] [-Noscrub] [-Notieragent] [-Noup] [-Pause] [<CommonParameters>]
@@ -39017,179 +44387,92 @@

Parameters

- + - - + + - + - -
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicket-Stop Ticket data connection.Stop running backup jobs on this host. false true (ByPropertyName)False
-Node-Stopwait The cluster node name.trueMaximal time to wait until a guest system is stopped (minutes).false true (ByPropertyName)0
-PruneBackups-Storage Use these retention options instead of those from the storage configuration.Store resulting file to this storage. false true (ByPropertyName)
-Storage-Tmpdir The storage identifier.trueStore temporary files to specified directory.false true (ByPropertyName)
-Type-Vmid Either 'qemu' or 'lxc'. Only consider backups for guests of this type. Enum: qemu,lxcThe ID of the guest system you want to backup. false true (ByPropertyName)
-Vmid-Zstd Only prune backups for this VM.Zstd threads. N=0 uses half of the available cores, if N is set to a value bigger than 0, N is used as thread count. false true (ByPropertyName) 0
-Node-Nobackfill The cluster node name.trueBackfilling of PGs is suspended.false true (ByPropertyName)False
-
-
-

Outputs

-

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
-
-
-
-
-

Remove-PveNodesTasks

-

-

Stop a task.

-
-
-

Syntax

-
-
-
- Remove-PveNodesTasks [[-PveTicket] <PveTicket>] [-Node] <String> [-Upid] <String> [<CommonParameters>] -
-
-
-

Parameters

- - - - - - - - - - - - - + - + - + - + - - + + - + - + - - + + - + - -
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicket-NodeepScrub Ticket data connection.Deep Scrubbing is disabled. false true (ByPropertyName)False
-Node-Nodown The cluster node name.trueOSD failure reports are being ignored, such that the monitors will not mark OSDs down.false true (ByPropertyName)False
-Upid-Noin --trueOSDs that were previously marked out will not be marked back in when they start.false true (ByPropertyName)False
-
-
-

Outputs

-

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
-
-
-
-
-

Remove-PvePools

-

-

Delete pool.

-
-
-

Syntax

-
-
-
- Remove-PvePools [[-PveTicket] <PveTicket>] [-Poolid] <String> [<CommonParameters>] -
-
-
-

Parameters

- - - - - - - - - - - - - + - + - + - + - - + + - + - -
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicket-Noout Ticket data connection.OSDs will not automatically be marked out after the configured interval. false true (ByPropertyName)False
-Poolid-Norebalance --trueRebalancing of PGs is suspended.false true (ByPropertyName)False
-
-
-

Outputs

-

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
-
-
-
-
-

Remove-PvePoolsIdx

-

-

Delete pool (deprecated, no support for nested pools, use 'DELETE /pools/?poolid={poolid}').

-
-
-

Syntax

-
-
-
- Remove-PvePoolsIdx [[-PveTicket] <PveTicket>] [-Poolid] <String> [<CommonParameters>] -
-
-
-

Parameters

- - - - - - - - - - - - - + - + - + - + - - + + - + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicket-Norecover Ticket data connection.Recovery of PGs is suspended. false true (ByPropertyName)False
-Poolid-Noscrub --trueScrubbing is disabled.false true (ByPropertyName)False
-NotieragentCache tiering activity is suspended.falsetrue (ByPropertyName)False
-NoupOSDs are not allowed to start.falsetrue (ByPropertyName)False
-PausePauses read and writes.falsetrue (ByPropertyName)False
@@ -39200,18 +44483,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveStorage

+

Set-PveClusterCephFlagsIdx

-

Delete storage configuration.

+

Set or clear (unset) a specific ceph flag

Syntax

- Remove-PveStorage [[-PveTicket] <PveTicket>] [-Storage] <String> [<CommonParameters>] + Set-PveClusterCephFlagsIdx [[-PveTicket] <PveTicket>] [-Flag] <String> -Value [<CommonParameters>]
@@ -39237,13 +44520,21 @@

Parameters

- -Storage + -Flag - The storage identifier. + The ceph flag to update Enum: nobackfill,nodeep-scrub,nodown,noin,noout,norebalance,norecover,noscrub,notieragent,noup,pause true true (ByPropertyName) + + -Value + + The new value of the flag + true + true (ByPropertyName) + False +
@@ -39253,18 +44544,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Remove-PveVmSnapshot

+

Set-PveClusterFirewallAliases

-

Delete a VM snapshot.

+

Update IP or Network alias.

Syntax

- Remove-PveVmSnapshot [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [-Snapname] <String> [<CommonParameters>] + Set-PveClusterFirewallAliases [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [[-Rename] <String>] [<CommonParameters>]
@@ -39286,23 +44577,47 @@

Parameters

Ticket data connection. false - true (ByValue, ByPropertyName) + true (ByPropertyName) - -VmIdOrName + -Cidr - The (unique) ID or Name of the VM. + Network/IP specification in CIDR format. true - true (ByValue, ByPropertyName) + true (ByPropertyName) - -Snapname + -Comment - The name of the snapshot. + -- + false + true (ByPropertyName) + + + + -Digest + + Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. + false + true (ByPropertyName) + + + + -Name + + Alias name. true - true (ByValue, ByPropertyName) + true (ByPropertyName) + + + + -Rename + + Rename an existing alias. + false + true (ByPropertyName) @@ -39314,18 +44629,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Reset-PveVm

+

Set-PveClusterFirewallGroups

-

Reset VM.

+

Modify rule data.

Syntax

- Reset-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>] + Set-PveClusterFirewallGroups [[-PveTicket] <PveTicket>] [[-Action] <String>] [[-Comment] <String>] [[-Delete] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [-Group] <String> [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [[-Moveto] <Int32>] [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [[-Type] <String>] [<CommonParameters>]
@@ -39347,15 +44662,151 @@

Parameters

Ticket data connection. false - true (ByValue, ByPropertyName) + true (ByPropertyName) - -VmIdOrName + -Action - The (unique) ID or Name of the VM. + Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. + false + true (ByPropertyName) + + + + -Comment + + Descriptive comment. + false + true (ByPropertyName) + + + + -Delete + + A list of settings you want to delete. + false + true (ByPropertyName) + + + + -Dest + + Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. + false + true (ByPropertyName) + + + + -Digest + + Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. + false + true (ByPropertyName) + + + + -Dport + + Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges. + false + true (ByPropertyName) + + + + -Enable + + Flag to enable/disable a rule. + false + true (ByPropertyName) + 0 + + + -Group + + Security Group name. true - true (ByValue, ByPropertyName) + true (ByPropertyName) + + + + -IcmpType + + Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. + false + true (ByPropertyName) + + + + -Iface + + Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. + false + true (ByPropertyName) + + + + -Log + + Log level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog + false + true (ByPropertyName) + + + + -Macro + + Use predefined standard macro. + false + true (ByPropertyName) + + + + -Moveto + + Move rule to new position <moveto>. Other arguments are ignored. + false + true (ByPropertyName) + 0 + + + -Pos + + Update rule at position <pos>. + false + true (ByPropertyName) + 0 + + + -Proto + + IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. + false + true (ByPropertyName) + + + + -Source + + Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. + false + true (ByPropertyName) + + + + -Sport + + Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges. + false + true (ByPropertyName) + + + + -Type + + Rule type. Enum: in,out,group + false + true (ByPropertyName) @@ -39367,18 +44818,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Resume-PveVm

+

Set-PveClusterFirewallIpset

-

Resume VM.

+

Update IP or Network settings

Syntax

- Resume-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>] + Set-PveClusterFirewallIpset [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Nomatch] [<CommonParameters>]
@@ -39400,17 +44851,49 @@

Parameters

Ticket data connection. false - true (ByValue, ByPropertyName) + true (ByPropertyName) - -VmIdOrName + -Cidr - The (unique) ID or Name of the VM. + Network/IP specification in CIDR format. true - true (ByValue, ByPropertyName) + true (ByPropertyName) + + + + -Comment + + -- + false + true (ByPropertyName) + + + + -Digest + + Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. + false + true (ByPropertyName) + + + + -Name + + IP set name. + true + true (ByPropertyName) + + -Nomatch + + -- + false + true (ByPropertyName) + False +
@@ -39420,18 +44903,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveAccessAcl

+

Set-PveClusterFirewallOptions

-

Update Access Control List (add or remove permissions).

+

Set Firewall options.

Syntax

- Set-PveAccessAcl [[-PveTicket] <PveTicket>] [-Delete] [[-Groups] <String>] [-Path] <String> [-Propagate] [-Roles] <String> [[-Tokens] <String>] [[-Users] <String>] [<CommonParameters>] + Set-PveClusterFirewallOptions [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Digest] <String>] [-Ebtables] [[-Enable] <Int32>] [[-LogRatelimit] <String>] [[-PolicyIn] <String>] [[-PolicyOut] <String>] [<CommonParameters>]
@@ -39459,55 +44942,55 @@

Parameters

-Delete - Remove permissions (instead of adding it). + A list of settings you want to delete. false true (ByPropertyName) - False + - -Groups + -Digest - List of groups. + Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName) - -Path + -Ebtables - Access control path - true + Enable ebtables rules cluster wide. + false true (ByPropertyName) - + False - -Propagate + -Enable - Allow to propagate (inherit) permissions. + Enable or disable the firewall cluster wide. false true (ByPropertyName) - False + 0 - -Roles + -LogRatelimit - List of roles. - true + Log ratelimiting settings + false true (ByPropertyName) - -Tokens + -PolicyIn - List of API tokens. + Input policy. Enum: ACCEPT,REJECT,DROP false true (ByPropertyName) - -Users + -PolicyOut - List of users. + Output policy. Enum: ACCEPT,REJECT,DROP false true (ByPropertyName) @@ -39521,18 +45004,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveAccessDomains

+

Set-PveClusterFirewallRules

-

Update authentication server settings.

+

Modify rule data.

Syntax

- Set-PveAccessDomains [[-PveTicket] <PveTicket>] [[-AcrValues] <String>] [-Autocreate] [[-BaseDn] <String>] [[-BindDn] <String>] [[-Capath] <String>] [-CaseSensitive] [[-Cert] <String>] [[-Certkey] <String>] [-CheckConnection] [[-ClientId] <String>] [[-ClientKey] <String>] [[-Comment] <String>] [-Default] [[-Delete] <String>] [[-Digest] <String>] [[-Domain] <String>] [[-Filter] <String>] [[-GroupClasses] <String>] [[-GroupDn] <String>] [[-GroupFilter] <String>] [[-GroupNameAttr] <String>] [[-IssuerUrl] <String>] [[-Mode] <String>] [[-Password] <SecureString>] [[-Port] <Int32>] [[-Prompt] <String>] [-Realm] <String> [[-Scopes] <String>] [-Secure] [[-Server1] <String>] [[-Server2] <String>] [[-Sslversion] <String>] [[-SyncDefaultsOptions] <String>] [[-SyncAttributes] <String>] [[-Tfa] <String>] [[-UserAttr] <String>] [[-UserClasses] <String>] [-Verify] [<CommonParameters>] + Set-PveClusterFirewallRules [[-PveTicket] <PveTicket>] [[-Action] <String>] [[-Comment] <String>] [[-Delete] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [[-Moveto] <Int32>] [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [[-Type] <String>] [<CommonParameters>]
@@ -39558,89 +45041,9 @@

Parameters

- -AcrValues - - Specifies the Authentication Context Class Reference values that theAuthorization Server is being requested to use for the Auth Request. - false - true (ByPropertyName) - - - - -Autocreate - - Automatically create users if they do not exist. - false - true (ByPropertyName) - False - - - -BaseDn - - LDAP base domain name - false - true (ByPropertyName) - - - - -BindDn - - LDAP bind domain name - false - true (ByPropertyName) - - - - -Capath - - Path to the CA certificate store - false - true (ByPropertyName) - - - - -CaseSensitive - - username is case-sensitive - false - true (ByPropertyName) - False - - - -Cert - - Path to the client certificate - false - true (ByPropertyName) - - - - -Certkey - - Path to the client certificate key - false - true (ByPropertyName) - - - - -CheckConnection - - Check bind connection to the server. - false - true (ByPropertyName) - False - - - -ClientId - - OpenID Client ID - false - true (ByPropertyName) - - - - -ClientKey + -Action - OpenID Client Key + Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. false true (ByPropertyName) @@ -39648,19 +45051,11 @@

Parameters

-Comment - Description. + Descriptive comment. false true (ByPropertyName) - - -Default - - Use this as default realm - false - true (ByPropertyName) - False - -Delete @@ -39670,193 +45065,214 @@

Parameters

- -Digest - - Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. - false - true (ByPropertyName) - - - - -Domain + -Dest - AD domain name + Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. false true (ByPropertyName) - -Filter + -Digest - LDAP filter for user sync. + Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName) - -GroupClasses + -Dport - The objectclasses for groups. + Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges. false true (ByPropertyName) - -GroupDn + -Enable - LDAP base domain name for group sync. If not set, the base_dn will be used. + Flag to enable/disable a rule. false true (ByPropertyName) - + 0 - -GroupFilter + -IcmpType - LDAP filter for group sync. + Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. false true (ByPropertyName) - -GroupNameAttr + -Iface - LDAP attribute representing a groups name. If not set or found, the first value of the DN will be used as name. + Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. false true (ByPropertyName) - -IssuerUrl + -Log - OpenID Issuer Url + Log level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog false true (ByPropertyName) - -Mode + -Macro - LDAP protocol mode. Enum: ldap,ldaps,ldap+starttls + Use predefined standard macro. false true (ByPropertyName) - -Password + -Moveto - LDAP bind password. Will be stored in '/etc/pve/priv/realm/<REALM>.pw'. + Move rule to new position <moveto>. Other arguments are ignored. false true (ByPropertyName) - + 0 - -Port + -Pos - Server port. + Update rule at position <pos>. false true (ByPropertyName) 0 - -Prompt + -Proto - Specifies whether the Authorization Server prompts the End-User for reauthentication and consent. + IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. false true (ByPropertyName) - -Realm - - Authentication domain ID - true - true (ByPropertyName) - - - - -Scopes + -Source - Specifies the scopes (user details) that should be authorized and returned, for example 'email' or 'profile'. + Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. false true (ByPropertyName) - -Secure + -Sport - Use secure LDAPS protocol. DEPRECATED':' use 'mode' instead. + Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges. false true (ByPropertyName) - False + - -Server1 + -Type - Server IP address (or DNS name) + Rule type. Enum: in,out,group false true (ByPropertyName) + + +
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Set-PveClusterHaGroups

+

+

Update ha group configuration.

+
+
+

Syntax

+
+
+
+ Set-PveClusterHaGroups [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Delete] <String>] [[-Digest] <String>] [-Group] <String> [[-Nodes] <String>] [-Nofailback] [-Restricted] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + - + - + - + - + - + - + - + - + - + - - + + - + - + - + - + - + - + - + @@ -39870,18 +45286,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveAccessGroups

+

Set-PveClusterHaResources

-

Update group data.

+

Update resource configuration.

Syntax

- Set-PveAccessGroups [[-PveTicket] <PveTicket>] [[-Comment] <String>] [-Groupid] <String> [<CommonParameters>] + Set-PveClusterHaResources [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Delete] <String>] [[-Digest] <String>] [[-Group] <String>] [[-MaxRelocate] <Int32>] [[-MaxRestart] <Int32>] [-Sid] <String> [[-State] <String>] [<CommonParameters>]
@@ -39909,19 +45325,67 @@

Parameters

- + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-Server2-PveTicket Fallback Server IP address (or DNS name)Ticket data connection. false true (ByPropertyName)
-Sslversion-Comment LDAPS TLS/SSL version. It's not recommended to use version older than 1.2! Enum: tlsv1,tlsv1_1,tlsv1_2,tlsv1_3Description. false true (ByPropertyName)
-SyncDefaultsOptions-Delete The default options for behavior of synchronizations.A list of settings you want to delete. false true (ByPropertyName)
-SyncAttributes-Digest Comma separated list of key=value pairs for specifying which LDAP attributes map to which PVE user field. For example, to map the LDAP attribute 'mail' to PVEs 'email', write 'email=mail'. By default, each PVE user field is represented by an LDAP attribute of the same name.Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Tfa-Group Use Two-factor authentication.falseThe HA group identifier.true true (ByPropertyName)
-UserAttr-Nodes LDAP user attribute nameList of cluster node names with optional priority. false true (ByPropertyName)
-UserClasses-Nofailback The objectclasses for users.The CRM tries to run services on the node with the highest priority. If a node with higher priority comes online, the CRM migrates the service to that node. Enabling nofailback prevents that behavior. false true (ByPropertyName)False
-Verify-Restricted Verify the server's SSL certificateResources bound to restricted groups may only run on nodes defined by the group. false true (ByPropertyName) False
-Comment --Description. false true (ByPropertyName)
-Groupid-Delete --A list of settings you want to delete.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-GroupThe HA group identifier.falsetrue (ByPropertyName)
-MaxRelocateMaximal number of service relocate tries when a service failes to start.falsetrue (ByPropertyName)0
-MaxRestartMaximal number of tries to restart the service on a node after its start failed.falsetrue (ByPropertyName)0
-SidHA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example':' vm':'100 / ct':'100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example':' 100). true true (ByPropertyName)
-StateRequested resource state. Enum: started,stopped,enabled,disabled,ignoredfalsetrue (ByPropertyName)
@@ -39931,18 +45395,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveAccessPassword

+

Set-PveClusterJobsRealmSync

-

Change user password.

+

Update realm-sync job definition.

Syntax

- Set-PveAccessPassword [[-PveTicket] <PveTicket>] [[-ConfirmationPassword] <SecureString>] [-Password] <SecureString> [-Userid] <String> [<CommonParameters>] + Set-PveClusterJobsRealmSync [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Delete] <String>] [-EnableNew] [-Enabled] [-Id] <String> [[-RemoveVanished] <String>] [-Schedule] <String> [[-Scope] <String>] [<CommonParameters>]
@@ -39968,29 +45432,69 @@

Parameters

- -ConfirmationPassword + -Comment - The current password of the user performing the change. + Description for the Job. false true (ByPropertyName) - -Password + -Delete - The new password. + A list of settings you want to delete. + false + true (ByPropertyName) + + + + -EnableNew + + Enable newly synced users immediately. + false + true (ByPropertyName) + False + + + -Enabled + + Determines if the job is enabled. + false + true (ByPropertyName) + False + + + -Id + + The ID of the job. true true (ByPropertyName) - -Userid + -RemoveVanished - Full User ID, in the `name@realm` format. + A semicolon-seperated list of things to remove when they or the user vanishes during a sync. The following values are possible':' 'entry' removes the user/group when not returned from the sync. 'properties' removes the set properties on existing user/group that do not appear in the source (even custom ones). 'acl' removes acls when the user/group is not returned from the sync. Instead of a list it also can be 'none' (the default). + false + true (ByPropertyName) + + + + -Schedule + + Backup schedule. The format is a subset of `systemd` calendar events. true true (ByPropertyName) + + -Scope + + Select what to sync. Enum: users,groups,both + false + true (ByPropertyName) + +
@@ -40000,18 +45504,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveAccessRoles

+

Set-PveClusterMappingPci

-

Update an existing role.

+

Update a hardware mapping.

Syntax

- Set-PveAccessRoles [[-PveTicket] <PveTicket>] [-Append] [[-Privs] <String>] [-Roleid] <String> [<CommonParameters>] + Set-PveClusterMappingPci [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Description] <String>] [[-Digest] <String>] [-Id] <String> [[-Map] <Array>] [-Mdev] [<CommonParameters>]
@@ -40037,29 +45541,53 @@

Parameters

- -Append + -Delete - -- + A list of settings you want to delete. false true (ByPropertyName) - False + - -Privs + -Description - -- + Description of the logical PCI device. false true (ByPropertyName) - -Roleid + -Digest - -- + Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. + false + true (ByPropertyName) + + + + -Id + + The ID of the logical PCI mapping. true true (ByPropertyName) + + -Map + + A list of maps for the cluster nodes. + false + true (ByPropertyName) + + + + -Mdev + + Marks the device(s) as being capable of providing mediated devices. + false + true (ByPropertyName) + False +
@@ -40069,18 +45597,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveAccessTfa

+

Set-PveClusterMappingUsb

-

Add a TFA entry for a user.

+

Update a hardware mapping.

Syntax

- Set-PveAccessTfa [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Enable] [-Id] <String> [[-Password] <SecureString>] [-Userid] <String> [<CommonParameters>] + Set-PveClusterMappingUsb [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Description] <String>] [[-Digest] <String>] [-Id] <String> [-Map] <Array> [<CommonParameters>]
@@ -40106,41 +45634,41 @@

Parameters

- -Description + -Delete - A description to distinguish multiple entries from one another + A list of settings you want to delete. false true (ByPropertyName) - -Enable + -Description - Whether the entry should be enabled for login. + Description of the logical USB device. false true (ByPropertyName) - False + - -Id + -Digest - A TFA entry id. - true + Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. + false true (ByPropertyName) - -Password + -Id - The current password of the user performing the change. - false + The ID of the logical USB mapping. + true true (ByPropertyName) - -Userid + -Map - Full User ID, in the `name@realm` format. + A list of maps for the cluster nodes. true true (ByPropertyName) @@ -40154,18 +45682,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveAccessUsers

+

Set-PveClusterMetricsServer

-

Update user configuration.

+

Update metric server configuration.

Syntax

- Set-PveAccessUsers [[-PveTicket] <PveTicket>] [-Append] [[-Comment] <String>] [[-Email] <String>] [-Enable] [[-Expire] <Int32>] [[-Firstname] <String>] [[-Groups] <String>] [[-Keys] <String>] [[-Lastname] <String>] [-Userid] <String> [<CommonParameters>] + Set-PveClusterMetricsServer [[-PveTicket] <PveTicket>] [[-ApiPathPrefix] <String>] [[-Bucket] <String>] [[-Delete] <String>] [[-Digest] <String>] [-Disable] [-Id] <String> [[-Influxdbproto] <String>] [[-MaxBodySize] <Int32>] [[-Mtu] <Int32>] [[-Organization] <String>] [[-Path] <String>] [-Port] <Int32> [[-Proto] <String>] [-Server] <String> [[-Timeout] <Int32>] [[-Token] <String>] [-VerifyCertificate] [<CommonParameters>]
@@ -40191,85 +45719,141 @@

Parameters

- -Append + -ApiPathPrefix - -- + An API path prefix inserted between '<host>':'<port>/' and '/api2/'. Can be useful if the InfluxDB service runs behind a reverse proxy. false true (ByPropertyName) - False + - -Comment + -Bucket - -- + The InfluxDB bucket/db. Only necessary when using the http v2 api. false true (ByPropertyName) - -Email + -Delete - -- + A list of settings you want to delete. false true (ByPropertyName) - -Enable + -Digest - Enable the account (default). You can set this to '0' to disable the account + Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. + false + true (ByPropertyName) + + + + -Disable + + Flag to disable the plugin. false true (ByPropertyName) False - -Expire + -Id - Account expiration date (seconds since epoch). '0' means no expiration date. + The ID of the entry. + true + true (ByPropertyName) + + + + -Influxdbproto + + -- Enum: udp,http,https + false + true (ByPropertyName) + + + + -MaxBodySize + + InfluxDB max-body-size in bytes. Requests are batched up to this size. false true (ByPropertyName) 0 - -Firstname + -Mtu - -- + MTU for metrics transmission over UDP false true (ByPropertyName) - + 0 - -Groups + -Organization - -- + The InfluxDB organization. Only necessary when using the http v2 api. Has no meaning when using v2 compatibility api. false true (ByPropertyName) - -Keys + -Path - Keys for two factor auth (yubico). + root graphite path (ex':' proxmox.mycluster.mykey) false true (ByPropertyName) - -Lastname + -Port - -- + server network port + true + true (ByPropertyName) + 0 + + + -Proto + + Protocol to send graphite data. TCP or UDP (default) Enum: udp,tcp false true (ByPropertyName) - -Userid + -Server - Full User ID, in the `name@realm` format. + server dns name or IP address true true (ByPropertyName) + + -Timeout + + graphite TCP socket timeout (default=1) + false + true (ByPropertyName) + 0 + + + -Token + + The InfluxDB access token. Only necessary when using the http v2 api. If the v2 compatibility api is used, use 'user':'password' instead. + false + true (ByPropertyName) + + + + -VerifyCertificate + + Set to 0 to disable certificate verification for https endpoints. + false + true (ByPropertyName) + False +
@@ -40279,18 +45863,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveAccessUsersToken

+

Set-PveClusterNotificationsEndpointsGotify

-

Update API token for a specific user.

+

Update existing gotify endpoint

Syntax

- Set-PveAccessUsersToken [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Expire] <Int32>] [-Privsep] [-Tokenid] <String> [-Userid] <String> [<CommonParameters>] + Set-PveClusterNotificationsEndpointsGotify [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Delete] <Array>] [[-Digest] <String>] [-Disable] [-Name] <String> [[-Server] <String>] [[-Token] <String>] [<CommonParameters>]
@@ -40318,40 +45902,56 @@

Parameters

-Comment - -- + Comment false true (ByPropertyName) - -Expire + -Delete - API token expiration date (seconds since epoch). '0' means no expiration date. + A list of settings you want to delete. false true (ByPropertyName) - 0 + - -Privsep + -Digest - Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. + Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. + false + true (ByPropertyName) + + + + -Disable + + Disable this target false true (ByPropertyName) False - -Tokenid + -Name - User-specific token identifier. + The name of the endpoint. true true (ByPropertyName) - -Userid + -Server - Full User ID, in the `name@realm` format. - true + Server URL + false + true (ByPropertyName) + + + + -Token + + Secret token + false true (ByPropertyName) @@ -40364,18 +45964,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveAccessUsersUnlockTfa

+

Set-PveClusterNotificationsEndpointsSendmail

-

Unlock a user's TFA authentication.

+

Update existing sendmail endpoint

Syntax

- Set-PveAccessUsersUnlockTfa [[-PveTicket] <PveTicket>] [-Userid] <String> [<CommonParameters>] + Set-PveClusterNotificationsEndpointsSendmail [[-PveTicket] <PveTicket>] [[-Author] <String>] [[-Comment] <String>] [[-Delete] <Array>] [[-Digest] <String>] [-Disable] [[-FromAddress] <String>] [[-Mailto] <Array>] [[-MailtoUser] <Array>] [-Name] <String> [<CommonParameters>]
@@ -40401,74 +46001,77 @@

Parameters

- -Userid + -Author - Full User ID, in the `name@realm` format. - true + Author of the mail + false true (ByPropertyName) - - -
-
-

Outputs

-

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
-
-
-
-
-

Set-PveClusterAcmeAccount

-

-

Update existing ACME account information with CA. Note':' not specifying any new account information triggers a refresh.

-
-
-

Syntax

-
-
-
- Set-PveClusterAcmeAccount [[-PveTicket] <PveTicket>] [[-Contact] <String>] [[-Name] <String>] [<CommonParameters>] -
-
-
-

Parameters

- - - - - - - - - - - - - + - + - + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicket-Comment Ticket data connection.Comment false true (ByPropertyName)
-Contact-Delete Contact email addresses.A list of settings you want to delete. false true (ByPropertyName)
-Name-Digest ACME account config file name.Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-DisableDisable this targetfalsetrue (ByPropertyName)False
-FromAddress`From` address for the mailfalsetrue (ByPropertyName)
-MailtoList of email recipientsfalsetrue (ByPropertyName)
-MailtoUserList of users false true (ByPropertyName)
-NameThe name of the endpoint.truetrue (ByPropertyName)
@@ -40478,18 +46081,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveClusterAcmePlugins

+

Set-PveClusterNotificationsEndpointsSmtp

-

Update ACME plugin configuration.

+

Update existing smtp endpoint

Syntax

- Set-PveClusterAcmePlugins [[-PveTicket] <PveTicket>] [[-Api] <String>] [[-Data] <String>] [[-Delete] <String>] [[-Digest] <String>] [-Disable] [-Id] <String> [[-Nodes] <String>] [[-ValidationDelay] <Int32>] [<CommonParameters>] + Set-PveClusterNotificationsEndpointsSmtp [[-PveTicket] <PveTicket>] [[-Author] <String>] [[-Comment] <String>] [[-Delete] <Array>] [[-Digest] <String>] [-Disable] [[-FromAddress] <String>] [[-Mailto] <Array>] [[-MailtoUser] <Array>] [[-Mode] <String>] [-Name] <String> [[-Password] <SecureString>] [[-Port] <Int32>] [[-Server] <String>] [[-Username] <String>] [<CommonParameters>]
@@ -40515,17 +46118,17 @@

Parameters

- -Api + -Author - API plugin name Enum: 1984hosting,acmedns,acmeproxy,active24,ad,ali,anx,artfiles,arvan,aurora,autodns,aws,azion,azure,bookmyname,bunny,cf,clouddns,cloudns,cn,conoha,constellix,cpanel,curanet,cyon,da,ddnss,desec,df,dgon,dnsexit,dnshome,dnsimple,dnsservices,do,doapi,domeneshop,dp,dpi,dreamhost,duckdns,durabledns,dyn,dynu,dynv6,easydns,edgedns,euserv,exoscale,fornex,freedns,gandi_livedns,gcloud,gcore,gd,geoscaling,googledomains,he,hetzner,hexonet,hostingde,huaweicloud,infoblox,infomaniak,internetbs,inwx,ionos,ipv64,ispconfig,jd,joker,kappernet,kas,kinghost,knot,la,leaseweb,lexicon,linode,linode_v4,loopia,lua,maradns,me,miab,misaka,myapi,mydevil,mydnsjp,mythic_beasts,namecheap,namecom,namesilo,nanelo,nederhost,neodigit,netcup,netlify,nic,njalla,nm,nsd,nsone,nsupdate,nw,oci,one,online,openprovider,openstack,opnsense,ovh,pdns,pleskxml,pointhq,porkbun,rackcorp,rackspace,rage4,rcode0,regru,scaleway,schlundtech,selectel,selfhost,servercow,simply,tele3,tencent,transip,udr,ultra,unoeuro,variomedia,veesp,vercel,vscale,vultr,websupport,world4you,yandex,yc,zilore,zone,zonomi + Author of the mail. Defaults to 'Proxmox VE'. false true (ByPropertyName) - -Data + -Comment - DNS plugin data. (base64 encoded) + Comment false true (ByPropertyName) @@ -40549,35 +46152,83 @@

Parameters

-Disable - Flag to disable the config. + Disable this target false true (ByPropertyName) False - -Id + -FromAddress - ACME Plugin ID name + `From` address for the mail + false + true (ByPropertyName) + + + + -Mailto + + List of email recipients + false + true (ByPropertyName) + + + + -MailtoUser + + List of users + false + true (ByPropertyName) + + + + -Mode + + Determine which encryption method shall be used for the connection. Enum: insecure,starttls,tls + false + true (ByPropertyName) + + + + -Name + + The name of the endpoint. true true (ByPropertyName) - -Nodes + -Password - List of cluster node names. + Password for SMTP authentication false true (ByPropertyName) - -ValidationDelay + -Port - Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records. + The port to be used. Defaults to 465 for TLS based connections, 587 for STARTTLS based connections and port 25 for insecure plain-text connections. false true (ByPropertyName) 0 + + -Server + + The address of the SMTP server. + false + true (ByPropertyName) + + + + -Username + + Username for SMTP authentication + false + true (ByPropertyName) + +
@@ -40587,18 +46238,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveClusterBackup

+

Set-PveClusterNotificationsMatchers

-

Update vzdump backup job definition.

+

Update existing matcher

Syntax

- Set-PveClusterBackup [[-PveTicket] <PveTicket>] [-All] [[-Bwlimit] <Int32>] [[-Comment] <String>] [[-Compress] <String>] [[-Delete] <String>] [[-Dow] <String>] [[-Dumpdir] <String>] [-Enabled] [[-Exclude] <String>] [[-ExcludePath] <Array>] [[-Fleecing] <String>] [-Id] <String> [[-Ionice] <Int32>] [[-Lockwait] <Int32>] [[-Mailnotification] <String>] [[-Mailto] <String>] [[-Maxfiles] <Int32>] [[-Mode] <String>] [[-Node] <String>] [[-NotesTemplate] <String>] [[-NotificationMode] <String>] [[-NotificationPolicy] <String>] [[-NotificationTarget] <String>] [[-Performance] <String>] [[-Pigz] <Int32>] [[-Pool] <String>] [-Protected] [[-PruneBackups] <String>] [-Quiet] [-Remove] [-RepeatMissed] [[-Schedule] <String>] [[-Script] <String>] [[-Starttime] <String>] [-Stdexcludes] [-Stop] [[-Stopwait] <Int32>] [[-Storage] <String>] [[-Tmpdir] <String>] [[-Vmid] <String>] [[-Zstd] <Int32>] [<CommonParameters>] + Set-PveClusterNotificationsMatchers [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Delete] <Array>] [[-Digest] <String>] [-Disable] [-InvertMatch] [[-MatchCalendar] <Array>] [[-MatchField] <Array>] [[-MatchSeverity] <Array>] [[-Mode] <String>] [-Name] <String> [[-Target] <Array>] [<CommonParameters>]
@@ -40623,34 +46274,10 @@

Parameters

true (ByPropertyName) - - -All - - Backup all known guest systems on this host. - false - true (ByPropertyName) - False - - - -Bwlimit - - Limit I/O bandwidth (in KiB/s). - false - true (ByPropertyName) - 0 - -Comment - Description for the Job. - false - true (ByPropertyName) - - - - -Compress - - Compress dump file. Enum: 0,1,gzip,lzo,zstd + Comment false true (ByPropertyName) @@ -40664,292 +46291,297 @@

Parameters

- -Dow + -Digest - Day of week selection. + Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName) - -Dumpdir + -Disable - Store resulting files to specified directory. + Disable this matcher false true (ByPropertyName) - + False - -Enabled + -InvertMatch - Enable or disable the job. + Invert match of the whole matcher false true (ByPropertyName) False - -Exclude + -MatchCalendar - Exclude specified guest systems (assumes --all) + Match notification timestamp false true (ByPropertyName) - -ExcludePath + -MatchField - Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. + Metadata fields to match (regex or exact match). Must be in the form (regex|exact)':'<field>=<value> false true (ByPropertyName) - -Fleecing + -MatchSeverity - Options for backup fleecing (VM only). + Notification severities to match false true (ByPropertyName) - -Id - - The job ID. - true - true (ByPropertyName) - - - - -Ionice + -Mode - Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value. + Choose between 'all' and 'any' for when multiple properties are specified Enum: all,any false true (ByPropertyName) - 0 + - -Lockwait + -Name - Maximal time to wait for the global lock (minutes). - false + Name of the matcher. + true true (ByPropertyName) - 0 + - -Mailnotification + -Target - Deprecated':' use notification targets/matchers instead. Specify when to send a notification mail Enum: always,failure + Targets to notify on match false true (ByPropertyName) + + +
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Set-PveClusterOptions

+

+

Set datacenter options.

+
+
+

Syntax

+
+
+
+ Set-PveClusterOptions [[-PveTicket] <PveTicket>] [[-Bwlimit] <String>] [[-Console] <String>] [[-Crs] <String>] [[-Delete] <String>] [[-Description] <String>] [[-EmailFrom] <String>] [[-Fencing] <String>] [[-Ha] <String>] [[-HttpProxy] <String>] [[-Keyboard] <String>] [[-Language] <String>] [[-MacPrefix] <String>] [[-MaxWorkers] <Int32>] [[-Migration] <String>] [-MigrationUnsecure] [[-NextId] <String>] [[-Notify] <String>] [[-RegisteredTags] <String>] [[-TagStyle] <String>] [[-U2f] <String>] [[-UserTagAccess] <String>] [[-Webauthn] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - - - - - - - - - - - - - - - - - - - - - - - - + - + - + - + - + - + - + - + - +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-Mailto-PveTicket Deprecated':' Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications.Ticket data connection. false true (ByPropertyName)
-Maxfiles-Bwlimit Deprecated':' use 'prune-backups' instead. Maximal number of backup files per guest system.Set I/O bandwidth limit for various operations (in KiB/s). false true (ByPropertyName)0
-Mode-Console Backup mode. Enum: snapshot,suspend,stopSelect the default Console viewer. You can either use the builtin java applet (VNC; deprecated and maps to html5), an external virt-viewer comtatible application (SPICE), an HTML5 based vnc viewer (noVNC), or an HTML5 based console client (xtermjs). If the selected viewer is not available (e.g. SPICE not activated for the VM), the fallback is noVNC. Enum: applet,vv,html5,xtermjs false true (ByPropertyName)
-Node-Crs Only run if executed on this node.Cluster resource scheduling settings. false true (ByPropertyName)
-NotesTemplate-Delete Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively.A list of settings you want to delete. false true (ByPropertyName)
-NotificationMode-Description Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not. Enum: auto,legacy-sendmail,notification-systemDatacenter description. Shown in the web-interface datacenter notes panel. This is saved as comment inside the configuration file. false true (ByPropertyName)
-NotificationPolicy-EmailFrom Deprecated':' Do not use Enum: always,failure,neverSpecify email address to send notification from (default is root@$hostname) false true (ByPropertyName)
-NotificationTarget-Fencing Deprecated':' Do not useSet the fencing mode of the HA cluster. Hardware mode needs a valid configuration of fence devices in /etc/pve/ha/fence.cfg. With both all two modes are used.WARNING':' 'hardware' and 'both' are EXPERIMENTAL & WIP Enum: watchdog,hardware,both false true (ByPropertyName)
-Performance-Ha Other performance-related settings.Cluster wide HA settings. false true (ByPropertyName)
-Pigz-HttpProxy Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.Specify external http proxy which is used for downloads (example':' 'http':'//username':'password@host':'port/') false true (ByPropertyName)0
-Pool-Keyboard Backup all known guest systems included in the specified pool.Default keybord layout for vnc server. Enum: de,de-ch,da,en-gb,en-us,es,fi,fr,fr-be,fr-ca,fr-ch,hu,is,it,ja,lt,mk,nl,no,pl,pt,pt-br,sv,sl,tr false true (ByPropertyName)
-Protected-Language If true, mark backup(s) as protected.Default GUI language. Enum: ar,ca,da,de,en,es,eu,fa,fr,hr,he,it,ja,ka,kr,nb,nl,nn,pl,pt_BR,ru,sl,sv,tr,ukr,zh_CN,zh_TW false true (ByPropertyName)False
-PruneBackups-MacPrefix Use these retention options instead of those from the storage configuration.Prefix for the auto-generated MAC addresses of virtual guests. The default 'BC':'24':'11' is the OUI assigned by the IEEE to Proxmox Server Solutions GmbH for a 24-bit large MAC block. You're allowed to use this in local networks, i.e., those not directly reachable by the public (e.g., in a LAN or behind NAT). false true (ByPropertyName)
-Quiet-MaxWorkers Be quiet.Defines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager. false true (ByPropertyName)False0
-Remove-Migration Prune older backups according to 'prune-backups'.For cluster wide migration settings. false true (ByPropertyName)False
-RepeatMissed-MigrationUnsecure If true, the job will be run as soon as possible if it was missed while the scheduler was not running.Migration is secure using SSH tunnel by default. For secure private networks you can disable it to speed up migration. Deprecated, use the 'migration' property instead! false true (ByPropertyName) False
-Schedule-NextId Backup schedule. The format is a subset of `systemd` calendar events.Control the range for the free VMID auto-selection pool. false true (ByPropertyName)
-Script-Notify Use specified hook script.Cluster-wide notification settings. false true (ByPropertyName)
-Starttime-RegisteredTags Job Start time.A list of tags that require a `Sys.Modify` on '/' to set and delete. Tags set here that are also in 'user-tag-access' also require `Sys.Modify`. false true (ByPropertyName)
-StdexcludesExclude temporary files and logs.falsetrue (ByPropertyName)False
-StopStop running backup jobs on this host.falsetrue (ByPropertyName)False
-StopwaitMaximal time to wait until a guest system is stopped (minutes).falsetrue (ByPropertyName)0
-Storage-TagStyle Store resulting file to this storage.Tag style options. false true (ByPropertyName)
-Tmpdir-U2f Store temporary files to specified directory.u2f false true (ByPropertyName)
-Vmid-UserTagAccess The ID of the guest system you want to backup.Privilege options for user-settable tags false true (ByPropertyName)
-Zstd-Webauthn Zstd threads. N=0 uses half of the available cores, if N is set to a value bigger than 0, N is used as thread count.webauthn configuration false true (ByPropertyName)0
@@ -40960,18 +46592,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveClusterCephFlags

+

Set-PveClusterReplication

-

Set/Unset multiple ceph flags at once.

+

Update replication job configuration.

Syntax

- Set-PveClusterCephFlags [[-PveTicket] <PveTicket>] [-Nobackfill] [-NodeepScrub] [-Nodown] [-Noin] [-Noout] [-Norebalance] [-Norecover] [-Noscrub] [-Notieragent] [-Noup] [-Pause] [<CommonParameters>] + Set-PveClusterReplication [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Delete] <String>] [[-Digest] <String>] [-Disable] [-Id] <String> [[-Rate] <Single>] [[-RemoveJob] <String>] [[-Schedule] <String>] [[-Source] <String>] [<CommonParameters>]
@@ -40997,154 +46629,77 @@

Parameters

- -Nobackfill - - Backfilling of PGs is suspended. - false - true (ByPropertyName) - False - - - -NodeepScrub - - Deep Scrubbing is disabled. - false - true (ByPropertyName) - False - - - -Nodown - - OSD failure reports are being ignored, such that the monitors will not mark OSDs down. - false - true (ByPropertyName) - False - - - -Noin - - OSDs that were previously marked out will not be marked back in when they start. - false - true (ByPropertyName) - False - - - -Noout + -Comment - OSDs will not automatically be marked out after the configured interval. + Description. false true (ByPropertyName) - False + - -Norebalance + -Delete - Rebalancing of PGs is suspended. + A list of settings you want to delete. false true (ByPropertyName) - False + - -Norecover + -Digest - Recovery of PGs is suspended. + Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName) - False + - -Noscrub + -Disable - Scrubbing is disabled. + Flag to disable/deactivate the entry. false true (ByPropertyName) False - -Notieragent + -Id - Cache tiering activity is suspended. - false + Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'. + true true (ByPropertyName) - False + - -Noup + -Rate - OSDs are not allowed to start. + Rate limit in mbps (megabytes per second) as floating point number. false true (ByPropertyName) - False + 0 - -Pause + -RemoveJob - Pauses read and writes. + Mark the replication job for removal. The job will remove all local replication snapshots. When set to 'full', it also tries to remove replicated volumes on the target. The job then removes itself from the configuration file. Enum: local,full false true (ByPropertyName) - False + - - -
-
-

Outputs

-

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
-
-
-
-
-

Set-PveClusterCephFlagsIdx

-

-

Set or clear (unset) a specific ceph flag

-
-
-

Syntax

-
-
-
- Set-PveClusterCephFlagsIdx [[-PveTicket] <PveTicket>] [-Flag] <String> -Value [<CommonParameters>] -
-
-
-

Parameters

- - - - - - - - - - - - - + - + - + - - + + - - - - - - - -
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicket-Schedule Ticket data connection.Storage replication schedule. The format is a subset of `systemd` calendar events. false true (ByPropertyName)
-Flag-Source The ceph flag to update Enum: nobackfill,nodeep-scrub,nodown,noin,noout,norebalance,norecover,noscrub,notieragent,noup,pausetrueFor internal use, to detect if the guest was stolen.false true (ByPropertyName)
-ValueThe new value of the flagtruetrue (ByPropertyName)False
@@ -41154,18 +46709,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveClusterFirewallAliases

+

Set-PveClusterSdn

-

Update IP or Network alias.

+

Apply sdn controller changes && reload.

Syntax

- Set-PveClusterFirewallAliases [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [[-Rename] <String>] [<CommonParameters>] + Set-PveClusterSdn [[-PveTicket] <PveTicket>] [<CommonParameters>]
@@ -41185,47 +46740,7 @@

Parameters

-PveTicket - Ticket data connection. - false - true (ByPropertyName) - - - - -Cidr - - Network/IP specification in CIDR format. - true - true (ByPropertyName) - - - - -Comment - - -- - false - true (ByPropertyName) - - - - -Digest - - Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. - false - true (ByPropertyName) - - - - -Name - - Alias name. - true - true (ByPropertyName) - - - - -Rename - - Rename an existing alias. + Ticket data connection. false true (ByPropertyName) @@ -41239,18 +46754,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveClusterFirewallGroups

+

Set-PveClusterSdnControllers

-

Modify rule data.

+

Update sdn controller object configuration.

Syntax

- Set-PveClusterFirewallGroups [[-PveTicket] <PveTicket>] [[-Action] <String>] [[-Comment] <String>] [[-Delete] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [-Group] <String> [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [[-Moveto] <Int32>] [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [[-Type] <String>] [<CommonParameters>] + Set-PveClusterSdnControllers [[-PveTicket] <PveTicket>] [[-Asn] <Int32>] [-BgpMultipathAsPathRelax] [-Controller] <String> [[-Delete] <String>] [[-Digest] <String>] [-Ebgp] [[-EbgpMultihop] <Int32>] [[-IsisDomain] <String>] [[-IsisIfaces] <String>] [[-IsisNet] <String>] [[-Loopback] <String>] [[-Node] <String>] [[-Peers] <String>] [<CommonParameters>]
@@ -41276,33 +46791,33 @@

Parameters

- -Action + -Asn - Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. + autonomous system number false true (ByPropertyName) - + 0 - -Comment + -BgpMultipathAsPathRelax - Descriptive comment. + -- false true (ByPropertyName) - + False - -Delete + -Controller - A list of settings you want to delete. - false + The SDN controller object identifier. + true true (ByPropertyName) - -Dest + -Delete - Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. + A list of settings you want to delete. false true (ByPropertyName) @@ -41316,105 +46831,65 @@

Parameters

- -Dport + -Ebgp - Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges. + Enable ebgp. (remote-as external) false true (ByPropertyName) - + False - -Enable + -EbgpMultihop - Flag to enable/disable a rule. + -- false true (ByPropertyName) 0 - -Group - - Security Group name. - true - true (ByPropertyName) - - - - -IcmpType - - Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. - false - true (ByPropertyName) - - - - -Iface - - Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. - false - true (ByPropertyName) - - - - -Log + -IsisDomain - Log level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog + ISIS domain. false true (ByPropertyName) - -Macro + -IsisIfaces - Use predefined standard macro. + ISIS interface. false true (ByPropertyName) - -Moveto - - Move rule to new position <moveto>. Other arguments are ignored. - false - true (ByPropertyName) - 0 - - - -Pos - - Update rule at position <pos>. - false - true (ByPropertyName) - 0 - - - -Proto + -IsisNet - IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. + ISIS network entity title. false true (ByPropertyName) - -Source + -Loopback - Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. + source loopback interface. false true (ByPropertyName) - -Sport + -Node - Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges. + The cluster node name. false true (ByPropertyName) - -Type + -Peers - Rule type. Enum: in,out,group + peers address list. false true (ByPropertyName) @@ -41428,18 +46903,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveClusterFirewallIpset

+

Set-PveClusterSdnDns

-

Update IP or Network settings

+

Update sdn dns object configuration.

Syntax

- Set-PveClusterFirewallIpset [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Nomatch] [<CommonParameters>] + Set-PveClusterSdnDns [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Digest] <String>] [-Dns] <String> [[-Key] <String>] [[-Reversemaskv6] <Int32>] [[-Ttl] <Int32>] [[-Url] <String>] [<CommonParameters>]
@@ -41465,15 +46940,31 @@

Parameters

- -Cidr + -Delete - Network/IP specification in CIDR format. + A list of settings you want to delete. + false + true (ByPropertyName) + + + + -Digest + + Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. + false + true (ByPropertyName) + + + + -Dns + + The SDN dns object identifier. true true (ByPropertyName) - -Comment + -Key -- false @@ -41481,28 +46972,28 @@

Parameters

- -Digest + -Reversemaskv6 - Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. + -- false true (ByPropertyName) - + 0 - -Name + -Ttl - IP set name. - true + -- + false true (ByPropertyName) - + 0 - -Nomatch + -Url -- false true (ByPropertyName) - False + @@ -41513,18 +47004,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveClusterFirewallOptions

+

Set-PveClusterSdnIpams

-

Set Firewall options.

+

Update sdn ipam object configuration.

Syntax

- Set-PveClusterFirewallOptions [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Digest] <String>] [-Ebtables] [[-Enable] <Int32>] [[-LogRatelimit] <String>] [[-PolicyIn] <String>] [[-PolicyOut] <String>] [<CommonParameters>] + Set-PveClusterSdnIpams [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Digest] <String>] [-Ipam] <String> [[-Section] <Int32>] [[-Token] <String>] [[-Url] <String>] [<CommonParameters>]
@@ -41566,41 +47057,33 @@

Parameters

- -Ebtables + -Ipam - Enable ebtables rules cluster wide. - false + The SDN ipam object identifier. + true true (ByPropertyName) - False + - -Enable + -Section - Enable or disable the firewall cluster wide. + -- false true (ByPropertyName) 0 - -LogRatelimit - - Log ratelimiting settings - false - true (ByPropertyName) - - - - -PolicyIn + -Token - Input policy. Enum: ACCEPT,REJECT,DROP + -- false true (ByPropertyName) - -PolicyOut + -Url - Output policy. Enum: ACCEPT,REJECT,DROP + -- false true (ByPropertyName) @@ -41614,18 +47097,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveClusterFirewallRules

+

Set-PveClusterSdnVnets

-

Modify rule data.

+

Update sdn vnet object configuration.

Syntax

- Set-PveClusterFirewallRules [[-PveTicket] <PveTicket>] [[-Action] <String>] [[-Comment] <String>] [[-Delete] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [[-Moveto] <Int32>] [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [[-Type] <String>] [<CommonParameters>] + Set-PveClusterSdnVnets [[-PveTicket] <PveTicket>] [[-Alias] <String>] [[-Delete] <String>] [[-Digest] <String>] [[-Tag] <Int32>] [-Vlanaware] [-Vnet] <String> [[-Zone] <String>] [<CommonParameters>]
@@ -41651,17 +47134,9 @@

Parameters

- -Action - - Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. - false - true (ByPropertyName) - - - - -Comment + -Alias - Descriptive comment. + alias name of the vnet false true (ByPropertyName) @@ -41674,14 +47149,6 @@

Parameters

true (ByPropertyName) - - -Dest - - Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. - false - true (ByPropertyName) - - -Digest @@ -41691,98 +47158,119 @@

Parameters

- -Dport - - Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges. - false - true (ByPropertyName) - - - - -Enable + -Tag - Flag to enable/disable a rule. + vlan or vxlan id false true (ByPropertyName) 0 - -IcmpType + -Vlanaware - Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. + Allow vm VLANs to pass through this vnet. false true (ByPropertyName) - + False - -Iface + -Vnet - Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. - false + The SDN vnet object identifier. + true true (ByPropertyName) - -Log + -Zone - Log level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog + zone id false true (ByPropertyName) + + +
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Set-PveClusterSdnVnetsIps

+

+

Update IP Mapping in a VNet

+
+
+

Syntax

+
+
+
+ Set-PveClusterSdnVnetsIps [[-PveTicket] <PveTicket>] [-Ip] <String> [[-Mac] <String>] [[-Vmid] <Int32>] [-Vnet] <String> [-Zone] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + - + - + - - - - - - - - - + - - + + - + - + - + - + - + - + - + - - + + - + - - + + @@ -41795,18 +47283,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveClusterHaGroups

+

Set-PveClusterSdnVnetsSubnets

-

Update ha group configuration.

+

Update sdn subnet object configuration.

Syntax

- Set-PveClusterHaGroups [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Delete] <String>] [[-Digest] <String>] [-Group] <String> [[-Nodes] <String>] [-Nofailback] [-Restricted] [<CommonParameters>] + Set-PveClusterSdnVnetsSubnets [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-DhcpDnsServer] <String>] [[-DhcpRange] <Array>] [[-Digest] <String>] [[-Dnszoneprefix] <String>] [[-Gateway] <String>] [-Snat] [-Subnet] <String> [[-Vnet] <String>] [<CommonParameters>]
@@ -41832,17 +47320,25 @@

Parameters

- + - + - + - + + + + + + + + + @@ -41856,36 +47352,44 @@

Parameters

- + - - + + - + - + - + - + - + - + + + + + + + + + - +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-Macro-PveTicket Use predefined standard macro.Ticket data connection. false true (ByPropertyName)
-MovetoMove rule to new position <moveto>. Other arguments are ignored.falsetrue (ByPropertyName)0
-Pos-Ip Update rule at position <pos>.falseThe IP address to associate with the given MAC addresstrue true (ByPropertyName)0
-Proto-Mac IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.Unicast MAC address. false true (ByPropertyName)
-Source-Vmid Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.The (unique) ID of the VM. false true (ByPropertyName)0
-Sport-Vnet Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.falseThe SDN vnet object identifier.true true (ByPropertyName)
-Type-Zone Rule type. Enum: in,out,groupfalseThe SDN zone object identifier.true true (ByPropertyName)
-Comment-Delete Description.A list of settings you want to delete. false true (ByPropertyName)
-Delete-DhcpDnsServer A list of settings you want to delete.IP address for the DNS serverfalsetrue (ByPropertyName)
-DhcpRangeA list of DHCP ranges for this subnet false true (ByPropertyName)
-Group-Dnszoneprefix The HA group identifier.truedns domain zone prefix ex':' 'adm' -> <hostname>.adm.mydomain.comfalse true (ByPropertyName)
-Nodes-Gateway List of cluster node names with optional priority.Subnet Gateway':' Will be assign on vnet for layer3 zones false true (ByPropertyName)
-Nofailback-Snat The CRM tries to run services on the node with the highest priority. If a node with higher priority comes online, the CRM migrates the service to that node. Enabling nofailback prevents that behavior.enable masquerade for this subnet if pve-firewall false true (ByPropertyName) False
-Restricted-Subnet Resources bound to restricted groups may only run on nodes defined by the group.The SDN subnet object identifier.truetrue (ByPropertyName)
-Vnetassociated vnet false true (ByPropertyName)False
@@ -41896,18 +47400,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveClusterHaResources

+

Set-PveClusterSdnZones

-

Update resource configuration.

+

Update sdn zone object configuration.

Syntax

- Set-PveClusterHaResources [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Delete] <String>] [[-Digest] <String>] [[-Group] <String>] [[-MaxRelocate] <Int32>] [[-MaxRestart] <Int32>] [-Sid] <String> [[-State] <String>] [<CommonParameters>] + Set-PveClusterSdnZones [[-PveTicket] <PveTicket>] [-AdvertiseSubnets] [[-Bridge] <String>] [-BridgeDisableMacLearning] [[-Controller] <String>] [[-Delete] <String>] [[-Dhcp] <String>] [[-Digest] <String>] [-DisableArpNdSuppression] [[-Dns] <String>] [[-Dnszone] <String>] [[-DpId] <Int32>] [[-Exitnodes] <String>] [-ExitnodesLocalRouting] [[-ExitnodesPrimary] <String>] [[-Ipam] <String>] [[-Mac] <String>] [[-Mtu] <Int32>] [[-Nodes] <String>] [[-Peers] <String>] [[-Reversedns] <String>] [[-RtImport] <String>] [[-Tag] <Int32>] [[-VlanProtocol] <String>] [[-VrfVxlan] <Int32>] [[-VxlanPort] <Int32>] [-Zone] <String> [<CommonParameters>]
@@ -41933,9 +47437,33 @@

Parameters

- -Comment + -AdvertiseSubnets - Description. + Advertise evpn subnets if you have silent hosts + false + true (ByPropertyName) + False + + + -Bridge + + -- + false + true (ByPropertyName) + + + + -BridgeDisableMacLearning + + Disable auto mac learning. + false + true (ByPropertyName) + False + + + -Controller + + Frr router name false true (ByPropertyName) @@ -41948,6 +47476,14 @@

Parameters

true (ByPropertyName) + + -Dhcp + + Type of the DHCP backend for this zone Enum: dnsmasq + false + true (ByPropertyName) + + -Digest @@ -41957,152 +47493,155 @@

Parameters

- -Group + -DisableArpNdSuppression - The HA group identifier. + Disable ipv4 arp && ipv6 neighbour discovery suppression + false + true (ByPropertyName) + False + + + -Dns + + dns api server false true (ByPropertyName) - -MaxRelocate + -Dnszone - Maximal number of service relocate tries when a service failes to start. + dns domain zone ex':' mydomain.com false true (ByPropertyName) - 0 + - -MaxRestart + -DpId - Maximal number of tries to restart the service on a node after its start failed. + Faucet dataplane id false true (ByPropertyName) 0 - -Sid + -Exitnodes - HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example':' vm':'100 / ct':'100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example':' 100). - true + List of cluster node names. + false true (ByPropertyName) - -State + -ExitnodesLocalRouting - Requested resource state. Enum: started,stopped,enabled,disabled,ignored + Allow exitnodes to connect to evpn guests + false + true (ByPropertyName) + False + + + -ExitnodesPrimary + + Force traffic to this exitnode first. + false + true (ByPropertyName) + + + + -Ipam + + use a specific ipam + false + true (ByPropertyName) + + + + -Mac + + Anycast logical router mac address false true (ByPropertyName) - - -
-
-

Outputs

-

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
-
-
-
-
-

Set-PveClusterJobsRealmSync

-

-

Update realm-sync job definition.

-
-
-

Syntax

-
-
-
- Set-PveClusterJobsRealmSync [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Delete] <String>] [-EnableNew] [-Enabled] [-Id] <String> [[-RemoveVanished] <String>] [-Schedule] <String> [[-Scope] <String>] [<CommonParameters>] -
-
-
-

Parameters

- - - - - - - - - - - - - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - + + - + - + - + - + - - + + - + - + - + + + + + + + + + @@ -42114,18 +47653,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveClusterMappingPci

+

Set-PveNodesLxcConfig

-

Update a hardware mapping.

+

Set container options.

Syntax

- Set-PveClusterMappingPci [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Description] <String>] [[-Digest] <String>] [-Id] <String> [[-Map] <Array>] [-Mdev] [<CommonParameters>] + Set-PveNodesLxcConfig [[-PveTicket] <PveTicket>] [[-Arch] <String>] [[-Cmode] <String>] [-Console] [[-Cores] <Int32>] [[-Cpulimit] <Single>] [[-Cpuunits] <Int32>] [-Debug_] [[-Delete] <String>] [[-Description] <String>] [[-DevN] <Hashtable>] [[-Digest] <String>] [[-Features] <String>] [[-Hookscript] <String>] [[-Hostname] <String>] [[-Lock] <String>] [[-Memory] <Int32>] [[-MpN] <Hashtable>] [[-Nameserver] <String>] [[-NetN] <Hashtable>] [-Node] <String> [-Onboot] [[-Ostype] <String>] [-Protection] [[-Revert] <String>] [[-Rootfs] <String>] [[-Searchdomain] <String>] [[-Startup] <String>] [[-Swap] <Int32>] [[-Tags] <String>] [-Template] [[-Timezone] <String>] [[-Tty] <Int32>] [-Unprivileged] [[-UnusedN] <Hashtable>] [-Vmid] <Int32> [<CommonParameters>]
@@ -42151,97 +47690,60 @@

Parameters

- + - + - + - + - + - + - + - + - - + + - + - + - + - + - + - + - + - -
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicket-Mtu Ticket data connection.MTU false true (ByPropertyName)0
-Comment-Nodes Description for the Job.List of cluster node names. false true (ByPropertyName)
-Delete-Peers A list of settings you want to delete.peers address list. false true (ByPropertyName)
-EnableNew-Reversedns Enable newly synced users immediately.reverse dns api server false true (ByPropertyName)False
-Enabled-RtImport Determines if the job is enabled.Route-Target import false true (ByPropertyName)False
-Id-Tag The ID of the job.trueService-VLAN Tagfalse true (ByPropertyName)0
-RemoveVanished-VlanProtocol A semicolon-seperated list of things to remove when they or the user vanishes during a sync. The following values are possible':' 'entry' removes the user/group when not returned from the sync. 'properties' removes the set properties on existing user/group that do not appear in the source (even custom ones). 'acl' removes acls when the user/group is not returned from the sync. Instead of a list it also can be 'none' (the default).-- Enum: 802.1q,802.1ad false true (ByPropertyName)
-Schedule-VrfVxlan Backup schedule. The format is a subset of `systemd` calendar events.truel3vni.false true (ByPropertyName)0
-Scope-VxlanPort Select what to sync. Enum: users,groups,bothVxlan tunnel udp port (default 4789). false true (ByPropertyName)0
-ZoneThe SDN zone object identifier.truetrue (ByPropertyName)
-Delete-Arch A list of settings you want to delete.OS architecture type. Enum: amd64,i386,arm64,armhf,riscv32,riscv64 false true (ByPropertyName)
-Description-Cmode Description of the logical PCI device.Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login). Enum: shell,console,tty false true (ByPropertyName)
-Digest-Console Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.Attach a console device (/dev/console) to the container. false true (ByPropertyName)False
-Id-Cores The ID of the logical PCI mapping.trueThe number of cores assigned to the container. A container can use all available cores by default.false true (ByPropertyName)0
-Map-Cpulimit A list of maps for the cluster nodes.Limit of CPU usage.NOTE':' If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit. false true (ByPropertyName)0
-Mdev-Cpuunits Marks the device(s) as being capable of providing mediated devices.CPU weight for a container, will be clamped to \[1, 10000] in cgroup v2. false true (ByPropertyName)False0
-
-
-

Outputs

-

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
-
-
-
-
-

Set-PveClusterMappingUsb

-

-

Update a hardware mapping.

-
-
-

Syntax

-
-
-
- Set-PveClusterMappingUsb [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Description] <String>] [[-Digest] <String>] [-Id] <String> [-Map] <Array> [<CommonParameters>] -
-
-
-

Parameters

- - - - - - - - - - - - - + - + - + @@ -42254,215 +47756,218 @@

Parameters

- + - + - + - + - - + + - + - - + + - -
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicket-Debug_ Ticket data connection.Try to be more verbose. For now this only enables debug log-level on start. false true (ByPropertyName)False
-Delete
-Description Description of the logical USB device.Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file. false true (ByPropertyName)
-Digest-DevN Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.Device to pass through to the container false true (ByPropertyName)
-Id-Digest The ID of the logical USB mapping.truePrevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.false true (ByPropertyName)
-Map-Features A list of maps for the cluster nodes.trueAllow containers access to advanced features.false true (ByPropertyName)
-
-
-

Outputs

-

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
-
-
-
-
-

Set-PveClusterMetricsServer

-

-

Update metric server configuration.

-
-
-

Syntax

-
-
-
- Set-PveClusterMetricsServer [[-PveTicket] <PveTicket>] [[-ApiPathPrefix] <String>] [[-Bucket] <String>] [[-Delete] <String>] [[-Digest] <String>] [-Disable] [-Id] <String> [[-Influxdbproto] <String>] [[-MaxBodySize] <Int32>] [[-Mtu] <Int32>] [[-Organization] <String>] [[-Path] <String>] [-Port] <Int32> [[-Proto] <String>] [-Server] <String> [[-Timeout] <Int32>] [[-Token] <String>] [-VerifyCertificate] [<CommonParameters>] -
-
-
-

Parameters

- - - - - - - - - - - - - + - + - + - + - + - + - + - + + + + + + + + + - + - + - + - + - + - + - + - + - + + + + + + + + + - + - + - + - + - + - + - + - + - + - + - + - - + + + + + + + + + + - + - + - + - - + + + + + + + + + + - + - + - + - + - + - + - + - + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicket-Hookscript Ticket data connection.Script that will be exectued during various steps in the containers lifetime. false true (ByPropertyName)
-ApiPathPrefix-Hostname An API path prefix inserted between '<host>':'<port>/' and '/api2/'. Can be useful if the InfluxDB service runs behind a reverse proxy.Set a host name for the container. false true (ByPropertyName)
-Bucket-Lock The InfluxDB bucket/db. Only necessary when using the http v2 api.Lock/unlock the container. Enum: backup,create,destroyed,disk,fstrim,migrate,mounted,rollback,snapshot,snapshot-delete false true (ByPropertyName)
-Delete-Memory A list of settings you want to delete.Amount of RAM for the container in MB.falsetrue (ByPropertyName)0
-MpNUse volume as container mount point. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. false true (ByPropertyName)
-Digest-Nameserver Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. false true (ByPropertyName)
-Disable-NetN Flag to disable the plugin.Specifies network interfaces for the container. false true (ByPropertyName)False
-Id-Node The ID of the entry.The cluster node name. true true (ByPropertyName)
-Influxdbproto-Onboot -- Enum: udp,http,httpsSpecifies whether a container will be started during system bootup.falsetrue (ByPropertyName)False
-OstypeOS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. Enum: debian,devuan,ubuntu,centos,fedora,opensuse,archlinux,alpine,gentoo,nixos,unmanaged false true (ByPropertyName)
-MaxBodySize-Protection InfluxDB max-body-size in bytes. Requests are batched up to this size.Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation. false true (ByPropertyName)0False
-Mtu-Revert MTU for metrics transmission over UDPRevert a pending change. false true (ByPropertyName)0
-Organization-Rootfs The InfluxDB organization. Only necessary when using the http v2 api. Has no meaning when using v2 compatibility api.Use volume as container root. false true (ByPropertyName)
-Path-Searchdomain root graphite path (ex':' proxmox.mycluster.mykey)Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. false true (ByPropertyName)
-Port-Startup server network porttrueStartup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.falsetrue (ByPropertyName)
-SwapAmount of SWAP for the container in MB.false true (ByPropertyName) 0
-Proto-Tags Protocol to send graphite data. TCP or UDP (default) Enum: udp,tcpTags of the Container. This is only meta information. false true (ByPropertyName)
-Server-Template server dns name or IP addresstrueEnable/disable Template.falsetrue (ByPropertyName)False
-TimezoneTime zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tabfalse true (ByPropertyName)
-Timeout-Tty graphite TCP socket timeout (default=1)Specify the number of tty available to the container false true (ByPropertyName) 0
-Token-Unprivileged The InfluxDB access token. Only necessary when using the http v2 api. If the v2 compatibility api is used, use 'user':'password' instead.Makes the container run as unprivileged user. (Should not be modified manually.) false true (ByPropertyName)False
-VerifyCertificate-UnusedN Set to 0 to disable certificate verification for https endpoints.Reference to unused volumes. This is used internally, and should not be modified manually. false true (ByPropertyName)False
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
@@ -42473,18 +47978,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveClusterNotificationsEndpointsGotify

+

Set-PveNodesLxcSnapshotConfig

-

Update existing gotify endpoint

+

Update snapshot metadata.

Syntax

- Set-PveClusterNotificationsEndpointsGotify [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Delete] <Array>] [[-Digest] <String>] [-Disable] [-Name] <String> [[-Server] <String>] [[-Token] <String>] [<CommonParameters>] + Set-PveNodesLxcSnapshotConfig [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
@@ -42510,58 +48015,103 @@

Parameters

- -Comment + -Description - Comment + A textual description or comment. false true (ByPropertyName) - -Delete + -Node - A list of settings you want to delete. - false + The cluster node name. + true true (ByPropertyName) - -Digest + -Snapname - Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. - false + The name of the snapshot. + true true (ByPropertyName) - -Disable + -Vmid - Disable this target - false + The (unique) ID of the VM. + true true (ByPropertyName) - False + 0 + + +
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Set-PveNodesAptRepositories

+

+

Add a standard repository to the configuration

+
+
+

Syntax

+
+
+
+ Set-PveNodesAptRepositories [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Handle] <String> [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + - + - - + + - + - + - + - - + + + + + + + + + + @@ -42574,18 +48124,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveClusterNotificationsEndpointsSendmail

+

Set-PveNodesCephPool

-

Update existing sendmail endpoint

+

Change POOL settings

Syntax

- Set-PveClusterNotificationsEndpointsSendmail [[-PveTicket] <PveTicket>] [[-Author] <String>] [[-Comment] <String>] [[-Delete] <Array>] [[-Digest] <String>] [-Disable] [[-FromAddress] <String>] [[-Mailto] <Array>] [[-MailtoUser] <Array>] [-Name] <String> [<CommonParameters>] + Set-PveNodesCephPool [[-PveTicket] <PveTicket>] [[-Application] <String>] [[-CrushRule] <String>] [[-MinSize] <Int32>] [-Name] <String> [-Node] <String> [[-PgAutoscaleMode] <String>] [[-PgNum] <Int32>] [[-PgNumMin] <Int32>] [[-Size] <Int32>] [[-TargetSize] <String>] [[-TargetSizeRatio] <Single>] [<CommonParameters>]
@@ -42611,73 +48161,150 @@

Parameters

- + - + - + - + - + - + + + + + + + + + - + - + + + + + + + + + - + - + - + - + - + + + + + + + + + + + + + + + + + - + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-Name-PveTicket The name of the endpoint.trueTicket data connection.false true (ByPropertyName)
-Server-Digest Server URLDigest to detect modifications. false true (ByPropertyName)
-Token-Handle Secret tokenfalseHandle that identifies a repository.truetrue (ByPropertyName)
-NodeThe cluster node name.true true (ByPropertyName)
-Author-Application Author of the mailThe application of the pool. Enum: rbd,cephfs,rgw false true (ByPropertyName)
-Comment-CrushRule CommentThe rule to use for mapping object placement in the cluster. false true (ByPropertyName)
-Delete-MinSize A list of settings you want to delete.Minimum number of replicas per object false true (ByPropertyName)0
-NameThe name of the pool. It must be unique.truetrue (ByPropertyName)
-Digest-Node Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.The cluster node name.truetrue (ByPropertyName)
-PgAutoscaleModeThe automatic PG scaling mode of the pool. Enum: on,off,warn false true (ByPropertyName)
-Disable-PgNum Disable this targetNumber of placement groups. false true (ByPropertyName)False0
-FromAddress-PgNumMin `From` address for the mailMinimal number of placement groups.falsetrue (ByPropertyName)0
-SizeNumber of replicas per objectfalsetrue (ByPropertyName)0
-TargetSizeThe estimated target size of the pool for the PG autoscaler. false true (ByPropertyName)
-Mailto-TargetSizeRatioThe estimated target ratio of the pool for the PG autoscaler.falsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Set-PveNodesCertificatesAcmeCertificate

+

+

Renew existing certificate from CA.

+
+
+

Syntax

+
+
+
+ Set-PveNodesCertificatesAcmeCertificate [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + - + - + - + - + - + - + @@ -42691,18 +48318,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveClusterNotificationsEndpointsSmtp

+

Set-PveNodesConfig

-

Update existing smtp endpoint

+

Set node configuration options.

Syntax

- Set-PveClusterNotificationsEndpointsSmtp [[-PveTicket] <PveTicket>] [[-Author] <String>] [[-Comment] <String>] [[-Delete] <Array>] [[-Digest] <String>] [-Disable] [[-FromAddress] <String>] [[-Mailto] <Array>] [[-MailtoUser] <Array>] [[-Mode] <String>] [-Name] <String> [[-Password] <SecureString>] [[-Port] <Int32>] [[-Server] <String>] [[-Username] <String>] [<CommonParameters>] + Set-PveNodesConfig [[-PveTicket] <PveTicket>] [[-Acme] <String>] [[-AcmedomainN] <Hashtable>] [[-Delete] <String>] [[-Description] <String>] [[-Digest] <String>] [-Node] <String> [[-StartallOnbootDelay] <Int32>] [[-Wakeonlan] <String>] [<CommonParameters>]
@@ -42728,17 +48355,17 @@

Parameters

- + - + - + - + @@ -42752,89 +48379,41 @@

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - + - + - + - + - - - - - - - - - + - + - - - - - - - - - + - + @@ -42848,18 +48427,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveClusterNotificationsMatchers

+

Set-PveNodesDisksWipedisk

-

Update existing matcher

+

Wipe a disk or partition.

Syntax

- Set-PveClusterNotificationsMatchers [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Delete] <Array>] [[-Digest] <String>] [-Disable] [-InvertMatch] [[-MatchCalendar] <Array>] [[-MatchField] <Array>] [[-MatchSeverity] <Array>] [[-Mode] <String>] [-Name] <String> [[-Target] <Array>] [<CommonParameters>] + Set-PveNodesDisksWipedisk [[-PveTicket] <PveTicket>] [-Disk] <String> [-Node] <String> [<CommonParameters>]
@@ -42885,90 +48464,103 @@

Parameters

- - - - - - - - - + - - + + - + - - + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicket List of email recipientsTicket data connection. false true (ByPropertyName)
-MailtoUser-Force List of usersForce renewal even if expiry is more than 30 days away. false true (ByPropertyName)False
-Name-Node The name of the endpoint.The cluster node name. true true (ByPropertyName)
-Author-Acme Author of the mail. Defaults to 'Proxmox VE'.Node specific ACME settings. false true (ByPropertyName)
-Comment-AcmedomainN CommentACME domain and validation plugin false true (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-DisableDisable this targetfalsetrue (ByPropertyName)False
-FromAddress`From` address for the mailfalsetrue (ByPropertyName)
-MailtoList of email recipientsfalsetrue (ByPropertyName)
-MailtoUser-Description List of usersDescription for the Node. Shown in the web-interface node notes panel. This is saved as comment inside the configuration file. false true (ByPropertyName)
-Mode-Digest Determine which encryption method shall be used for the connection. Enum: insecure,starttls,tlsPrevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Name-Node The name of the endpoint.The cluster node name. true true (ByPropertyName)
-PasswordPassword for SMTP authenticationfalsetrue (ByPropertyName)
-Port-StartallOnbootDelay The port to be used. Defaults to 465 for TLS based connections, 587 for STARTTLS based connections and port 25 for insecure plain-text connections.Initial delay in seconds, before starting all the Virtual Guests with on-boot enabled. false true (ByPropertyName) 0
-ServerThe address of the SMTP server.falsetrue (ByPropertyName)
-Username-Wakeonlan Username for SMTP authenticationNode specific wake on LAN settings. false true (ByPropertyName)
-CommentCommentfalsetrue (ByPropertyName)
-Delete-Disk A list of settings you want to delete.falseBlock device nametrue true (ByPropertyName)
-Digest-Node Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falseThe cluster node name.true true (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Set-PveNodesDns

+

+

Write DNS settings.

+
+
+

Syntax

+
+
+
+ Set-PveNodesDns [[-PveTicket] <PveTicket>] [[-Dns1] <String>] [[-Dns2] <String>] [[-Dns3] <String>] [-Node] <String> [-Search] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + - - - - - - - - - - - - - - - - - + - + - + - + - + - + - + - + - + - + - + - - + + @@ -42981,18 +48573,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveClusterOptions

+

Set-PveNodesFirewallOptions

-

Set datacenter options.

+

Set Firewall options.

Syntax

- Set-PveClusterOptions [[-PveTicket] <PveTicket>] [[-Bwlimit] <String>] [[-Console] <String>] [[-Crs] <String>] [[-Delete] <String>] [[-Description] <String>] [[-EmailFrom] <String>] [[-Fencing] <String>] [[-Ha] <String>] [[-HttpProxy] <String>] [[-Keyboard] <String>] [[-Language] <String>] [[-MacPrefix] <String>] [[-MaxWorkers] <Int32>] [[-Migration] <String>] [-MigrationUnsecure] [[-NextId] <String>] [[-Notify] <String>] [[-RegisteredTags] <String>] [[-TagStyle] <String>] [[-U2f] <String>] [[-UserTagAccess] <String>] [[-Webauthn] <String>] [<CommonParameters>] + Set-PveNodesFirewallOptions [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Digest] <String>] [-Enable] [[-LogLevelIn] <String>] [[-LogLevelOut] <String>] [-LogNfConntrack] [-Ndp] [-NfConntrackAllowInvalid] [[-NfConntrackHelpers] <String>] [[-NfConntrackMax] <Int32>] [[-NfConntrackTcpTimeoutEstablished] <Int32>] [[-NfConntrackTcpTimeoutSynRecv] <Int32>] [-Nftables] [-Node] <String> [-Nosmurfs] [-ProtectionSynflood] [[-ProtectionSynfloodBurst] <Int32>] [[-ProtectionSynfloodRate] <Int32>] [[-SmurfLogLevel] <String>] [[-TcpFlagsLogLevel] <String>] [-Tcpflags] [<CommonParameters>]
@@ -43018,180 +48610,172 @@

Parameters

- + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - + + - + - + - - - - - - - - - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-DisableDisable this matcherfalsetrue (ByPropertyName)False
-InvertMatchInvert match of the whole matcherfalsetrue (ByPropertyName)False
-MatchCalendar-PveTicket Match notification timestampTicket data connection. false true (ByPropertyName)
-MatchField-Dns1 Metadata fields to match (regex or exact match). Must be in the form (regex|exact)':'<field>=<value>First name server IP address. false true (ByPropertyName)
-MatchSeverity-Dns2 Notification severities to matchSecond name server IP address. false true (ByPropertyName)
-Mode-Dns3 Choose between 'all' and 'any' for when multiple properties are specified Enum: all,anyThird name server IP address. false true (ByPropertyName)
-Name-Node Name of the matcher.The cluster node name. true true (ByPropertyName)
-Target-Search Targets to notify on matchfalseSearch domain for host-name lookup.true true (ByPropertyName)
-Bwlimit-Delete Set I/O bandwidth limit for various operations (in KiB/s).A list of settings you want to delete. false true (ByPropertyName)
-Console-Digest Select the default Console viewer. You can either use the builtin java applet (VNC; deprecated and maps to html5), an external virt-viewer comtatible application (SPICE), an HTML5 based vnc viewer (noVNC), or an HTML5 based console client (xtermjs). If the selected viewer is not available (e.g. SPICE not activated for the VM), the fallback is noVNC. Enum: applet,vv,html5,xtermjsPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Crs-Enable Cluster resource scheduling settings.Enable host firewall rules. false true (ByPropertyName)False
-Delete-LogLevelIn A list of settings you want to delete.Log level for incoming traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog false true (ByPropertyName)
-Description-LogLevelOut Datacenter description. Shown in the web-interface datacenter notes panel. This is saved as comment inside the configuration file.Log level for outgoing traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog false true (ByPropertyName)
-EmailFrom-LogNfConntrack Specify email address to send notification from (default is root@$hostname)Enable logging of conntrack information. false true (ByPropertyName)False
-Fencing-Ndp Set the fencing mode of the HA cluster. Hardware mode needs a valid configuration of fence devices in /etc/pve/ha/fence.cfg. With both all two modes are used.WARNING':' 'hardware' and 'both' are EXPERIMENTAL & WIP Enum: watchdog,hardware,bothEnable NDP (Neighbor Discovery Protocol). false true (ByPropertyName)False
-Ha-NfConntrackAllowInvalid Cluster wide HA settings.Allow invalid packets on connection tracking. false true (ByPropertyName)False
-HttpProxy-NfConntrackHelpers Specify external http proxy which is used for downloads (example':' 'http':'//username':'password@host':'port/')Enable conntrack helpers for specific protocols. Supported protocols':' amanda, ftp, irc, netbios-ns, pptp, sane, sip, snmp, tftp false true (ByPropertyName)
-Keyboard-NfConntrackMax Default keybord layout for vnc server. Enum: de,de-ch,da,en-gb,en-us,es,fi,fr,fr-be,fr-ca,fr-ch,hu,is,it,ja,lt,mk,nl,no,pl,pt,pt-br,sv,sl,trMaximum number of tracked connections. false true (ByPropertyName)0
-Language-NfConntrackTcpTimeoutEstablished Default GUI language. Enum: ar,ca,da,de,en,es,eu,fa,fr,hr,he,it,ja,ka,kr,nb,nl,nn,pl,pt_BR,ru,sl,sv,tr,ukr,zh_CN,zh_TWConntrack established timeout. false true (ByPropertyName)0
-MacPrefix-NfConntrackTcpTimeoutSynRecv Prefix for the auto-generated MAC addresses of virtual guests. The default 'BC':'24':'11' is the OUI assigned by the IEEE to Proxmox Server Solutions GmbH for a 24-bit large MAC block. You're allowed to use this in local networks, i.e., those not directly reachable by the public (e.g., in a LAN or behind NAT).Conntrack syn recv timeout. false true (ByPropertyName)0
-MaxWorkers-Nftables Defines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager.Enable nftables based firewall (tech preview) false true (ByPropertyName)0False
-Migration-Node For cluster wide migration settings.falseThe cluster node name.true true (ByPropertyName)
-MigrationUnsecure-Nosmurfs Migration is secure using SSH tunnel by default. For secure private networks you can disable it to speed up migration. Deprecated, use the 'migration' property instead!Enable SMURFS filter. false true (ByPropertyName) False
-NextIdControl the range for the free VMID auto-selection pool.falsetrue (ByPropertyName)
-Notify-ProtectionSynflood Cluster-wide notification settings.Enable synflood protection false true (ByPropertyName)False
-RegisteredTags-ProtectionSynfloodBurst A list of tags that require a `Sys.Modify` on '/' to set and delete. Tags set here that are also in 'user-tag-access' also require `Sys.Modify`.Synflood protection rate burst by ip src. false true (ByPropertyName)0
-TagStyle-ProtectionSynfloodRate Tag style options.Synflood protection rate syn/sec by ip src. false true (ByPropertyName)0
-U2f-SmurfLogLevel u2fLog level for SMURFS filter. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog false true (ByPropertyName)
-UserTagAccess-TcpFlagsLogLevel Privilege options for user-settable tagsLog level for illegal tcp flags filter. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog false true (ByPropertyName)
-Webauthn-Tcpflags webauthn configurationFilter illegal combinations of TCP flags. false true (ByPropertyName)False
@@ -43202,18 +48786,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveClusterReplication

+

Set-PveNodesFirewallRules

-

Update replication job configuration.

+

Modify rule data.

Syntax

- Set-PveClusterReplication [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Delete] <String>] [[-Digest] <String>] [-Disable] [-Id] <String> [[-Rate] <Single>] [[-RemoveJob] <String>] [[-Schedule] <String>] [[-Source] <String>] [<CommonParameters>] + Set-PveNodesFirewallRules [[-PveTicket] <PveTicket>] [[-Action] <String>] [[-Comment] <String>] [[-Delete] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [[-Moveto] <Int32>] [-Node] <String> [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [[-Type] <String>] [<CommonParameters>]
@@ -43238,10 +48822,18 @@

Parameters

true (ByPropertyName) + + -Action + + Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. + false + true (ByPropertyName) + + -Comment - Description. + Descriptive comment. false true (ByPropertyName) @@ -43254,6 +48846,14 @@

Parameters

true (ByPropertyName) + + -Dest + + Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. + false + true (ByPropertyName) + + -Digest @@ -43263,49 +48863,105 @@

Parameters

- -Disable + -Dport - Flag to disable/deactivate the entry. + Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges. false true (ByPropertyName) - False + - -Id + -Enable - Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'. + Flag to enable/disable a rule. + false + true (ByPropertyName) + 0 + + + -IcmpType + + Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. + false + true (ByPropertyName) + + + + -Iface + + Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. + false + true (ByPropertyName) + + + + -Log + + Log level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog + false + true (ByPropertyName) + + + + -Macro + + Use predefined standard macro. + false + true (ByPropertyName) + + + + -Moveto + + Move rule to new position <moveto>. Other arguments are ignored. + false + true (ByPropertyName) + 0 + + + -Node + + The cluster node name. true true (ByPropertyName) - -Rate + -Pos - Rate limit in mbps (megabytes per second) as floating point number. + Update rule at position <pos>. false true (ByPropertyName) 0 - -RemoveJob + -Proto - Mark the replication job for removal. The job will remove all local replication snapshots. When set to 'full', it also tries to remove replicated volumes on the target. The job then removes itself from the configuration file. Enum: local,full + IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. false true (ByPropertyName) - -Schedule + -Source - Storage replication schedule. The format is a subset of `systemd` calendar events. + Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. false true (ByPropertyName) - -Source + -Sport - For internal use, to detect if the guest was stolen. + Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges. + false + true (ByPropertyName) + + + + -Type + + Rule type. Enum: in,out,group false true (ByPropertyName) @@ -43319,18 +48975,28 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveClusterSdn

+

Set-PveNodesLxcConfig

-

Apply sdn controller changes && reload.

+

Set container options.

+
+
+
+

Aliases

+
+
+
    +
  • Set-PveLxcConfig
    • +
+

Syntax

- Set-PveClusterSdn [[-PveTicket] <PveTicket>] [<CommonParameters>] + Set-PveNodesLxcConfig [[-PveTicket] <PveTicket>] [[-Arch] <String>] [[-Cmode] <String>] [-Console] [[-Cores] <Int32>] [[-Cpulimit] <Single>] [[-Cpuunits] <Int32>] [-Debug_] [[-Delete] <String>] [[-Description] <String>] [[-DevN] <Hashtable>] [[-Digest] <String>] [[-Features] <String>] [[-Hookscript] <String>] [[-Hostname] <String>] [[-Lock] <String>] [[-Memory] <Int32>] [[-MpN] <Hashtable>] [[-Nameserver] <String>] [[-NetN] <Hashtable>] [-Node] <String> [-Onboot] [[-Ostype] <String>] [-Protection] [[-Revert] <String>] [[-Rootfs] <String>] [[-Searchdomain] <String>] [[-Startup] <String>] [[-Swap] <Int32>] [[-Tags] <String>] [-Template] [[-Timezone] <String>] [[-Tty] <Int32>] [-Unprivileged] [[-UnusedN] <Hashtable>] [-Vmid] <Int32> [<CommonParameters>]
@@ -43355,349 +49021,286 @@

Parameters

true (ByPropertyName) - - -
-
-

Outputs

-

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
-
-
-
-
-

Set-PveClusterSdnControllers

-

-

Update sdn controller object configuration.

-
-
-

Syntax

-
-
-
- Set-PveClusterSdnControllers [[-PveTicket] <PveTicket>] [[-Asn] <Int32>] [-BgpMultipathAsPathRelax] [-Controller] <String> [[-Delete] <String>] [[-Digest] <String>] [-Ebgp] [[-EbgpMultihop] <Int32>] [[-IsisDomain] <String>] [[-IsisIfaces] <String>] [[-IsisNet] <String>] [[-Loopback] <String>] [[-Node] <String>] [[-Peers] <String>] [<CommonParameters>] -
-
-
-

Parameters

- - - - - - - - - - - - - + - + - + - + - + - + - + - + - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - -
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicket-Arch Ticket data connection.OS architecture type. Enum: amd64,i386,arm64,armhf,riscv32,riscv64 false true (ByPropertyName)
-Asn-Cmode autonomous system numberConsole mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login). Enum: shell,console,tty false true (ByPropertyName)0
-BgpMultipathAsPathRelax-Console --Attach a console device (/dev/console) to the container. false true (ByPropertyName) False
-Controller-Cores The SDN controller object identifier.trueThe number of cores assigned to the container. A container can use all available cores by default.false true (ByPropertyName)0
-Delete-Cpulimit A list of settings you want to delete.Limit of CPU usage.NOTE':' If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit. false true (ByPropertyName)0
-Digest-Cpuunits Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.CPU weight for a container, will be clamped to \[1, 10000] in cgroup v2. false true (ByPropertyName)0
-Ebgp-Debug_ Enable ebgp. (remote-as external)Try to be more verbose. For now this only enables debug log-level on start. false true (ByPropertyName) False
-EbgpMultihop-Delete --A list of settings you want to delete. false true (ByPropertyName)0
-IsisDomain-Description ISIS domain.Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file. false true (ByPropertyName)
-IsisIfaces-DevN ISIS interface.Device to pass through to the container false true (ByPropertyName)
-IsisNet-Digest ISIS network entity title.Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Loopback-Features source loopback interface.Allow containers access to advanced features. false true (ByPropertyName)
-Node-Hookscript The cluster node name.Script that will be exectued during various steps in the containers lifetime. false true (ByPropertyName)
-Peers-Hostname peers address list.Set a host name for the container. false true (ByPropertyName)
-
-
-

Outputs

-

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
-
-
-
-
-

Set-PveClusterSdnDns

-

-

Update sdn dns object configuration.

-
-
-

Syntax

-
-
-
- Set-PveClusterSdnDns [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Digest] <String>] [-Dns] <String> [[-Key] <String>] [[-Reversemaskv6] <Int32>] [[-Ttl] <Int32>] [[-Url] <String>] [<CommonParameters>] -
-
-
-

Parameters

- - - - - - - - - - - - - + - + - + - + + + + + + + + + - + - + - + - + + + + + + + + + - + - + + + + + + + + + - + - + - + - + - + - + - + - + - -
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicket-Lock Ticket data connection.Lock/unlock the container. Enum: backup,create,destroyed,disk,fstrim,migrate,mounted,rollback,snapshot,snapshot-delete false true (ByPropertyName)
-Delete-Memory A list of settings you want to delete.Amount of RAM for the container in MB.falsetrue (ByPropertyName)0
-MpNUse volume as container mount point. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. false true (ByPropertyName)
-Digest-Nameserver Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. false true (ByPropertyName)
-Dns-NetN The SDN dns object identifier.Specifies network interfaces for the container.falsetrue (ByPropertyName)
-NodeThe cluster node name. true true (ByPropertyName)
-Key-Onboot --Specifies whether a container will be started during system bootup.falsetrue (ByPropertyName)False
-OstypeOS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. Enum: debian,devuan,ubuntu,centos,fedora,opensuse,archlinux,alpine,gentoo,nixos,unmanaged false true (ByPropertyName)
-Reversemaskv6-Protection --Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation. false true (ByPropertyName)0False
-Ttl-Revert --Revert a pending change. false true (ByPropertyName)0
-Url-Rootfs --Use volume as container root. false true (ByPropertyName)
-
-
-

Outputs

-

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
-
-
-
-
-

Set-PveClusterSdnIpams

-

-

Update sdn ipam object configuration.

-
-
-

Syntax

-
-
-
- Set-PveClusterSdnIpams [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Digest] <String>] [-Ipam] <String> [[-Section] <Int32>] [[-Token] <String>] [[-Url] <String>] [<CommonParameters>] -
-
-
-

Parameters

- - - - - - - - - - - - - + - + - + - + - + - + + + + + + + + + - + - - + + + + + + + + + + - + - + - + - + - + - + - + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicket-Searchdomain Ticket data connection.Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. false true (ByPropertyName)
-Delete-Startup A list of settings you want to delete.Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. false true (ByPropertyName)
-Digest-Swap Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.Amount of SWAP for the container in MB.falsetrue (ByPropertyName)0
-TagsTags of the Container. This is only meta information. false true (ByPropertyName)
-Ipam-Template The SDN ipam object identifier.trueEnable/disable Template.falsetrue (ByPropertyName)False
-TimezoneTime zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tabfalse true (ByPropertyName)
-Section-Tty --Specify the number of tty available to the container false true (ByPropertyName) 0
-Token-Unprivileged --Makes the container run as unprivileged user. (Should not be modified manually.) false true (ByPropertyName)False
-Url-UnusedN --Reference to unused volumes. This is used internally, and should not be modified manually. false true (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
@@ -43707,18 +49310,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveClusterSdnVnets

+

Set-PveNodesLxcFirewallAliases

-

Update sdn vnet object configuration.

+

Update IP or Network alias.

Syntax

- Set-PveClusterSdnVnets [[-PveTicket] <PveTicket>] [[-Alias] <String>] [[-Delete] <String>] [[-Digest] <String>] [[-Tag] <Int32>] [-Vlanaware] [-Vnet] <String> [[-Zone] <String>] [<CommonParameters>] + Set-PveNodesLxcFirewallAliases [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [[-Rename] <String>] [-Vmid] <Int32> [<CommonParameters>]
@@ -43744,17 +49347,17 @@

Parameters

- -Alias + -Cidr - alias name of the vnet - false + Network/IP specification in CIDR format. + true true (ByPropertyName) - -Delete + -Comment - A list of settings you want to delete. + -- false true (ByPropertyName) @@ -43768,36 +49371,36 @@

Parameters

- -Tag + -Name - vlan or vxlan id - false + Alias name. + true true (ByPropertyName) - 0 + - -Vlanaware + -Node - Allow vm VLANs to pass through this vnet. - false + The cluster node name. + true true (ByPropertyName) - False + - -Vnet + -Rename - The SDN vnet object identifier. - true + Rename an existing alias. + false true (ByPropertyName) - -Zone + -Vmid - zone id - false + The (unique) ID of the VM. + true true (ByPropertyName) - + 0 @@ -43808,18 +49411,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveClusterSdnVnetsIps

+

Set-PveNodesLxcFirewallIpset

-

Update IP Mapping in a VNet

+

Update IP or Network settings

Syntax

- Set-PveClusterSdnVnetsIps [[-PveTicket] <PveTicket>] [-Ip] <String> [[-Mac] <String>] [[-Vmid] <Int32>] [-Vnet] <String> [-Zone] <String> [<CommonParameters>] + Set-PveNodesLxcFirewallIpset [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Nomatch] [-Vmid] <Int32> [<CommonParameters>]
@@ -43845,45 +49448,61 @@

Parameters

- -Ip + -Cidr - The IP address to associate with the given MAC address + Network/IP specification in CIDR format. true true (ByPropertyName) - -Mac + -Comment - Unicast MAC address. + -- false true (ByPropertyName) - -Vmid + -Digest - The (unique) ID of the VM. + Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName) - 0 + - -Vnet + -Name - The SDN vnet object identifier. + IP set name. true true (ByPropertyName) - -Zone + -Node - The SDN zone object identifier. + The cluster node name. true true (ByPropertyName) + + -Nomatch + + -- + false + true (ByPropertyName) + False + + + -Vmid + + The (unique) ID of the VM. + true + true (ByPropertyName) + 0 +
@@ -43893,18 +49512,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveClusterSdnVnetsSubnets

+

Set-PveNodesLxcFirewallOptions

-

Update sdn subnet object configuration.

+

Set Firewall options.

Syntax

- Set-PveClusterSdnVnetsSubnets [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-DhcpDnsServer] <String>] [[-DhcpRange] <Array>] [[-Digest] <String>] [[-Dnszoneprefix] <String>] [[-Gateway] <String>] [-Snat] [-Subnet] <String> [[-Vnet] <String>] [<CommonParameters>] + Set-PveNodesLxcFirewallOptions [[-PveTicket] <PveTicket>] [[-Delete] <String>] [-Dhcp] [[-Digest] <String>] [-Enable] [-Ipfilter] [[-LogLevelIn] <String>] [[-LogLevelOut] <String>] [-Macfilter] [-Ndp] [-Node] <String> [[-PolicyIn] <String>] [[-PolicyOut] <String>] [-Radv] [-Vmid] <Int32> [<CommonParameters>]
@@ -43938,69 +49557,109 @@

Parameters

- -DhcpDnsServer + -Dhcp - IP address for the DNS server + Enable DHCP. false true (ByPropertyName) - + False - -DhcpRange + -Digest - A list of DHCP ranges for this subnet + Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName) - -Digest + -Enable - Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. + Enable/disable firewall rules. false true (ByPropertyName) - + False - -Dnszoneprefix + -Ipfilter - dns domain zone prefix ex':' 'adm' -> <hostname>.adm.mydomain.com + Enable default IP filters. This is equivalent to adding an empty ipfilter-net<id> ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added. + false + true (ByPropertyName) + False + + + -LogLevelIn + + Log level for incoming traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog false true (ByPropertyName) - -Gateway + -LogLevelOut - Subnet Gateway':' Will be assign on vnet for layer3 zones + Log level for outgoing traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog false true (ByPropertyName) - -Snat + -Macfilter - enable masquerade for this subnet if pve-firewall + Enable/disable MAC address filter. false true (ByPropertyName) False - -Subnet + -Ndp - The SDN subnet object identifier. + Enable NDP (Neighbor Discovery Protocol). + false + true (ByPropertyName) + False + + + -Node + + The cluster node name. true true (ByPropertyName) - -Vnet + -PolicyIn - associated vnet + Input policy. Enum: ACCEPT,REJECT,DROP + false + true (ByPropertyName) + + + + -PolicyOut + + Output policy. Enum: ACCEPT,REJECT,DROP false true (ByPropertyName) + + -Radv + + Allow sending Router Advertisement. + false + true (ByPropertyName) + False + + + -Vmid + + The (unique) ID of the VM. + true + true (ByPropertyName) + 0 +
@@ -44010,18 +49669,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveClusterSdnZones

+

Set-PveNodesLxcFirewallRules

-

Update sdn zone object configuration.

+

Modify rule data.

Syntax

- Set-PveClusterSdnZones [[-PveTicket] <PveTicket>] [-AdvertiseSubnets] [[-Bridge] <String>] [-BridgeDisableMacLearning] [[-Controller] <String>] [[-Delete] <String>] [[-Dhcp] <String>] [[-Digest] <String>] [-DisableArpNdSuppression] [[-Dns] <String>] [[-Dnszone] <String>] [[-DpId] <Int32>] [[-Exitnodes] <String>] [-ExitnodesLocalRouting] [[-ExitnodesPrimary] <String>] [[-Ipam] <String>] [[-Mac] <String>] [[-Mtu] <Int32>] [[-Nodes] <String>] [[-Peers] <String>] [[-Reversedns] <String>] [[-RtImport] <String>] [[-Tag] <Int32>] [[-VlanProtocol] <String>] [[-VrfVxlan] <Int32>] [[-VxlanPort] <Int32>] [-Zone] <String> [<CommonParameters>] + Set-PveNodesLxcFirewallRules [[-PveTicket] <PveTicket>] [[-Action] <String>] [[-Comment] <String>] [[-Delete] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [[-Moveto] <Int32>] [-Node] <String> [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [[-Type] <String>] [-Vmid] <Int32> [<CommonParameters>]
@@ -44047,33 +49706,17 @@

Parameters

- -AdvertiseSubnets - - Advertise evpn subnets if you have silent hosts - false - true (ByPropertyName) - False - - - -Bridge + -Action - -- + Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. false true (ByPropertyName) - -BridgeDisableMacLearning - - Disable auto mac learning. - false - true (ByPropertyName) - False - - - -Controller + -Comment - Frr router name + Descriptive comment. false true (ByPropertyName) @@ -44087,9 +49730,9 @@

Parameters

- -Dhcp + -Dest - Type of the DHCP backend for this zone Enum: dnsmasq + Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. false true (ByPropertyName) @@ -44097,162 +49740,122 @@

Parameters

-Digest - Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. - false - true (ByPropertyName) - - - - -DisableArpNdSuppression - - Disable ipv4 arp && ipv6 neighbour discovery suppression - false - true (ByPropertyName) - False - - - -Dns - - dns api server - false - true (ByPropertyName) - - - - -Dnszone - - dns domain zone ex':' mydomain.com - false - true (ByPropertyName) - - - - -DpId - - Faucet dataplane id - false - true (ByPropertyName) - 0 - - - -Exitnodes - - List of cluster node names. + Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName) - -ExitnodesLocalRouting + -Dport - Allow exitnodes to connect to evpn guests + Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges. false true (ByPropertyName) - False + - -ExitnodesPrimary + -Enable - Force traffic to this exitnode first. + Flag to enable/disable a rule. false true (ByPropertyName) - + 0 - -Ipam + -IcmpType - use a specific ipam + Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. false true (ByPropertyName) - -Mac + -Iface - Anycast logical router mac address + Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. false true (ByPropertyName) - -Mtu + -Log - MTU + Log level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog false true (ByPropertyName) - 0 + - -Nodes + -Macro - List of cluster node names. + Use predefined standard macro. false true (ByPropertyName) - -Peers + -Moveto - peers address list. + Move rule to new position <moveto>. Other arguments are ignored. false true (ByPropertyName) - + 0 - -Reversedns + -Node - reverse dns api server - false + The cluster node name. + true true (ByPropertyName) - -RtImport + -Pos - Route-Target import + Update rule at position <pos>. false true (ByPropertyName) - + 0 - -Tag + -Proto - Service-VLAN Tag + IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. false true (ByPropertyName) - 0 + - -VlanProtocol + -Source - -- Enum: 802.1q,802.1ad + Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. false true (ByPropertyName) - -VrfVxlan + -Sport - l3vni. + Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges. false true (ByPropertyName) - 0 + - -VxlanPort + -Type - Vxlan tunnel udp port (default 4789). + Rule type. Enum: in,out,group false true (ByPropertyName) - 0 + - -Zone + -Vmid - The SDN zone object identifier. + The (unique) ID of the VM. true true (ByPropertyName) - + 0 @@ -44263,18 +49866,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveNodesAptRepositories

+

Set-PveNodesLxcResize

-

Add a standard repository to the configuration

+

Resize a container mount point.

Syntax

- Set-PveNodesAptRepositories [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Handle] <String> [-Node] <String> [<CommonParameters>] + Set-PveNodesLxcResize [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Disk] <String> [-Node] <String> [-Size] <String> [-Vmid] <Int32> [<CommonParameters>]
@@ -44302,15 +49905,15 @@

Parameters

-Digest - Digest to detect modifications. + Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. false true (ByPropertyName) - -Handle + -Disk - Handle that identifies a repository. + The disk you want to resize. Enum: rootfs,mp0,mp1,mp2,mp3,mp4,mp5,mp6,mp7,mp8,mp9,mp10,mp11,mp12,mp13,mp14,mp15,mp16,mp17,mp18,mp19,mp20,mp21,mp22,mp23,mp24,mp25,mp26,mp27,mp28,mp29,mp30,mp31,mp32,mp33,mp34,mp35,mp36,mp37,mp38,mp39,mp40,mp41,mp42,mp43,mp44,mp45,mp46,mp47,mp48,mp49,mp50,mp51,mp52,mp53,mp54,mp55,mp56,mp57,mp58,mp59,mp60,mp61,mp62,mp63,mp64,mp65,mp66,mp67,mp68,mp69,mp70,mp71,mp72,mp73,mp74,mp75,mp76,mp77,mp78,mp79,mp80,mp81,mp82,mp83,mp84,mp85,mp86,mp87,mp88,mp89,mp90,mp91,mp92,mp93,mp94,mp95,mp96,mp97,mp98,mp99,mp100,mp101,mp102,mp103,mp104,mp105,mp106,mp107,mp108,mp109,mp110,mp111,mp112,mp113,mp114,mp115,mp116,mp117,mp118,mp119,mp120,mp121,mp122,mp123,mp124,mp125,mp126,mp127,mp128,mp129,mp130,mp131,mp132,mp133,mp134,mp135,mp136,mp137,mp138,mp139,mp140,mp141,mp142,mp143,mp144,mp145,mp146,mp147,mp148,mp149,mp150,mp151,mp152,mp153,mp154,mp155,mp156,mp157,mp158,mp159,mp160,mp161,mp162,mp163,mp164,mp165,mp166,mp167,mp168,mp169,mp170,mp171,mp172,mp173,mp174,mp175,mp176,mp177,mp178,mp179,mp180,mp181,mp182,mp183,mp184,mp185,mp186,mp187,mp188,mp189,mp190,mp191,mp192,mp193,mp194,mp195,mp196,mp197,mp198,mp199,mp200,mp201,mp202,mp203,mp204,mp205,mp206,mp207,mp208,mp209,mp210,mp211,mp212,mp213,mp214,mp215,mp216,mp217,mp218,mp219,mp220,mp221,mp222,mp223,mp224,mp225,mp226,mp227,mp228,mp229,mp230,mp231,mp232,mp233,mp234,mp235,mp236,mp237,mp238,mp239,mp240,mp241,mp242,mp243,mp244,mp245,mp246,mp247,mp248,mp249,mp250,mp251,mp252,mp253,mp254,mp255 true true (ByPropertyName) @@ -44323,6 +49926,22 @@

Parameters

true (ByPropertyName) + + -Size + + The new size. With the '+' sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported. + true + true (ByPropertyName) + + + + -Vmid + + The (unique) ID of the VM. + true + true (ByPropertyName) + 0 +
@@ -44332,18 +49951,28 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveNodesCephPool

+

Set-PveNodesLxcSnapshotConfig

-

Change POOL settings

+

Update snapshot metadata.

+
+
+
+

Aliases

+
+
+
    +
  • Set-PveLxcSnapshot
    • +
+

Syntax

- Set-PveNodesCephPool [[-PveTicket] <PveTicket>] [[-Application] <String>] [[-CrushRule] <String>] [[-MinSize] <Int32>] [-Name] <String> [-Node] <String> [[-PgAutoscaleMode] <String>] [[-PgNum] <Int32>] [[-PgNumMin] <Int32>] [[-Size] <Int32>] [[-TargetSize] <String>] [[-TargetSizeRatio] <Single>] [<CommonParameters>] + Set-PveNodesLxcSnapshotConfig [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
@@ -44369,35 +49998,11 @@

Parameters

- -Application - - The application of the pool. Enum: rbd,cephfs,rgw - false - true (ByPropertyName) - - - - -CrushRule - - The rule to use for mapping object placement in the cluster. - false - true (ByPropertyName) - - - - -MinSize + -Description - Minimum number of replicas per object + A textual description or comment. false true (ByPropertyName) - 0 - - - -Name - - The name of the pool. It must be unique. - true - true (ByPropertyName) @@ -44409,50 +50014,18 @@

Parameters

- -PgAutoscaleMode - - The automatic PG scaling mode of the pool. Enum: on,off,warn - false - true (ByPropertyName) - - - - -PgNum - - Number of placement groups. - false - true (ByPropertyName) - 0 - - - -PgNumMin - - Minimal number of placement groups. - false - true (ByPropertyName) - 0 - - - -Size - - Number of replicas per object - false - true (ByPropertyName) - 0 - - - -TargetSize + -Snapname - The estimated target size of the pool for the PG autoscaler. - false + The name of the snapshot. + true true (ByPropertyName) - -TargetSizeRatio + -Vmid - The estimated target ratio of the pool for the PG autoscaler. - false + The (unique) ID of the VM. + true true (ByPropertyName) 0 @@ -44465,18 +50038,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveNodesCertificatesAcmeCertificate

+

Set-PveNodesNetwork

-

Renew existing certificate from CA.

+

Reload network configuration

Syntax

- Set-PveNodesCertificatesAcmeCertificate [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [<CommonParameters>] + Set-PveNodesNetwork [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
@@ -44501,14 +50074,6 @@

Parameters

true (ByPropertyName) - - -Force - - Force renewal even if expiry is more than 30 days away. - false - true (ByPropertyName) - False - -Node @@ -44526,18 +50091,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveNodesConfig

+

Set-PveNodesNetworkIdx

-

Set node configuration options.

+

Update network device configuration

Syntax

- Set-PveNodesConfig [[-PveTicket] <PveTicket>] [[-Acme] <String>] [[-AcmedomainN] <Hashtable>] [[-Delete] <String>] [[-Description] <String>] [[-Digest] <String>] [-Node] <String> [[-StartallOnbootDelay] <Int32>] [[-Wakeonlan] <String>] [<CommonParameters>] + Set-PveNodesNetworkIdx [[-PveTicket] <PveTicket>] [[-Address] <String>] [[-Address6] <String>] [-Autostart] [[-BondPrimary] <String>] [[-BondMode] <String>] [[-BondXmitHashPolicy] <String>] [[-BridgePorts] <String>] [-BridgeVlanAware] [[-Cidr] <String>] [[-Cidr6] <String>] [[-Comments] <String>] [[-Comments6] <String>] [[-Delete] <String>] [[-Gateway] <String>] [[-Gateway6] <String>] [-Iface] <String> [[-Mtu] <Int32>] [[-Netmask] <String>] [[-Netmask6] <Int32>] [-Node] <String> [[-OvsBonds] <String>] [[-OvsBridge] <String>] [[-OvsOptions] <String>] [[-OvsPorts] <String>] [[-OvsTag] <Int32>] [[-Slaves] <String>] [-Type] <String> [[-VlanId] <Int32>] [[-VlanRawDevice] <String>] [<CommonParameters>]
@@ -44563,17 +50128,97 @@

Parameters

- -Acme + -Address - Node specific ACME settings. + IP address. false true (ByPropertyName) - -AcmedomainN + -Address6 - ACME domain and validation plugin + IP address. + false + true (ByPropertyName) + + + + -Autostart + + Automatically start interface on boot. + false + true (ByPropertyName) + False + + + -BondPrimary + + Specify the primary interface for active-backup bond. + false + true (ByPropertyName) + + + + -BondMode + + Bonding mode. Enum: balance-rr,active-backup,balance-xor,broadcast,802.3ad,balance-tlb,balance-alb,balance-slb,lacp-balance-slb,lacp-balance-tcp + false + true (ByPropertyName) + + + + -BondXmitHashPolicy + + Selects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes. Enum: layer2,layer2+3,layer3+4 + false + true (ByPropertyName) + + + + -BridgePorts + + Specify the interfaces you want to add to your bridge. + false + true (ByPropertyName) + + + + -BridgeVlanAware + + Enable bridge vlan support. + false + true (ByPropertyName) + False + + + -Cidr + + IPv4 CIDR. + false + true (ByPropertyName) + + + + -Cidr6 + + IPv6 CIDR. + false + true (ByPropertyName) + + + + -Comments + + Comments + false + true (ByPropertyName) + + + + -Comments6 + + Comments false true (ByPropertyName) @@ -44587,21 +50232,53 @@

Parameters

- -Description + -Gateway - Description for the Node. Shown in the web-interface node notes panel. This is saved as comment inside the configuration file. + Default gateway address. false true (ByPropertyName) - -Digest + -Gateway6 - Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. + Default ipv6 gateway address. + false + true (ByPropertyName) + + + + -Iface + + Network interface name. + true + true (ByPropertyName) + + + + -Mtu + + MTU. + false + true (ByPropertyName) + 0 + + + -Netmask + + Network mask. false true (ByPropertyName) + + -Netmask6 + + Network mask. + false + true (ByPropertyName) + 0 + -Node @@ -44611,82 +50288,77 @@

Parameters

- -StartallOnbootDelay + -OvsBonds - Initial delay in seconds, before starting all the Virtual Guests with on-boot enabled. + Specify the interfaces used by the bonding device. false true (ByPropertyName) - 0 + - -Wakeonlan + -OvsBridge - Node specific wake on LAN settings. + The OVS bridge associated with a OVS port. This is required when you create an OVS port. false true (ByPropertyName) - - -
-
-

Outputs

-

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
-
-
-
-
-

Set-PveNodesDisksWipedisk

-

-

Wipe a disk or partition.

-
-
-

Syntax

-
-
-
- Set-PveNodesDisksWipedisk [[-PveTicket] <PveTicket>] [-Disk] <String> [-Node] <String> [<CommonParameters>] -
-
-
-

Parameters

- - - - - - - - - - - - - + - + - + - - + + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicket-OvsOptions Ticket data connection.OVS interface options. false true (ByPropertyName)
-Disk-OvsPorts Block device nametrueSpecify the interfaces you want to add to your bridge.false true (ByPropertyName)
-Node-OvsTag The cluster node name.Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond)falsetrue (ByPropertyName)0
-SlavesSpecify the interfaces used by the bonding device.falsetrue (ByPropertyName)
-TypeNetwork interface type Enum: bridge,bond,eth,alias,vlan,OVSBridge,OVSBond,OVSPort,OVSIntPort,unknown true true (ByPropertyName)
-VlanIdvlan-id for a custom named vlan interface (ifupdown2 only).falsetrue (ByPropertyName)0
-VlanRawDeviceSpecify the raw interface for the vlan interface.falsetrue (ByPropertyName)
@@ -44696,18 +50368,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveNodesDns

+

Set-PveNodesQemuCloudinit

-

Write DNS settings.

+

Regenerate and change cloudinit config drive.

Syntax

- Set-PveNodesDns [[-PveTicket] <PveTicket>] [[-Dns1] <String>] [[-Dns2] <String>] [[-Dns3] <String>] [-Node] <String> [-Search] <String> [<CommonParameters>] + Set-PveNodesQemuCloudinit [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
@@ -44732,30 +50404,6 @@

Parameters

true (ByPropertyName) - - -Dns1 - - First name server IP address. - false - true (ByPropertyName) - - - - -Dns2 - - Second name server IP address. - false - true (ByPropertyName) - - - - -Dns3 - - Third name server IP address. - false - true (ByPropertyName) - - -Node @@ -44765,12 +50413,12 @@

Parameters

- -Search + -Vmid - Search domain for host-name lookup. + The (unique) ID of the VM. true true (ByPropertyName) - + 0 @@ -44781,18 +50429,28 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveNodesFirewallOptions

+

Set-PveNodesQemuConfig

-

Set Firewall options.

+

Set virtual machine options (synchrounous API) - You should consider using the POST method instead for any actions involving hotplug or storage allocation.

+
+
+
+

Aliases

+
+
+
    +
  • Set-PveQemuConfig
    • +
+

Syntax

- Set-PveNodesFirewallOptions [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Digest] <String>] [-Enable] [[-LogLevelIn] <String>] [[-LogLevelOut] <String>] [-LogNfConntrack] [-Ndp] [-NfConntrackAllowInvalid] [[-NfConntrackHelpers] <String>] [[-NfConntrackMax] <Int32>] [[-NfConntrackTcpTimeoutEstablished] <Int32>] [[-NfConntrackTcpTimeoutSynRecv] <Int32>] [-Nftables] [-Node] <String> [-Nosmurfs] [-ProtectionSynflood] [[-ProtectionSynfloodBurst] <Int32>] [[-ProtectionSynfloodRate] <Int32>] [[-SmurfLogLevel] <String>] [[-TcpFlagsLogLevel] <String>] [-Tcpflags] [<CommonParameters>] + Set-PveNodesQemuConfig [[-PveTicket] <PveTicket>] [-Acpi] [[-Affinity] <String>] [[-Agent] <String>] [[-Arch] <String>] [[-Args_] <String>] [[-Audio0] <String>] [-Autostart] [[-Balloon] <Int32>] [[-Bios] <String>] [[-Boot] <String>] [[-Bootdisk] <String>] [[-Cdrom] <String>] [[-Cicustom] <String>] [[-Cipassword] <SecureString>] [[-Citype] <String>] [-Ciupgrade] [[-Ciuser] <String>] [[-Cores] <Int32>] [[-Cpu] <String>] [[-Cpulimit] <Single>] [[-Cpuunits] <Int32>] [[-Delete] <String>] [[-Description] <String>] [[-Digest] <String>] [[-Efidisk0] <String>] [-Force] [-Freeze] [[-Hookscript] <String>] [[-HostpciN] <Hashtable>] [[-Hotplug] <String>] [[-Hugepages] <String>] [[-IdeN] <Hashtable>] [[-IpconfigN] <Hashtable>] [[-Ivshmem] <String>] [-Keephugepages] [[-Keyboard] <String>] [-Kvm] [-Localtime] [[-Lock] <String>] [[-Machine] <String>] [[-Memory] <String>] [[-MigrateDowntime] <Single>] [[-MigrateSpeed] <Int32>] [[-Name] <String>] [[-Nameserver] <String>] [[-NetN] <Hashtable>] [-Node] <String> [-Numa] [[-NumaN] <Hashtable>] [-Onboot] [[-Ostype] <String>] [[-ParallelN] <Hashtable>] [-Protection] [-Reboot] [[-Revert] <String>] [[-Rng0] <String>] [[-SataN] <Hashtable>] [[-ScsiN] <Hashtable>] [[-Scsihw] <String>] [[-Searchdomain] <String>] [[-SerialN] <Hashtable>] [[-Shares] <Int32>] [-Skiplock] [[-Smbios1] <String>] [[-Smp] <Int32>] [[-Sockets] <Int32>] [[-SpiceEnhancements] <String>] [[-Sshkeys] <String>] [[-Startdate] <String>] [[-Startup] <String>] [-Tablet] [[-Tags] <String>] [-Tdf] [-Template] [[-Tpmstate0] <String>] [[-UnusedN] <Hashtable>] [[-UsbN] <Hashtable>] [[-Vcpus] <Int32>] [[-Vga] <String>] [[-VirtioN] <Hashtable>] [[-Vmgenid] <String>] [-Vmid] <Int32> [[-Vmstatestorage] <String>] [[-Watchdog] <String>] [<CommonParameters>]
@@ -44812,693 +50470,683 @@

Parameters

-PveTicket - Ticket data connection. + Ticket data connection. + false + true (ByPropertyName) + + + + -Acpi + + Enable/disable ACPI. + false + true (ByPropertyName) + False + + + -Affinity + + List of host cores used to execute guest processes, for example':' 0,5,8-11 false true (ByPropertyName) - -Delete + -Agent - A list of settings you want to delete. + Enable/disable communication with the QEMU Guest Agent and its properties. false true (ByPropertyName) - -Digest + -Arch - Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. + Virtual processor architecture. Defaults to the host. Enum: x86_64,aarch64 false true (ByPropertyName) - -Enable + -Args_ - Enable host firewall rules. + Arbitrary arguments passed to kvm. false true (ByPropertyName) - False + - -LogLevelIn + -Audio0 - Log level for incoming traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog + Configure a audio device, useful in combination with QXL/Spice. false true (ByPropertyName) - -LogLevelOut + -Autostart - Log level for outgoing traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog + Automatic restart after crash (currently ignored). false true (ByPropertyName) - + False - -LogNfConntrack + -Balloon - Enable logging of conntrack information. + Amount of target RAM for the VM in MiB. Using zero disables the ballon driver. false true (ByPropertyName) - False + 0 - -Ndp + -Bios - Enable NDP (Neighbor Discovery Protocol). + Select BIOS implementation. Enum: seabios,ovmf false true (ByPropertyName) - False + - -NfConntrackAllowInvalid + -Boot - Allow invalid packets on connection tracking. + Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. false true (ByPropertyName) - False + - -NfConntrackHelpers + -Bootdisk - Enable conntrack helpers for specific protocols. Supported protocols':' amanda, ftp, irc, netbios-ns, pptp, sane, sip, snmp, tftp + Enable booting from specified disk. Deprecated':' Use 'boot':' order=foo;bar' instead. false true (ByPropertyName) - -NfConntrackMax + -Cdrom - Maximum number of tracked connections. + This is an alias for option -ide2 false true (ByPropertyName) - 0 + - -NfConntrackTcpTimeoutEstablished + -Cicustom - Conntrack established timeout. + cloud-init':' Specify custom files to replace the automatically generated ones at start. false true (ByPropertyName) - 0 + - -NfConntrackTcpTimeoutSynRecv + -Cipassword - Conntrack syn recv timeout. + cloud-init':' Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords. false true (ByPropertyName) - 0 + - -Nftables + -Citype - Enable nftables based firewall (tech preview) + Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows. Enum: configdrive2,nocloud,opennebula + false + true (ByPropertyName) + + + + -Ciupgrade + + cloud-init':' do an automatic package upgrade after the first boot. false true (ByPropertyName) False - -Node + -Ciuser - The cluster node name. - true + cloud-init':' User name to change ssh keys and password for instead of the image's configured default user. + false true (ByPropertyName) - -Nosmurfs + -Cores - Enable SMURFS filter. + The number of cores per socket. false true (ByPropertyName) - False + 0 - -ProtectionSynflood + -Cpu - Enable synflood protection + Emulated CPU type. false true (ByPropertyName) - False + - -ProtectionSynfloodBurst + -Cpulimit - Synflood protection rate burst by ip src. + Limit of CPU usage. false true (ByPropertyName) 0 - -ProtectionSynfloodRate + -Cpuunits - Synflood protection rate syn/sec by ip src. + CPU weight for a VM, will be clamped to \[1, 10000] in cgroup v2. false true (ByPropertyName) 0 - -SmurfLogLevel + -Delete - Log level for SMURFS filter. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog + A list of settings you want to delete. false true (ByPropertyName) - -TcpFlagsLogLevel + -Description - Log level for illegal tcp flags filter. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog + Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. false true (ByPropertyName) - -Tcpflags + -Digest - Filter illegal combinations of TCP flags. + Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. + false + true (ByPropertyName) + + + + -Efidisk0 + + Configure a disk for storing EFI vars. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume. + false + true (ByPropertyName) + + + + -Force + + Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused\[n]', which contains the volume ID. Unlink of unused\[n] always cause physical removal. false true (ByPropertyName) False - - -
-
-

Outputs

-

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
-
-
-
-
-

Set-PveNodesFirewallRules

-

-

Modify rule data.

-
-
-

Syntax

-
-
-
- Set-PveNodesFirewallRules [[-PveTicket] <PveTicket>] [[-Action] <String>] [[-Comment] <String>] [[-Delete] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [[-Moveto] <Int32>] [-Node] <String> [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [[-Type] <String>] [<CommonParameters>] -
-
-
-

Parameters

- - - - - - - - - - - - - + - + + + + + + + + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - + + - + - + - + - + - + - + - + - + - + - + - + - -
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicket-Freeze Ticket data connection.Freeze CPU at startup (use 'c' monitor command to start execution).falsetrue (ByPropertyName)False
-HookscriptScript that will be executed during various steps in the vms lifetime. false true (ByPropertyName)
-Action-HostpciN Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name.Map host PCI devices into guest. false true (ByPropertyName)
-Comment-Hotplug Descriptive comment.Selectively enable hotplug features. This is a comma separated list of hotplug features':' 'network', 'disk', 'cpu', 'memory', 'usb' and 'cloudinit'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7. false true (ByPropertyName)
-Delete-Hugepages A list of settings you want to delete.Enable/disable hugepages memory. Enum: any,2,1024 false true (ByPropertyName)
-Dest-IdeN Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume. false true (ByPropertyName)
-Digest-IpconfigN Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.cloud-init':' Specify IP addresses and gateways for the corresponding interface.IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicitgateway should be provided.For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requirescloud-init 19.4 or newer.If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to usingdhcp on IPv4. false true (ByPropertyName)
-Dport-Ivshmem Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.Inter-VM shared memory. Useful for direct communication between VMs, or to the host. false true (ByPropertyName)
-Enable-Keephugepages Flag to enable/disable a rule.Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. false true (ByPropertyName)0False
-IcmpType-Keyboard Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'.Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. Enum: de,de-ch,da,en-gb,en-us,es,fi,fr,fr-be,fr-ca,fr-ch,hu,is,it,ja,lt,mk,nl,no,pl,pt,pt-br,sv,sl,tr false true (ByPropertyName)
-Iface-Kvm Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings.Enable/disable KVM hardware virtualization. false true (ByPropertyName)False
-Log-Localtime Log level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nologSet the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. false true (ByPropertyName)False
-Macro-Lock Use predefined standard macro.Lock/unlock the VM. Enum: backup,clone,create,migrate,rollback,snapshot,snapshot-delete,suspending,suspended false true (ByPropertyName)
-Moveto-Machine Move rule to new position <moveto>. Other arguments are ignored.Specify the QEMU machine. false true (ByPropertyName)0
-Node-Memory The cluster node name.trueMemory properties.false true (ByPropertyName)
-Pos-MigrateDowntime Update rule at position <pos>.Set maximum tolerated downtime (in seconds) for migrations. false true (ByPropertyName) 0
-Proto-MigrateSpeed IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.Set maximum speed (in MB/s) for migrations. Value 0 is no limit. false true (ByPropertyName)0
-Source-Name Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.Set a name for the VM. Only used on the configuration web interface. false true (ByPropertyName)
-Sport-Nameserver Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.cloud-init':' Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. false true (ByPropertyName)
-Type-NetN Rule type. Enum: in,out,groupSpecify network devices. false true (ByPropertyName)
-
-
-

Outputs

-

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
-
-
-
-
-

Set-PveNodesLxcConfig

-

-

Set container options.

-
-
-

Syntax

-
-
-
- Set-PveNodesLxcConfig [[-PveTicket] <PveTicket>] [[-Arch] <String>] [[-Cmode] <String>] [-Console] [[-Cores] <Int32>] [[-Cpulimit] <Single>] [[-Cpuunits] <Int32>] [-Debug_] [[-Delete] <String>] [[-Description] <String>] [[-DevN] <Hashtable>] [[-Digest] <String>] [[-Features] <String>] [[-Hookscript] <String>] [[-Hostname] <String>] [[-Lock] <String>] [[-Memory] <Int32>] [[-MpN] <Hashtable>] [[-Nameserver] <String>] [[-NetN] <Hashtable>] [-Node] <String> [-Onboot] [[-Ostype] <String>] [-Protection] [[-Revert] <String>] [[-Rootfs] <String>] [[-Searchdomain] <String>] [[-Startup] <String>] [[-Swap] <Int32>] [[-Tags] <String>] [-Template] [[-Timezone] <String>] [[-Tty] <Int32>] [-Unprivileged] [[-UnusedN] <Hashtable>] [-Vmid] <Int32> [<CommonParameters>] -
-
-
-

Parameters

- - - - - - - - - - - - - + - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + + + + + + + + + + + + + + + + + - + - + - + - + + + + + + + + + - + - + - + - + - + - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - + + - + - + - + - + - + - - - - - - - -
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicket-Node Ticket data connection.falseThe cluster node name.true true (ByPropertyName)
-Arch-Numa OS architecture type. Enum: amd64,i386,arm64,armhf,riscv32,riscv64Enable/disable NUMA. false true (ByPropertyName)False
-Cmode-NumaN Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login). Enum: shell,console,ttyNUMA topology. false true (ByPropertyName)
-Console-Onboot Attach a console device (/dev/console) to the container.Specifies whether a VM will be started during system bootup. false true (ByPropertyName) False
-Cores-Ostype The number of cores assigned to the container. A container can use all available cores by default.Specify guest operating system. Enum: other,wxp,w2k,w2k3,w2k8,wvista,win7,win8,win10,win11,l24,l26,solaris false true (ByPropertyName)0
-Cpulimit-ParallelN Limit of CPU usage.NOTE':' If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.Map host parallel devices (n is 0 to 2). false true (ByPropertyName)0
-Cpuunits-Protection CPU weight for a container, will be clamped to \[1, 10000] in cgroup v2.Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. false true (ByPropertyName)0False
-Debug_-Reboot Try to be more verbose. For now this only enables debug log-level on start.Allow reboot. If set to '0' the VM exit on reboot. false true (ByPropertyName) False
-Delete-Revert A list of settings you want to delete.Revert a pending change. false true (ByPropertyName)
-Description-Rng0 Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.Configure a VirtIO-based Random Number Generator. false true (ByPropertyName)
-DevN-SataN Device to pass through to the containerUse volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume. false true (ByPropertyName)
-Digest-ScsiN Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume. false true (ByPropertyName)
-Features-Scsihw Allow containers access to advanced features.SCSI controller model Enum: lsi,lsi53c810,virtio-scsi-pci,virtio-scsi-single,megasas,pvscsi false true (ByPropertyName)
-Hookscript-Searchdomain Script that will be exectued during various steps in the containers lifetime.cloud-init':' Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. false true (ByPropertyName)
-Hostname-SerialN Set a host name for the container.Create a serial device inside the VM (n is 0 to 3) false true (ByPropertyName)
-Lock-Shares Lock/unlock the container. Enum: backup,create,destroyed,disk,fstrim,migrate,mounted,rollback,snapshot,snapshot-deleteAmount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd.falsetrue (ByPropertyName)0
-SkiplockIgnore locks - only root is allowed to use this option.falsetrue (ByPropertyName)False
-Smbios1Specify SMBIOS type 1 fields. false true (ByPropertyName)
-Memory-Smp Amount of RAM for the container in MB.The number of CPUs. Please use option -sockets instead. false true (ByPropertyName) 0
-MpN-Sockets Use volume as container mount point. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume.The number of CPU sockets.falsetrue (ByPropertyName)0
-SpiceEnhancementsConfigure additional enhancements for SPICE. false true (ByPropertyName)
-Nameserver-Sshkeys Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.cloud-init':' Setup public SSH keys (one key per line, OpenSSH format). false true (ByPropertyName)
-NetN-Startdate Specifies network interfaces for the container.Set the initial date of the real time clock. Valid format for date are':''now' or '2006-06-17T16':'01':'21' or '2006-06-17'. false true (ByPropertyName)
-Node-Startup The cluster node name.trueStartup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.false true (ByPropertyName)
-Onboot-Tablet Specifies whether a container will be started during system bootup.Enable/disable the USB tablet device. false true (ByPropertyName) False
-Ostype-Tags OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. Enum: debian,devuan,ubuntu,centos,fedora,opensuse,archlinux,alpine,gentoo,nixos,unmanagedTags of the VM. This is only meta information. false true (ByPropertyName)
-Protection-Tdf Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.Enable/disable time drift fix. false true (ByPropertyName) False
-Revert-Template Revert a pending change.Enable/disable Template. false true (ByPropertyName)False
-Rootfs-Tpmstate0 Use volume as container root.Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume. false true (ByPropertyName)
-Searchdomain-UnusedN Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.Reference to unused volumes. This is used internally, and should not be modified manually. false true (ByPropertyName)
-Startup-UsbN Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). false true (ByPropertyName)
-Swap-Vcpus Amount of SWAP for the container in MB.Number of hotplugged vcpus. false true (ByPropertyName) 0
-Tags-Vga Tags of the Container. This is only meta information.Configure the VGA hardware. false true (ByPropertyName)
-Template-VirtioN Enable/disable Template.Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume. false true (ByPropertyName)False
-Timezone-Vmgenid Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tabSet VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. false true (ByPropertyName)
-Tty-Vmid Specify the number of tty available to the containerfalseThe (unique) ID of the VM.true true (ByPropertyName) 0
-Unprivileged-Vmstatestorage Makes the container run as unprivileged user. (Should not be modified manually.)Default storage for VM state volumes/files. false true (ByPropertyName)False
-UnusedN-Watchdog Reference to unused volumes. This is used internally, and should not be modified manually.Create a virtual hardware watchdog device. false true (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
@@ -45508,9 +51156,9 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveNodesLxcFirewallAliases

+

Set-PveNodesQemuFirewallAliases

Update IP or Network alias.

@@ -45519,7 +51167,7 @@

Syntax

- Set-PveNodesLxcFirewallAliases [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [[-Rename] <String>] [-Vmid] <Int32> [<CommonParameters>] + Set-PveNodesQemuFirewallAliases [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [[-Rename] <String>] [-Vmid] <Int32> [<CommonParameters>]
@@ -45609,9 +51257,9 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveNodesLxcFirewallIpset

+

Set-PveNodesQemuFirewallIpset

Update IP or Network settings

@@ -45620,7 +51268,7 @@

Syntax

- Set-PveNodesLxcFirewallIpset [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Nomatch] [-Vmid] <Int32> [<CommonParameters>] + Set-PveNodesQemuFirewallIpset [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Nomatch] [-Vmid] <Int32> [<CommonParameters>]
@@ -45710,9 +51358,9 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveNodesLxcFirewallOptions

+

Set-PveNodesQemuFirewallOptions

Set Firewall options.

@@ -45721,7 +51369,7 @@

Syntax

- Set-PveNodesLxcFirewallOptions [[-PveTicket] <PveTicket>] [[-Delete] <String>] [-Dhcp] [[-Digest] <String>] [-Enable] [-Ipfilter] [[-LogLevelIn] <String>] [[-LogLevelOut] <String>] [-Macfilter] [-Ndp] [-Node] <String> [[-PolicyIn] <String>] [[-PolicyOut] <String>] [-Radv] [-Vmid] <Int32> [<CommonParameters>] + Set-PveNodesQemuFirewallOptions [[-PveTicket] <PveTicket>] [[-Delete] <String>] [-Dhcp] [[-Digest] <String>] [-Enable] [-Ipfilter] [[-LogLevelIn] <String>] [[-LogLevelOut] <String>] [-Macfilter] [-Ndp] [-Node] <String> [[-PolicyIn] <String>] [[-PolicyOut] <String>] [-Radv] [-Vmid] <Int32> [<CommonParameters>]
@@ -45867,9 +51515,9 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveNodesLxcFirewallRules

+

Set-PveNodesQemuFirewallRules

Modify rule data.

@@ -45878,7 +51526,7 @@

Syntax

- Set-PveNodesLxcFirewallRules [[-PveTicket] <PveTicket>] [[-Action] <String>] [[-Comment] <String>] [[-Delete] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [[-Moveto] <Int32>] [-Node] <String> [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [[-Type] <String>] [-Vmid] <Int32> [<CommonParameters>] + Set-PveNodesQemuFirewallRules [[-PveTicket] <PveTicket>] [[-Action] <String>] [[-Comment] <String>] [[-Delete] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [[-Moveto] <Int32>] [-Node] <String> [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [[-Type] <String>] [-Vmid] <Int32> [<CommonParameters>]
@@ -46064,18 +51712,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveNodesLxcResize

+

Set-PveNodesQemuResize

-

Resize a container mount point.

+

Extend volume size.

Syntax

- Set-PveNodesLxcResize [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Disk] <String> [-Node] <String> [-Size] <String> [-Vmid] <Int32> [<CommonParameters>] + Set-PveNodesQemuResize [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Disk] <String> [-Node] <String> [-Size] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]
@@ -46111,7 +51759,7 @@

Parameters

-Disk - The disk you want to resize. Enum: rootfs,mp0,mp1,mp2,mp3,mp4,mp5,mp6,mp7,mp8,mp9,mp10,mp11,mp12,mp13,mp14,mp15,mp16,mp17,mp18,mp19,mp20,mp21,mp22,mp23,mp24,mp25,mp26,mp27,mp28,mp29,mp30,mp31,mp32,mp33,mp34,mp35,mp36,mp37,mp38,mp39,mp40,mp41,mp42,mp43,mp44,mp45,mp46,mp47,mp48,mp49,mp50,mp51,mp52,mp53,mp54,mp55,mp56,mp57,mp58,mp59,mp60,mp61,mp62,mp63,mp64,mp65,mp66,mp67,mp68,mp69,mp70,mp71,mp72,mp73,mp74,mp75,mp76,mp77,mp78,mp79,mp80,mp81,mp82,mp83,mp84,mp85,mp86,mp87,mp88,mp89,mp90,mp91,mp92,mp93,mp94,mp95,mp96,mp97,mp98,mp99,mp100,mp101,mp102,mp103,mp104,mp105,mp106,mp107,mp108,mp109,mp110,mp111,mp112,mp113,mp114,mp115,mp116,mp117,mp118,mp119,mp120,mp121,mp122,mp123,mp124,mp125,mp126,mp127,mp128,mp129,mp130,mp131,mp132,mp133,mp134,mp135,mp136,mp137,mp138,mp139,mp140,mp141,mp142,mp143,mp144,mp145,mp146,mp147,mp148,mp149,mp150,mp151,mp152,mp153,mp154,mp155,mp156,mp157,mp158,mp159,mp160,mp161,mp162,mp163,mp164,mp165,mp166,mp167,mp168,mp169,mp170,mp171,mp172,mp173,mp174,mp175,mp176,mp177,mp178,mp179,mp180,mp181,mp182,mp183,mp184,mp185,mp186,mp187,mp188,mp189,mp190,mp191,mp192,mp193,mp194,mp195,mp196,mp197,mp198,mp199,mp200,mp201,mp202,mp203,mp204,mp205,mp206,mp207,mp208,mp209,mp210,mp211,mp212,mp213,mp214,mp215,mp216,mp217,mp218,mp219,mp220,mp221,mp222,mp223,mp224,mp225,mp226,mp227,mp228,mp229,mp230,mp231,mp232,mp233,mp234,mp235,mp236,mp237,mp238,mp239,mp240,mp241,mp242,mp243,mp244,mp245,mp246,mp247,mp248,mp249,mp250,mp251,mp252,mp253,mp254,mp255 + The disk you want to resize. Enum: ide0,ide1,ide2,ide3,scsi0,scsi1,scsi2,scsi3,scsi4,scsi5,scsi6,scsi7,scsi8,scsi9,scsi10,scsi11,scsi12,scsi13,scsi14,scsi15,scsi16,scsi17,scsi18,scsi19,scsi20,scsi21,scsi22,scsi23,scsi24,scsi25,scsi26,scsi27,scsi28,scsi29,scsi30,virtio0,virtio1,virtio2,virtio3,virtio4,virtio5,virtio6,virtio7,virtio8,virtio9,virtio10,virtio11,virtio12,virtio13,virtio14,virtio15,sata0,sata1,sata2,sata3,sata4,sata5,efidisk0,tpmstate0 true true (ByPropertyName) @@ -46127,11 +51775,19 @@

Parameters

-Size - The new size. With the '+' sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported. + The new size. With the `+` sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported. true true (ByPropertyName) + + -Skiplock + + Ignore locks - only root is allowed to use this option. + false + true (ByPropertyName) + False + -Vmid @@ -46149,18 +51805,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveNodesLxcSnapshotConfig

+

Set-PveNodesQemuSendkey

-

Update snapshot metadata.

+

Send key event to virtual machine.

Syntax

- Set-PveNodesLxcSnapshotConfig [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>] + Set-PveNodesQemuSendkey [[-PveTicket] <PveTicket>] [-Key] <String> [-Node] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]
@@ -46186,10 +51842,10 @@

Parameters

- -Description + -Key - A textual description or comment. - false + The key (qemu monitor encoding). + true true (ByPropertyName) @@ -46202,12 +51858,12 @@

Parameters

- -Snapname + -Skiplock - The name of the snapshot. - true + Ignore locks - only root is allowed to use this option. + false true (ByPropertyName) - + False -Vmid @@ -46226,18 +51882,28 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveNodesNetwork

+

Set-PveNodesQemuSnapshotConfig

-

Reload network configuration

+

Update snapshot metadata.

+
+
+
+

Aliases

+
+
+
    +
  • Set-PveQemuSnapshot
    • +
+

Syntax

- Set-PveNodesNetwork [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] + Set-PveNodesQemuSnapshotConfig [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
@@ -46262,6 +51928,14 @@

Parameters

true (ByPropertyName) + + -Description + + A textual description or comment. + false + true (ByPropertyName) + + -Node @@ -46270,6 +51944,22 @@

Parameters

true (ByPropertyName) + + -Snapname + + The name of the snapshot. + true + true (ByPropertyName) + + + + -Vmid + + The (unique) ID of the VM. + true + true (ByPropertyName) + 0 +
@@ -46279,18 +51969,18 @@

Outputs

  • PveResponse. Return response.
-
+ +
+
+

Set-PveNodesStorageContent

+

+

Update volume attributes

+
+
+

Syntax

+
+
+
+ Set-PveNodesStorageContent [[-PveTicket] <PveTicket>] [-Node] <String> [[-Notes] <String>] [-Protected] [[-Storage] <String>] [-Volume] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + - + - + - - - - - - - - @@ -46476,74 +52091,95 @@

Parameters

- + - + - + - + - + - + - + - + - - + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-Netmask-PveTicket Network mask.Ticket data connection. false true (ByPropertyName)
-Netmask6Network mask.falsetrue (ByPropertyName)0
-Node
-OvsBonds-Notes Specify the interfaces used by the bonding device.The new notes. false true (ByPropertyName)
-OvsBridge-Protected The OVS bridge associated with a OVS port. This is required when you create an OVS port.Protection status. Currently only supported for backups. false true (ByPropertyName)False
-OvsOptions-Storage OVS interface options.The storage identifier. false true (ByPropertyName)
-OvsPorts-Volume Specify the interfaces you want to add to your bridge.falseVolume identifiertrue true (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Set-PveNodesSubscription

+

+

Set subscription key.

+
+
+

Syntax

+
+
+
+ Set-PveNodesSubscription [[-PveTicket] <PveTicket>] [-Key] <String> [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + - - - - - - - - - + - + - + - + - - - - - - - - - + - - + + @@ -46556,18 +52192,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveNodesQemuCloudinit

+

Set-PveNodesTime

-

Regenerate and change cloudinit config drive.

+

Set time zone.

Syntax

- Set-PveNodesQemuCloudinit [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] + Set-PveNodesTime [[-PveTicket] <PveTicket>] [-Node] <String> [-Timezone] <String> [<CommonParameters>]
@@ -46601,12 +52237,198 @@

Parameters

- + - + - + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-OvsTagSpecify a VLan tag (used by OVSPort, OVSIntPort, OVSBond)falsetrue (ByPropertyName)0
-Slaves-PveTicket Specify the interfaces used by the bonding device.Ticket data connection. false true (ByPropertyName)
-Type-Key Network interface type Enum: bridge,bond,eth,alias,vlan,OVSBridge,OVSBond,OVSPort,OVSIntPort,unknownProxmox VE subscription key true true (ByPropertyName)
-VlanIdvlan-id for a custom named vlan interface (ifupdown2 only).falsetrue (ByPropertyName)0
-VlanRawDevice-Node Specify the raw interface for the vlan interface.falseThe cluster node name.true true (ByPropertyName)
-Vmid-Timezone The (unique) ID of the VM.Time zone. The file '/usr/share/zoneinfo/zone.tab' contains the list of valid names. true true (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Set-PvePools

+

+

Update pool.

+
+
+

Syntax

+
+
+
+ Set-PvePools [[-PveTicket] <PveTicket>] [-AllowMove] [[-Comment] <String>] [-Delete] [-Poolid] <String> [[-Storage] <String>] [[-Vms] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-AllowMoveAllow adding a guest even if already in another pool. The guest will be removed from its current pool and added to this one.falsetrue (ByPropertyName)False
-Comment--falsetrue (ByPropertyName)
-DeleteRemove the passed VMIDs and/or storage IDs instead of adding them.falsetrue (ByPropertyName)False
-Poolid--truetrue (ByPropertyName)
-StorageList of storage IDs to add or remove from this pool.falsetrue (ByPropertyName)
-VmsList of guest VMIDs to add or remove from this pool.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Set-PvePoolsIdx

+

+

Update pool data (deprecated, no support for nested pools - use 'PUT /pools/?poolid={poolid}' instead).

+
+
+

Syntax

+
+
+
+ Set-PvePoolsIdx [[-PveTicket] <PveTicket>] [-AllowMove] [[-Comment] <String>] [-Delete] [-Poolid] <String> [[-Storage] <String>] [[-Vms] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-AllowMoveAllow adding a guest even if already in another pool. The guest will be removed from its current pool and added to this one.falsetrue (ByPropertyName)False
-Comment--falsetrue (ByPropertyName)
-DeleteRemove the passed VMIDs and/or storage IDs instead of adding them.falsetrue (ByPropertyName)False
-Poolid--truetrue (ByPropertyName)
-StorageList of storage IDs to add or remove from this pool.falsetrue (ByPropertyName)
-VmsList of guest VMIDs to add or remove from this pool.falsetrue (ByPropertyName)
@@ -47235,185 +53057,68 @@

Parameters

Enable/disable time drift fix. false true (ByPropertyName) - False - - - -Template - - Enable/disable Template. - false - true (ByPropertyName) - False - - - -Tpmstate0 - - Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume. - false - true (ByPropertyName) - - - - -UnusedN - - Reference to unused volumes. This is used internally, and should not be modified manually. - false - true (ByPropertyName) - - - - -UsbN - - Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). - false - true (ByPropertyName) - - - - -Vcpus - - Number of hotplugged vcpus. - false - true (ByPropertyName) - 0 - - - -Vga - - Configure the VGA hardware. - false - true (ByPropertyName) - - - - -VirtioN - - Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume. - false - true (ByPropertyName) - - - - -Vmgenid - - Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. - false - true (ByPropertyName) - - - - -Vmid - - The (unique) ID of the VM. - true - true (ByPropertyName) - 0 - - - -Vmstatestorage - - Default storage for VM state volumes/files. - false - true (ByPropertyName) - - - - -Watchdog - - Create a virtual hardware watchdog device. - false - true (ByPropertyName) - - - - -
-
-

Outputs

-

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
-
-
-
-
-

Set-PveNodesQemuFirewallAliases

-

-

Update IP or Network alias.

-
-
-

Syntax

-
-
-
- Set-PveNodesQemuFirewallAliases [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [[-Rename] <String>] [-Vmid] <Int32> [<CommonParameters>] -
-
-
-

Parameters

- - - - - - - - - - - - + + - + - + - + - + - - + + - + - + - + - + - + - - + + + + + + + + + + - + - - + + - + - + @@ -47426,6 +53131,22 @@

Parameters

+ + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
False
-PveTicket-Template Ticket data connection.Enable/disable Template. false true (ByPropertyName)False
-Cidr-Tpmstate0 Network/IP specification in CIDR format.trueConfigure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.false true (ByPropertyName)
-Comment-UnusedN --Reference to unused volumes. This is used internally, and should not be modified manually. false true (ByPropertyName)
-Digest-UsbN Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). false true (ByPropertyName)
-Name-Vcpus Alias name.trueNumber of hotplugged vcpus.falsetrue (ByPropertyName)0
-VgaConfigure the VGA hardware.false true (ByPropertyName)
-Node-VirtioN The cluster node name.trueUse volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.false true (ByPropertyName)
-Rename-Vmgenid Rename an existing alias.Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. false true (ByPropertyName) true (ByPropertyName) 0
-VmstatestorageDefault storage for VM state volumes/files.falsetrue (ByPropertyName)
-WatchdogCreate a virtual hardware watchdog device.falsetrue (ByPropertyName)
@@ -47435,18 +53156,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveNodesQemuFirewallIpset

+

Set-PveNodesQemuSnapshotConfig

-

Update IP or Network settings

+

Update snapshot metadata.

Syntax

- Set-PveNodesQemuFirewallIpset [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Nomatch] [-Vmid] <Int32> [<CommonParameters>] + Set-PveNodesQemuSnapshotConfig [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
@@ -47472,37 +53193,13 @@

Parameters

- -Cidr - - Network/IP specification in CIDR format. - true - true (ByPropertyName) - - - - -Comment - - -- - false - true (ByPropertyName) - - - - -Digest + -Description - Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. + A textual description or comment. false true (ByPropertyName) - - -Name - - IP set name. - true - true (ByPropertyName) - - -Node @@ -47512,12 +53209,12 @@

Parameters

- -Nomatch + -Snapname - -- - false + The name of the snapshot. + true true (ByPropertyName) - False + -Vmid @@ -47536,18 +53233,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveNodesQemuFirewallOptions

+

Set-PveStorage

-

Set Firewall options.

+

Update storage configuration.

Syntax

- Set-PveNodesQemuFirewallOptions [[-PveTicket] <PveTicket>] [[-Delete] <String>] [-Dhcp] [[-Digest] <String>] [-Enable] [-Ipfilter] [[-LogLevelIn] <String>] [[-LogLevelOut] <String>] [-Macfilter] [-Ndp] [-Node] <String> [[-PolicyIn] <String>] [[-PolicyOut] <String>] [-Radv] [-Vmid] <Int32> [<CommonParameters>] + Set-PveStorage [[-PveTicket] <PveTicket>] [[-Blocksize] <String>] [[-Bwlimit] <String>] [[-ComstarHg] <String>] [[-ComstarTg] <String>] [[-Content] <String>] [[-ContentDirs] <String>] [-CreateBasePath] [-CreateSubdirs] [[-DataPool] <String>] [[-Delete] <String>] [[-Digest] <String>] [-Disable] [[-Domain] <String>] [[-EncryptionKey] <String>] [[-Fingerprint] <String>] [[-Format] <String>] [[-FsName] <String>] [-Fuse] [[-IsMountpoint] <String>] [[-Keyring] <String>] [-Krbd] [[-LioTpg] <String>] [[-MasterPubkey] <String>] [[-MaxProtectedBackups] <Int32>] [[-Maxfiles] <Int32>] [-Mkdir] [[-Monhost] <String>] [[-Mountpoint] <String>] [[-Namespace] <String>] [-Nocow] [[-Nodes] <String>] [-Nowritecache] [[-Options] <String>] [[-Password] <SecureString>] [[-Pool] <String>] [[-Port] <Int32>] [[-Preallocation] <String>] [[-PruneBackups] <String>] [-Saferemove] [[-SaferemoveThroughput] <String>] [[-Server] <String>] [[-Server2] <String>] [-Shared] [-SkipCertVerification] [[-Smbversion] <String>] [-Sparse] [-Storage] <String> [[-Subdir] <String>] [-TaggedOnly] [[-Transport] <String>] [[-Username] <String>] [<CommonParameters>]
@@ -47573,720 +53270,410 @@

Parameters

- -Delete + -Blocksize - A list of settings you want to delete. + block size false true (ByPropertyName) - -Dhcp - - Enable DHCP. - false - true (ByPropertyName) - False - - - -Digest + -Bwlimit - Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. + Set I/O bandwidth limit for various operations (in KiB/s). false true (ByPropertyName) - -Enable + -ComstarHg - Enable/disable firewall rules. + host group for comstar views false true (ByPropertyName) - False + - -Ipfilter + -ComstarTg - Enable default IP filters. This is equivalent to adding an empty ipfilter-net<id> ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added. + target group for comstar views false true (ByPropertyName) - False + - -LogLevelIn + -Content - Log level for incoming traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog + Allowed content types.NOTE':' the value 'rootdir' is used for Containers, and value 'images' for VMs. false true (ByPropertyName) - -LogLevelOut + -ContentDirs - Log level for outgoing traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog + Overrides for default content type directories. false true (ByPropertyName) - -Macfilter + -CreateBasePath - Enable/disable MAC address filter. + Create the base directory if it doesn't exist. false true (ByPropertyName) False - -Ndp + -CreateSubdirs - Enable NDP (Neighbor Discovery Protocol). + Populate the directory with the default structure. false true (ByPropertyName) False - -Node + -DataPool - The cluster node name. - true + Data Pool (for erasure coding only) + false true (ByPropertyName) - -PolicyIn + -Delete - Input policy. Enum: ACCEPT,REJECT,DROP + A list of settings you want to delete. false true (ByPropertyName) - -PolicyOut + -Digest - Output policy. Enum: ACCEPT,REJECT,DROP + Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName) - -Radv + -Disable - Allow sending Router Advertisement. + Flag to disable the storage. false true (ByPropertyName) False - -Vmid - - The (unique) ID of the VM. - true - true (ByPropertyName) - 0 - - - -
-
-

Outputs

-

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
-
-
-
-
-

Set-PveNodesQemuFirewallRules

-

-

Modify rule data.

-
-
-

Syntax

-
-
-
- Set-PveNodesQemuFirewallRules [[-PveTicket] <PveTicket>] [[-Action] <String>] [[-Comment] <String>] [[-Delete] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [[-Moveto] <Int32>] [-Node] <String> [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [[-Type] <String>] [-Vmid] <Int32> [<CommonParameters>] -
-
-
-

Parameters

- - - - - - - - - - - - - - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - - - - - - - - + - + - + - + - + - + - + - + - + - + - + - - - - - - - - - + - + - + - + - + - + - + - + - + - + - + - - - - - - - - -
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicket-Domain Ticket data connection.CIFS domain. false true (ByPropertyName)
-Action-EncryptionKey Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name.Encryption key. Use 'autogen' to generate one automatically without passphrase. false true (ByPropertyName)
-Comment-Fingerprint Descriptive comment.Certificate SHA 256 fingerprint. false true (ByPropertyName)
-Delete-Format A list of settings you want to delete.Default image format. false true (ByPropertyName)
-Dest-FsName Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.The Ceph filesystem name. false true (ByPropertyName)
-Digest-Fuse Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.Mount CephFS through FUSE. false true (ByPropertyName)False
-Dport-IsMountpoint Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field. false true (ByPropertyName)
-EnableFlag to enable/disable a rule.falsetrue (ByPropertyName)0
-IcmpType-Keyring Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'.Client keyring contents (for external clusters). false true (ByPropertyName)
-Iface-Krbd Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings.Always access rbd through krbd kernel module. false true (ByPropertyName)False
-Log-LioTpg Log level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nologtarget portal group for Linux LIO targets false true (ByPropertyName)
-Macro-MasterPubkey Use predefined standard macro.Base64-encoded, PEM-formatted public RSA key. Used to encrypt a copy of the encryption-key which will be added to each encrypted backup. false true (ByPropertyName)
-Moveto-MaxProtectedBackups Move rule to new position <moveto>. Other arguments are ignored.Maximal number of protected backups per guest. Use '-1' for unlimited. false true (ByPropertyName) 0
-NodeThe cluster node name.truetrue (ByPropertyName)
-Pos-Maxfiles Update rule at position <pos>.Deprecated':' use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimited. false true (ByPropertyName) 0
-Proto-Mkdir IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.Create the directory if it doesn't exist and populate it with default sub-dirs. NOTE':' Deprecated, use the 'create-base-path' and 'create-subdirs' options instead. false true (ByPropertyName)False
-Source-Monhost Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.IP addresses of monitors (for external clusters). false true (ByPropertyName)
-Sport-Mountpoint Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.mount point false true (ByPropertyName)
-Type-Namespace Rule type. Enum: in,out,groupNamespace. false true (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
-
-
-

Outputs

-

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
-
-
-
-
-

Set-PveNodesQemuResize

-

-

Extend volume size.

-
-
-

Syntax

-
-
-
- Set-PveNodesQemuResize [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Disk] <String> [-Node] <String> [-Size] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>] -
-
-
-

Parameters

- - - - - - - - - - - - - - + - + - + - + - + - - - - - - - - - - - - - - - - - - - - - - - - - + - + - - - - - - - - -
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicket-Nocow Ticket data connection.Set the NOCOW flag on files. Disables data checksumming and causes data errors to be unrecoverable from while allowing direct I/O. Only use this if data does not need to be any more safe than on a single ext4 formatted disk with no underlying raid system. false true (ByPropertyName)False
-Digest-Nodes Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.List of nodes for which the storage configuration applies. false true (ByPropertyName)
-DiskThe disk you want to resize. Enum: ide0,ide1,ide2,ide3,scsi0,scsi1,scsi2,scsi3,scsi4,scsi5,scsi6,scsi7,scsi8,scsi9,scsi10,scsi11,scsi12,scsi13,scsi14,scsi15,scsi16,scsi17,scsi18,scsi19,scsi20,scsi21,scsi22,scsi23,scsi24,scsi25,scsi26,scsi27,scsi28,scsi29,scsi30,virtio0,virtio1,virtio2,virtio3,virtio4,virtio5,virtio6,virtio7,virtio8,virtio9,virtio10,virtio11,virtio12,virtio13,virtio14,virtio15,sata0,sata1,sata2,sata3,sata4,sata5,efidisk0,tpmstate0truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-SizeThe new size. With the `+` sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported.truetrue (ByPropertyName)
-Skiplock-Nowritecache Ignore locks - only root is allowed to use this option.disable write caching on the target false true (ByPropertyName) False
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
-
-
-

Outputs

-

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
-
-
-
-
-

Set-PveNodesQemuSendkey

-

-

Send key event to virtual machine.

-
-
-

Syntax

-
-
-
- Set-PveNodesQemuSendkey [[-PveTicket] <PveTicket>] [-Key] <String> [-Node] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>] -
-
-
-

Parameters

- - - - - - - - - - - - - - + - + - + - - + + - + - - + + - + - + - - - - - - - - - -
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicket-Options Ticket data connection.NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs') false true (ByPropertyName)
-Key-Password The key (qemu monitor encoding).truePassword for accessing the share/datastore.false true (ByPropertyName)
-Node-Pool The cluster node name.truePool.false true (ByPropertyName)
-Skiplock-Port Ignore locks - only root is allowed to use this option.For non default port. false true (ByPropertyName)False
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName) 0
-
-
-

Outputs

-

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
-
-
-
-
-

Set-PveNodesQemuSnapshotConfig

-

-

Update snapshot metadata.

-
-
-

Syntax

-
-
-
- Set-PveNodesQemuSnapshotConfig [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>] -
-
-
-

Parameters

- - - - - - - - - - - - - + - + - + - + - + - - + + - + - + - - + + - + - - + + - + - -
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicket-Preallocation Ticket data connection.Preallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off. Enum: off,metadata,falloc,full false true (ByPropertyName)
-Description-PruneBackups A textual description or comment.The retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups. false true (ByPropertyName)
-Node-Saferemove The cluster node name.trueZero-out data when removing LVs.false true (ByPropertyName)False
-Snapname-SaferemoveThroughput The name of the snapshot.trueWipe throughput (cstream -t parameter value).false true (ByPropertyName)
-Vmid-Server The (unique) ID of the VM.trueServer IP or DNS name.false true (ByPropertyName)0
-
-
-

Outputs

-

The output type is the type of the objects that the cmdlet emits.

-
  • PveResponse. Return response.
-
-
- -
-
-

Set-PveNodesStorageContent

-

-

Update volume attributes

-
-
-

Syntax

-
-
-
- Set-PveNodesStorageContent [[-PveTicket] <PveTicket>] [-Node] <String> [[-Notes] <String>] [-Protected] [[-Storage] <String>] [-Volume] <String> [<CommonParameters>] -
-
-
-

Parameters

- - - - - - - - - - - - - - + - + - + - + - + - + - + - + - + - + - + - + - - + + @@ -48299,18 +53686,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveNodesSubscription

+

Invoke-PveSpice

-

Set subscription key.

+

Enter Spice VM.

Syntax

- Set-PveNodesSubscription [[-PveTicket] <PveTicket>] [-Key] <String> [-Node] <String> [<CommonParameters>] + Invoke-PveSpice [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [-Viewer] <String> [<CommonParameters>]
@@ -48332,23 +53719,23 @@

Parameters

- + - + - + - + - + - + - + @@ -48360,18 +53747,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveNodesTime

+

New-PveNodesLxcStatusShutdown

-

Set time zone.

+

Shutdown the container. This will trigger a clean shutdown of the container, see lxc-stop(1) for details.

Syntax

- Set-PveNodesTime [[-PveTicket] <PveTicket>] [-Node] <String> [-Timezone] <String> [<CommonParameters>] + New-PveNodesLxcStatusShutdown [[-PveTicket] <PveTicket>] [-Forcestop] [-Node] <String> [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
@@ -48396,6 +53783,14 @@

Parameters

+ + + + + + + + @@ -48405,12 +53800,20 @@

Parameters

- + - + + + + + + + + + - +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicket-Sparse Ticket data connection.use sparse volumes false true (ByPropertyName)False
-Node-Storage The cluster node name.The storage identifier. true true (ByPropertyName)
-Notes-Subdir The new notes.Subdir to mount. false true (ByPropertyName)
-Protected-TaggedOnly Protection status. Currently only supported for backups.Only use logical volumes tagged with 'pve-vm-ID'. false true (ByPropertyName) False
-Storage-Transport The storage identifier.Gluster transport':' tcp or rdma Enum: tcp,rdma,unix false true (ByPropertyName)
-Volume-Username Volume identifiertrueRBD Id.false true (ByPropertyName)
Ticket data connection. falsetrue (ByPropertyName)true (ByValue, ByPropertyName)
-Key-VmIdOrName Proxmox VE subscription keyThe (unique) ID or Name of the VM. truetrue (ByPropertyName)true (ByValue, ByPropertyName)
-Node-Viewer The cluster node name.Path of Spice remove viewer.- Linux /usr/bin/remote-viewer- Windows C:\Program Files\VirtViewer v?.?-???\bin\remote-viewer.exe truetrue (ByPropertyName)true (ByValue, ByPropertyName)
true (ByPropertyName)
-ForcestopMake sure the Container stops.falsetrue (ByPropertyName)False
-Node
-Timezone-Timeout Time zone. The file '/usr/share/zoneinfo/zone.tab' contains the list of valid names.Wait maximal timeout seconds.falsetrue (ByPropertyName)0
-VmidThe (unique) ID of the VM. true true (ByPropertyName)0
@@ -48421,18 +53824,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PvePools

+

New-PveNodesQemuStatusShutdown

-

Update pool.

+

Shutdown virtual machine. This is similar to pressing the power button on a physical machine. This will send an ACPI event for the guest OS, which should then proceed to a clean shutdown.

Syntax

- Set-PvePools [[-PveTicket] <PveTicket>] [-AllowMove] [[-Comment] <String>] [-Delete] [-Poolid] <String> [[-Storage] <String>] [[-Vms] <String>] [<CommonParameters>] + New-PveNodesQemuStatusShutdown [[-PveTicket] <PveTicket>] [-Forcestop] [-Keepactive] [-Node] <String> [-Skiplock] [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
@@ -48458,52 +53861,52 @@

Parameters

- -AllowMove + -Forcestop - Allow adding a guest even if already in another pool. The guest will be removed from its current pool and added to this one. + Make sure the VM stops. false true (ByPropertyName) False - -Comment - - -- - false - true (ByPropertyName) - - - - -Delete + -Keepactive - Remove the passed VMIDs and/or storage IDs instead of adding them. + Do not deactivate storage volumes. false true (ByPropertyName) False - -Poolid + -Node - -- + The cluster node name. true true (ByPropertyName) - -Storage + -Skiplock - List of storage IDs to add or remove from this pool. + Ignore locks - only root is allowed to use this option. false true (ByPropertyName) - + False - -Vms + -Timeout - List of guest VMIDs to add or remove from this pool. + Wait maximal timeout seconds. false true (ByPropertyName) - + 0 + + + -Vmid + + The (unique) ID of the VM. + true + true (ByPropertyName) + 0 @@ -48514,18 +53917,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PvePoolsIdx

+

New-PveNodesLxcStatusStart

-

Update pool data (deprecated, no support for nested pools - use 'PUT /pools/?poolid={poolid}' instead).

+

Start the container.

Syntax

- Set-PvePoolsIdx [[-PveTicket] <PveTicket>] [-AllowMove] [[-Comment] <String>] [-Delete] [-Poolid] <String> [[-Storage] <String>] [[-Vms] <String>] [<CommonParameters>] + New-PveNodesLxcStatusStart [[-PveTicket] <PveTicket>] [-Debug_] [-Node] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]
@@ -48551,52 +53954,36 @@

Parameters

- -AllowMove + -Debug_ - Allow adding a guest even if already in another pool. The guest will be removed from its current pool and added to this one. + If set, enables very verbose debug log-level on start. false true (ByPropertyName) False - -Comment + -Node - -- - false + The cluster node name. + true true (ByPropertyName) - -Delete + -Skiplock - Remove the passed VMIDs and/or storage IDs instead of adding them. + Ignore locks - only root is allowed to use this option. false true (ByPropertyName) False - -Poolid + -Vmid - -- + The (unique) ID of the VM. true true (ByPropertyName) - - - - -Storage - - List of storage IDs to add or remove from this pool. - false - true (ByPropertyName) - - - - -Vms - - List of guest VMIDs to add or remove from this pool. - false - true (ByPropertyName) - + 0 @@ -48607,18 +53994,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Set-PveStorage

+

New-PveNodesQemuStatusStart

-

Update storage configuration.

+

Start virtual machine.

Syntax

- Set-PveStorage [[-PveTicket] <PveTicket>] [[-Blocksize] <String>] [[-Bwlimit] <String>] [[-ComstarHg] <String>] [[-ComstarTg] <String>] [[-Content] <String>] [[-ContentDirs] <String>] [-CreateBasePath] [-CreateSubdirs] [[-DataPool] <String>] [[-Delete] <String>] [[-Digest] <String>] [-Disable] [[-Domain] <String>] [[-EncryptionKey] <String>] [[-Fingerprint] <String>] [[-Format] <String>] [[-FsName] <String>] [-Fuse] [[-IsMountpoint] <String>] [[-Keyring] <String>] [-Krbd] [[-LioTpg] <String>] [[-MasterPubkey] <String>] [[-MaxProtectedBackups] <Int32>] [[-Maxfiles] <Int32>] [-Mkdir] [[-Monhost] <String>] [[-Mountpoint] <String>] [[-Namespace] <String>] [-Nocow] [[-Nodes] <String>] [-Nowritecache] [[-Options] <String>] [[-Password] <SecureString>] [[-Pool] <String>] [[-Port] <Int32>] [[-Preallocation] <String>] [[-PruneBackups] <String>] [-Saferemove] [[-SaferemoveThroughput] <String>] [[-Server] <String>] [[-Server2] <String>] [-Shared] [-SkipCertVerification] [[-Smbversion] <String>] [-Sparse] [-Storage] <String> [[-Subdir] <String>] [-TaggedOnly] [[-Transport] <String>] [[-Username] <String>] [<CommonParameters>] + New-PveNodesQemuStatusStart [[-PveTicket] <PveTicket>] [[-ForceCpu] <String>] [[-Machine] <String>] [[-Migratedfrom] <String>] [[-MigrationNetwork] <String>] [[-MigrationType] <String>] [-Node] <String> [-Skiplock] [[-Stateuri] <String>] [[-Targetstorage] <String>] [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
@@ -48644,412 +54031,436 @@

Parameters

- -Blocksize - - block size - false - true (ByPropertyName) - - - - -Bwlimit - - Set I/O bandwidth limit for various operations (in KiB/s). - false - true (ByPropertyName) - - - - -ComstarHg - - host group for comstar views - false - true (ByPropertyName) - - - - -ComstarTg - - target group for comstar views - false - true (ByPropertyName) - - - - -Content - - Allowed content types.NOTE':' the value 'rootdir' is used for Containers, and value 'images' for VMs. - false - true (ByPropertyName) - - - - -ContentDirs - - Overrides for default content type directories. - false - true (ByPropertyName) - - - - -CreateBasePath - - Create the base directory if it doesn't exist. - false - true (ByPropertyName) - False - - - -CreateSubdirs - - Populate the directory with the default structure. - false - true (ByPropertyName) - False - - - -DataPool - - Data Pool (for erasure coding only) - false - true (ByPropertyName) - - - - -Delete - - A list of settings you want to delete. - false - true (ByPropertyName) - - - - -Digest - - Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. - false - true (ByPropertyName) - - - - -Disable - - Flag to disable the storage. - false - true (ByPropertyName) - False - - - -Domain - - CIFS domain. - false - true (ByPropertyName) - - - - -EncryptionKey - - Encryption key. Use 'autogen' to generate one automatically without passphrase. - false - true (ByPropertyName) - - - - -Fingerprint - - Certificate SHA 256 fingerprint. - false - true (ByPropertyName) - - - - -Format - - Default image format. - false - true (ByPropertyName) - - - - -FsName - - The Ceph filesystem name. - false - true (ByPropertyName) - - - - -Fuse - - Mount CephFS through FUSE. - false - true (ByPropertyName) - False - - - -IsMountpoint - - Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field. - false - true (ByPropertyName) - - - - -Keyring - - Client keyring contents (for external clusters). - false - true (ByPropertyName) - - - - -Krbd - - Always access rbd through krbd kernel module. - false - true (ByPropertyName) - False - - - -LioTpg - - target portal group for Linux LIO targets - false - true (ByPropertyName) - - - - -MasterPubkey + -ForceCpu - Base64-encoded, PEM-formatted public RSA key. Used to encrypt a copy of the encryption-key which will be added to each encrypted backup. + Override QEMU's -cpu argument with the given string. false true (ByPropertyName) - -MaxProtectedBackups - - Maximal number of protected backups per guest. Use '-1' for unlimited. - false - true (ByPropertyName) - 0 - - - -Maxfiles - - Deprecated':' use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimited. - false - true (ByPropertyName) - 0 - - - -Mkdir - - Create the directory if it doesn't exist and populate it with default sub-dirs. NOTE':' Deprecated, use the 'create-base-path' and 'create-subdirs' options instead. - false - true (ByPropertyName) - False - - - -Monhost + -Machine - IP addresses of monitors (for external clusters). + Specify the QEMU machine. false true (ByPropertyName) - -Mountpoint + -Migratedfrom - mount point + The cluster node name. false true (ByPropertyName) - -Namespace + -MigrationNetwork - Namespace. + CIDR of the (sub) network that is used for migration. false true (ByPropertyName) - -Nocow + -MigrationType - Set the NOCOW flag on files. Disables data checksumming and causes data errors to be unrecoverable from while allowing direct I/O. Only use this if data does not need to be any more safe than on a single ext4 formatted disk with no underlying raid system. + Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. Enum: secure,insecure false true (ByPropertyName) - False + - -Nodes + -Node - List of nodes for which the storage configuration applies. - false + The cluster node name. + true true (ByPropertyName) - -Nowritecache + -Skiplock - disable write caching on the target + Ignore locks - only root is allowed to use this option. false true (ByPropertyName) False - -Options + -Stateuri - NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs') + Some command save/restore state from this location. false true (ByPropertyName) - -Password + -Targetstorage - Password for accessing the share/datastore. + Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. false true (ByPropertyName) - -Pool + -Timeout - Pool. + Wait maximal timeout seconds. false true (ByPropertyName) - + 0 - -Port + -Vmid - For non default port. - false + The (unique) ID of the VM. + true true (ByPropertyName) 0 + + +
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Start-PveVm

+

+

Start VM.

+
+
+

Syntax

+
+
+
+ Start-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + - + - + - + - + - - - + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-Preallocation-PveTicket Preallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off. Enum: off,metadata,falloc,fullTicket data connection. falsetrue (ByPropertyName)true (ByValue, ByPropertyName)
-PruneBackups-VmIdOrName The retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups.falsetrue (ByPropertyName)The (unique) ID or Name of the VM.truetrue (ByValue, ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

New-PveNodesLxcStatusStop

+

+

Stop the container. This will abruptly stop all processes running in the container.

+
+
+

Syntax

+
+
+
+ New-PveNodesLxcStatusStop [[-PveTicket] <PveTicket>] [-Node] <String> [-OverruleShutdown] [-Skiplock] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + - + - + - + - + - - + + - + - + - + - + - + - + - + - - + + - + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-Saferemove-PveTicket Zero-out data when removing LVs.Ticket data connection. false true (ByPropertyName)False
-SaferemoveThroughput-Node Wipe throughput (cstream -t parameter value).falseThe cluster node name.true true (ByPropertyName)
-Server-OverruleShutdown Server IP or DNS name.Try to abort active 'vzshutdown' tasks before stopping. false true (ByPropertyName)False
-Server2-Skiplock Backup volfile server IP or DNS name.Ignore locks - only root is allowed to use this option. false true (ByPropertyName)False
-Shared-Vmid Indicate that this is a single storage with the same contents on all nodes (or all listed in the 'nodes' option). It will not make the contents of a local storage automatically accessible to other nodes, it just marks an already shared storage as such!falseThe (unique) ID of the VM.true true (ByPropertyName)False0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

Stop-PveQemu

+

New-PveNodesQeumStatusStop

+

+
+
+

Syntax

+
+
+
+ +
+
+
+
+
+

Stop-PveVm

+

+

Stop VM.

+
+
+

Syntax

+
+
+
+ Stop-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + - + - + - - + + - + - - - + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-SkipCertVerification-PveTicket Disable TLS certificate verification, only enable on fully trusted networks!Ticket data connection. falsetrue (ByPropertyName)Falsetrue (ByValue, ByPropertyName)
-Smbversion-VmIdOrName SMB protocol version. 'default' if not set, negotiates the highest SMB2+ version supported by both the client and server. Enum: default,2.0,2.1,3,3.0,3.11falsetrue (ByPropertyName)The (unique) ID or Name of the VM.truetrue (ByValue, ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

New-PveNodesLxcStatusSuspend

+

+

Suspend the container. This is experimental.

+
+
+

Syntax

+
+
+
+ New-PveNodesLxcStatusSuspend [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + - + - + - + - + - + - + - + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-Sparse-PveTicket use sparse volumesTicket data connection. false true (ByPropertyName)False
-Storage-Node The storage identifier.The cluster node name. true true (ByPropertyName)
-Subdir-Vmid Subdir to mount.The (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

New-PveNodesQemuStatusSuspend

+

+

Suspend virtual machine.

+
+
+

Syntax

+
+
+
+ New-PveNodesQemuStatusSuspend [[-PveTicket] <PveTicket>] [-Node] <String> [-Skiplock] [[-Statestorage] <String>] [-Todisk] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + - + - + + + + + + + + + - + - + - + - + - + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection. false true (ByPropertyName)
-TaggedOnly-Node Only use logical volumes tagged with 'pve-vm-ID'.The cluster node name.truetrue (ByPropertyName)
-SkiplockIgnore locks - only root is allowed to use this option. false true (ByPropertyName) False
-Transport-Statestorage Gluster transport':' tcp or rdma Enum: tcp,rdma,unixThe storage for the VM state false true (ByPropertyName)
-Username-Todisk RBD Id.If set, suspends the VM to disk. Will be resumed on next VM start. false true (ByPropertyName)False
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
@@ -49060,18 +54471,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Start-PveVm

+

Suspend-PveVm

-

Start VM.

+

Suspend VM.

Syntax

- Start-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>] + Suspend-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]
@@ -49113,18 +54524,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Stop-PveVm

+

New-PveNodesLxcSnapshotRollback

-

Stop VM.

+

Rollback LXC state to specified snapshot.

Syntax

- Stop-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>] + New-PveNodesLxcSnapshotRollback [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Start] [-Vmid] <Int32> [<CommonParameters>]
@@ -49146,17 +54557,41 @@

Parameters

Ticket data connection. false - true (ByValue, ByPropertyName) + true (ByPropertyName) - -VmIdOrName + -Node - The (unique) ID or Name of the VM. + The cluster node name. true - true (ByValue, ByPropertyName) + true (ByPropertyName) + + + + -Snapname + + The name of the snapshot. + true + true (ByPropertyName) + + -Start + + Whether the container should get started after rolling back successfully + false + true (ByPropertyName) + False + + + -Vmid + + The (unique) ID of the VM. + true + true (ByPropertyName) + 0 +
@@ -49166,18 +54601,18 @@

Outputs

  • PveResponse. Return response.
-
+
-

Suspend-PveVm

+

New-PveNodesQemuSnapshotRollback

-

Suspend VM.

+

Rollback VM state to specified snapshot.

Syntax

- Suspend-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>] + New-PveNodesQemuSnapshotRollback [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Start] [-Vmid] <Int32> [<CommonParameters>]
@@ -49199,17 +54634,41 @@

Parameters

Ticket data connection. false - true (ByValue, ByPropertyName) + true (ByPropertyName) - -VmIdOrName + -Node - The (unique) ID or Name of the VM. + The cluster node name. true - true (ByValue, ByPropertyName) + true (ByPropertyName) + + + + -Snapname + + The name of the snapshot. + true + true (ByPropertyName) + + -Start + + Whether the VM should get started after rolling back successfully. (Note':' VMs will be automatically started if the snapshot includes RAM.) + false + true (ByPropertyName) + False + + + -Vmid + + The (unique) ID of the VM. + true + true (ByPropertyName) + 0 +
@@ -49327,6 +54786,75 @@

Parameters

+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+
+

New-PveNodesAptUpdate

+

+

This is used to resynchronize the package index files from their sources (apt-get update).

+
+
+

Syntax

+
+
+
+ New-PveNodesAptUpdate [[-PveTicket] <PveTicket>] [-Node] <String> [-Notify] [-Quiet] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-NotifySend notification about new packages.falsetrue (ByPropertyName)False
-QuietOnly produces output suitable for logging, omitting progress indicators.falsetrue (ByPropertyName)False
+

Outputs

The output type is the type of the objects that the cmdlet emits.

@@ -49446,7 +54974,7 @@

Outputs

cv4pve-api-powershell - Proxmox VE Client API PowerShell Module by Corsinvest Srl
This is a part of suite cv4pve - - Version 8.1.2 + - Version 0.0