forked from scriptrunner/ActionPacks
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathRemove-CTXApplicationGroupMetadata.ps1
94 lines (79 loc) · 3.18 KB
/
Remove-CTXApplicationGroupMetadata.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
83
84
85
86
87
88
89
90
91
92
93
94
#Requires -Version 5.0
<#
.SYNOPSIS
Deletes Metadata from the Application Group object
.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 the library script CitrixLibrary.ps1
Requires PSSnapIn Citrix*
.LINK
https://github.com/scriptrunner/ActionPacks/blob/master/Citrix/Applications
.Parameter SiteServer
[sr-en] Address of a XenDesktop controller.
This can be provided as a host name or an IP address
[sr-de] Name oder IP Adresse des XenDesktop Controllers
.Parameter GroupName
[sr-en] Name of the application group
[sr-de] Name der Anwendungsgruppe
.Parameter GroupUid
[sr-en] Uid of the application group
[sr-de] Uid der Anwendungsgruppe
.Parameter PropertyName
[sr-en] Name of the metadata to be deleted
[sr-de] Name der Eigenschaft die gelöscht wird
#>
param(
[Parameter(Mandatory = $true,ParameterSetName = 'ByName')]
[string]$GroupName,
[Parameter(Mandatory = $true,ParameterSetName = 'ById')]
[string]$GroupUid,
[Parameter(Mandatory = $true,ParameterSetName = 'ByName')]
[Parameter(Mandatory = $true,ParameterSetName = 'ById')]
[string]$PropertyName,
[string]$SiteServer
)
$LogID = $null
[bool]$success = $false
try{
StartCitrixSessionAdv -ServerName ([ref]$SiteServer)
[hashtable]$cmdArgs = @{'ErrorAction' = 'Stop'
'AdminAddress' = $SiteServer
}
if($PSCmdlet.ParameterSetName -eq 'ByName'){
$cmdArgs.Add('Name',$GroupName)
}
else{
$cmdArgs.Add('Uid',$GroupUid)
}
$group = Get-BrokerApplicationGroup @cmdArgs
StartLogging -ServerAddress $SiteServer -LogText "Remove application group metadata $($PropertyName)" -LoggingID ([ref]$LogID)
[hashtable]$delArgs = @{'ErrorAction' = 'Stop'
'AdminAddress' = $SiteServer
'InputObject' = $group
'Name' = $PropertyName
'LoggingId' = $LogID
}
$null = Remove-BrokerApplicationGroupMetadata @delArgs
$success = $true
$ret = Get-BrokerApplicationGroup @cmdArgs | Select-Object -ExpandProperty MetadataMap
if($SRXEnv) {
$SRXEnv.ResultMessage = $ret
}
else{
Write-Output $ret
}
}
catch{
throw
}
finally{
StopLogging -LoggingID $LogID -ServerAddress $SiteServer -IsSuccessful $success
CloseCitrixSession
}