mirror of
https://github.com/GoodOlClint/PSProxmoxVE.git
synced 2026-07-26 07:58:14 +00:00
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>
308 lines
5.1 KiB
Markdown
308 lines
5.1 KiB
Markdown
---
|
|
external help file: PSProxmoxVE.dll-Help.xml
|
|
Module Name: PSProxmoxVE
|
|
online version:
|
|
schema: 2.0.0
|
|
---
|
|
|
|
# Set-PveBackupJob
|
|
|
|
## SYNOPSIS
|
|
Updates a scheduled backup job on Proxmox VE.
|
|
|
|
## SYNTAX
|
|
|
|
```
|
|
Set-PveBackupJob [-Id] <String> [-Schedule <String>] [-Storage <String>] [-Mode <String>]
|
|
[-VmId <String>] [-All] [-Compress <String>] [-Node <String>] [-MailTo <String>]
|
|
[-MailNotification <String>] [-Enabled] [-Comment <String>] [-PruneBackups <String>]
|
|
[-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
|
|
```
|
|
|
|
## DESCRIPTION
|
|
Modifies properties of an existing backup job. Only specified parameters are updated.
|
|
|
|
## EXAMPLES
|
|
|
|
### Example 1
|
|
```powershell
|
|
PS C:\> Set-PveBackupJob -Id backup-abc -Schedule '0 3 * * *'
|
|
```
|
|
|
|
## PARAMETERS
|
|
|
|
### -Id
|
|
The backup job ID.
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: (All)
|
|
Aliases:
|
|
|
|
Required: True
|
|
Position: 0
|
|
Default value: None
|
|
Accept pipeline input: True (ByPropertyName)
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -Schedule
|
|
Cron-style schedule expression.
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: (All)
|
|
Aliases:
|
|
|
|
Required: False
|
|
Position: Named
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -Storage
|
|
The target storage for backups.
|
|
|
|
```yaml
|
|
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.
|
|
|
|
```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
|
|
```
|
|
|
|
### -VmId
|
|
Comma-separated list of VM IDs to back up.
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: (All)
|
|
Aliases:
|
|
|
|
Required: False
|
|
Position: Named
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -All
|
|
Back up all VMs.
|
|
|
|
```yaml
|
|
Type: SwitchParameter
|
|
Parameter Sets: (All)
|
|
Aliases:
|
|
|
|
Required: False
|
|
Position: Named
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -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
|
|
```
|
|
|
|
### -Node
|
|
The node to restrict the backup job to.
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: (All)
|
|
Aliases:
|
|
|
|
Required: False
|
|
Position: Named
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -MailTo
|
|
Email address(es) for notifications.
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: (All)
|
|
Aliases:
|
|
|
|
Required: False
|
|
Position: Named
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -MailNotification
|
|
When to send email notifications.
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: (All)
|
|
Aliases:
|
|
|
|
Accepted values: always, failure
|
|
|
|
Required: False
|
|
Position: Named
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -Enabled
|
|
Enable or disable the backup job.
|
|
|
|
```yaml
|
|
Type: SwitchParameter
|
|
Parameter Sets: (All)
|
|
Aliases:
|
|
|
|
Required: False
|
|
Position: Named
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -Comment
|
|
A comment or description for the backup job.
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: (All)
|
|
Aliases:
|
|
|
|
Required: False
|
|
Position: Named
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -PruneBackups
|
|
Prune-backups configuration string.
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: (All)
|
|
Aliases:
|
|
|
|
Required: False
|
|
Position: Named
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
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
|
|
```
|
|
|
|
### -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
|
|
```
|
|
|
|
### -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
|
|
```
|
|
|
|
### -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
|
|
## OUTPUTS
|
|
|
|
### System.Void
|
|
## NOTES
|
|
|
|
## RELATED LINKS
|