DSCResources/VE_SFStoreFarm/VE_SFStoreFarm.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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
Import-LocalizedData -BindingVariable localizedData -FileName Resources.psd1;

$immutableProperties = @( # Properties that cannot be changed after creation
);

$mutableProperties = @( # Properties that can be successfully updated
    'FarmType',
    'BypassDuration',
    'MaxFailedServersPerRequest',
    'SSLRelaryServicePort',
    'RadeTicketTimeToLive',
    'TransportType',
    'AllFailedBypassDuration',
    'LoadBalance',
    'TicketTimeToLive',
    'Port',
    'Servers'
);

function Get-TargetResource {
    [CmdletBinding()]
    [OutputType([System.Collections.Hashtable])]
    param (
        ## Store virtual directory, i.e. /Citrix/Store
        [Parameter(Mandatory)] [ValidateNotNullOrEmpty()]
        [System.String] $StoreVirtualPath,

        ## Farm (display) name
        [Parameter(Mandatory)] [ValidateNotNullOrEmpty()]
        [System.String] $FarmName,

        ## Farm type
        [Parameter(Mandatory)] [ValidateSet('XenApp','XenDesktop','AppController','VDIinaBox')]
        [System.String] $FarmType,

        ## The hostnames or IP addresses of the xml services
        [Parameter(Mandatory)] [ValidateNotNullOrEmpty()]
        [System.String[]] $Servers,

        ## Xml service communication port, defaults to 443
        [Parameter()] [ValidateNotNull()]
        [System.UInt32] $Port = 443,

        ## Xml service transport type
        [Parameter()] [ValidateSet('HTTP','HTTPS','SSL')]
        [System.String] $TransportType = 'HTTPS',

        ## Xml service communication port, defaults to 443
        [Parameter()] [ValidateNotNull()]
        [System.UInt32] $SSLRelayServicePort,

        ## Round robin load balance the xml service servers
        [Parameter()] [ValidateNotNull()]
        [System.Boolean] $LoadBalance = $true,

        ## Period of time to skip all xml service requests should all servers fail to respond
        [Parameter()] [ValidateNotNull()]
        [System.UInt32] $AllFailedBypassDuration,

        ## Period of time to skip a server when is fails to respond
        [Parameter()] [ValidateNotNull()]
        [System.UInt32] $BypassDuration,

        ## Period of time an ICA launch ticket is valid once requested on pre 7.0 XenApp and XenDesktop farms
        [Parameter()] [ValidateNotNull()]
        [System.UInt32] $TicketTimeToLive,

        ## Period of time a RADE launch ticket is valid once requested on pre 7.0 XenApp and XenDesktop farms
        [Parameter()] [ValidateNotNull()]
        [System.UInt32] $RadeTicketTimeToLive,

        ## Maximum number of servers within a single farm that can fail before aborting a request
        [Parameter()] [ValidateNotNull()]
        [System.UInt32] $MaxFailedServersPerRequest,

        [Parameter()] [ValidateSet('Present','Absent')]
        [System.String] $Ensure = 'Present'
    )
    process {
        ImportSFModule -Name 'Citrix.StoreFront.Stores';
        $farm = GetStoreFarm @PSBoundParameters;
        $targetResource = @{
            StoreVirtualPath = $StoreVirtualPath;
            FarmName = $farm.FarmName;
            FarmType = $farm.FarmType;
            Port = $farm.Port;
            SSLRelaryServicePort = $farm.SSLRelayPort;
            TransportType = $farm.TransportType;
            LoadBalance = $farm.LoadBalance;
            Servers = $farm.Servers;
            AllFailedBypassDuration = $farm.AllFailedBypassDuration;
            BypassDuration = $farm.BypassDuration;
            TicketTimeToLive = $farm.TicketTimeToLive;
            RadeTicketTimeToLive = $farm.RadeTicketTimeToLive;
            MaxFailedServersPerRequest = $farm.MaxFailedServersPerRequest;
            Ensure = if ($farm) { 'Present' } else { 'Absent' };
        }
        return $targetResource;
    } #end process
} #end function Get-TargetResource

function Test-TargetResource {
    [CmdletBinding()]
    [OutputType([System.Boolean])]
    param (
        ## Store virtual directory, i.e. /Citrix/Store
        [Parameter(Mandatory)] [ValidateNotNullOrEmpty()]
        [System.String] $StoreVirtualPath,

        ## Farm (display) name
        [Parameter(Mandatory)] [ValidateNotNullOrEmpty()]
        [System.String] $FarmName,

        ## Farm type
        [Parameter(Mandatory)] [ValidateSet('XenApp','XenDesktop','AppController','VDIinaBox')]
        [System.String] $FarmType,

        ## The hostnames or IP addresses of the xml services
        [Parameter(Mandatory)] [ValidateNotNullOrEmpty()]
        [System.String[]] $Servers,

        ## Xml service communication port, defaults to 443
        [Parameter()] [ValidateNotNull()]
        [System.UInt32] $Port = 443,

        ## Xml service transport type
        [Parameter()] [ValidateSet('HTTP','HTTPS','SSL')]
        [System.String] $TransportType = 'HTTPS',

        ## Xml service communication port, defaults to 443
        [Parameter()] [ValidateNotNull()]
        [System.UInt32] $SSLRelayServicePort,

        ## Round robin load balance the xml service servers
        [Parameter()] [ValidateNotNull()]
        [System.Boolean] $LoadBalance = $true,

        ## Period of time to skip all xml service requests should all servers fail to respond
        [Parameter()] [ValidateNotNull()]
        [System.UInt32] $AllFailedBypassDuration,

        ## Period of time to skip a server when is fails to respond
        [Parameter()] [ValidateNotNull()]
        [System.UInt32] $BypassDuration,

        ## Period of time an ICA launch ticket is valid once requested on pre 7.0 XenApp and XenDesktop farms
        [Parameter()] [ValidateNotNull()]
        [System.UInt32] $TicketTimeToLive,

        ## Period of time a RADE launch ticket is valid once requested on pre 7.0 XenApp and XenDesktop farms
        [Parameter()] [ValidateNotNull()]
        [System.UInt32] $RadeTicketTimeToLive,

        ## Maximum number of servers within a single farm that can fail before aborting a request
        [Parameter()] [ValidateNotNull()]
        [System.UInt32] $MaxFailedServersPerRequest,

        [Parameter()] [ValidateSet('Present','Absent')]
        [System.String] $Ensure = 'Present'
    )
    process {
        $targetResource = Get-TargetResource @PSBoundParameters;
        $inDesiredState = $true;

        if ($Ensure -ne $targetResource.Ensure) {
            Write-Verbose -Message ($localizedData.ResourcePropertyMismatch -f 'Ensure', $Ensure, $targetResource.Ensure);
            $inDesiredState = $false;
        }

        ## Only check all remaing properties if we're setting
        if ($Ensure -eq 'Present') {

            ## Throw if we have immutable properties
            foreach ($property in $immutableProperties) {
                if ($PSBoundParameters.ContainsKey($property)) {
                    $propertyValue = (Get-Variable -Name $property).Value;
                    if ($targetResource.$property -ne $propertyValue) {
                        $errorMessage = $localizedData.CannotUpdatePropertyError -f $property;
                        ThrowInvalidOperationException -ErrorId 'ImmutableProperty' -ErrorMessage $errorMessage;
                    }  
                } #end if is PSBoundParameter
            } #end foreach immutable property

            foreach ($property in $mutableProperties) {
                if ($PSBoundParameters.ContainsKey($property)) {
                    
                    $propertyValue = (Get-Variable -Name $property).Value;
                    if ($propertyValue -is [System.String[]]) {
                        ## We have to treat string[] differently
                        if (-not (TestStringArrayEqual -Expected $propertyValue -Actual $targetResource.$property)) {
                            $message = $localizedData.ResourcePropertyMismatch -f $property, ($propertyValue -join ','), ($targetResource.$property -join ',');
                            Write-Verbose -Message $message;
                            $inDesiredState = $false;
                        }
                    } #end if string[]
                    else {
                        if ($targetResource.$property -ne $propertyValue) {
                            $message = $localizedData.ResourcePropertyMismatch -f $property, $propertyValue, $targetResource.$property;
                            Write-Verbose -Message $message;
                            $inDesiredState = $false;
                        }
                    } #end if not string[]
                    
                } #end if is PSBoundParameter
            } #end foreach property
        } #end if ensure is present

        if ($inDesiredState) {
            Write-Verbose -Message ($localizedData.ResourceInDesiredState -f $FarmName);
        }
        else {
            Write-Verbose -Message ($localizedData.ResourceNotInDesiredState -f $FarmName);
        }
        return $inDesiredState;
    } #end process
} #end function Test-TargetResource

function Set-TargetResource {
    [CmdletBinding()]
    param (
        ## Store virtual directory, i.e. /Citrix/Store
        [Parameter(Mandatory)] [ValidateNotNullOrEmpty()]
        [System.String] $StoreVirtualPath,

        ## Farm (display) name
        [Parameter(Mandatory)] [ValidateNotNullOrEmpty()]
        [System.String] $FarmName,

        ## Farm type
        [Parameter(Mandatory)] [ValidateSet('XenApp','XenDesktop','AppController','VDIinaBox')]
        [System.String] $FarmType,

        ## The hostnames or IP addresses of the xml services
        [Parameter(Mandatory)] [ValidateNotNullOrEmpty()]
        [System.String[]] $Servers,

        ## Xml service communication port, defaults to 443
        [Parameter()] [ValidateNotNull()]
        [System.UInt32] $Port = 443,

        ## Xml service transport type
        [Parameter()] [ValidateSet('HTTP','HTTPS','SSL')]
        [System.String] $TransportType = 'HTTPS',

        ## The SSL Relay port
        [Parameter()] [ValidateNotNull()]
        [System.UInt32] $SSLRelayServicePort,

        ## Round robin load balance the xml service servers
        [Parameter()] [ValidateNotNull()]
        [System.Boolean] $LoadBalance = $true,

        ## Period of time to skip all xml service requests should all servers fail to respond
        [Parameter()] [ValidateNotNull()]
        [System.UInt32] $AllFailedBypassDuration,

        ## Period of time to skip a server when is fails to respond
        [Parameter()] [ValidateNotNull()]
        [System.UInt32] $BypassDuration,

        ## Period of time an ICA launch ticket is valid once requested on pre 7.0 XenApp and XenDesktop farms
        [Parameter()] [ValidateNotNull()]
        [System.UInt32] $TicketTimeToLive,

        ## Period of time a RADE launch ticket is valid once requested on pre 7.0 XenApp and XenDesktop farms
        [Parameter()] [ValidateNotNull()]
        [System.UInt32] $RadeTicketTimeToLive,

        ## Maximum number of servers within a single farm that can fail before aborting a request
        [Parameter()] [ValidateNotNull()]
        [System.UInt32] $MaxFailedServersPerRequest,

        [Parameter()] [ValidateSet('Present','Absent')]
        [System.String] $Ensure = 'Present'
    )
    process {
        ImportSFModule -Name 'Citrix.Storefront.Stores';
        $store = GetStoreService -VirtualPath $StoreVirtualPath -ThrowIfNull;
        $farm = GetStoreFarm -StoreVirtualPath $StoreVirtualPath -FarmName $FarmName;

        if ($Ensure -eq 'Absent') {
            
            if ($farm) {
                ## Farm exists, removing
                Write-Verbose -Message ($localizedData.RemovingStoreFarm -f $FarmName);
                [ref] $null = Remove-STFStoreFarm -StoreService $store -FarmName $FarmName -Confirm:$false;
            }

        }
        elseif ($Ensure -eq 'Present') {
            
            
            if (-not $farm) {
                Write-Verbose -Message ($localizedData.AddStoreFarm -f $FarmName);
                $farm = Add-STFStoreFarm -StoreService $store -FarmName $FarmName -FarmType $FarmType -Servers $Servers -Confirm:$false;
            }

            $setSTFStoreFarmParams = @{
                StoreService = $store;
                FarmName = $FarmName;
            }

            foreach ($property in $mutableProperties) {
                if ($PSBoundParameters.ContainsKey($property)) {
                    $propertyValue = (Get-Variable -Name $property).Value;
                    if ($propertyValue -is [System.String[]]) {
                        $message = $localizedData.UpdatingResourceProperty -f $property, ($propertyValue -join ',');
                    }
                    else {
                        $message = $localizedData.UpdatingResourceProperty -f $property, $propertyValue;
                    }
                    Write-Verbose -Message $message;
                    $setSTFStoreFarmParams[$property] = $propertyValue;
                }
            } #end foreach property

            Write-Verbose -Message ($localizedData.UpdatingStoreFarm -f $FarmName);
            [ref] $null = Set-STFStoreFarm @setSTFStoreFarmParams -Confirm:$false;
        
        }
    } #end process
} #end function Set-TargetResource