Wait-PveTaskIsFinishedWithProgress¶
SYNOPSIS¶
SYNTAX¶
Wait-PveTaskIsFinishedWithProgress [[-PveTicket] <PveTicket>] [-Upid] <String> [[-Wait] <Int32>]
[[-Timeout] <Int32>] [[-ProgressActivityText] <String>] [[-ProgressStatusText] <String>]
[[-ProgessActivityId] <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION¶
Wait for a task to finish, show Powershell Progressbar while waiting
EXAMPLES¶
Example 1¶
{{ Add example description here }}
PARAMETERS¶
-PveTicket¶
Ticket data connection.
Type: PveTicket
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-Upid¶
Upid task e.g UPID:pve1:00004A1A:0964214C:5EECEF11:vzdump:134:root@pam:
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-Wait¶
Millisecond wait next check
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 500
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-Timeout¶
Millisecond timeout
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 10000
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-ProgressActivityText¶
Acitivity (Text) for Write-Progress, defaults to Upid when empty
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-ProgressStatusText¶
Status-Text for Write-Progress, default is "Waiting...", is shown in front of remaining time and percent
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: Waiting...
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-ProgessActivityId¶
Id for Write-Progress, change when other Write-Progress is already shown
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: 1
Accept pipeline input: True (ByPropertyName, ByValue)
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.