--- external help file: PSProxmoxVE.dll-Help.xml Module Name: PSProxmoxVE online version: schema: 2.0.0 --- # New-PveBackup ## SYNOPSIS Creates an ad-hoc backup of a virtual machine via vzdump. ## SYNTAX ``` New-PveBackup [-Node] [-VmId] [-Storage ] [-Mode ] [-Compress ] [-Wait] [-Timeout ] [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## 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 ```powershell 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 ### -Compress The compression algorithm. ```yaml 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 ``` ### -Confirm Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Mode The backup mode. ```yaml 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 ``` ### -Node The PVE node name. ```yaml Type: String Parameter Sets: (All) Aliases: Required: True Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` ### -Session {{ Fill Session Description }} ```yaml Type: PveSession Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Storage The target storage for the backup. ```yaml Type: String 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). ```yaml Type: Int32 Parameter Sets: (All) Aliases: Required: False Position: Named Default value: 3600 Accept pipeline input: False Accept wildcard characters: False ``` ### -VmId The VM identifier. ```yaml Type: Int32 Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` ### -Wait Wait for the task to complete before returning. ```yaml Type: SwitchParameter 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. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -ProgressAction {{ Fill ProgressAction Description }} ```yaml 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### System.String ### System.Int32 ## OUTPUTS ### PSProxmoxVE.Core.Models.Vms.PveTask ## NOTES ## RELATED LINKS