DSCResources/MSFT_xWaitForAvailabilityGroup/MSFT_xWaitForAvailabilityGroup.psm1

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
Import-Module -Name (Join-Path -Path (Split-Path (Split-Path $PSScriptRoot -Parent) -Parent) `
        -ChildPath 'xSQLServerHelper.psm1') `
    -Force

<#
    .SYNOPSIS
        Returns the cluster role/group that is waiting to be created,
        along with the time and number of times to wait.
 
    .PARAMETER Name
        Name of the cluster role/group to look for (normally the same as the Availability Group name).
 
    .PARAMETER RetryIntervalSec
        The interval, in seconds, to check for the presence of the cluster role/group.
        Default value is 20 seconds.
        When the cluster role/group has been found the resource will wait for this amount of time once
        more before returning.
 
    .PARAMETER RetryCount
        Maximum number of retries until the resource will timeout and throw an error. Default values is 30 times.
#>

function Get-TargetResource
{
    [CmdletBinding()]
    [OutputType([System.Collections.Hashtable])]
    param
    (
        [Parameter(Mandatory = $true)]
        [System.String]
        $Name,

        [Parameter()]
        [System.UInt64]
        $RetryIntervalSec = 20,

        [Parameter()]
        [System.UInt32]
        $RetryCount = 30
    )

    $clusterGroupFound = $false

    $clusterGroup = Get-ClusterGroup -Name $Name -ErrorAction SilentlyContinue
    if ($null -ne $clusterGroup)
    {
        $clusterGroupFound = $true
    }

    return @{
        Name             = $Name
        RetryIntervalSec = $RetryIntervalSec
        RetryCount       = $RetryCount
        GroupExist       = $clusterGroupFound
    }
}

<#
    .SYNOPSIS
        Waits for a cluster role/group to be created
 
    .PARAMETER Name
        Name of the cluster role/group to look for (normally the same as the Availability Group name).
 
    .PARAMETER RetryIntervalSec
        The interval, in seconds, to check for the presence of the cluster role/group.
        Default value is 20 seconds.
        When the cluster role/group has been found the resource will wait for this amount of time once
        more before returning.
 
    .PARAMETER RetryCount
        Maximum number of retries until the resource will timeout and throw an error. Default values is 30 times.
#>

function Set-TargetResource
{
    [CmdletBinding()]
    param
    (
        [Parameter(Mandatory = $true)]
        [System.String]
        $Name,

        [Parameter()]
        [System.UInt64]
        $RetryIntervalSec = 20,

        [Parameter()]
        [System.UInt32]
        $RetryCount = 30
    )

    New-VerboseMessage -Message "Checking for cluster group $Name. Will try for a total of $($RetryIntervalSec*$RetryCount) seconds."

    $getTargetResourceParameters = @{
        Name             = $Name
        RetryIntervalSec = $RetryIntervalSec
        RetryCount       = $RetryCount
    }

    for ($forLoopCount = 0; $forLoopCount -lt $RetryCount; $forLoopCount++)
    {
        $clusterGroupFound = (Get-TargetResource @getTargetResourceParameters).GroupExist
        if ($clusterGroupFound)
        {
            New-VerboseMessage -Message "Found cluster group $Name. Will sleep for another $RetryIntervalSec seconds before continuing."
            Start-Sleep -Seconds $RetryIntervalSec
            break
        }

        New-VerboseMessage -Message "Cluster group $Name not found. Will retry again after $RetryIntervalSec sec"
        Start-Sleep -Seconds $RetryIntervalSec
    }

    if (-not $clusterGroupFound)
    {
        throw "Cluster group $Name not found after $RetryCount attempts with $RetryIntervalSec sec interval"
    }
}

<#
    .SYNOPSIS
        Tests if the cluster role/group has been created.
 
    .PARAMETER Name
        Name of the cluster role/group to look for (normally the same as the Availability Group name).
 
    .PARAMETER RetryIntervalSec
        The interval, in seconds, to check for the presence of the cluster role/group.
        Default value is 20 seconds.
        When the cluster role/group has been found the resource will wait for this amount of time once
        more before returning.
 
    .PARAMETER RetryCount
        Maximum number of retries until the resource will timeout and throw an error. Default values is 30 times.
#>

function Test-TargetResource
{
    [CmdletBinding()]
    [OutputType([System.Boolean])]
    param
    (
        [Parameter(Mandatory = $true)]
        [System.String]
        $Name,

        [Parameter()]
        [System.UInt64]
        $RetryIntervalSec = 20,

        [Parameter()]
        [System.UInt32]
        $RetryCount = 30
    )

    New-VerboseMessage -Message "Testing for cluster group $Name."

    $getTargetResourceParameters = @{
        Name             = $Name
        RetryIntervalSec = $RetryIntervalSec
        RetryCount       = $RetryCount
    }

    $clusterGroupFound = (Get-TargetResource @getTargetResourceParameters).GroupExist
    if ($clusterGroupFound)
    {
        New-VerboseMessage -Message "Found cluster group $Name"
    }
    else
    {
        New-VerboseMessage -Message "Cluster group $Name not found"
    }

    return $clusterGroupFound
}

Export-ModuleMember -Function *-TargetResource