Clint Branham
94424367bf
F058 (critical): Replace while(true) infinite-loop task polling with TaskService.WaitForTask in 5 container snapshot and storage cmdlets. F073+F047 (high): Migrate net9.0 → net10.0 across both source .csproj files, build.yml, publish.yml, and test helper. F071 (medium): Add Uri.EscapeDataString() to all inline URL path segments in ~16 cmdlets that bypass service classes (D003). F062+F063 (medium): Add ConfirmImpact.High to Restart-PveContainer and Suspend-PveContainer (D006). F075 (medium): Generate markdown help docs for 89 cmdlets that were missing documentation (170 total, up from 81). F072 (low): Remove unused System.Text.Json dependency from Core.csproj. F074 (low): Raise publish smoke-test threshold from 60 to 150. F065 (low): Add .github/ISSUE_TEMPLATE/config.yml. F066 (low): Add CODEOWNERS. Also fix _TestHelper.ps1 net9.0 → net10.0 framework reference. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
3.8 KiB
external help file, Module Name, online version, schema
| external help file | Module Name | online version | schema |
|---|---|---|---|
| PSProxmoxVE.dll-Help.xml | PSProxmoxVE | 2.0.0 |
New-PveBackup
SYNOPSIS
Creates an ad-hoc backup of a virtual machine via vzdump.
SYNTAX
New-PveBackup [-Node] <String> [-VmId] <Int32> [-Storage <String>] [-Mode <String>] [-Compress <String>]
[-Wait] [-Timeout <Int32>] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Triggers an immediate backup (vzdump) of the specified VM on the given node. Returns a PveTask representing the backup operation. Use -Wait to block until the backup completes.
EXAMPLES
Example 1
PS C:\> New-PveBackup -Node "pve1" -VmId 100 -Storage "backup-store" -Mode snapshot -Wait
Creates a snapshot backup of VM 100 and waits for completion.
PARAMETERS
-Node
The PVE node name.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-VmId
The VM identifier.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Storage
The target storage for the backup.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Mode
The backup mode.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: snapshot, suspend, stop
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Compress
The compression algorithm.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: zstd, lzo, gzip, none
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Wait
Wait for the task to complete before returning.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Timeout
Timeout in seconds for -Wait (default 3600).
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 3600
Accept pipeline input: False
Accept wildcard characters: False
-Session
{{ Fill Session Description }}
Type: PveSession
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.