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 @@
+Create backup.
+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>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | Backup all known guest systems on this host. | +false | +true (ByPropertyName) | +False | +|
+ | Limit I/O bandwidth (in KiB/s). | +false | +true (ByPropertyName) | +0 | +|
+ | Compress dump file. Enum: 0,1,gzip,lzo,zstd | +false | +true (ByPropertyName) | ++ | |
+ | Store resulting files to specified directory. | +false | +true (ByPropertyName) | ++ | |
+ | Exclude specified guest systems (assumes --all) | +false | +true (ByPropertyName) | ++ | |
+ | Exclude 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) | ++ | |
+ | Options for backup fleecing (VM only). | +false | +true (ByPropertyName) | ++ | |
+ | 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. | +false | +true (ByPropertyName) | +0 | +|
+ | Maximal time to wait for the global lock (minutes). | +false | +true (ByPropertyName) | +0 | +|
+ | Deprecated':' use notification targets/matchers instead. Specify when to send a notification mail Enum: always,failure | +false | +true (ByPropertyName) | ++ | |
+ | Deprecated':' Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications. | +false | +true (ByPropertyName) | ++ | |
+ | Deprecated':' use 'prune-backups' instead. Maximal number of backup files per guest system. | +false | +true (ByPropertyName) | +0 | +|
+ | Backup mode. Enum: snapshot,suspend,stop | +false | +true (ByPropertyName) | ++ | |
+ | Only run if executed on this node. | +false | +true (ByPropertyName) | ++ | |
+ | 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. | +false | +true (ByPropertyName) | ++ | |
+ | 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) | ++ | |
+ | Deprecated':' Do not use Enum: always,failure,never | +false | +true (ByPropertyName) | ++ | |
+ | Deprecated':' Do not use | +false | +true (ByPropertyName) | ++ | |
+ | Other performance-related settings. | +false | +true (ByPropertyName) | ++ | |
+ | Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. | +false | +true (ByPropertyName) | +0 | +|
+ | Backup all known guest systems included in the specified pool. | +false | +true (ByPropertyName) | ++ | |
+ | If true, mark backup(s) as protected. | +false | +true (ByPropertyName) | +False | +|
+ | Use these retention options instead of those from the storage configuration. | +false | +true (ByPropertyName) | ++ | |
+ | Be quiet. | +false | +true (ByPropertyName) | +False | +|
+ | Prune older backups according to 'prune-backups'. | +false | +true (ByPropertyName) | +False | +|
+ | Use specified hook script. | +false | +true (ByPropertyName) | ++ | |
+ | Exclude temporary files and logs. | +false | +true (ByPropertyName) | +False | +|
+ | Write tar to stdout, not to a file. | +false | +true (ByPropertyName) | +False | +|
+ | Stop running backup jobs on this host. | +false | +true (ByPropertyName) | +False | +|
+ | Maximal time to wait until a guest system is stopped (minutes). | +false | +true (ByPropertyName) | +0 | +|
+ | Store resulting file to this storage. | +false | +true (ByPropertyName) | ++ | |
+ | Store temporary files to specified directory. | +false | +true (ByPropertyName) | ++ | |
+ | The ID of the guest system you want to backup. | +false | +true (ByPropertyName) | ++ | |
+ | 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 | +
The output type is the type of the objects that the cmdlet emits.
+Enter Spice VM.
+Create a container clone/copy
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>]
The output type is the type of the objects that the cmdlet emits.
+Create a copy of virtual machine/template.
+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>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | Override I/O bandwidth limit (in KiB/s). | +false | +true (ByPropertyName) | +0 | +|
+ | Description for the new VM. | +false | +true (ByPropertyName) | ++ | |
+ | Target format for file storage. Only valid for full clone. Enum: raw,qcow2,vmdk | +false | +true (ByPropertyName) | ++ | |
+ | Create 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. | +false | +true (ByPropertyName) | +False | +|
+ | Set a name for the new VM. | +false | +true (ByPropertyName) | ++ | |
+ | VMID for the clone. | +true | +true (ByPropertyName) | +0 | +|
+ | The cluster node name. | +true | +true (ByPropertyName) | ++ | |
+ | Add the new VM to the specified pool. | +false | +true (ByPropertyName) | ++ | |
+ | The name of the snapshot. | +false | +true (ByPropertyName) | ++ | |
+ | Target storage for full clone. | +false | +true (ByPropertyName) | ++ | |
+ | Target node. Only allowed if the original VM is on shared storage. | +false | +true (ByPropertyName) | ||
+ | The (unique) ID of the VM. | +true | +true (ByPropertyName) | +0 | +
The output type is the type of the objects that the cmdlet emits.
+Snapshot a container.
+New-PveNodesLxcSnapshot [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | A textual description or comment. | +false | +true (ByPropertyName) | ++ | |
+ | The cluster node name. | +true | +true (ByPropertyName) | ++ | |
+ | The name of the snapshot. | +true | +true (ByPropertyName) | ++ | |
+ | The (unique) ID of the VM. | +true | +true (ByPropertyName) | +0 | +
The output type is the type of the objects that the cmdlet emits.
+Snapshot a VM.
+New-PveNodesQemuSnapshot [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [-Vmstate] [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | A textual description or comment. | +false | +true (ByPropertyName) | ++ | |
+ | The cluster node name. | +true | +true (ByPropertyName) | ++ | |
+ | The name of the snapshot. | +true | +true (ByPropertyName) | ++ | |
+ | The (unique) ID of the VM. | +true | +true (ByPropertyName) | +0 | +|
+ | Save the vmstate | +false | +true (ByPropertyName) | +False | +
Get nodes
+Get container configuration.
Get-PveNode [[-PveTicket] <PveTicket>] [[-Node] <String>] [<CommonParameters>]
+ Get-PveNodesLxcConfig [[-PveTicket] <PveTicket>] [-Current] [-Node] <String> [[-Snapshot] <String>] [-Vmid] <Int32> [<CommonParameters>]
The output type is the type of the objects that the cmdlet emits.
-Cluster node index.
-Get-PveNodes [[-PveTicket] <PveTicket>] [<CommonParameters>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -||
---|---|---|---|---|---|---|---|
- | Ticket data connection. | +Fetch config values from given snapshot. | false | true (ByPropertyName) | |||
+ | The (unique) ID of the VM. | +true | +true (ByPropertyName) | +0 | +
Get list of appliances.
+List all snapshots.
Get-PveNodesAplinfo [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
+ Get-PveNodesLxcSnapshot [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Directory index for apt (Advanced Package Tool).
+Get snapshot configuration
Get-PveNodesApt [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
+ Get-PveNodesLxcSnapshotConfig [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
Get package changelogs.
+Get nodes
Get-PveNodesAptChangelog [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [[-Version] <String>] [<CommonParameters>]
+ Get-PveNode [[-PveTicket] <PveTicket>] [[-Node] <String>] [<CommonParameters>]
The output type is the type of the objects that the cmdlet emits.
-Get APT repository information.
+Cluster node index.
Get-PveNodesAptRepositories [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
+ Get-PveNodes [[-PveTicket] <PveTicket>] [<CommonParameters>]
List available updates.
+Get list of appliances.
Get-PveNodesAptUpdate [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
+ Get-PveNodesAplinfo [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Get package information for important Proxmox packages.
+Directory index for apt (Advanced Package Tool).
Get-PveNodesAptVersions [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
+ Get-PveNodesApt [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Node capabilities index.
+Get package changelogs.
Get-PveNodesCapabilities [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
+ Get-PveNodesAptChangelog [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [[-Version] <String>] [<CommonParameters>]
QEMU capabilities index.
+Get APT repository information.
Get-PveNodesCapabilitiesQemu [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
+ Get-PveNodesAptRepositories [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
List all custom and default CPU models.
+List available updates.
Get-PveNodesCapabilitiesQemuCpu [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
+ Get-PveNodesAptUpdate [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Get available QEMU/KVM machine types.
+Get package information for important Proxmox packages.
Get-PveNodesCapabilitiesQemuMachines [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
+ Get-PveNodesAptVersions [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Directory index.
+Node capabilities index.
Get-PveNodesCeph [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
+ Get-PveNodesCapabilities [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Directory index.
+QEMU capabilities index.
Get-PveNodesCephCfg [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
+ Get-PveNodesCapabilitiesQemu [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Get the Ceph configuration database.
+List all custom and default CPU models.
Get-PveNodesCephCfgDb [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
+ Get-PveNodesCapabilitiesQemuCpu [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Get the Ceph configuration file.
+Get available QEMU/KVM machine types.
Get-PveNodesCephCfgRaw [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
+ Get-PveNodesCapabilitiesQemuMachines [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | The cluster node name. | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Directory index.
+Get-PveNodesCeph [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | The cluster node name. | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Directory index.
+Get-PveNodesCephCfg [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | The cluster node name. | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Get the Ceph configuration database.
+Get-PveNodesCephCfgDb [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | The cluster node name. | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Get the Ceph configuration file.
+Get-PveNodesCephCfgRaw [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Get container configuration.
List all snapshots.
Get snapshot configuration
Get the virtual machine configuration with pending configuration changes applied. Set the 'current' parameter to get the current configuration instead.
List all snapshots.
Get snapshot configuration
Storage index.
+Get the virtual machine configuration with pending configuration changes applied. Set the 'current' parameter to get the current configuration instead.
Get-PveStorage [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>]
+ Get-PveNodesQemuConfig [[-PveTicket] <PveTicket>] [-Current] [-Node] <String> [[-Snapshot] <String>] [-Vmid] <Int32> [<CommonParameters>]
Read storage configuration.
+List all snapshots.
Get-PveStorageIdx [[-PveTicket] <PveTicket>] [-Storage] <String> [<CommonParameters>]
+ Get-PveNodesQemuSnapshot [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Get task is running.
+Get snapshot configuration
Get-PveTaskIsRunning [[-PveTicket] <PveTicket>] [-Upid] <String> [<CommonParameters>]
+ Get-PveNodesQemuSnapshotConfig [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
The output type is the type of the objects that the cmdlet emits.
-API version details, including some parts of the global datacenter config.
+Storage index.
Get-PveVersion [[-PveTicket] <PveTicket>] [<CommonParameters>]
+ Get-PveStorage [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>]
Get VMs/CTs from id or name.
+Read storage configuration.
Get-PveVm [[-PveTicket] <PveTicket>] [[-VmIdOrName] <String>] [<CommonParameters>]
+ Get-PveStorageIdx [[-PveTicket] <PveTicket>] [-Storage] <String> [<CommonParameters>]
The output type is the type of the objects that the cmdlet emits.
-Get snapshots VM.
+Get task is running.
Get-PveVmSnapshot [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]
+ Get-PveTaskIsRunning [[-PveTicket] <PveTicket>] [-Upid] <String> [<CommonParameters>]
The output type is the type of the objects that the cmdlet emits.
-Invoke Proxmox VE Rest API
+Read task status.
Invoke-PveRestApi [[-PveTicket] <PveTicket>] [-Resource] <String> [[-Method] <String>] [[-ResponseType] <String>] [[-Parameters] <Hashtable>] [<CommonParameters>]
+ Get-PveNodesTasksStatus [[-PveTicket] <PveTicket>] [-Node] <String> [-Upid] <String> [<CommonParameters>]
The output type is the type of the objects that the cmdlet emits.
-API version details, including some parts of the global datacenter config.
Get-PveVersion [[-PveTicket] <PveTicket>] [<CommonParameters>]
$PveTicket = Connect-PveCluster -HostsAndPorts '192.168.128.115' -Credentials (Get-Credential -Username 'root').
-(Invoke-PveRestApi -PveTicket $PveTicket -Method Get -Resource '/version').Resonse.data
- Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Enter Spice VM.
-Get VMs/CTs from id or name.
Invoke-PveSpice [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [-Viewer] <String> [<CommonParameters>]
+ Get-PveVm [[-PveTicket] <PveTicket>] [[-VmIdOrName] <String>] [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByValue, ByPropertyName) | ++ | |
+ | 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 output type is the type of the objects that the cmdlet emits.
+Get snapshots VM.
+Get-PveVmSnapshot [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByValue, ByPropertyName) | ++ | |
+ | The (unique) ID or Name of the VM. | +true | +true (ByValue, ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Invoke Proxmox VE Rest API
+Invoke-PveRestApi [[-PveTicket] <PveTicket>] [-Resource] <String> [[-Method] <String>] [[-ResponseType] <String>] [[-Parameters] <Hashtable>] [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data | +false | +true (ByValue, ByPropertyName) | ++ | |
+ | Resource Request | +true | +false | ++ | |
+ | Method request | +false | +false | +Get | +|
+ | Type request | +false | +false | +json | +|
+ | Parameters request | +false | +false | ++ |
The output type is the type of the objects that the cmdlet emits.
+$PveTicket = Connect-PveCluster -HostsAndPorts '192.168.128.115' -Credentials (Get-Credential -Username 'root').
+(Invoke-PveRestApi -PveTicket $PveTicket -Method Get -Resource '/version').Resonse.data
+ Enter Spice VM.
+Invoke-PveSpice [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [-Viewer] <String> [<CommonParameters>]
Migrate the container to another node. Creates a new migration task.
+New-PveNodesLxcMigrate [[-PveTicket] <PveTicket>] [[-Bwlimit] <Single>] [-Node] <String> [-Online] [-Restart] [-Target] <String> [[-TargetStorage] <String>] [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | Override I/O bandwidth limit (in KiB/s). | +false | +true (ByPropertyName) | +0 | +|
+ | The cluster node name. | +true | +true (ByPropertyName) | ++ | |
+ | Use online/live migration. | +false | +true (ByPropertyName) | +False | +|
+ | Use restart migration | +false | +true (ByPropertyName) | +False | +|
+ | Target node. | +true | +true (ByPropertyName) | ++ | |
+ | 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) | ++ | |
+ | Timeout in seconds for shutdown for restart migration | +false | +true (ByPropertyName) | +0 | +|
+ | The (unique) ID of the VM. | +true | +true (ByPropertyName) | +0 | +
The output type is the type of the objects that the cmdlet emits.
+Migrate virtual machine. Creates a new migration task.
+New-PveNodesQemuMigrate [[-PveTicket] <PveTicket>] [[-Bwlimit] <Int32>] [-Force] [[-MigrationNetwork] <String>] [[-MigrationType] <String>] [-Node] <String> [-Online] [-Target] <String> [[-Targetstorage] <String>] [-Vmid] <Int32> [-WithLocalDisks] [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | Override I/O bandwidth limit (in KiB/s). | +false | +true (ByPropertyName) | +0 | +|
+ | Allow to migrate VMs which use local devices. Only root may use this option. | +false | +true (ByPropertyName) | +False | +|
+ | CIDR of the (sub) network that is used for migration. | +false | +true (ByPropertyName) | ++ | |
+ | 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) | ++ | |
+ | The cluster node name. | +true | +true (ByPropertyName) | ++ | |
+ | Use online/live migration if VM is running. Ignored if VM is stopped. | +false | +true (ByPropertyName) | +False | +|
+ | Target node. | +true | +true (ByPropertyName) | ++ | |
+ | 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) | ++ | |
+ | The (unique) ID of the VM. | +true | +true (ByPropertyName) | +0 | +|
+ | Enable live storage migration for local disk | +false | +true (ByPropertyName) | +False | +
The output type is the type of the objects that the cmdlet emits.
+The output type is the type of the objects that the cmdlet emits.
+Create or restore a container.
+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>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | OS architecture type. Enum: amd64,i386,arm64,armhf,riscv32,riscv64 | +false | +true (ByPropertyName) | ++ | |
+ | Override I/O bandwidth limit (in KiB/s). | +false | +true (ByPropertyName) | +0 | +|
+ | 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) | ++ | |
+ | Attach a console device (/dev/console) to the container. | +false | +true (ByPropertyName) | +False | +|
+ | The number of cores assigned to the container. A container can use all available cores by default. | +false | +true (ByPropertyName) | +0 | +|
+ | 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 | +|
+ | CPU weight for a container, will be clamped to \[1, 10000] in cgroup v2. | +false | +true (ByPropertyName) | +0 | +|
+ | Try to be more verbose. For now this only enables debug log-level on start. | +false | +true (ByPropertyName) | +False | +|
+ | Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file. | +false | +true (ByPropertyName) | ++ | |
+ | Device to pass through to the container | +false | +true (ByPropertyName) | ++ | |
+ | Allow containers access to advanced features. | +false | +true (ByPropertyName) | ++ | |
+ | Allow to overwrite existing container. | +false | +true (ByPropertyName) | +False | +|
+ | Script that will be exectued during various steps in the containers lifetime. | +false | +true (ByPropertyName) | ++ | |
+ | Set a host name for the container. | +false | +true (ByPropertyName) | ++ | |
+ | Ignore errors when extracting the template. | +false | +true (ByPropertyName) | +False | +|
+ | Lock/unlock the container. Enum: backup,create,destroyed,disk,fstrim,migrate,mounted,rollback,snapshot,snapshot-delete | +false | +true (ByPropertyName) | ++ | |
+ | Amount of RAM for the container in MB. | +false | +true (ByPropertyName) | +0 | +|
+ | Use volume as container mount point. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. | +false | +true (ByPropertyName) | ++ | |
+ | 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) | ++ | |
+ | Specifies network interfaces for the container. | +false | +true (ByPropertyName) | ++ | |
+ | The cluster node name. | +true | +true (ByPropertyName) | ++ | |
+ | Specifies whether a container will be started during system bootup. | +false | +true (ByPropertyName) | +False | +|
+ | The OS template or backup file. | +true | +true (ByPropertyName) | ++ | |
+ | 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,unmanaged | +false | +true (ByPropertyName) | ++ | |
+ | Sets root password inside container. | +false | +true (ByPropertyName) | ++ | |
+ | Add the VM to the specified pool. | +false | +true (ByPropertyName) | ++ | |
+ | Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation. | +false | +true (ByPropertyName) | +False | +|
+ | Mark this as restore task. | +false | +true (ByPropertyName) | +False | +|
+ | Use volume as container root. | +false | +true (ByPropertyName) | ++ | |
+ | 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) | ++ | |
+ | Setup public SSH keys (one key per line, OpenSSH format). | +false | +true (ByPropertyName) | ++ | |
+ | Start the CT after its creation finished successfully. | +false | +true (ByPropertyName) | +False | +|
+ | 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) | ++ | |
+ | Default Storage. | +false | +true (ByPropertyName) | ++ | |
+ | Amount of SWAP for the container in MB. | +false | +true (ByPropertyName) | +0 | +|
+ | Tags of the Container. This is only meta information. | +false | +true (ByPropertyName) | ++ | |
+ | Enable/disable Template. | +false | +true (ByPropertyName) | +False | +|
+ | 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.tab | +false | +true (ByPropertyName) | ++ | |
+ | Specify the number of tty available to the container | +false | +true (ByPropertyName) | +0 | +|
+ | Assign a unique random ethernet address. | +false | +true (ByPropertyName) | +False | +|
+ | Makes the container run as unprivileged user. (Should not be modified manually.) | +false | +true (ByPropertyName) | +False | +|
+ | Reference to unused volumes. This is used internally, and should not be modified manually. | +false | +true (ByPropertyName) | ++ | |
+ | The (unique) ID of the VM. | +true | +true (ByPropertyName) | +0 | +
The output type is the type of the objects that the cmdlet emits.
@@ -25348,6 +27238,16 @@Create or restore a container.
Snapshot a container.
Rollback LXC state to specified snapshot.
Snapshot a VM.
New-PveNodesQemuSnapshot [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [-Vmstate] [<CommonParameters>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -
---|---|---|---|---|---|
- | Ticket data connection. | -false | -true (ByPropertyName) | -- | |
- | A textual description or comment. | -false | -true (ByPropertyName) | -- | |
- | The cluster node name. | -true | -true (ByPropertyName) | -- | |
- | The name of the snapshot. | -true | -true (ByPropertyName) | -- | |
- | The (unique) ID of the VM. | -true | -true (ByPropertyName) | -0 | -|
- | Save the vmstate | -false | -true (ByPropertyName) | -False | -
The output type is the type of the objects that the cmdlet emits.
-Rollback VM state to specified snapshot.
-New-PveNodesQemuSnapshotRollback [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Start] [-Vmid] <Int32> [<CommonParameters>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -
---|---|---|---|---|---|
- | Ticket data connection. | -false | -true (ByPropertyName) | -- | |
- | The cluster node name. | -true | -true (ByPropertyName) | -- | |
- | The name of the snapshot. | -true | -true (ByPropertyName) | -- | |
- | 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 | -|
- | The (unique) ID of the VM. | -true | -true (ByPropertyName) | -0 | -
The output type is the type of the objects that the cmdlet emits.
-Returns a SPICE configuration to connect to the VM.
-New-PveNodesQemuSpiceproxy [[-PveTicket] <PveTicket>] [-Node] <String> [[-Proxy] <String>] [-Vmid] <Int32> [<CommonParameters>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -
---|---|---|---|---|---|
- | Ticket data connection. | -false | -true (ByPropertyName) | -- | |
- | The cluster node name. | -true | -true (ByPropertyName) | -- | |
- | SPICE 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). | -false | -true (ByPropertyName) | -- | |
- | The (unique) ID of the VM. | -true | -true (ByPropertyName) | -0 | -
The output type is the type of the objects that the cmdlet emits.
-Reboot the VM by shutting it down, and starting it again. Applies pending changes.
-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>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | A textual description or comment. | +false | +true (ByPropertyName) | ++ | |
+ | The cluster node name. | +true | +true (ByPropertyName) | ++ | |
+ | The name of the snapshot. | +true | +true (ByPropertyName) | ++ | |
+ | The (unique) ID of the VM. | +true | +true (ByPropertyName) | +0 | +|
+ | Save the vmstate | +false | +true (ByPropertyName) | +False | +
The output type is the type of the objects that the cmdlet emits.
+Rollback VM state to specified snapshot.
+New-PveNodesQemuSnapshotRollback [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Start] [-Vmid] <Int32> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | The cluster node name. | +true | +true (ByPropertyName) | ++ | |
+ | The name of the snapshot. | +true | +true (ByPropertyName) | ++ | |
+ | 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 | +|
+ | The (unique) ID of the VM. | +true | +true (ByPropertyName) | +0 | +
The output type is the type of the objects that the cmdlet emits.
+Returns a SPICE configuration to connect to the VM.
+New-PveNodesQemuSpiceproxy [[-PveTicket] <PveTicket>] [-Node] <String> [[-Proxy] <String>] [-Vmid] <Int32> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | The cluster node name. | +true | +true (ByPropertyName) | ++ | |
+ | SPICE 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). | +false | +true (ByPropertyName) | ++ | |
+ | The (unique) ID of the VM. | +true | +true (ByPropertyName) | +0 | +
The output type is the type of the objects that the cmdlet emits.
+Reboot the VM by shutting it down, and starting it again. Applies pending changes.
+New-PveNodesQemuStatusReboot [[-PveTicket] <PveTicket>] [-Node] <String> [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
Create a new storage.
+Create or restore a virtual machine.
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>]
Create snapshot VM.
+Create a new storage.
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>]
The output type is the type of the objects that the cmdlet emits.
+Create snapshot VM.
+New-PveVmSnapshot [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [[-Description] <String>] [-Snapname] <String> [-Vmstate] [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByValue, ByPropertyName) | ++ | |
+ | The (unique) ID or Name of the VM. | +true | +true (ByValue, ByPropertyName) | ++ | |
+ | A textual description or comment. | +false | +true (ByValue, ByPropertyName) | ++ | |
+ | The name of the snapshot. | +true | +true (ByValue, ByPropertyName) | ++ | |
+ | Save the vmstate | +false | +true (ByValue, ByPropertyName) | +False | +
The output type is the type of the objects that the cmdlet emits.
+Delete an authentication server.
+Remove-PveAccessDomains [[-PveTicket] <PveTicket>] [-Realm] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | Authentication domain ID | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Delete group.
+Remove-PveAccessGroups [[-PveTicket] <PveTicket>] [-Groupid] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | -- | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Delete role.
+Remove-PveAccessRoles [[-PveTicket] <PveTicket>] [-Roleid] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | -- | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Delete a TFA entry by ID.
+Remove-PveAccessTfa [[-PveTicket] <PveTicket>] [-Id] <String> [[-Password] <SecureString>] [-Userid] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | A TFA entry id. | +true | +true (ByPropertyName) | ++ | |
+ | The current password of the user performing the change. | +false | +true (ByPropertyName) | ++ | |
+ | Full User ID, in the `name@realm` format. | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Delete user.
+Remove-PveAccessUsers [[-PveTicket] <PveTicket>] [-Userid] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | Full User ID, in the `name@realm` format. | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Remove API token for a specific user.
+Remove-PveAccessUsersToken [[-PveTicket] <PveTicket>] [-Tokenid] <String> [-Userid] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | User-specific token identifier. | +true | +true (ByPropertyName) | ++ | |
+ | Full User ID, in the `name@realm` format. | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Deactivate existing ACME account at CA.
+Remove-PveClusterAcmeAccount [[-PveTicket] <PveTicket>] [[-Name] <String>] [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | ACME account config file name. | +false | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Delete ACME plugin configuration.
+Remove-PveClusterAcmePlugins [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | Unique identifier for ACME plugin instance. | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Delete vzdump backup job definition.
+Remove-PveClusterBackup [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | The job ID. | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Removes a node from the cluster configuration.
+Remove-PveClusterConfigNodes [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | The cluster node name. | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Remove IP or Network alias.
+Remove-PveClusterFirewallAliases [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Name] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | +false | +true (ByPropertyName) | ++ | |
+ | Alias name. | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Delete security group.
+Remove-PveClusterFirewallGroups [[-PveTicket] <PveTicket>] [-Group] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | Security Group name. | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Delete rule.
+Remove-PveClusterFirewallGroupsIdx [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Group] <String> [[-Pos] <Int32>] [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | +false | +true (ByPropertyName) | ++ | |
+ | Security Group name. | +true | +true (ByPropertyName) | ++ | |
+ | Update rule at position <pos>. | +false | +true (ByPropertyName) | +0 | +
The output type is the type of the objects that the cmdlet emits.
+Delete IPSet
+Remove-PveClusterFirewallIpset [[-PveTicket] <PveTicket>] [-Force] [-Name] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | Delete all members of the IPSet, if there are any. | +false | +true (ByPropertyName) | +False | +|
+ | IP set name. | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Remove IP or Network from IPSet.
+Remove-PveClusterFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Digest] <String>] [-Name] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | Network/IP specification in CIDR format. | +true | +true (ByPropertyName) | ++ | |
+ | Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | +false | +true (ByPropertyName) | ++ | |
+ | IP set name. | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Delete rule.
+Remove-PveClusterFirewallRules [[-PveTicket] <PveTicket>] [[-Digest] <String>] [[-Pos] <Int32>] [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | +false | +true (ByPropertyName) | ++ | |
+ | Update rule at position <pos>. | +false | +true (ByPropertyName) | +0 | +
The output type is the type of the objects that the cmdlet emits.
+Delete ha group configuration.
+Remove-PveClusterHaGroups [[-PveTicket] <PveTicket>] [-Group] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | The HA group identifier. | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Delete resource configuration.
+Remove-PveClusterHaResources [[-PveTicket] <PveTicket>] [-Sid] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | 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 | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Delete realm-sync job definition.
+Remove-PveClusterJobsRealmSync [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | -- | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Remove Hardware Mapping.
+Remove-PveClusterMappingPci [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | -- | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Remove Hardware Mapping.
+Remove-PveClusterMappingUsb [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | -- | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Remove Metric server.
+Remove-PveClusterMetricsServer [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | -- | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Remove gotify endpoint
+Remove-PveClusterNotificationsEndpointsGotify [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | -- | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Remove sendmail endpoint
+Remove-PveClusterNotificationsEndpointsSendmail [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | -- | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Remove smtp endpoint
+Remove-PveClusterNotificationsEndpointsSmtp [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | -- | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Remove matcher
+Remove-PveClusterNotificationsMatchers [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | -- | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Mark replication job for removal.
+Remove-PveClusterReplication [[-PveTicket] <PveTicket>] [-Force] [-Id] <String> [-Keep] [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | Will remove the jobconfig entry, but will not cleanup. | +false | +true (ByPropertyName) | +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) | ++ | |
+ | Keep replicated data at target (do not remove). | +false | +true (ByPropertyName) | +False | +
The output type is the type of the objects that the cmdlet emits.
+Delete sdn controller object configuration.
+Remove-PveClusterSdnControllers [[-PveTicket] <PveTicket>] [-Controller] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | The SDN controller object identifier. | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Delete sdn dns object configuration.
+Remove-PveClusterSdnDns [[-PveTicket] <PveTicket>] [-Dns] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | The SDN dns object identifier. | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Delete sdn ipam object configuration.
+Remove-PveClusterSdnIpams [[-PveTicket] <PveTicket>] [-Ipam] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | The SDN ipam object identifier. | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Delete sdn vnet object configuration.
+Remove-PveClusterSdnVnets [[-PveTicket] <PveTicket>] [-Vnet] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | The SDN vnet object identifier. | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Delete IP Mappings in a VNet
+Remove-PveClusterSdnVnetsIps [[-PveTicket] <PveTicket>] [-Ip] <String> [[-Mac] <String>] [-Vnet] <String> [-Zone] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | The IP address to delete | +true | +true (ByPropertyName) | ++ | |
+ | Unicast MAC address. | +false | +true (ByPropertyName) | ++ | |
+ | The SDN vnet object identifier. | +true | +true (ByPropertyName) | ++ | |
+ | The SDN zone object identifier. | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Delete sdn subnet object configuration.
+Remove-PveClusterSdnVnetsSubnets [[-PveTicket] <PveTicket>] [-Subnet] <String> [-Vnet] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | The SDN subnet object identifier. | +true | +true (ByPropertyName) | ++ | |
+ | The SDN vnet object identifier. | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Delete sdn zone object configuration.
+Remove-PveClusterSdnZones [[-PveTicket] <PveTicket>] [-Zone] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | The SDN zone object identifier. | +true | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Destroy the container (also delete all uses files).
+Remove-PveNodesLxc [[-PveTicket] <PveTicket>] [-DestroyUnreferencedDisks] [-Force] [-Node] <String> [-Purge] [-Vmid] <Int32> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | 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 destroy, even if running. | +false | +true (ByPropertyName) | +False | +|
+ | The cluster node name. | +true | +true (ByPropertyName) | ++ | |
+ | 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 | +|
+ | The (unique) ID of the VM. | +true | +true (ByPropertyName) | +0 | +
Delete an authentication server.
+Delete a LXC snapshot.
Remove-PveAccessDomains [[-PveTicket] <PveTicket>] [-Realm] <String> [<CommonParameters>]
+ Remove-PveNodesLxcSnapshot [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
Delete group.
+Destroy Ceph Metadata Server
Remove-PveAccessGroups [[-PveTicket] <PveTicket>] [-Groupid] <String> [<CommonParameters>]
+ Remove-PveNodesCephMds [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [<CommonParameters>]
Delete role.
+Destroy Ceph Manager.
Remove-PveAccessRoles [[-PveTicket] <PveTicket>] [-Roleid] <String> [<CommonParameters>]
+ Remove-PveNodesCephMgr [[-PveTicket] <PveTicket>] [-Id] <String> [-Node] <String> [<CommonParameters>]
Delete a TFA entry by ID.
+Destroy Ceph Monitor and Manager.
Remove-PveAccessTfa [[-PveTicket] <PveTicket>] [-Id] <String> [[-Password] <SecureString>] [-Userid] <String> [<CommonParameters>]
+ Remove-PveNodesCephMon [[-PveTicket] <PveTicket>] [-Monid] <String> [-Node] <String> [<CommonParameters>]
The output type is the type of the objects that the cmdlet emits.
+Destroy OSD
+Remove-PveNodesCephOsd [[-PveTicket] <PveTicket>] [-Cleanup] [-Node] <String> [-Osdid] <Int32> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +||
---|---|---|---|---|---|---|---|
+ | Ticket data connection. | false | true (ByPropertyName) | ||||
- | Full User ID, in the `name@realm` format. | +If set, we remove partition table entries. | +false | +true (ByPropertyName) | +False | +||
+ | The cluster node name. | true | true (ByPropertyName) | ||||
+ | OSD ID | +true | +true (ByPropertyName) | +0 | +
Delete user.
+Destroy pool
Remove-PveAccessUsers [[-PveTicket] <PveTicket>] [-Userid] <String> [<CommonParameters>]
+ Remove-PveNodesCephPool [[-PveTicket] <PveTicket>] [-Force] [-Name] <String> [-Node] <String> [-RemoveEcprofile] [-RemoveStorages] [<CommonParameters>]
Remove API token for a specific user.
+Revoke existing certificate from CA.
Remove-PveAccessUsersToken [[-PveTicket] <PveTicket>] [-Tokenid] <String> [-Userid] <String> [<CommonParameters>]
+ Remove-PveNodesCertificatesAcmeCertificate [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
The output type is the type of the objects that the cmdlet emits.
+DELETE custom certificate chain and key.
+Remove-PveNodesCertificatesCustom [[-PveTicket] <PveTicket>] [-Node] <String> [-Restart] [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +||
---|---|---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |||
- | Full User ID, in the `name@realm` format. | +The cluster node name. | true | true (ByPropertyName) | |||
+ | Restart pveproxy. | +false | +true (ByPropertyName) | +False | +
Deactivate existing ACME account at CA.
+Unmounts the storage and removes the mount unit.
Remove-PveClusterAcmeAccount [[-PveTicket] <PveTicket>] [[-Name] <String>] [<CommonParameters>]
+ Remove-PveNodesDisksDirectory [[-PveTicket] <PveTicket>] [-CleanupConfig] [-CleanupDisks] [-Name] <String> [-Node] <String> [<CommonParameters>]
Delete ACME plugin configuration.
+Remove an LVM Volume Group.
Remove-PveClusterAcmePlugins [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
+ Remove-PveNodesDisksLvm [[-PveTicket] <PveTicket>] [-CleanupConfig] [-CleanupDisks] [-Name] <String> [-Node] <String> [<CommonParameters>]
Delete vzdump backup job definition.
+Remove an LVM thin pool.
Remove-PveClusterBackup [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
+ Remove-PveNodesDisksLvmthin [[-PveTicket] <PveTicket>] [-CleanupConfig] [-CleanupDisks] [-Name] <String> [-Node] <String> [-VolumeGroup] <String> [<CommonParameters>]
Removes a node from the cluster configuration.
+Destroy a ZFS pool.
Remove-PveClusterConfigNodes [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
+ Remove-PveNodesDisksZfs [[-PveTicket] <PveTicket>] [-CleanupConfig] [-CleanupDisks] [-Name] <String> [-Node] <String> [<CommonParameters>]
Remove IP or Network alias.
+Delete rule.
Remove-PveClusterFirewallAliases [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Name] <String> [<CommonParameters>]
+ Remove-PveNodesFirewallRules [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Node] <String> [[-Pos] <Int32>] [<CommonParameters>]
Delete security group.
+Destroy the container (also delete all uses files).
+Remove-PveClusterFirewallGroups [[-PveTicket] <PveTicket>] [-Group] <String> [<CommonParameters>]
+ Remove-PveNodesLxc [[-PveTicket] <PveTicket>] [-DestroyUnreferencedDisks] [-Force] [-Node] <String> [-Purge] [-Vmid] <Int32> [<CommonParameters>]
Delete rule.
+Remove IP or Network alias.
Remove-PveClusterFirewallGroupsIdx [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Group] <String> [[-Pos] <Int32>] [<CommonParameters>]
+ Remove-PveNodesLxcFirewallAliases [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Delete IPSet
Remove-PveClusterFirewallIpset [[-PveTicket] <PveTicket>] [-Force] [-Name] <String> [<CommonParameters>]
+ Remove-PveNodesLxcFirewallIpset [[-PveTicket] <PveTicket>] [-Force] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Remove IP or Network from IPSet.
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>]
Delete rule.
Remove-PveClusterFirewallRules [[-PveTicket] <PveTicket>] [[-Digest] <String>] [[-Pos] <Int32>] [<CommonParameters>]
+ Remove-PveNodesLxcFirewallRules [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Node] <String> [[-Pos] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
Delete ha group configuration.
+Delete a LXC snapshot.
+Remove-PveClusterHaGroups [[-PveTicket] <PveTicket>] [-Group] <String> [<CommonParameters>]
+ Remove-PveNodesLxcSnapshot [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
Delete resource configuration.
+Revert network configuration changes.
Remove-PveClusterHaResources [[-PveTicket] <PveTicket>] [-Sid] <String> [<CommonParameters>]
+ Remove-PveNodesNetwork [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Delete realm-sync job definition.
+Delete network device configuration
Remove-PveClusterJobsRealmSync [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
+ Remove-PveNodesNetworkIdx [[-PveTicket] <PveTicket>] [-Iface] <String> [-Node] <String> [<CommonParameters>]
Remove Hardware Mapping.
+Destroy the VM and all used/owned volumes. Removes any VM specific permissions and firewall rules
+Remove-PveClusterMappingPci [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
+ Remove-PveNodesQemu [[-PveTicket] <PveTicket>] [-DestroyUnreferencedDisks] [-Node] <String> [-Purge] [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]
Remove Hardware Mapping.
+Remove IP or Network alias.
Remove-PveClusterMappingUsb [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
+ Remove-PveNodesQemuFirewallAliases [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Remove Metric server.
+Delete IPSet
Remove-PveClusterMetricsServer [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
+ Remove-PveNodesQemuFirewallIpset [[-PveTicket] <PveTicket>] [-Force] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Remove gotify endpoint
+Remove IP or Network from IPSet.
Remove-PveClusterNotificationsEndpointsGotify [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]
+ Remove-PveNodesQemuFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Remove sendmail endpoint
+Delete rule.
Remove-PveClusterNotificationsEndpointsSendmail [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]
+ Remove-PveNodesQemuFirewallRules [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Node] <String> [[-Pos] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
Remove smtp endpoint
+Delete a VM snapshot.
+Remove-PveClusterNotificationsEndpointsSmtp [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]
+ Remove-PveNodesQemuSnapshot [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
Remove matcher
+Delete volume
Remove-PveClusterNotificationsMatchers [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]
+ Remove-PveNodesStorageContent [[-PveTicket] <PveTicket>] [[-Delay] <Int32>] [-Node] <String> [[-Storage] <String>] [-Volume] <String> [<CommonParameters>]
Mark replication job for removal.
+Prune backups. Only those using the standard naming scheme are considered.
Remove-PveClusterReplication [[-PveTicket] <PveTicket>] [-Force] [-Id] <String> [-Keep] [<CommonParameters>]
+ Remove-PveNodesStoragePrunebackups [[-PveTicket] <PveTicket>] [-Node] <String> [[-PruneBackups] <String>] [-Storage] <String> [[-Type] <String>] [[-Vmid] <Int32>] [<CommonParameters>]
Delete sdn controller object configuration.
+Delete subscription key of this node.
Remove-PveClusterSdnControllers [[-PveTicket] <PveTicket>] [-Controller] <String> [<CommonParameters>]
+ Remove-PveNodesSubscription [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Delete sdn dns object configuration.
+Stop a task.
Remove-PveClusterSdnDns [[-PveTicket] <PveTicket>] [-Dns] <String> [<CommonParameters>]
+ Remove-PveNodesTasks [[-PveTicket] <PveTicket>] [-Node] <String> [-Upid] <String> [<CommonParameters>]
Delete sdn ipam object configuration.
+Delete pool.
Remove-PveClusterSdnIpams [[-PveTicket] <PveTicket>] [-Ipam] <String> [<CommonParameters>]
+ Remove-PvePools [[-PveTicket] <PveTicket>] [-Poolid] <String> [<CommonParameters>]
Delete sdn vnet object configuration.
+Delete pool (deprecated, no support for nested pools, use 'DELETE /pools/?poolid={poolid}').
Remove-PveClusterSdnVnets [[-PveTicket] <PveTicket>] [-Vnet] <String> [<CommonParameters>]
+ Remove-PvePoolsIdx [[-PveTicket] <PveTicket>] [-Poolid] <String> [<CommonParameters>]
Delete IP Mappings in a VNet
+Destroy the VM and all used/owned volumes. Removes any VM specific permissions and firewall rules
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>]
Delete sdn subnet object configuration.
+Delete a VM snapshot.
Remove-PveClusterSdnVnetsSubnets [[-PveTicket] <PveTicket>] [-Subnet] <String> [-Vnet] <String> [<CommonParameters>]
+ Remove-PveNodesQemuSnapshot [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
The output type is the type of the objects that the cmdlet emits.
-Delete sdn zone object configuration.
-Remove-PveClusterSdnZones [[-PveTicket] <PveTicket>] [-Zone] <String> [<CommonParameters>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -|||
---|---|---|---|---|---|---|---|---|
- | Ticket data connection. | -false | +The name of the snapshot. | +true | true (ByPropertyName) | |||
- | The SDN zone object identifier. | +The (unique) ID of the VM. | true | true (ByPropertyName) | -+ | 0 |
Destroy Ceph Metadata Server
+Delete storage configuration.
Remove-PveNodesCephMds [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [<CommonParameters>]
+ Remove-PveStorage [[-PveTicket] <PveTicket>] [-Storage] <String> [<CommonParameters>]
Destroy Ceph Manager.
+Delete a VM snapshot.
Remove-PveNodesCephMgr [[-PveTicket] <PveTicket>] [-Id] <String> [-Node] <String> [<CommonParameters>]
+ Remove-PveVmSnapshot [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [-Snapname] <String> [<CommonParameters>]
Destroy Ceph Monitor and Manager.
+Reset virtual machine.
Remove-PveNodesCephMon [[-PveTicket] <PveTicket>] [-Monid] <String> [-Node] <String> [<CommonParameters>]
+ New-PveNodesQemuStatusReset [[-PveTicket] <PveTicket>] [-Node] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]
Destroy OSD
+Reset VM.
Remove-PveNodesCephOsd [[-PveTicket] <PveTicket>] [-Cleanup] [-Node] <String> [-Osdid] <Int32> [<CommonParameters>]
+ Reset-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]
Destroy pool
+Reboot the container by shutting it down, and starting it again. Applies pending changes.
Remove-PveNodesCephPool [[-PveTicket] <PveTicket>] [-Force] [-Name] <String> [-Node] <String> [-RemoveEcprofile] [-RemoveStorages] [<CommonParameters>]
+ New-PveNodesLxcStatusReboot [[-PveTicket] <PveTicket>] [-Node] <String> [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
Revoke existing certificate from CA.
+Reboot the VM by shutting it down, and starting it again. Applies pending changes.
Remove-PveNodesCertificatesAcmeCertificate [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
+ New-PveNodesQemuStatusReboot [[-PveTicket] <PveTicket>] [-Node] <String> [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
DELETE custom certificate chain and key.
+Resume the container.
Remove-PveNodesCertificatesCustom [[-PveTicket] <PveTicket>] [-Node] <String> [-Restart] [<CommonParameters>]
+ New-PveNodesLxcStatusResume [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Unmounts the storage and removes the mount unit.
+Resume virtual machine.
Remove-PveNodesDisksDirectory [[-PveTicket] <PveTicket>] [-CleanupConfig] [-CleanupDisks] [-Name] <String> [-Node] <String> [<CommonParameters>]
+ New-PveNodesQemuStatusResume [[-PveTicket] <PveTicket>] [-Nocheck] [-Node] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]
Remove an LVM Volume Group.
+Resume VM.
Remove-PveNodesDisksLvm [[-PveTicket] <PveTicket>] [-CleanupConfig] [-CleanupDisks] [-Name] <String> [-Node] <String> [<CommonParameters>]
+ Resume-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]
Remove an LVM thin pool.
+Update Access Control List (add or remove permissions).
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>]
Destroy a ZFS pool.
+Update authentication server settings.
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>]
The output type is the type of the objects that the cmdlet emits.
-Delete rule.
-Remove-PveNodesFirewallRules [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Node] <String> [[-Pos] <Int32>] [<CommonParameters>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -||
---|---|---|---|---|---|---|---|
- | Ticket data connection. | +Check bind connection to the server. | +false | +true (ByPropertyName) | +False | +||
+ | OpenID Client ID | +false | +true (ByPropertyName) | ++ | |||
+ | OpenID Client Key | +false | +true (ByPropertyName) | ++ | |||
+ | Description. | +false | +true (ByPropertyName) | ++ | |||
+ | Use this as default realm | +false | +true (ByPropertyName) | +False | +|||
+ | A list of settings you want to delete. | false | true (ByPropertyName) | @@ -37724,20 +43068,188 @@ | |||
- | The cluster node name. | +AD domain name | +false | +true (ByPropertyName) | ++ | ||
+ | LDAP filter for user sync. | +false | +true (ByPropertyName) | ++ | |||
+ | The objectclasses for groups. | +false | +true (ByPropertyName) | ++ | |||
+ | LDAP base domain name for group sync. If not set, the base_dn will be used. | +false | +true (ByPropertyName) | ++ | |||
+ | LDAP filter for group sync. | +false | +true (ByPropertyName) | ++ | |||
+ | LDAP attribute representing a groups name. If not set or found, the first value of the DN will be used as name. | +false | +true (ByPropertyName) | ++ | |||
+ | OpenID Issuer Url | +false | +true (ByPropertyName) | ++ | |||
+ | LDAP protocol mode. Enum: ldap,ldaps,ldap+starttls | +false | +true (ByPropertyName) | ++ | |||
+ | LDAP bind password. Will be stored in '/etc/pve/priv/realm/<REALM>.pw'. | +false | +true (ByPropertyName) | ++ | |||
+ | Server port. | +false | +true (ByPropertyName) | +0 | +|||
+ | Specifies whether the Authorization Server prompts the End-User for reauthentication and consent. | +false | +true (ByPropertyName) | ++ | |||
+ | Authentication domain ID | true | true (ByPropertyName) | ||||
+ | Specifies the scopes (user details) that should be authorized and returned, for example 'email' or 'profile'. | +false | +true (ByPropertyName) | ++ | |||
+ | Use secure LDAPS protocol. DEPRECATED':' use 'mode' instead. | +false | +true (ByPropertyName) | +False | +|||
+ | Server IP address (or DNS name) | +false | +true (ByPropertyName) | ++ | |||
+ | Fallback Server IP address (or DNS name) | +false | +true (ByPropertyName) | ++ | |||
+ | LDAPS TLS/SSL version. It's not recommended to use version older than 1.2! Enum: tlsv1,tlsv1_1,tlsv1_2,tlsv1_3 | +false | +true (ByPropertyName) | ++ | |||
+ | The default options for behavior of synchronizations. | +false | +true (ByPropertyName) | ++ | |||
+ | 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. | +false | +true (ByPropertyName) | ++ | |||
+ | Use Two-factor authentication. | +false | +true (ByPropertyName) | ++ | |||
+ | LDAP user attribute name | +false | +true (ByPropertyName) | ++ | |||
+ | The objectclasses for users. | +false | +true (ByPropertyName) | ++ | |||
- | Update rule at position <pos>. | +Verify the server's SSL certificate | false | true (ByPropertyName) | -0 | +False |
Destroy the container (also delete all uses files).
+Update group data.
Remove-PveNodesLxc [[-PveTicket] <PveTicket>] [-DestroyUnreferencedDisks] [-Force] [-Node] <String> [-Purge] [-Vmid] <Int32> [<CommonParameters>]
+ Set-PveAccessGroups [[-PveTicket] <PveTicket>] [[-Comment] <String>] [-Groupid] <String> [<CommonParameters>]
Remove IP or Network alias.
+Change user password.
Remove-PveNodesLxcFirewallAliases [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
+ Set-PveAccessPassword [[-PveTicket] <PveTicket>] [[-ConfirmationPassword] <SecureString>] [-Password] <SecureString> [-Userid] <String> [<CommonParameters>]
Delete IPSet
+Update an existing role.
Remove-PveNodesLxcFirewallIpset [[-PveTicket] <PveTicket>] [-Force] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
+ Set-PveAccessRoles [[-PveTicket] <PveTicket>] [-Append] [[-Privs] <String>] [-Roleid] <String> [<CommonParameters>]
Remove IP or Network from IPSet.
+Add a TFA entry for a user.
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>]
Delete rule.
+Update user configuration.
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>]
Delete a LXC snapshot.
+Update API token for a specific user.
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>]
Revert network configuration changes.
+Unlock a user's TFA authentication.
Remove-PveNodesNetwork [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
+ Set-PveAccessUsersUnlockTfa [[-PveTicket] <PveTicket>] [-Userid] <String> [<CommonParameters>]
Delete network device configuration
+Update existing ACME account information with CA. Note':' not specifying any new account information triggers a refresh.
Remove-PveNodesNetworkIdx [[-PveTicket] <PveTicket>] [-Iface] <String> [-Node] <String> [<CommonParameters>]
+ Set-PveClusterAcmeAccount [[-PveTicket] <PveTicket>] [[-Contact] <String>] [[-Name] <String>] [<CommonParameters>]
Destroy the VM and all used/owned volumes. Removes any VM specific permissions and firewall rules
+Update ACME plugin configuration.
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>]
Remove IP or Network alias.
+Update vzdump backup job definition.
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>]
The output type is the type of the objects that the cmdlet emits.
-Delete IPSet
-Remove-PveNodesQemuFirewallIpset [[-PveTicket] <PveTicket>] [-Force] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -|||
---|---|---|---|---|---|---|---|---|
- | Ticket data connection. | +Store resulting files to specified directory. | false | true (ByPropertyName) | ||||
- | Delete all members of the IPSet, if there are any. | +Enable or disable the job. | false | true (ByPropertyName) | False | |||
- | IP set name. | -true | +Exclude specified guest systems (assumes --all) | +false | true (ByPropertyName) | |||
- | The cluster node name. | -true | +Exclude 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) | |||
- | The (unique) ID of the VM. | +Options for backup fleecing (VM only). | +false | +true (ByPropertyName) | ++ | |||
+ | The job ID. | true | true (ByPropertyName) | -0 | ++ | |||
+ | 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. | +false | +true (ByPropertyName) | +0 |
The output type is the type of the objects that the cmdlet emits.
-Remove IP or Network from IPSet.
-Remove-PveNodesQemuFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -||||
---|---|---|---|---|---|---|---|---|---|
- | Ticket data connection. | +Maximal time to wait for the global lock (minutes). | false | true (ByPropertyName) | -+ | 0 | |||
- | Network/IP specification in CIDR format. | -true | +Deprecated':' use notification targets/matchers instead. Specify when to send a notification mail Enum: always,failure | +false | true (ByPropertyName) | ||||
- | 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) | |||||
- | IP set name. | -true | +Deprecated':' use 'prune-backups' instead. Maximal number of backup files per guest system. | +false | +true (ByPropertyName) | +0 | +|||
+ | Backup mode. Enum: snapshot,suspend,stop | +false | true (ByPropertyName) | ||||||
- | The cluster node name. | -true | +Only run if executed on this node. | +false | true (ByPropertyName) | ||||
- | The (unique) ID of the VM. | -true | +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. | +false | true (ByPropertyName) | -0 | +
The output type is the type of the objects that the cmdlet emits.
-Delete rule.
-Remove-PveNodesQemuFirewallRules [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Node] <String> [[-Pos] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -|||
---|---|---|---|---|---|---|---|---|
- | 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) | ||||
- | 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) | ||||
- | The cluster node name. | -true | +Deprecated':' Do not use | +false | true (ByPropertyName) | |||
- | Update rule at position <pos>. | +Other performance-related settings. | false | true (ByPropertyName) | -0 | +|||
- | The (unique) ID of the VM. | -true | +Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. | +false | true (ByPropertyName) | 0 |
The output type is the type of the objects that the cmdlet emits.
-Delete a VM snapshot.
-Remove-PveNodesQemuSnapshot [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -||||
---|---|---|---|---|---|---|---|---|---|
- | Ticket data connection. | +Backup all known guest systems included in the specified pool. | false | true (ByPropertyName) | |||||
- | For removal from config file, even if removing disk snapshots fails. | +If true, mark backup(s) as protected. | false | true (ByPropertyName) | False | ||||
- | The cluster node name. | -true | +Use these retention options instead of those from the storage configuration. | +false | true (ByPropertyName) | ||||
- | The name of the snapshot. | -true | +Be quiet. | +false | true (ByPropertyName) | -+ | False | ||
- | The (unique) ID of the VM. | -true | +Prune older backups according to 'prune-backups'. | +false | true (ByPropertyName) | -0 | +False |
The output type is the type of the objects that the cmdlet emits.
-Delete volume
-Remove-PveNodesStorageContent [[-PveTicket] <PveTicket>] [[-Delay] <Int32>] [-Node] <String> [[-Storage] <String>] [-Volume] <String> [<CommonParameters>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -||||
---|---|---|---|---|---|---|---|---|---|
- | 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 | |||
- | 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 | +||||
- | The cluster node name. | -true | +Use specified hook script. | +false | true (ByPropertyName) | ||||
- | The storage identifier. | +Job Start time. | false | true (ByPropertyName) | |||||
- | Volume identifier | -true | +Exclude temporary files and logs. | +false | true (ByPropertyName) | -+ | False |
The output type is the type of the objects that the cmdlet emits.
-Prune backups. Only those using the standard naming scheme are considered.
-Remove-PveNodesStoragePrunebackups [[-PveTicket] <PveTicket>] [-Node] <String> [[-PruneBackups] <String>] [-Storage] <String> [[-Type] <String>] [[-Vmid] <Int32>] [<CommonParameters>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -||||
---|---|---|---|---|---|---|---|---|---|
- | Ticket data connection. | +Stop running backup jobs on this host. | false | true (ByPropertyName) | -+ | False | |||
- | The cluster node name. | -true | +Maximal time to wait until a guest system is stopped (minutes). | +false | true (ByPropertyName) | -+ | 0 | ||
- | Use these retention options instead of those from the storage configuration. | +Store resulting file to this storage. | false | true (ByPropertyName) | |||||
- | The storage identifier. | -true | +Store temporary files to specified directory. | +false | true (ByPropertyName) | ||||
- | Either 'qemu' or 'lxc'. Only consider backups for guests of this type. Enum: qemu,lxc | +The ID of the guest system you want to backup. | false | true (ByPropertyName) | |||||
- | 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 | @@ -38980,18 +44350,18 @@||||
- | The cluster node name. | -true | +Backfilling of PGs is suspended. | +false | true (ByPropertyName) | -+ | False |
The output type is the type of the objects that the cmdlet emits.
-Stop a task.
-Remove-PveNodesTasks [[-PveTicket] <PveTicket>] [-Node] <String> [-Upid] <String> [<CommonParameters>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -||||
---|---|---|---|---|---|---|---|---|---|
- | Ticket data connection. | +Deep Scrubbing is disabled. | false | true (ByPropertyName) | -+ | False | |||
- | The cluster node name. | -true | +OSD failure reports are being ignored, such that the monitors will not mark OSDs down. | +false | true (ByPropertyName) | -+ | False | ||
- | -- | -true | +OSDs that were previously marked out will not be marked back in when they start. | +false | true (ByPropertyName) | -+ | False |
The output type is the type of the objects that the cmdlet emits.
-Delete pool.
-Remove-PvePools [[-PveTicket] <PveTicket>] [-Poolid] <String> [<CommonParameters>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -||||
---|---|---|---|---|---|---|---|---|---|
- | Ticket data connection. | +OSDs will not automatically be marked out after the configured interval. | false | true (ByPropertyName) | -+ | False | |||
- | -- | -true | +Rebalancing of PGs is suspended. | +false | true (ByPropertyName) | -+ | False |
The output type is the type of the objects that the cmdlet emits.
-Delete pool (deprecated, no support for nested pools, use 'DELETE /pools/?poolid={poolid}').
-Remove-PvePoolsIdx [[-PveTicket] <PveTicket>] [-Poolid] <String> [<CommonParameters>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -||||
---|---|---|---|---|---|---|---|---|---|
- | Ticket data connection. | +Recovery of PGs is suspended. | false | true (ByPropertyName) | -+ | False | |||
- | -- | -true | +Scrubbing is disabled. | +false | true (ByPropertyName) | -+ | False | +||
+ | Cache tiering activity is suspended. | +false | +true (ByPropertyName) | +False | +|||||
+ | OSDs are not allowed to start. | +false | +true (ByPropertyName) | +False | +|||||
+ | Pauses read and writes. | +false | +true (ByPropertyName) | +False |
Delete storage configuration.
+Set or clear (unset) a specific ceph flag
Remove-PveStorage [[-PveTicket] <PveTicket>] [-Storage] <String> [<CommonParameters>]
+ Set-PveClusterCephFlagsIdx [[-PveTicket] <PveTicket>] [-Flag] <String> -Value [<CommonParameters>]
Delete a VM snapshot.
+Update IP or Network alias.
Remove-PveVmSnapshot [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [-Snapname] <String> [<CommonParameters>]
+ Set-PveClusterFirewallAliases [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [[-Rename] <String>] [<CommonParameters>]
Reset VM.
+Modify rule data.
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>]
Resume VM.
+Update IP or Network settings
Resume-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]
+ Set-PveClusterFirewallIpset [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Nomatch] [<CommonParameters>]
Update Access Control List (add or remove permissions).
+Set Firewall options.
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>]
Update authentication server settings.
+Modify rule data.
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>]
The output type is the type of the objects that the cmdlet emits.
+Update ha group configuration.
+Set-PveClusterHaGroups [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Delete] <String>] [[-Digest] <String>] [-Group] <String> [[-Nodes] <String>] [-Nofailback] [-Restricted] [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +|||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
- | Fallback Server IP address (or DNS name) | +Ticket data connection. | false | true (ByPropertyName) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
- | LDAPS TLS/SSL version. It's not recommended to use version older than 1.2! Enum: tlsv1,tlsv1_1,tlsv1_2,tlsv1_3 | +Description. | false | true (ByPropertyName) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
- | The default options for behavior of synchronizations. | +A list of settings you want to delete. | false | true (ByPropertyName) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
- | 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) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
- | Use Two-factor authentication. | -false | +The HA group identifier. | +true | true (ByPropertyName) | |||||||||||||||||||||||||||||||||||||||||||||||||||||
- | LDAP user attribute name | +List of cluster node names with optional priority. | false | true (ByPropertyName) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
- | 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 the server's SSL certificate | +Resources bound to restricted groups may only run on nodes defined by the group. | false | true (ByPropertyName) | False | @@ -39870,18 +45286,18 @@|||||||||||||||||||||||||||||||||||||||||||||||||||||
- | -- | +Description. | false | true (ByPropertyName) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
- | -- | +A list of settings you want to delete. | +false | +true (ByPropertyName) | ++ | |||||||||||||||||||||||||||||||||||||||||||||||||||||
+ | Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | +false | +true (ByPropertyName) | ++ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
+ | The HA group identifier. | +false | +true (ByPropertyName) | ++ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
+ | Maximal number of service relocate tries when a service failes to start. | +false | +true (ByPropertyName) | +0 | +||||||||||||||||||||||||||||||||||||||||||||||||||||||
+ | Maximal number of tries to restart the service on a node after its start failed. | +false | +true (ByPropertyName) | +0 | +||||||||||||||||||||||||||||||||||||||||||||||||||||||
+ | 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 | true (ByPropertyName) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
+ | Requested resource state. Enum: started,stopped,enabled,disabled,ignored | +false | +true (ByPropertyName) | ++ |
Change user password.
+Update realm-sync job definition.
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>]
Update an existing role.
+Update a hardware mapping.
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>]
Add a TFA entry for a user.
+Update a hardware mapping.
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>]
Update user configuration.
+Update metric server configuration.
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>]
Update API token for a specific user.
+Update existing gotify endpoint
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>]
Unlock a user's TFA authentication.
+Update existing sendmail endpoint
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>]
The output type is the type of the objects that the cmdlet emits.
-Update existing ACME account information with CA. Note':' not specifying any new account information triggers a refresh.
-Set-PveClusterAcmeAccount [[-PveTicket] <PveTicket>] [[-Contact] <String>] [[-Name] <String>] [<CommonParameters>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -||
---|---|---|---|---|---|---|---|
- | Ticket data connection. | +Comment | false | true (ByPropertyName) | |||
- | Contact email addresses. | +A list of settings you want to delete. | false | true (ByPropertyName) | |||
- | ACME account config file name. | +Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | +false | +true (ByPropertyName) | ++ | ||
+ | Disable this target | +false | +true (ByPropertyName) | +False | +|||
+ | `From` address for the mail | +false | +true (ByPropertyName) | ++ | |||
+ | List of email recipients | +false | +true (ByPropertyName) | ++ | |||
+ | List of users | false | true (ByPropertyName) | ||||
+ | The name of the endpoint. | +true | +true (ByPropertyName) | ++ |
Update ACME plugin configuration.
+Update existing smtp endpoint
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>]
Update vzdump backup job definition.
+Update existing matcher
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>]
The output type is the type of the objects that the cmdlet emits.
+Set datacenter options.
+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>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +|||
---|---|---|---|---|---|---|---|---|
- | 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) | ||||
- | 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 | +|||
- | Backup mode. Enum: snapshot,suspend,stop | +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,xtermjs | false | true (ByPropertyName) | ||||
- | Only run if executed on this node. | +Cluster resource scheduling settings. | false | true (ByPropertyName) | ||||
- | 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) | ||||
- | 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 | +Datacenter description. Shown in the web-interface datacenter notes panel. This is saved as comment inside the configuration file. | false | true (ByPropertyName) | ||||
- | Deprecated':' Do not use Enum: always,failure,never | +Specify email address to send notification from (default is root@$hostname) | false | true (ByPropertyName) | ||||
- | Deprecated':' Do not use | +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,both | false | true (ByPropertyName) | ||||
- | Other performance-related settings. | +Cluster wide HA settings. | false | true (ByPropertyName) | ||||
- | 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 | +|||
- | 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) | ||||
- | 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 | +|||
- | 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) | ||||
- | 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) | -False | +0 | ||
- | Prune older backups according to 'prune-backups'. | +For cluster wide migration settings. | false | true (ByPropertyName) | -False | +|||
- | 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 | |||
- | Backup schedule. The format is a subset of `systemd` calendar events. | +Control the range for the free VMID auto-selection pool. | false | true (ByPropertyName) | ||||
- | Use specified hook script. | +Cluster-wide notification settings. | false | true (ByPropertyName) | ||||
- | 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) | ||||
- | Exclude temporary files and logs. | -false | -true (ByPropertyName) | -False | -||||
- | Stop running backup jobs on this host. | -false | -true (ByPropertyName) | -False | -||||
- | Maximal time to wait until a guest system is stopped (minutes). | -false | -true (ByPropertyName) | -0 | -||||
- | Store resulting file to this storage. | +Tag style options. | false | true (ByPropertyName) | ||||
- | Store temporary files to specified directory. | +u2f | false | true (ByPropertyName) | ||||
- | The ID of the guest system you want to backup. | +Privilege options for user-settable tags | false | true (ByPropertyName) | ||||
- | 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 | +
Set/Unset multiple ceph flags at once.
+Update replication job configuration.
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>]
The output type is the type of the objects that the cmdlet emits.
-Set or clear (unset) a specific ceph flag
-Set-PveClusterCephFlagsIdx [[-PveTicket] <PveTicket>] [-Flag] <String> -Value [<CommonParameters>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -|||
---|---|---|---|---|---|---|---|---|
- | Ticket data connection. | +Storage replication schedule. The format is a subset of `systemd` calendar events. | false | true (ByPropertyName) | ||||
- | The ceph flag to update Enum: nobackfill,nodeep-scrub,nodown,noin,noout,norebalance,norecover,noscrub,notieragent,noup,pause | -true | +For internal use, to detect if the guest was stolen. | +false | true (ByPropertyName) | |||
- | The new value of the flag | -true | -true (ByPropertyName) | -False | -
Update IP or Network alias.
+Apply sdn controller changes && reload.
Set-PveClusterFirewallAliases [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [[-Rename] <String>] [<CommonParameters>]
+ Set-PveClusterSdn [[-PveTicket] <PveTicket>] [<CommonParameters>]
Modify rule data.
+Update sdn controller object configuration.
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>]
Update IP or Network settings
+Update sdn dns object configuration.
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>]
Set Firewall options.
+Update sdn ipam object configuration.
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>]
Modify rule data.
+Update sdn vnet object configuration.
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>]
The output type is the type of the objects that the cmdlet emits.
+Update IP Mapping in a VNet
+Set-PveClusterSdnVnetsIps [[-PveTicket] <PveTicket>] [-Ip] <String> [[-Mac] <String>] [[-Vmid] <Int32>] [-Vnet] <String> [-Zone] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +||||
---|---|---|---|---|---|---|---|---|---|
- | Use predefined standard macro. | +Ticket data connection. | false | true (ByPropertyName) | |||||
- | Move rule to new position <moveto>. Other arguments are ignored. | -false | -true (ByPropertyName) | -0 | -|||||
- | Update rule at position <pos>. | -false | +The IP address to associate with the given MAC address | +true | true (ByPropertyName) | -0 | +|||
- | IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. | +Unicast MAC address. | false | true (ByPropertyName) | |||||
- | 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 | |||
- | 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 | +The SDN vnet object identifier. | +true | true (ByPropertyName) | ||||
- | Rule type. Enum: in,out,group | -false | +The SDN zone object identifier. | +true | true (ByPropertyName) | ||||
- | Description. | +A list of settings you want to delete. | false | true (ByPropertyName) | |||||
- | A list of settings you want to delete. | +IP address for the DNS server | +false | +true (ByPropertyName) | ++ | ||||
+ | A list of DHCP ranges for this subnet | false | true (ByPropertyName) | @@ -41856,36 +47352,44 @@ | |||||
- | The HA group identifier. | -true | +dns domain zone prefix ex':' 'adm' -> <hostname>.adm.mydomain.com | +false | true (ByPropertyName) | ||||
- | List of cluster node names with optional priority. | +Subnet Gateway':' Will be assign on vnet for layer3 zones | false | true (ByPropertyName) | |||||
- | 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 | ||||
- | Resources bound to restricted groups may only run on nodes defined by the group. | +The SDN subnet object identifier. | +true | +true (ByPropertyName) | ++ | ||||
+ | associated vnet | false | true (ByPropertyName) | -False | +
Update resource configuration.
+Update sdn zone object configuration.
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>]
The output type is the type of the objects that the cmdlet emits.
-Update realm-sync job definition.
-Set-PveClusterJobsRealmSync [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Delete] <String>] [-EnableNew] [-Enabled] [-Id] <String> [[-RemoveVanished] <String>] [-Schedule] <String> [[-Scope] <String>] [<CommonParameters>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -||||
---|---|---|---|---|---|---|---|---|---|
- | Ticket data connection. | +MTU | false | true (ByPropertyName) | -+ | 0 | |||
- | Description for the Job. | +List of cluster node names. | false | true (ByPropertyName) | |||||
- | A list of settings you want to delete. | +peers address list. | false | true (ByPropertyName) | |||||
- | Enable newly synced users immediately. | +reverse dns api server | false | true (ByPropertyName) | -False | +||||
- | Determines if the job is enabled. | +Route-Target import | false | true (ByPropertyName) | -False | +||||
- | The ID of the job. | -true | +Service-VLAN Tag | +false | true (ByPropertyName) | -+ | 0 | ||
- | 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) | |||||
- | Backup schedule. The format is a subset of `systemd` calendar events. | -true | +l3vni. | +false | true (ByPropertyName) | -+ | 0 | ||
- | Select what to sync. Enum: users,groups,both | +Vxlan tunnel udp port (default 4789). | false | true (ByPropertyName) | +0 | +||||
+ | The SDN zone object identifier. | +true | +true (ByPropertyName) | ||||||
- | A list of settings you want to delete. | +OS architecture type. Enum: amd64,i386,arm64,armhf,riscv32,riscv64 | false | true (ByPropertyName) | |||||
- | 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) | |||||
- | 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 | |||
- | The ID of the logical PCI mapping. | -true | +The number of cores assigned to the container. A container can use all available cores by default. | +false | true (ByPropertyName) | -+ | 0 | ||
- | 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 | |||
- | 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) | -False | +0 |
The output type is the type of the objects that the cmdlet emits.
-Update a hardware mapping.
-Set-PveClusterMappingUsb [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Description] <String>] [[-Digest] <String>] [-Id] <String> [-Map] <Array> [<CommonParameters>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -|||
---|---|---|---|---|---|---|---|---|
- | Ticket data connection. | +Try to be more verbose. For now this only enables debug log-level on start. | false | true (ByPropertyName) | -+ | False | ||
- | 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) | ||||
- | 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) | ||||
- | The ID of the logical USB mapping. | -true | +Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. | +false | true (ByPropertyName) | |||
- | A list of maps for the cluster nodes. | -true | +Allow containers access to advanced features. | +false | true (ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
-Update metric server configuration.
-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>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -|||
---|---|---|---|---|---|---|---|---|
- | Ticket data connection. | +Script that will be exectued during various steps in the containers lifetime. | false | true (ByPropertyName) | ||||
- | 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) | ||||
- | 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) | ||||
- | A list of settings you want to delete. | +Amount of RAM for the container in MB. | +false | +true (ByPropertyName) | +0 | +|||
+ | Use volume as container mount point. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. | false | true (ByPropertyName) | |||||
- | 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) | ||||
- | Flag to disable the plugin. | +Specifies network interfaces for the container. | false | true (ByPropertyName) | -False | +|||
- | The ID of the entry. | +The cluster node name. | true | true (ByPropertyName) | ||||
- | -- Enum: udp,http,https | +Specifies whether a container will be started during system bootup. | +false | +true (ByPropertyName) | +False | +|||
+ | 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,unmanaged | false | true (ByPropertyName) | |||||
- | 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) | -0 | +False | ||
- | MTU for metrics transmission over UDP | +Revert a pending change. | false | true (ByPropertyName) | -0 | +|||
- | 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) | ||||
- | 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) | ||||
- | server network port | -true | +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) | ++ | ||
+ | Amount of SWAP for the container in MB. | +false | true (ByPropertyName) | 0 | ||||
- | Protocol to send graphite data. TCP or UDP (default) Enum: udp,tcp | +Tags of the Container. This is only meta information. | false | true (ByPropertyName) | ||||
- | server dns name or IP address | -true | +Enable/disable Template. | +false | +true (ByPropertyName) | +False | +||
+ | 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.tab | +false | true (ByPropertyName) | |||||
- | graphite TCP socket timeout (default=1) | +Specify the number of tty available to the container | false | true (ByPropertyName) | 0 | |||
- | 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 | ||
- | 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 | ++ | ||
+ | The (unique) ID of the VM. | +true | +true (ByPropertyName) | +0 |
Update existing gotify endpoint
+Update snapshot metadata.
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>]
The output type is the type of the objects that the cmdlet emits.
+Add a standard repository to the configuration
+Set-PveNodesAptRepositories [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Handle] <String> [-Node] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +|||
---|---|---|---|---|---|---|---|---|
- | The name of the endpoint. | -true | +Ticket data connection. | +false | true (ByPropertyName) | |||
- | Server URL | +Digest to detect modifications. | false | true (ByPropertyName) | ||||
- | Secret token | -false | +Handle that identifies a repository. | +true | +true (ByPropertyName) | ++ | ||
+ | The cluster node name. | +true | true (ByPropertyName) | |||||
- | Author of the mail | +The application of the pool. Enum: rbd,cephfs,rgw | false | true (ByPropertyName) | ||||
- | Comment | +The rule to use for mapping object placement in the cluster. | false | true (ByPropertyName) | ||||
- | A list of settings you want to delete. | +Minimum number of replicas per object | false | true (ByPropertyName) | +0 | +|||
+ | The name of the pool. It must be unique. | +true | +true (ByPropertyName) | |||||
- | Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | +The cluster node name. | +true | +true (ByPropertyName) | ++ | |||
+ | The automatic PG scaling mode of the pool. Enum: on,off,warn | false | true (ByPropertyName) | |||||
- | Disable this target | +Number of placement groups. | false | true (ByPropertyName) | -False | +0 | ||
- | `From` address for the mail | +Minimal number of placement groups. | +false | +true (ByPropertyName) | +0 | +|||
+ | Number of replicas per object | +false | +true (ByPropertyName) | +0 | +||||
+ | The estimated target size of the pool for the PG autoscaler. | false | true (ByPropertyName) | |||||
+ | The estimated target ratio of the pool for the PG autoscaler. | +false | +true (ByPropertyName) | +0 | +
The output type is the type of the objects that the cmdlet emits.
+Renew existing certificate from CA.
+Set-PveNodesCertificatesAcmeCertificate [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +|||
---|---|---|---|---|---|---|---|---|
- | List of email recipients | +Ticket data connection. | false | true (ByPropertyName) | ||||
- | List of users | +Force renewal even if expiry is more than 30 days away. | false | true (ByPropertyName) | -+ | False | ||
- | The name of the endpoint. | +The cluster node name. | true | true (ByPropertyName) | @@ -42691,18 +48318,18 @@ | |||
- | Author of the mail. Defaults to 'Proxmox VE'. | +Node specific ACME settings. | false | true (ByPropertyName) | ||||
- | Comment | +ACME domain and validation plugin | false | true (ByPropertyName) | @@ -42752,89 +48379,41 @@ | |||
- | Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | -false | -true (ByPropertyName) | -- | ||||
- | Disable this target | -false | -true (ByPropertyName) | -False | -||||
- | `From` address for the mail | -false | -true (ByPropertyName) | -- | ||||
- | List of email recipients | -false | -true (ByPropertyName) | -- | ||||
- | List of users | +Description for the Node. Shown in the web-interface node notes panel. This is saved as comment inside the configuration file. | false | true (ByPropertyName) | ||||
- | Determine which encryption method shall be used for the connection. Enum: insecure,starttls,tls | +Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | ||||
- | The name of the endpoint. | +The cluster node name. | true | true (ByPropertyName) | ||||
- | Password for SMTP authentication | -false | -true (ByPropertyName) | -- | ||||
- | 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 | |||
- | The address of the SMTP server. | -false | -true (ByPropertyName) | -- | ||||
- | Username for SMTP authentication | +Node specific wake on LAN settings. | false | true (ByPropertyName) | @@ -42848,18 +48427,18 @@ | |||
- | Comment | -false | -true (ByPropertyName) | -- | ||||
- | A list of settings you want to delete. | -false | +Block device name | +true | true (ByPropertyName) | |||
- | Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | -false | +The cluster node name. | +true | true (ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
+Write DNS settings.
+Set-PveNodesDns [[-PveTicket] <PveTicket>] [[-Dns1] <String>] [[-Dns2] <String>] [[-Dns3] <String>] [-Node] <String> [-Search] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +|||
---|---|---|---|---|---|---|---|---|
- | Disable this matcher | -false | -true (ByPropertyName) | -False | -||||
- | Invert match of the whole matcher | -false | -true (ByPropertyName) | -False | -||||
- | Match notification timestamp | +Ticket data connection. | false | true (ByPropertyName) | ||||
- | 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) | ||||
- | Notification severities to match | +Second name server IP address. | false | true (ByPropertyName) | ||||
- | Choose between 'all' and 'any' for when multiple properties are specified Enum: all,any | +Third name server IP address. | false | true (ByPropertyName) | ||||
- | Name of the matcher. | +The cluster node name. | true | true (ByPropertyName) | ||||
- | Targets to notify on match | -false | +Search domain for host-name lookup. | +true | true (ByPropertyName) | |||
- | Set I/O bandwidth limit for various operations (in KiB/s). | +A list of settings you want to delete. | false | true (ByPropertyName) | ||||
- | 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,xtermjs | +Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | ||||
- | Cluster resource scheduling settings. | +Enable host firewall rules. | false | true (ByPropertyName) | -+ | False | ||
- | 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) | ||||
- | 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) | ||||
- | Specify email address to send notification from (default is root@$hostname) | +Enable logging of conntrack information. | false | true (ByPropertyName) | -+ | False | ||
- | 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,both | +Enable NDP (Neighbor Discovery Protocol). | false | true (ByPropertyName) | -+ | False | ||
- | Cluster wide HA settings. | +Allow invalid packets on connection tracking. | false | true (ByPropertyName) | -+ | False | ||
- | 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) | ||||
- | 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 | +Maximum number of tracked connections. | false | true (ByPropertyName) | -+ | 0 | ||
- | 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 | +Conntrack established timeout. | false | true (ByPropertyName) | -+ | 0 | ||
- | 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 | ||
- | 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) | -0 | +False | ||
- | For cluster wide migration settings. | -false | +The cluster node name. | +true | true (ByPropertyName) | |||
- | 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 | |||
- | Control the range for the free VMID auto-selection pool. | -false | -true (ByPropertyName) | -- | ||||
- | Cluster-wide notification settings. | +Enable synflood protection | false | true (ByPropertyName) | -+ | False | ||
- | 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 | ||
- | Tag style options. | +Synflood protection rate syn/sec by ip src. | false | true (ByPropertyName) | -+ | 0 | ||
- | u2f | +Log level for SMURFS filter. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog | false | true (ByPropertyName) | ||||
- | Privilege options for user-settable tags | +Log level for illegal tcp flags filter. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog | false | true (ByPropertyName) | ||||
- | webauthn configuration | +Filter illegal combinations of TCP flags. | false | true (ByPropertyName) | -+ | False |
Update replication job configuration.
+Modify rule data.
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>]
Apply sdn controller changes && reload.
+Set container options.
+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>]
The output type is the type of the objects that the cmdlet emits.
-Update sdn controller object configuration.
-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>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -||||
---|---|---|---|---|---|---|---|---|---|
- | Ticket data connection. | +OS architecture type. Enum: amd64,i386,arm64,armhf,riscv32,riscv64 | false | true (ByPropertyName) | |||||
- | autonomous system number | +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) | -0 | +||||
- | -- | +Attach a console device (/dev/console) to the container. | false | true (ByPropertyName) | False | ||||
- | The SDN controller object identifier. | -true | +The number of cores assigned to the container. A container can use all available cores by default. | +false | true (ByPropertyName) | -+ | 0 | ||
- | 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 | |||
- | 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 | |||
- | Enable ebgp. (remote-as external) | +Try to be more verbose. For now this only enables debug log-level on start. | false | true (ByPropertyName) | False | ||||
- | -- | +A list of settings you want to delete. | false | true (ByPropertyName) | -0 | +||||
- | 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) | |||||
- | ISIS interface. | +Device to pass through to the container | false | true (ByPropertyName) | |||||
- | 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) | |||||
- | source loopback interface. | +Allow containers access to advanced features. | false | true (ByPropertyName) | |||||
- | The cluster node name. | +Script that will be exectued during various steps in the containers lifetime. | false | true (ByPropertyName) | |||||
- | peers address list. | +Set a host name for the container. | false | true (ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
-Update sdn dns object configuration.
-Set-PveClusterSdnDns [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Digest] <String>] [-Dns] <String> [[-Key] <String>] [[-Reversemaskv6] <Int32>] [[-Ttl] <Int32>] [[-Url] <String>] [<CommonParameters>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -|||
---|---|---|---|---|---|---|---|---|
- | Ticket data connection. | +Lock/unlock the container. Enum: backup,create,destroyed,disk,fstrim,migrate,mounted,rollback,snapshot,snapshot-delete | false | true (ByPropertyName) | ||||
- | A list of settings you want to delete. | +Amount of RAM for the container in MB. | +false | +true (ByPropertyName) | +0 | +|||
+ | Use volume as container mount point. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. | false | true (ByPropertyName) | |||||
- | 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) | ||||
- | The SDN dns object identifier. | +Specifies network interfaces for the container. | +false | +true (ByPropertyName) | ++ | |||
+ | The cluster node name. | true | true (ByPropertyName) | |||||
- | -- | +Specifies whether a container will be started during system bootup. | +false | +true (ByPropertyName) | +False | +|||
+ | 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,unmanaged | false | true (ByPropertyName) | |||||
- | -- | +Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation. | false | true (ByPropertyName) | -0 | +False | ||
- | -- | +Revert a pending change. | false | true (ByPropertyName) | -0 | +|||
- | -- | +Use volume as container root. | false | true (ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
-Update sdn ipam object configuration.
-Set-PveClusterSdnIpams [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Digest] <String>] [-Ipam] <String> [[-Section] <Int32>] [[-Token] <String>] [[-Url] <String>] [<CommonParameters>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -|||
---|---|---|---|---|---|---|---|---|
- | 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) | ||||
- | 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) | ||||
- | 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. | +false | +true (ByPropertyName) | +0 | +|||
+ | Tags of the Container. This is only meta information. | false | true (ByPropertyName) | |||||
- | The SDN ipam object identifier. | -true | +Enable/disable Template. | +false | +true (ByPropertyName) | +False | +||
+ | 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.tab | +false | true (ByPropertyName) | |||||
- | -- | +Specify the number of tty available to the container | false | true (ByPropertyName) | 0 | |||
- | -- | +Makes the container run as unprivileged user. (Should not be modified manually.) | false | true (ByPropertyName) | -+ | False | ||
- | -- | +Reference to unused volumes. This is used internally, and should not be modified manually. | false | true (ByPropertyName) | ||||
+ | The (unique) ID of the VM. | +true | +true (ByPropertyName) | +0 | +
Update sdn vnet object configuration.
+Update IP or Network alias.
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>]
Update IP Mapping in a VNet
+Update IP or Network settings
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>]
Update sdn subnet object configuration.
+Set Firewall options.
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>]
Update sdn zone object configuration.
+Modify rule data.
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>]
Add a standard repository to the configuration
+Resize a container mount point.
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>]
Change POOL settings
+Update snapshot metadata.
+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>]
Renew existing certificate from CA.
+Reload network configuration
Set-PveNodesCertificatesAcmeCertificate [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [<CommonParameters>]
+ Set-PveNodesNetwork [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Set node configuration options.
+Update network device configuration
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>]
The output type is the type of the objects that the cmdlet emits.
-Wipe a disk or partition.
-Set-PveNodesDisksWipedisk [[-PveTicket] <PveTicket>] [-Disk] <String> [-Node] <String> [<CommonParameters>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -|||
---|---|---|---|---|---|---|---|---|
- | Ticket data connection. | +OVS interface options. | false | true (ByPropertyName) | ||||
- | Block device name | -true | +Specify the interfaces you want to add to your bridge. | +false | true (ByPropertyName) | |||
- | The cluster node name. | +Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond) | +false | +true (ByPropertyName) | +0 | +|||
+ | Specify the interfaces used by the bonding device. | +false | +true (ByPropertyName) | ++ | ||||
+ | Network interface type Enum: bridge,bond,eth,alias,vlan,OVSBridge,OVSBond,OVSPort,OVSIntPort,unknown | true | true (ByPropertyName) | |||||
+ | vlan-id for a custom named vlan interface (ifupdown2 only). | +false | +true (ByPropertyName) | +0 | +||||
+ | Specify the raw interface for the vlan interface. | +false | +true (ByPropertyName) | ++ |
Write DNS settings.
+Regenerate and change cloudinit config drive.
Set-PveNodesDns [[-PveTicket] <PveTicket>] [[-Dns1] <String>] [[-Dns2] <String>] [[-Dns3] <String>] [-Node] <String> [-Search] <String> [<CommonParameters>]
+ Set-PveNodesQemuCloudinit [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
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.
+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>]
The output type is the type of the objects that the cmdlet emits.
-Modify rule data.
-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>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -|||
---|---|---|---|---|---|---|---|---|
- | Ticket data connection. | +Freeze CPU at startup (use 'c' monitor command to start execution). | +false | +true (ByPropertyName) | +False | +|||
+ | Script that will be executed during various steps in the vms lifetime. | false | true (ByPropertyName) | |||||
- | Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. | +Map host PCI devices into guest. | false | true (ByPropertyName) | ||||
- | 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) | ||||
- | A list of settings you want to delete. | +Enable/disable hugepages memory. Enum: any,2,1024 | false | true (ByPropertyName) | ||||
- | 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) | ||||
- | 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) | ||||
- | 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) | ||||
- | 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) | -0 | +False | ||
- | 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) | ||||
- | 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 level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog | +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 | ||
- | Use predefined standard macro. | +Lock/unlock the VM. Enum: backup,clone,create,migrate,rollback,snapshot,snapshot-delete,suspending,suspended | false | true (ByPropertyName) | ||||
- | Move rule to new position <moveto>. Other arguments are ignored. | +Specify the QEMU machine. | false | true (ByPropertyName) | -0 | +|||
- | The cluster node name. | -true | +Memory properties. | +false | true (ByPropertyName) | |||
- | Update rule at position <pos>. | +Set maximum tolerated downtime (in seconds) for migrations. | false | true (ByPropertyName) | 0 | |||
- | 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 | ||
- | 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) | ||||
- | 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) | ||||
- | Rule type. Enum: in,out,group | +Specify network devices. | false | true (ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
-Set container options.
-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>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -|||
---|---|---|---|---|---|---|---|---|
- | Ticket data connection. | -false | +The cluster node name. | +true | true (ByPropertyName) | |||
- | OS architecture type. Enum: amd64,i386,arm64,armhf,riscv32,riscv64 | +Enable/disable NUMA. | false | true (ByPropertyName) | -+ | False | ||
- | 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 | +NUMA topology. | false | true (ByPropertyName) | ||||
- | Attach a console device (/dev/console) to the container. | +Specifies whether a VM will be started during system bootup. | false | true (ByPropertyName) | False | |||
- | 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 | +|||
- | 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 | +|||
- | 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) | -0 | +False | ||
- | 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 | |||
- | A list of settings you want to delete. | +Revert a pending change. | false | true (ByPropertyName) | ||||
- | 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) | ||||
- | Device to pass through to the container | +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) | ||||
- | 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) | ||||
- | Allow containers access to advanced features. | +SCSI controller model Enum: lsi,lsi53c810,virtio-scsi-pci,virtio-scsi-single,megasas,pvscsi | false | true (ByPropertyName) | ||||
- | 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) | ||||
- | Set a host name for the container. | +Create a serial device inside the VM (n is 0 to 3) | false | true (ByPropertyName) | ||||
- | Lock/unlock the container. Enum: backup,create,destroyed,disk,fstrim,migrate,mounted,rollback,snapshot,snapshot-delete | +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 | +|||
+ | Ignore locks - only root is allowed to use this option. | +false | +true (ByPropertyName) | +False | +||||
+ | Specify SMBIOS type 1 fields. | false | true (ByPropertyName) | |||||
- | Amount of RAM for the container in MB. | +The number of CPUs. Please use option -sockets instead. | false | true (ByPropertyName) | 0 | |||
- | 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. | +false | +true (ByPropertyName) | +0 | +|||
+ | Configure additional enhancements for SPICE. | false | true (ByPropertyName) | |||||
- | 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) | ||||
- | 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) | ||||
- | The cluster node name. | -true | +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) | |||
- | Specifies whether a container will be started during system bootup. | +Enable/disable the USB tablet device. | false | true (ByPropertyName) | False | |||
- | 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,unmanaged | +Tags of the VM. This is only meta information. | false | true (ByPropertyName) | ||||
- | 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 a pending change. | +Enable/disable Template. | false | true (ByPropertyName) | -+ | False | ||
- | 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) | ||||
- | 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 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) | ||||
- | Amount of SWAP for the container in MB. | +Number of hotplugged vcpus. | false | true (ByPropertyName) | 0 | |||
- | Tags of the Container. This is only meta information. | +Configure the VGA hardware. | false | true (ByPropertyName) | ||||
- | 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 | +|||
- | 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.tab | +Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. | false | true (ByPropertyName) | ||||
- | Specify the number of tty available to the container | -false | +The (unique) ID of the VM. | +true | true (ByPropertyName) | 0 | ||
- | Makes the container run as unprivileged user. (Should not be modified manually.) | +Default storage for VM state volumes/files. | false | true (ByPropertyName) | -False | +|||
- | Reference to unused volumes. This is used internally, and should not be modified manually. | +Create a virtual hardware watchdog device. | false | true (ByPropertyName) | ||||
- | The (unique) ID of the VM. | -true | -true (ByPropertyName) | -0 | -
Update IP or Network alias.
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>]
Update IP or Network settings
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>]
Set Firewall options.
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>]
Modify rule data.
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>]
Resize a container mount point.
+Extend volume size.
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>]
Update snapshot metadata.
+Send key event to virtual machine.
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>]
Reload network configuration
+Update snapshot metadata.
+Set-PveNodesNetwork [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
+ Set-PveNodesQemuSnapshotConfig [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
Update network device configuration
+Unlink/delete disk images.
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>]
+ Set-PveNodesQemuUnlink [[-PveTicket] <PveTicket>] [-Force] [-Idlist] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
The output type is the type of the objects that the cmdlet emits.
+Update volume attributes
+Set-PveNodesStorageContent [[-PveTicket] <PveTicket>] [-Node] <String> [[-Notes] <String>] [-Protected] [[-Storage] <String>] [-Volume] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +|||
---|---|---|---|---|---|---|---|---|
- | Network mask. | +Ticket data connection. | false | true (ByPropertyName) | ||||
- | Network mask. | -false | -true (ByPropertyName) | -0 | -||||
@@ -46476,74 +52091,95 @@ | ||||||||
- | Specify the interfaces used by the bonding device. | +The new notes. | false | true (ByPropertyName) | ||||
- | 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 | ||
- | OVS interface options. | +The storage identifier. | false | true (ByPropertyName) | ||||
- | Specify the interfaces you want to add to your bridge. | -false | +Volume identifier | +true | true (ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
+Set subscription key.
+Set-PveNodesSubscription [[-PveTicket] <PveTicket>] [-Key] <String> [-Node] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +|||
---|---|---|---|---|---|---|---|---|
- | Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond) | -false | -true (ByPropertyName) | -0 | -||||
- | Specify the interfaces used by the bonding device. | +Ticket data connection. | false | true (ByPropertyName) | ||||
- | Network interface type Enum: bridge,bond,eth,alias,vlan,OVSBridge,OVSBond,OVSPort,OVSIntPort,unknown | +Proxmox VE subscription key | true | true (ByPropertyName) | ||||
- | vlan-id for a custom named vlan interface (ifupdown2 only). | -false | -true (ByPropertyName) | -0 | -||||
- | Specify the raw interface for the vlan interface. | -false | +The cluster node name. | +true | true (ByPropertyName) | |||
- | 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 | ++ |
The output type is the type of the objects that the cmdlet emits.
+Update pool.
+Set-PvePools [[-PveTicket] <PveTicket>] [-AllowMove] [[-Comment] <String>] [-Delete] [-Poolid] <String> [[-Storage] <String>] [[-Vms] <String>] [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | Allow adding a guest even if already in another pool. The guest will be removed from its current pool and added to this one. | +false | +true (ByPropertyName) | +False | +|
+ | -- | +false | +true (ByPropertyName) | ++ | |
+ | Remove the passed VMIDs and/or storage IDs instead of adding them. | +false | +true (ByPropertyName) | +False | +|
+ | -- | +true | +true (ByPropertyName) | ++ | |
+ | List of storage IDs to add or remove from this pool. | +false | +true (ByPropertyName) | ++ | |
+ | List of guest VMIDs to add or remove from this pool. | +false | +true (ByPropertyName) | ++ |
The output type is the type of the objects that the cmdlet emits.
+Update pool data (deprecated, no support for nested pools - use 'PUT /pools/?poolid={poolid}' instead).
+Set-PvePoolsIdx [[-PveTicket] <PveTicket>] [-AllowMove] [[-Comment] <String>] [-Delete] [-Poolid] <String> [[-Storage] <String>] [[-Vms] <String>] [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | Allow adding a guest even if already in another pool. The guest will be removed from its current pool and added to this one. | +false | +true (ByPropertyName) | +False | +|
+ | -- | +false | +true (ByPropertyName) | ++ | |
+ | Remove the passed VMIDs and/or storage IDs instead of adding them. | +false | +true (ByPropertyName) | +False | +|
+ | -- | +true | +true (ByPropertyName) | ++ | |
+ | List of storage IDs to add or remove from this pool. | +false | +true (ByPropertyName) | ++ | |
+ | List of guest VMIDs to add or remove from this pool. | +false | +true (ByPropertyName) | +
The output type is the type of the objects that the cmdlet emits.
-Update IP or Network alias.
-Set-PveNodesQemuFirewallAliases [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [[-Rename] <String>] [-Vmid] <Int32> [<CommonParameters>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -False | +|||
---|---|---|---|---|---|---|---|---|---|
- | Ticket data connection. | +Enable/disable Template. | false | true (ByPropertyName) | -+ | False | |||
- | Network/IP specification in CIDR format. | -true | +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) | ||||
- | -- | +Reference to unused volumes. This is used internally, and should not be modified manually. | false | true (ByPropertyName) | |||||
- | 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) | |||||
- | Alias name. | -true | +Number of hotplugged vcpus. | +false | +true (ByPropertyName) | +0 | +|||
+ | Configure the VGA hardware. | +false | true (ByPropertyName) | ||||||
- | The cluster node name. | -true | +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) | ||||
- | Rename an existing alias. | +Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. | false | true (ByPropertyName) | @@ -47426,6 +53131,22 @@ | true (ByPropertyName) | 0 | ||
+ | Default storage for VM state volumes/files. | +false | +true (ByPropertyName) | ++ | |||||
+ | Create a virtual hardware watchdog device. | +false | +true (ByPropertyName) | ++ |
Update IP or Network settings
+Update snapshot metadata.
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>]
Set Firewall options.
+Update storage configuration.
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>]
The output type is the type of the objects that the cmdlet emits.
-Modify rule data.
-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>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -|||
---|---|---|---|---|---|---|---|---|
- | Ticket data connection. | +CIFS domain. | false | true (ByPropertyName) | ||||
- | Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. | +Encryption key. Use 'autogen' to generate one automatically without passphrase. | false | true (ByPropertyName) | ||||
- | Descriptive comment. | +Certificate SHA 256 fingerprint. | false | true (ByPropertyName) | ||||
- | A list of settings you want to delete. | +Default image format. | false | true (ByPropertyName) | ||||
- | 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) | ||||
- | 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 | ||
- | 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) | ||||
- | Flag to enable/disable a rule. | -false | -true (ByPropertyName) | -0 | -||||
- | Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. | +Client keyring contents (for external clusters). | false | true (ByPropertyName) | ||||
- | 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 level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog | +target portal group for Linux LIO targets | false | true (ByPropertyName) | ||||
- | 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) | ||||
- | 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 | |||
- | The cluster node name. | -true | -true (ByPropertyName) | -- | ||||
- | 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 | |||
- | 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 | ||
- | 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) | ||||
- | 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) | ||||
- | Rule type. Enum: in,out,group | +Namespace. | false | true (ByPropertyName) | ||||
- | The (unique) ID of the VM. | -true | -true (ByPropertyName) | -0 | -
The output type is the type of the objects that the cmdlet emits.
-Extend volume size.
-Set-PveNodesQemuResize [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Disk] <String> [-Node] <String> [-Size] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -|||
---|---|---|---|---|---|---|---|---|
- | 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 | ||
- | 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) | ||||
- | 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) | -- | ||||
- | The cluster node name. | -true | -true (ByPropertyName) | -- | ||||
- | 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) | -- | ||||
- | Ignore locks - only root is allowed to use this option. | +disable write caching on the target | false | true (ByPropertyName) | False | |||
- | The (unique) ID of the VM. | -true | -true (ByPropertyName) | -0 | -
The output type is the type of the objects that the cmdlet emits.
-Send key event to virtual machine.
-Set-PveNodesQemuSendkey [[-PveTicket] <PveTicket>] [-Key] <String> [-Node] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -|||
---|---|---|---|---|---|---|---|---|
- | Ticket data connection. | +NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs') | false | true (ByPropertyName) | ||||
- | The key (qemu monitor encoding). | -true | +Password for accessing the share/datastore. | +false | true (ByPropertyName) | |||
- | The cluster node name. | -true | +Pool. | +false | true (ByPropertyName) | |||
- | Ignore locks - only root is allowed to use this option. | +For non default port. | false | true (ByPropertyName) | -False | -|||
- | The (unique) ID of the VM. | -true | -true (ByPropertyName) | 0 |
The output type is the type of the objects that the cmdlet emits.
-Update snapshot metadata.
-Set-PveNodesQemuSnapshotConfig [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -||||
---|---|---|---|---|---|---|---|---|---|
- | 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) | |||||
- | 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) | |||||
- | The cluster node name. | -true | +Zero-out data when removing LVs. | +false | true (ByPropertyName) | -+ | False | ||
- | The name of the snapshot. | -true | +Wipe throughput (cstream -t parameter value). | +false | true (ByPropertyName) | ||||
- | The (unique) ID of the VM. | -true | +Server IP or DNS name. | +false | true (ByPropertyName) | -0 | +
The output type is the type of the objects that the cmdlet emits.
-Unlink/delete disk images.
-Set-PveNodesQemuUnlink [[-PveTicket] <PveTicket>] [-Force] [-Idlist] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -||||
---|---|---|---|---|---|---|---|---|---|
- | Ticket data connection. | +Backup volfile server IP or DNS name. | false | true (ByPropertyName) | |||||
- | 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. | +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 | ||||
- | A list of disk IDs you want to delete. | -true | +Disable TLS certificate verification, only enable on fully trusted networks! | +false | true (ByPropertyName) | -+ | False | ||
- | The cluster node name. | -true | +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) | ||||
- | The (unique) ID of the VM. | -true | -true (ByPropertyName) | -0 | -
The output type is the type of the objects that the cmdlet emits.
-Update volume attributes
-Set-PveNodesStorageContent [[-PveTicket] <PveTicket>] [-Node] <String> [[-Notes] <String>] [-Protected] [[-Storage] <String>] [-Volume] <String> [<CommonParameters>]
- Name | -Alias | -Description | -Required? | -Pipeline Input | -Default Value | -|||
---|---|---|---|---|---|---|---|---|
- | Ticket data connection. | +use sparse volumes | false | true (ByPropertyName) | -+ | False | ||
- | The cluster node name. | +The storage identifier. | true | true (ByPropertyName) | ||||
- | The new notes. | +Subdir to mount. | false | true (ByPropertyName) | ||||
- | Protection status. Currently only supported for backups. | +Only use logical volumes tagged with 'pve-vm-ID'. | false | true (ByPropertyName) | False | |||
- | The storage identifier. | +Gluster transport':' tcp or rdma Enum: tcp,rdma,unix | false | true (ByPropertyName) | ||||
- | Volume identifier | -true | +RBD Id. | +false | true (ByPropertyName) | Ticket data connection. | false | -true (ByPropertyName) | +true (ByValue, ByPropertyName) |
- | Proxmox VE subscription key | +The (unique) ID or Name of the VM. | true | -true (ByPropertyName) | +true (ByValue, ByPropertyName) | |||
- | The cluster node name. | +Path of Spice remove viewer.- Linux /usr/bin/remote-viewer- Windows C:\Program Files\VirtViewer v?.?-???\bin\remote-viewer.exe | true | -true (ByPropertyName) | +true (ByValue, ByPropertyName) | true (ByPropertyName) | + | |
+ | Make sure the Container stops. | +false | +true (ByPropertyName) | +False | +||||
@@ -48405,12 +53800,20 @@ | ||||||||
- | Time zone. The file '/usr/share/zoneinfo/zone.tab' contains the list of valid names. | +Wait maximal timeout seconds. | +false | +true (ByPropertyName) | +0 | +|||
+ | The (unique) ID of the VM. | true | true (ByPropertyName) | -+ | 0 |
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.
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>]
Update pool data (deprecated, no support for nested pools - use 'PUT /pools/?poolid={poolid}' instead).
+Start the container.
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>]
Update storage configuration.
+Start virtual machine.
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>]
The output type is the type of the objects that the cmdlet emits.
+Start VM.
+Start-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +||||
---|---|---|---|---|---|---|---|---|---|
- | Preallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off. Enum: off,metadata,falloc,full | +Ticket data connection. | false | -true (ByPropertyName) | +true (ByValue, ByPropertyName) | ||||
- | 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) | +The (unique) ID or Name of the VM. | +true | +true (ByValue, ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
+Stop the container. This will abruptly stop all processes running in the container.
+New-PveNodesLxcStatusStop [[-PveTicket] <PveTicket>] [-Node] <String> [-OverruleShutdown] [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +||||
---|---|---|---|---|---|---|---|---|---|
- | Zero-out data when removing LVs. | +Ticket data connection. | false | true (ByPropertyName) | -False | +||||
- | Wipe throughput (cstream -t parameter value). | -false | +The cluster node name. | +true | true (ByPropertyName) | ||||
- | Server IP or DNS name. | +Try to abort active 'vzshutdown' tasks before stopping. | false | true (ByPropertyName) | -+ | False | |||
- | Backup volfile server IP or DNS name. | +Ignore locks - only root is allowed to use this option. | false | true (ByPropertyName) | -+ | False | |||
- | 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 | +The (unique) ID of the VM. | +true | true (ByPropertyName) | -False | +0 |
The output type is the type of the objects that the cmdlet emits.
+New-PveNodesQeumStatusStop
+ +
+ Stop VM.
+Stop-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +||||
---|---|---|---|---|---|---|---|---|---|
- | Disable TLS certificate verification, only enable on fully trusted networks! | +Ticket data connection. | false | -true (ByPropertyName) | -False | +true (ByValue, ByPropertyName) | +|||
- | 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) | +The (unique) ID or Name of the VM. | +true | +true (ByValue, ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
+Suspend the container. This is experimental.
+New-PveNodesLxcStatusSuspend [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +|||
---|---|---|---|---|---|---|---|---|
- | use sparse volumes | +Ticket data connection. | false | true (ByPropertyName) | -False | +|||
- | The storage identifier. | +The cluster node name. | true | true (ByPropertyName) | ||||
- | Subdir to mount. | +The (unique) ID of the VM. | +true | +true (ByPropertyName) | +0 | +
The output type is the type of the objects that the cmdlet emits.
+Suspend virtual machine.
+New-PveNodesQemuStatusSuspend [[-PveTicket] <PveTicket>] [-Node] <String> [-Skiplock] [[-Statestorage] <String>] [-Todisk] [-Vmid] <Int32> [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +|||
---|---|---|---|---|---|---|---|---|
+ | Ticket data connection. | false | true (ByPropertyName) | |||||
- | Only use logical volumes tagged with 'pve-vm-ID'. | +The cluster node name. | +true | +true (ByPropertyName) | ++ | |||
+ | Ignore locks - only root is allowed to use this option. | false | true (ByPropertyName) | False | ||||
- | Gluster transport':' tcp or rdma Enum: tcp,rdma,unix | +The storage for the VM state | false | true (ByPropertyName) | ||||
- | RBD Id. | +If set, suspends the VM to disk. Will be resumed on next VM start. | false | true (ByPropertyName) | -+ | False | +||
+ | The (unique) ID of the VM. | +true | +true (ByPropertyName) | +0 |
Start VM.
+Suspend VM.
Start-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]
+ Suspend-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]
Stop VM.
+Rollback LXC state to specified snapshot.
Stop-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]
+ New-PveNodesLxcSnapshotRollback [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Start] [-Vmid] <Int32> [<CommonParameters>]
Suspend VM.
+Rollback VM state to specified snapshot.
Suspend-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]
+ New-PveNodesQemuSnapshotRollback [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Start] [-Vmid] <Int32> [<CommonParameters>]
The output type is the type of the objects that the cmdlet emits.
+This is used to resynchronize the package index files from their sources (apt-get update).
+New-PveNodesAptUpdate [[-PveTicket] <PveTicket>] [-Node] <String> [-Notify] [-Quiet] [<CommonParameters>]
+ Name | +Alias | +Description | +Required? | +Pipeline Input | +Default Value | +
---|---|---|---|---|---|
+ | Ticket data connection. | +false | +true (ByPropertyName) | ++ | |
+ | The cluster node name. | +true | +true (ByPropertyName) | ++ | |
+ | Send notification about new packages. | +false | +true (ByPropertyName) | +False | +|
+ | Only produces output suitable for logging, omitting progress indicators. | +false | +true (ByPropertyName) | +False | +
The output type is the type of the objects that the cmdlet emits.
@@ -49446,7 +54974,7 @@