|
| 1 | +--- |
| 2 | +external help file: Corsinvest.ProxmoxVE.Api-help.xml |
| 3 | +Module Name: Corsinvest.ProxmoxVE.Api |
| 4 | +online version: |
| 5 | +schema: 2.0.0 |
| 6 | +--- |
| 7 | + |
| 8 | +# Wait-PveTaskIsFinishedWithProgress |
| 9 | + |
| 10 | +## SYNOPSIS |
| 11 | + |
| 12 | +## SYNTAX |
| 13 | + |
| 14 | +``` |
| 15 | +Wait-PveTaskIsFinishedWithProgress [[-PveTicket] <PveTicket>] [-Upid] <String> [[-Wait] <Int32>] |
| 16 | + [[-Timeout] <Int32>] [[-ProgressActivityText] <String>] [[-ProgressStatusText] <String>] |
| 17 | + [[-ProgessActivityId] <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>] |
| 18 | +``` |
| 19 | + |
| 20 | +## DESCRIPTION |
| 21 | +Wait for a task to finish, show Powershell Progressbar while waiting |
| 22 | + |
| 23 | +## EXAMPLES |
| 24 | + |
| 25 | +### Example 1 |
| 26 | +```powershell |
| 27 | +PS C:\> {{ Add example code here }} |
| 28 | +``` |
| 29 | + |
| 30 | +{{ Add example description here }} |
| 31 | + |
| 32 | +## PARAMETERS |
| 33 | + |
| 34 | +### -PveTicket |
| 35 | +Ticket data connection. |
| 36 | + |
| 37 | +```yaml |
| 38 | +Type: PveTicket |
| 39 | +Parameter Sets: (All) |
| 40 | +Aliases: |
| 41 | + |
| 42 | +Required: False |
| 43 | +Position: 1 |
| 44 | +Default value: None |
| 45 | +Accept pipeline input: True (ByPropertyName, ByValue) |
| 46 | +Accept wildcard characters: False |
| 47 | +``` |
| 48 | +
|
| 49 | +### -Upid |
| 50 | +Upid task e.g UPID:pve1:00004A1A:0964214C:5EECEF11:vzdump:134:root@pam: |
| 51 | +
|
| 52 | +```yaml |
| 53 | +Type: String |
| 54 | +Parameter Sets: (All) |
| 55 | +Aliases: |
| 56 | + |
| 57 | +Required: True |
| 58 | +Position: 2 |
| 59 | +Default value: None |
| 60 | +Accept pipeline input: True (ByPropertyName, ByValue) |
| 61 | +Accept wildcard characters: False |
| 62 | +``` |
| 63 | +
|
| 64 | +### -Wait |
| 65 | +Millisecond wait next check |
| 66 | +
|
| 67 | +```yaml |
| 68 | +Type: Int32 |
| 69 | +Parameter Sets: (All) |
| 70 | +Aliases: |
| 71 | + |
| 72 | +Required: False |
| 73 | +Position: 3 |
| 74 | +Default value: 500 |
| 75 | +Accept pipeline input: True (ByPropertyName, ByValue) |
| 76 | +Accept wildcard characters: False |
| 77 | +``` |
| 78 | +
|
| 79 | +### -Timeout |
| 80 | +Millisecond timeout |
| 81 | +
|
| 82 | +```yaml |
| 83 | +Type: Int32 |
| 84 | +Parameter Sets: (All) |
| 85 | +Aliases: |
| 86 | + |
| 87 | +Required: False |
| 88 | +Position: 4 |
| 89 | +Default value: 10000 |
| 90 | +Accept pipeline input: True (ByPropertyName, ByValue) |
| 91 | +Accept wildcard characters: False |
| 92 | +``` |
| 93 | +
|
| 94 | +### -ProgressActivityText |
| 95 | +Acitivity (Text) for Write-Progress, defaults to Upid when empty |
| 96 | +
|
| 97 | +```yaml |
| 98 | +Type: String |
| 99 | +Parameter Sets: (All) |
| 100 | +Aliases: |
| 101 | + |
| 102 | +Required: False |
| 103 | +Position: 5 |
| 104 | +Default value: None |
| 105 | +Accept pipeline input: True (ByPropertyName, ByValue) |
| 106 | +Accept wildcard characters: False |
| 107 | +``` |
| 108 | +
|
| 109 | +### -ProgressStatusText |
| 110 | +Status-Text for Write-Progress, default is "Waiting...", is shown in front of remaining time and percent |
| 111 | +
|
| 112 | +```yaml |
| 113 | +Type: String |
| 114 | +Parameter Sets: (All) |
| 115 | +Aliases: |
| 116 | + |
| 117 | +Required: False |
| 118 | +Position: 6 |
| 119 | +Default value: Waiting... |
| 120 | +Accept pipeline input: True (ByPropertyName, ByValue) |
| 121 | +Accept wildcard characters: False |
| 122 | +``` |
| 123 | +
|
| 124 | +### -ProgessActivityId |
| 125 | +Id for Write-Progress, change when other Write-Progress is already shown |
| 126 | +
|
| 127 | +```yaml |
| 128 | +Type: Int32 |
| 129 | +Parameter Sets: (All) |
| 130 | +Aliases: |
| 131 | + |
| 132 | +Required: False |
| 133 | +Position: 7 |
| 134 | +Default value: 1 |
| 135 | +Accept pipeline input: True (ByPropertyName, ByValue) |
| 136 | +Accept wildcard characters: False |
| 137 | +``` |
| 138 | +
|
| 139 | +### -ProgressAction |
| 140 | +{{ Fill ProgressAction Description }} |
| 141 | +
|
| 142 | +```yaml |
| 143 | +Type: ActionPreference |
| 144 | +Parameter Sets: (All) |
| 145 | +Aliases: proga |
| 146 | + |
| 147 | +Required: False |
| 148 | +Position: Named |
| 149 | +Default value: None |
| 150 | +Accept pipeline input: False |
| 151 | +Accept wildcard characters: False |
| 152 | +``` |
| 153 | +
|
| 154 | +### CommonParameters |
| 155 | +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). |
| 156 | +
|
| 157 | +## INPUTS |
| 158 | +
|
| 159 | +## OUTPUTS |
| 160 | +
|
| 161 | +### Bool. $True Return task is done within Timeout, $False if not |
| 162 | +## NOTES |
| 163 | +
|
| 164 | +## RELATED LINKS |
0 commit comments