Public/Vrfs.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
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
#
# Copyright 2020, Alexis La Goutte <alexis dot lagoutte at gmail dot com>
#
# SPDX-License-Identifier: Apache-2.0
#


function Add-ArubaCXVrfs {

    <#
        .SYNOPSIS
        Add Aruba CX Vrf

        .DESCRIPTION
        Add Vrf (name, rd, https, ssh, snmp)

        .EXAMPLE
        Add-ArubaCXVrfs -name MyVRF

        Add Vrf named MyVRF

        .EXAMPLE
        Add-ArubaCXVrfs -name MyVRF -rd 65001:1

        Add Vrf named myVRF with RD 65001:1

        .EXAMPLE
        Add-ArubaCXVrfs -name myVRF -ssh_enable -snmp_enable -https_server

        Add Vrf named MyVRF with ssh, snmp and https enable
    #>

    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseSingularNouns", "")]
    Param(
        [Parameter (Mandatory = $true, Position = 1)]
        [string]$name,
        [Parameter (Mandatory = $false)]
        [string]$rd,
        [Parameter (Mandatory = $false)]
        [switch]$https_server,
        [Parameter (Mandatory = $false)]
        [switch]$snmp_enable,
        [Parameter (Mandatory = $false)]
        [switch]$ssh_enable,
        [Parameter (Mandatory = $False)]
        [ValidateNotNullOrEmpty()]
        [PSObject]$connection = $DefaultArubaCXConnection
    )

    Begin {
    }

    Process {

        $uri = "system/vrfs"

        $_vrf = new-Object -TypeName PSObject

        $_vrf | add-member -name "name" -membertype NoteProperty -Value $name

        if ( $PsBoundParameters.ContainsKey('rd') ) {
            $_vrf | add-member -name "rd" -membertype NoteProperty -Value $rd
        }

        if ( $PsBoundParameters.ContainsKey('https_server') ) {
            if ($https_server) {
                $_vrf | add-member -name "https_server" -membertype NoteProperty -Value @{"enable" = $True }
            }
            else {
                $_vrf | add-member -name "https_server" -membertype NoteProperty -Value @{ }
            }
        }

        if ( $PsBoundParameters.ContainsKey('snmp_enable') ) {
            if ($snmp_enable) {
                $_vrf | add-member -name "snmp_enable" -membertype NoteProperty -Value $true
            }
            else {
                $_vrf | add-member -name "snmp_enable" -membertype NoteProperty -Value $false
            }
        }

        if ( $PsBoundParameters.ContainsKey('ssh_enable') ) {
            if ($ssh_enable) {
                $_vrf | add-member -name "ssh_enable" -membertype NoteProperty -Value $true
            }
            else {
                $_vrf | add-member -name "ssh_enable" -membertype NoteProperty -Value $false
            }
        }
        $response = Invoke-ArubaCXRestMethod -uri $uri -method 'POST' -body $_vrf -connection $connection
        $response

        Get-ArubaCXVrfs -name $name -connection $connection
    }

    End {
    }
}

function Get-ArubaCXVrfs {

    <#
        .SYNOPSIS
        Get list of all Aruba CX Vrf

        .DESCRIPTION
        Get list of all Aruba CX Vrf (name, rd, https, ssh, snmp)

        .EXAMPLE
        Get-ArubaCXVrfs

        Get list of all Vrf (name, rd, https, ssh, snmp.)

        .EXAMPLE
        Get-ArubaCXVrfs -name MyVrf

        Get Vrf named MyVrf
    #>


    [CmdletBinding(DefaultParametersetname = "Default")]
    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseSingularNouns", "")]
    Param(
        [Parameter (Mandatory = $false, ParameterSetName = "name", position = "1")]
        [string]$name,
        [Parameter(Mandatory = $false)]
        [ValidateRange(1, 4)]
        [Int]$depth,
        [Parameter(Mandatory = $false)]
        [ValidateSet("configuration", "status", "statistics", "writable")]
        [String]$selector,
        [Parameter(Mandatory = $false)]
        [String[]]$attributes,
        [Parameter(Mandatory = $false)]
        [switch]$vsx_peer,
        [Parameter (Mandatory = $False)]
        [ValidateNotNullOrEmpty()]
        [PSObject]$connection = $DefaultArubaCXConnection
    )

    Begin {
    }

    Process {


        $invokeParams = @{ }
        if ( $PsBoundParameters.ContainsKey('depth') ) {
            $invokeParams.add( 'depth', $depth )
        }
        if ( $PsBoundParameters.ContainsKey('selector') ) {
            #You need to specify a vrf for use writable selector (it is not possible to use on collections...)
            if ($PSCmdlet.ParameterSetName -eq "Default" -and $selector -eq "writable") {
                Throw "You need to specify a vrf to use writable selector"
            }
            $invokeParams.add( 'selector', $selector )
        }
        if ( $PsBoundParameters.ContainsKey('attributes') ) {
            $invokeParams.add( 'attributes', $attributes )
        }
        if ( $PsBoundParameters.ContainsKey('vsx_peer') ) {
            $invokeParams.add( 'vsx_peer', $true )
        }

        $uri = "system/vrfs"

        # you can directly filter by name
        if ( $PsBoundParameters.ContainsKey('name') ) {
            $uri += "/$name"
        }

        $response = Invoke-ArubaCXRestMethod -uri $uri -method 'GET' -connection $connection @invokeParams

        #Add id parameter when use writable type selector
        if ( $PsBoundParameters.ContainsKey('selector') -and $selector -eq "writable" ) {
            $response | add-member -name "name" -membertype NoteProperty -Value $name
        }

        $response
    }

    End {
    }
}

function Set-ArubaCXVrfs {

    <#
        .SYNOPSIS
        Configure Aruba CX Vrf

        .DESCRIPTION
        Configure Vrf (name, rd, https, ssh, snmp)

        .EXAMPLE
        Get-ArubaCXVrfs -name MyVrf | Set-ArubaCXVrfs -rd 65001:01

        Configure RD on VRF MyVrf

        .EXAMPLE
        Get-ArubaCXVrfs -name MyVrf | Set-ArubaCXVrfs -https_server -ssh_enable:$false -snmp_enable:$false

        Configure https_server (enable) and ssh/snmp (disable) on VRF MyVrf

        .EXAMPLE
        $vrf = Get-ArubaCXVrfs -name MyVRF -selector writable
        PS> $vrf.ssh_enable = $true
        PS> $vrf | Set-ArubaCXVrfs -use_pipeline

        Configure Vrf myVRF name using pipeline (can be only with selector equal writable)
    #>

    [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'medium')]
    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseSingularNouns", "")]
    Param(
        [Parameter (Mandatory = $true, ParameterSetName = "name")]
        [string]$name,
        [Parameter (Mandatory = $true, ValueFromPipeline = $true, Position = 1, ParameterSetName = "vrf")]
        [ValidateScript( { Confirm-ArubaCXVrfs $_ })]
        [psobject]$vrf,
        [Parameter (Mandatory = $false)]
        [string]$rd,
        [Parameter (Mandatory = $false)]
        [switch]$https_server,
        [Parameter (Mandatory = $false)]
        [switch]$snmp_enable,
        [Parameter (Mandatory = $false)]
        [switch]$ssh_enable,
        [Parameter (Mandatory = $false)]
        [switch]$use_pipeline,
        [Parameter (Mandatory = $False)]
        [ValidateNotNullOrEmpty()]
        [PSObject]$connection = $DefaultArubaCXConnection
    )

    Begin {
    }

    Process {

        #get vrf id from vrf ps object
        if ($vrf) {
            $name = $vrf.name
        }

        $uri = "system/vrfs/${name}"

        if ($use_pipeline) {
            $_vrf = $vrf
        }
        else {
            $_vrf = Get-ArubaCXVrfs -name $name -selector writable -connection $connection
        }

        #Remove name from vrf (can not be modified)
        $_vrf.psobject.Properties.remove("name")

        if ( $PsBoundParameters.ContainsKey('rd') ) {
            $_vrf.rd = $rd
        }

        if ( $PsBoundParameters.ContainsKey('https_server') ) {
            if ($https_server) {
                $_vrf.https_server = @{"enable" = $true }
            }
            else {
                $_vrf.https_server = @{ }
            }
        }

        if ( $PsBoundParameters.ContainsKey('snmp_enable') ) {
            if ($snmp_enable) {
                $_vrf.snmp_enable = $true
            }
            else {
                $_vrf.snmp_enable = $false
            }
        }

        if ( $PsBoundParameters.ContainsKey('ssh_enable') ) {
            if ($ssh_enable) {
                $_vrf.ssh_enable = $true
            }
            else {
                $_vrf.ssh_enable = $false
            }
        }

        if ($PSCmdlet.ShouldProcess($id, 'Configure Vrf Settings')) {
            $response = Invoke-ArubaCXRestMethod -uri $uri -method 'PUT' -body $_vrf -connection $connection
            $response
        }

        Get-ArubaCXVrfs -name $name -connection $connection
    }

    End {
    }
}

function Remove-ArubaCXVrfs {

    <#
        .SYNOPSIS
        Remove a Vrf on Aruba CX Switch

        .DESCRIPTION
        Remove a Vrf on Aruba CX Switch

        .EXAMPLE
        $vrf = Get-ArubaCXVrfs -name MyVrf
        PS C:\>$vrf | Remove-ArubaCXVrfs

        Remove Vrf named MyVrf

        .EXAMPLE
        Remove-ArubaCXVrfs -name MyVrf -confirm:$false

        Remove Vrf named MyVrf with no confirmation
    #>


    [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'high')]
    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseSingularNouns", "")]
    Param(
        [Parameter (Mandatory = $true, ParameterSetName = "name")]
        [string]$name,
        [Parameter (Mandatory = $true, ValueFromPipeline = $true, Position = 1, ParameterSetName = "vrf")]
        [ValidateScript( { Confirm-ArubaCXVrfs $_ })]
        [psobject]$vrf,
        [Parameter (Mandatory = $False)]
        [ValidateNotNullOrEmpty()]
        [PSObject]$connection = $DefaultArubaCXConnection
    )

    Begin {
    }

    Process {

        #get vrf id from vrf ps object
        if ($vrf) {
            $name = $vrf.name
        }

        $uri = "system/vrfs/${name}"

        if ($PSCmdlet.ShouldProcess("Vrf", "Remove Vrf ${name}")) {
            Write-Progress -activity "Remove Vrf"
            Invoke-ArubaCXRestMethod -method "DELETE" -uri $uri -connection $connection
            Write-Progress -activity "Remove Vrf" -completed
        }
    }

    End {
    }
}