DSCResources/MSFT_WaitForNetworkTeam/MSFT_WaitForNetworkTeam.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
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
# Suppressed as per PSSA Rule Severity guidelines for unit/integration tests:
# https://github.com/PowerShell/DscResources/blob/master/PSSARuleSeverities.md
[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '')]
param ()

$modulePath = Join-Path -Path (Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent) -ChildPath 'Modules'

# Import the Storage Common Modules
Import-Module -Name (Join-Path -Path $modulePath `
        -ChildPath (Join-Path -Path 'NetworkingDsc.Common' `
            -ChildPath 'NetworkingDsc.Common.psm1'))

# Import Localization Strings
$script:localizedData = Get-LocalizedData -ResourceName 'MSFT_WaitForNetworkTeam'

<#
    .SYNOPSIS
    Returns the current state of the wait for network team resource.
 
    .PARAMETER Name
    Specifies the name of the network team to wait for.
#>

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

    Write-Verbose -Message ( @(
            "$($MyInvocation.MyCommand): "
            $($script:localizedData.GettingWaitForNetworkTeamStatusMessage -f $Name)
        ) -join '' )


    $null = Get-NetLbfoTeamStatus -Name $Name

    $returnValue = @{
        Name             = $Name
        RetryIntervalSec = $null
        RetryCount       = $null
    }

    return $returnValue
} # function Get-TargetResource

<#
    .SYNOPSIS
    Sets the current state of the wait for network team resource.
 
    .PARAMETER Name
    Specifies the name of the network team to wait for.
 
    .PARAMETER RetryIntervalSec
    Specifies the number of seconds to wait for the network team to become available.
 
    .PARAMETER RetryCount
    The number of times to loop the retry interval while waiting for the network team.
#>

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

        [Parameter()]
        [System.UInt32]
        $RetryIntervalSec = 10,

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

    Write-Verbose -Message ( @(
            "$($MyInvocation.MyCommand): "
            $($script:localizedData.SettingWaitForNetworkTeamStatusMessage -f $Name)
        ) -join '' )

    $lbfoTeamUp = $false

    for ($count = 0; $count -lt $RetryCount; $count++)
    {
        $lbfoTeamStatus = Get-NetLbfoTeamStatus -Name $Name

        if ($lbfoTeamStatus -eq 'Up')
        {
            Write-Verbose -Message ( @(
                    "$($MyInvocation.MyCommand): "
                    $($script:localizedData.NetworkTeamUpMessage -f $Name)
                ) -join '' )

            $lbfoTeamUp = $true
            break
        }
        else
        {
            Write-Verbose -Message ( @(
                    "$($MyInvocation.MyCommand): "
                    $($script:localizedData.NetworkTeamNotUpRetryingMessage -f $Name, $RetryIntervalSec)
                ) -join '' )

            Start-Sleep -Seconds $RetryIntervalSec
        } # if
    } # for

    if ($lbfoTeamUp -eq $false)
    {
        New-InvalidOperationException `
            -Message ($script:localizedData.NetworkTeamNotUpAfterError -f $Name, $RetryCount)
    } # if
} # function Set-TargetResource

<#
    .SYNOPSIS
    Tests the current state of the wait for network team resource.
 
    .PARAMETER Name
    Specifies the name of the network team to wait for.
 
    .PARAMETER RetryIntervalSec
    Specifies the number of seconds to wait for the network team to become available.
 
    .PARAMETER RetryCount
    The number of times to loop the retry interval while waiting for the network team.
#>

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

        [Parameter()]
        [System.UInt32]
        $RetryIntervalSec = 10,

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

    Write-Verbose -Message ( @(
            "$($MyInvocation.MyCommand): "
            $($script:localizedData.TestingWaitForNetworkTeamStatusMessage -f $Name)
        ) -join '' )

    $lbfoTeamStatus = Get-NetLbfoTeamStatus -Name $Name

    if ($lbfoTeamStatus -eq 'Up')
    {
        Write-Verbose -Message ( @(
                "$($MyInvocation.MyCommand): "
                $($script:localizedData.NetworkTeamUpMessage -f $Name)
            ) -join '' )

        return $true
    }

    Write-Verbose -Message ( @(
            "$($MyInvocation.MyCommand): "
            $($script:localizedData.NetworkTeamNotUpMessage -f $Name)
        ) -join '' )

    return $false
} # function Test-TargetResource

<#
    .SYNOPSIS
    Returns the current status of a network team.
    'Up' indicates that the network team is acive.
    'Degraded' indicates that the network team is not yet
    available.
    If the network team does not exist an exception will be
    thrown.
 
    .PARAMETER Name
    Specifies the name of the network team to get the status of.
#>


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

    try
    {
        $lbfoTeam = Get-NetLbfoTeam -Name $Name

        Write-Verbose -Message ( @(
            "$($MyInvocation.MyCommand): "
            $($script:localizedData.NetworkTeamFoundMessage -f $Name)
        ) -join '' )

    }
    catch [Microsoft.PowerShell.Cmdletization.Cim.CimJobException]
    {
        New-InvalidOperationException `
            -Message ($script:localizedData.NetworkTeamNotFoundMessage -f $Name)
    }

    return $lbfoTeam.Status
}

Export-ModuleMember -Function *-TargetResource