Public/Vlans.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
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
#
# Copyright 2020, Alexis La Goutte <alexis dot lagoutte at gmail dot com>
#
# SPDX-License-Identifier: Apache-2.0
#


function Add-ArubaCXVlans {

    <#
        .SYNOPSIS
        Add Aruba CX Vlan

        .DESCRIPTION
        Add Vlan (name, description, vsx_sync...)

        .EXAMPLE
        Add-ArubaCXVlans -name Vlan 2 -id 2

        Add Vlan id 2 named Vlan 2

        .EXAMPLE
        Add-ArubaCXVlans -name Vlan 2 -id 2 -description "Add via PowerArubaCX" -voice

        Add Vlan with a description and enable voice

        .EXAMPLE
        Add-ArubaCXVlans -name Vlan 2 -id 2 -admin down -vsx_sync

        Add Vlan with a VSX Sync and admin down
    #>

    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseSingularNouns", "")]
    Param(
        [Parameter (Mandatory = $true)]
        [ValidateRange(1, 4096)]
        [int]$id,
        [Parameter (Mandatory = $true)]
        [string]$name,
        [Parameter (Mandatory = $false)]
        [string]$description,
        [Parameter (Mandatory = $false)]
        [ValidateSet('up', 'down')]
        [string]$admin,
        [Parameter (Mandatory = $false)]
        [switch]$voice,
        [Parameter (Mandatory = $false)]
        [switch]$vsx_sync,
        [Parameter (Mandatory = $False)]
        [ValidateNotNullOrEmpty()]
        [PSObject]$connection = $DefaultArubaCXConnection
    )

    Begin {
    }

    Process {

        $uri = "system/vlans"

        $_vlan = new-Object -TypeName PSObject

        $_vlan | add-member -name "id" -membertype NoteProperty -Value $id

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

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

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

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

        if ( $PsBoundParameters.ContainsKey('vsx_sync') ) {
            if ($vsx_sync) {
                $_vlan | add-member -name "vsx_sync" -membertype NoteProperty -Value @("all_attributes_and_dependents")
            }
            else {
                $_vlan | add-member -name "vsx_sync" -membertype NoteProperty -Value ""
            }
        }

        $response = Invoke-ArubaCXRestMethod -uri $uri -method 'POST' -body $_vlan -connection $connection
        $response

        Get-ArubaCXVlans -id $id -connection $connection
    }

    End {
    }
}

function Get-ArubaCXVlans {

    <#
        .SYNOPSIS
        Get list of all Aruba CX Vlan

        .DESCRIPTION
        Get list of all Aruba CX Vlan (name, description, vsx_sync...)

        .EXAMPLE
        Get-ArubaCXVlans

        Get list of all vlan (name, description, vsx_sync...)

        .EXAMPLE
        Get-ArubaCXVlans -id 23

        Get vlan with id 23

        .EXAMPLE
        Get-ArubaCXVlans -name MyVlan

        Get vlan named MyVlan
    #>


    [CmdletBinding(DefaultParametersetname = "Default")]
    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseSingularNouns", "")]
    Param(
        [Parameter (Mandatory = $false, ParameterSetName = "id")]
        [ValidateRange(1, 4096)]
        [int]$id,
        [Parameter (Mandatory = $false, ParameterSetName = "name")]
        [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 vlan 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 vlan (id or name) 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 )
        }

        #if filter by name always set depth to 2
        if ($PsBoundParameters.ContainsKey('name') -and ($depth -eq "")) {
            $invokeParams.add( 'depth', 2 )
        }

        $uri = "system/vlans"

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

        $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 "id" -membertype NoteProperty -Value $id
        }

        switch ( $PSCmdlet.ParameterSetName ) {
            "name" {
                #Need to make own filter for name (and use a depth >= 2)
                $response.psobject.Properties.Value | Where-Object { $_.name -eq $name }
            }
            default {
                $response
            }
        }
    }

    End {
    }
}

function Set-ArubaCXVlans {

    <#
        .SYNOPSIS
        Configure Aruba CX Vlan

        .DESCRIPTION
        Configure Vlan (name, description, vsx_sync...)

        .EXAMPLE
        Get-ArubaCXVlans -id 44 | Set-ArubaCXVlans -name "My New Vlan Name" -description "My Description change by PowerArubaCX"

        Change the name and description of vlan id 44

        .EXAMPLE
        Get-ArubaCXVlans -id 44 | Set-ArubaCXVlans -voice -admin up

        Configure Vlan 44 with voice vlan and set admin to up

        .EXAMPLE
        Get-ArubaCXVlans -id 44 | Set-ArubaCXVlans -vsx_sync -voice -admin down

        Configure Vlan 44 with enable VSX sync and set admin to status

        .EXAMPLE
        $vlan = Get-ArubaCXVlans -id 44 -selector writable
        PS> $vlan.name = "My Vlan"
        PS> $vlan | Set-ArubaCXVlans -use_pipeline

        Configure Vlan 44 name using pipeline (can be only with selector equal writable)
    #>

    [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'medium')]
    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseSingularNouns", "")]
    Param(
        [Parameter (Mandatory = $true, ParameterSetName = "id")]
        [ValidateRange(1, 4096)]
        [int]$id,
        [Parameter (Mandatory = $true, ValueFromPipeline = $true, Position = 1, ParameterSetName = "vlan")]
        [ValidateScript( { Confirm-ArubaCXVlans $_ })]
        [psobject]$vlan,
        [Parameter (Mandatory = $false)]
        [string]$name,
        [Parameter (Mandatory = $false)]
        [string]$description,
        [Parameter (Mandatory = $false)]
        [ValidateSet('up', 'down')]
        [string]$admin,
        [Parameter (Mandatory = $false)]
        [switch]$voice,
        [Parameter (Mandatory = $false)]
        [switch]$vsx_sync,
        [Parameter (Mandatory = $false)]
        [switch]$use_pipeline,
        [Parameter (Mandatory = $False)]
        [ValidateNotNullOrEmpty()]
        [PSObject]$connection = $DefaultArubaCXConnection
    )

    Begin {
    }

    Process {

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

        $uri = "system/vlans/${id}"

        if ($use_pipeline) {
            $_vlan = $vlan
        }
        else {
            $_vlan = Get-ArubaCXVlans -id $id -selector writable -connection $connection
        }

        #Remove id from vlan (can not be modified)
        $_vlan.psobject.Properties.remove("id")

        if ( $PsBoundParameters.ContainsKey('name') ) {
            $_vlan.name = $name
        }
        if ( $PsBoundParameters.ContainsKey('description') ) {
            $_vlan.description = $description
        }

        if ( $PsBoundParameters.ContainsKey('admin') ) {
            $_vlan.admin = $admin
        }

        if ( $PsBoundParameters.ContainsKey('voice') ) {
            if ($voice) {
                $_vlan.voice = $true
            }
            else {
                $_vlan.voice = $false
            }
        }

        if ( $PsBoundParameters.ContainsKey('vsx_sync') ) {
            if ($vsx_sync) {
                $_vlan.vsx_sync = @("all_attributes_and_dependents")
            }
            else {
                $_vlan.vsx_sync = $null
            }
        }

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

        Get-ArubaCXVlans -id $id -connection $connection
    }

    End {
    }
}

function Remove-ArubaCXVlans {

    <#
        .SYNOPSIS
        Remove a vlan on Aruba CX Switch

        .DESCRIPTION
        Remove a vlan on Aruba CX Switch

        .EXAMPLE
        $vlan = Get-ArubaCXVlans -name MyVlan
        PS C:\>$vlan | Remove-ArubaCXVlans

        Remove vlan named MyVlan

        .EXAMPLE
        Remove-ArubaCXVlans -id 23 -confirm:$false

        Remove Vlan with id 23 with no confirmation
    #>


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

    Begin {
    }

    Process {

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

        $uri = "system/vlans/${id}"

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

    End {
    }
}