forked from scriptrunner/ActionPacks
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathGet-VMHVTask.ps1
82 lines (68 loc) · 2.83 KB
/
Get-VMHVTask.ps1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
#Requires -Version 5.0
# Requires -Modules VMware.VimAutomation.Common
<#
.SYNOPSIS
Retrieves information about the current or recent tasks
.DESCRIPTION
.NOTES
This PowerShell script was developed and optimized for ScriptRunner. The use of the scripts requires ScriptRunner.
The customer or user is authorized to copy the script from the repository and use them in ScriptRunner.
The terms of use for ScriptRunner do not apply to this script. In particular, ScriptRunner Software GmbH assumes no liability for the function,
the use and the consequences of the use of this freely available script.
PowerShell is a product of Microsoft Corporation. ScriptRunner is a product of ScriptRunner Software GmbH.
© ScriptRunner Software GmbH
.COMPONENT
Requires Module VMware.VimAutomation.Common
.LINK
https://github.com/scriptrunner/ActionPacks/tree/master/VMware/Tasks
.Parameter VIServer
[sr-en] IP address or the DNS name of the vSphere server to which you want to connect
[sr-de] IP Adresse oder DNS des vSphere Servers
.Parameter VICredential
[sr-en] PSCredential object that contains credentials for authenticating with the server
[sr-de] Benutzerkonto für die Ausführung
.Parameter Status
[sr-en] Status of the tasks you want to retrieve
[sr-de] Task Status
.Parameter Properties
[sr-en] List of properties to expand. Use * for all properties
[sr-de] Liste der zu anzuzeigenden Eigenschaften. Verwenden Sie * für alle Eigenschaften
#>
[CmdLetBinding()]
Param(
[Parameter(Mandatory = $true)]
[string]$VIServer,
[Parameter(Mandatory = $true)]
[pscredential]$VICredential,
[ValidateSet("Error","Queued","Running","Success")]
[string]$Status,
[ValidateSet('*','Description','State','IsCancelable','StartTime','FinishTime','PercentComplete','Name')]
[string[]]$Properties = @('Description','State','IsCancelable','StartTime','FinishTime','PercentComplete','Name')
)
Import-Module VMware.VimAutomation.Common
try{
if($Properties -contains '*'){
$Properties = @('*')
}
$Script:vmServer = Connect-VIServer -Server $VIServer -Credential $VICredential -ErrorAction Stop
if([System.String]::IsNullOrWhiteSpace($Status) -eq $true){
$Script:Output = Get-Task -Server $Script:vmServer -ErrorAction Stop | Select-Object $Properties
}
else {
$Script:Output = Get-Task -Server $Script:vmServer -Status $Status -ErrorAction Stop | Select-Object $Properties
}
if($SRXEnv) {
$SRXEnv.ResultMessage = $Script:Output
}
else{
Write-Output $Script:Output
}
}
catch{
throw
}
finally{
if($null -ne $Script:vmServer){
Disconnect-VIServer -Server $Script:vmServer -Force -Confirm:$false
}
}