DSCResources/VE_SFStoreRegisterGateway/VE_SFStoreRegisterGateway.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
Import-LocalizedData -BindingVariable localizedData -FileName Resources.psd1;

function Get-TargetResource {
    [CmdletBinding()]
    [OutputType([System.Collections.Hashtable])]
    param (
        ## Citrix Storefront Store Service IIS Virtual Path
        [Parameter(Mandatory)]
        [System.String] $StoreVirtualPath,


        ## Citrix Storefront Store Service IIS Site Id
        [Parameter()] [ValidateNotNull()]
        [System.UInt16] $SiteId = 1,


        ## Netscaler Gateway to register
        [Parameter(Mandatory)] [ValidateNotNull()]
        [System.String] $Gateway,


        ## Use this Gateway as the default if more than one is defined
        [Parameter()] [ValidateNotNull()]
        [System.Boolean] $DefaultGateway = $true,


        ## Use full VPN access when accessing the Store through this Gateway
        [Parameter()] [ValidateNotNull()]
        [System.Boolean] $UseFullVpn = $false,

        [Parameter()] [ValidateSet('Present','Absent')]
        [System.String] $Ensure = 'Present'
    )
    
    process {

        ImportSFModule -Name 'Citrix.StoreFront.Stores';

        $storeService = Get-STFStoreService -VirtualPath $StoreVirtualPath;
        $storeGatewayList = Get-STFStoreRegisteredGateway -StoreService $storeService

        #Initialize target resource to absen by default
        $targetResource = @{
            VirtualPath = $StoreVirtualPath;
            SiteId = $SiteId;
            Gateway = $null;
            DefaultGateway = $null;
            UseFullVpn = $nll;
            Ensure = 'Absent';
        }

        #Parse each registered Gateway to check is the desired gateway is already registered
        foreach ($storeGateway in $storeGatewayList) {
            if($storeGateway.Name -eq $Gateway) {
                if($storeGateway.RemoteAccessType -eq 'StoresOnly') {
                    $FullVpn = $false;
                }
                elseif($storeGateway.RemoteAccessType -eq 'FullVPN') {
                    $FullVpn = $true;
                }

                $targetResource = @{
                    VirtualPath = $StoreVirtualPath;
                    SiteId = $SiteId;
                    Gateway = $storeGateway.Name;
                    DefaultGateway = $storeGateway.Default;
                    UseFullVpn = $FullVpn;
                    Ensure = 'Present';
                }
            }
        }

        return $targetResource;

    } #end process
} #end function Get-TargetResource


function Test-TargetResource {
    [CmdletBinding()]
    [OutputType([System.Boolean])]
    param (
        ## Citrix Storefront Store Service IIS Virtual Path
        [Parameter(Mandatory)]
        [System.String] $StoreVirtualPath,


        ## Citrix Storefront Store Service IIS Site Id
        [Parameter()] [ValidateNotNull()]
        [System.UInt16] $SiteId = 1,


        ## Netscaler Gateway to register
        [Parameter(Mandatory)] [ValidateNotNull()]
        [System.String] $Gateway,


        ## Use this Gateway as the default if more than one is defined
        [Parameter()] [ValidateNotNull()]
        [System.Boolean] $DefaultGateway = $true,


        ## Use full VPN access when accessing the Store through this Gateway
        [Parameter()] [ValidateNotNull()]
        [System.Boolean] $UseFullVpn = $false,

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

        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') {
            if(($targetResource.Gateway -eq $Gateway) -and  ($targetResource.DefaultGateway -eq $DefaultGateway) -and  ($targetResource.UseFullVpn -eq $UseFullVpn)) {
                    $inDesiredState = $true;
            }
            else {
                $inDesiredState = $false;
            }
        }

        if ($inDesiredState) {

            Write-Verbose ($localizedData.ResourceInDesiredState);
            return $true;
        }
        else {

            Write-Verbose ($localizedData.ResourceNotInDesiredState);
            return $false;
        }

    } #end process
} #end function Test-TargetResource


function Set-TargetResource {
    [CmdletBinding()]

    param (
        ## Citrix Storefront Store Service IIS Virtual Path
        [Parameter(Mandatory)]
        [System.String] $StoreVirtualPath,


        ## Citrix Storefront Store Service IIS Site Id
        [Parameter()] [ValidateNotNull()]
        [System.UInt16] $SiteId = 1,


        ## Netscaler Gateway to register
        [Parameter(Mandatory)] [ValidateNotNull()]
        [System.String] $Gateway,


        ## Use this Gateway as the default if more than one is defined
        [Parameter()] [ValidateNotNull()]
        [System.Boolean] $DefaultGateway = $true,


        ## Use full VPN access when accessing the Store through this Gateway
        [Parameter()] [ValidateNotNull()]
        [System.Boolean] $UseFullVpn = $false,

        [Parameter()] [ValidateSet('Present','Absent')]
        [System.String] $Ensure = 'Present'
    )
    
    process {

        ImportSFModule -Name 'Citrix.StoreFront.Stores';
        ImportSFModule -Name Citrix.Storefront.Authentication;

        Write-Verbose ($localizedData.UpdatingStoreRegisteredGateway -f $StoreVirtualPath);

        $targetResource = Get-TargetResource @PSBoundParameters;
        
        #Get the store and gateway objects from Storefront
        $GatewayObject = Get-STFRoamingGateway -Name $Gateway;
        $storeService = Get-STFStoreService -VirtualPath $StoreVirtualPath;

        #
        if ($Ensure -eq 'Absent') {
            if($targetResource.Gateway -eq $Gateway) {
                ## Netscaler Gateway registered to store, removing
                [ref] $null = Unregister-STFStoreGateway -Gateway $GatewayObject -StoreService $storeService;
            }
        }
        elseif ($Ensure -eq 'Present') {
            #The CitrixAGBasic authentication protocol is used when accessing StoreFront remotely through a Citrix NetScaler Gateway
            $AuthenticationService = Get-STFAuthenticationService -VirtualPath $storeService.AuthenticationServiceVirtualPath;
            [ref] $null = Add-STFAuthenticationServiceProtocol -AuthenticationService $authenticationService -Name 'CitrixAGBasic';

            if($DefaultGateway -and $UseFullVpn) {
                [ref] $null = Register-STFStoreGateway -Gateway $GatewayObject -StoreService $storeService -DefaultGateway -UseFullVpn; 
            }
            elseif($DefaultGateway -and (-Not $UseFullVpn)) {
                [ref] $null = Register-STFStoreGateway -Gateway $GatewayObject -StoreService $storeService -DefaultGateway;
            }
            elseif((-Not $DefaultGateway) -and $UseFullVpn) {
                [ref] $null = Register-STFStoreGateway -Gateway $GatewayObject -StoreService $storeService -UseFullVpn;
            }
            else {
                [ref] $null = Register-STFStoreGateway -Gateway $GatewayObject -StoreService $storeService;
            }
        }
        
    } #end process
} #end function Set-TargetResource