forked from scriptrunner/ActionPacks
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathGet-VMHVTask.ps1
More file actions
77 lines (63 loc) · 2.42 KB
/
Copy pathGet-VMHVTask.ps1
File metadata and controls
77 lines (63 loc) · 2.42 KB
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
#Requires -Version 4.0
# Requires -Modules VMware.PowerCLI
<#
.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, AppSphere AG 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 AppSphere AG.
© AppSphere AG
.COMPONENT
Requires Module VMware.PowerCLI
.LINK
https://github.com/scriptrunner/ActionPacks/tree/master/VMware/Tasks
.Parameter VIServer
Specifies the IP address or the DNS name of the vSphere server to which you want to connect
.Parameter VICredential
Specifies a PSCredential object that contains credentials for authenticating with the server
.Parameter Status
Specifies the status of the tasks you want to retrieve
.Parameter Properties
List of properties to expand, comma separated e.g. Description,StartTime. Use * for all properties
#>
[CmdLetBinding()]
Param(
[Parameter(Mandatory = $true)]
[string]$VIServer,
[Parameter(Mandatory = $true)]
[pscredential]$VICredential,
[ValidateSet("Error","Queued","Running","Success")]
[string]$Status,
[string]$Properties = "Description,State,IsCancelable,StartTime,FinishTime,PercentComplete,Name"
)
Import-Module VMware.PowerCLI
try{
if([System.String]::IsNullOrWhiteSpace($Properties) -eq $true){
$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.Split(",")
}
else {
$Script:Output = Get-Task -Server $Script:vmServer -Status $Status -ErrorAction Stop | Select-Object $Properties.Split(",")
}
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
}
}