Public/Interfaces.ps1
|
# # Copyright 2019, Alexis La Goutte <alexis dot lagoutte at gmail dot com> # # SPDX-License-Identifier: Apache-2.0 # function Add-ArubaCXInterfacesVlanTrunks { <# .SYNOPSIS Add vlan on an interface .DESCRIPTION Add vlan (tagged) on an interface The interface need already to be on tagged mode .EXAMPLE Get-ArubaCXInterfaces -interface 1/1/1 | Add-ArubaCXInterfacesVlanTrunks -vlan_trunks 44 Add vlan 44 to vlan trunks on interface 1/1/1 .EXAMPLE Get-ArubaCXInterfaces -interface 1/1/1 | Add-ArubaCXInterfacesVlanTrunks -vlan_trunks 44, 45 Add vlan 44 and 45 to vlan trunks on interface 1/1/1 #> Param( [Parameter (Mandatory = $true, ValueFromPipeline = $true, Position = 1)] [ValidateScript( { Confirm-ArubaCXInterfaces $_ })] [psobject]$int, [Parameter(Mandatory = $true)] #[ValidateRange(1, 4096)] [int[]]$vlan_trunks, [Parameter (Mandatory = $False)] [ValidateNotNullOrEmpty()] [PSObject]$connection = $DefaultArubaCXConnection ) Begin { } Process { $uri = "system/interfaces" #get interface name from int ps object $interface = $int.name #Add interface to $uri $interface = $interface -replace '/', '%2F' $uri += "/$interface" $_interface = Get-ArubaCXInterfaces $interface -selector writable -connection $connection #Remove name from vlan (can not be modified) $_interface.psobject.Properties.remove("name") if ($_interface.routing -eq $true) { Throw "You need to disable routing mode for use vlan_trunks" } if (-not ($_interface.vlan_mode -eq "native-untagged" -or $_interface.vlan_mode -eq "native-tagged")) { Throw "You need to use native-(un)tagged vlan mode" } #get list of existant vlan $vlans = $_interface.vlan_trunks if ($vlans) { foreach ($v in $vlans.psobject.Properties.Name) { $vlan_trunks += $v } } $trunks = @() #Add new vlan foreach ($trunk in $vlan_trunks) { $trunks += "/rest/" + $($connection.version) + "/system/vlans/" + $trunk } $_interface.vlan_trunks = $trunks $response = Invoke-ArubaCXRestMethod -uri $uri -method 'PUT' -body $_interface -connection $connection $response Get-ArubaCXInterfaces $interface -connection $connection } End { } } function Get-ArubaCXInterfaces { <# .SYNOPSIS Get list of all Aruba CX Interfacess .DESCRIPTION Get list of all Aruba CX Interfaces (port, lag, vlan... with name, IP Address, description) .EXAMPLE Get-ArubaCXInterfaces Get list of all interface (lag/port/vlan) .EXAMPLE Get-ArubaCXInterfaces 1/1/1 Get interface 1/1/1 info .EXAMPLE Get-ArubaCXInterfaces -interface vlan85 Get interface vlan 85 info #> Param( [Parameter(Mandatory = $false, position = 1)] [String]$interface, [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') ) { $invokeParams.add( 'selector', $selector ) } if ( $PsBoundParameters.ContainsKey('attributes') ) { $invokeParams.add( 'attributes', $attributes ) } if ( $PsBoundParameters.ContainsKey('vsx_peer') ) { $invokeParams.add( 'vsx_peer', $true ) } $uri = "system/interfaces" if ( $PsBoundParameters.ContainsKey('interface') ) { $interface = $interface -replace '/', '%2F' $uri += "/$interface" } $response = Invoke-ArubaCXRestMethod -uri $uri -method 'GET' -connection $connection @invokeParams #Add name parameter when use writable type selector if ( $PsBoundParameters.ContainsKey('selector') -and $selector -eq "writable" ) { $response | add-member -name "name" -membertype NoteProperty -Value $interface } $response } End { } } function Set-ArubaCXInterfaces { <# .SYNOPSIS Confgure Aruba CX Interfaces .DESCRIPTION Configure Aruba CX Interfaces (port, lag, vlan... with name, IP Address, description) .EXAMPLE Get-ArubaCXInterfaces -interface 1/1/1 | Set-ArubaCXInterfaces -description "Changed by PowerArubaCX" Set the description "Change by PowerArubaCX" for the Interface 1/1/1 .EXAMPLE Get-ArubaCXInterfaces -interface 1/1/1 | Set-ArubaCXInterfaces -admin up Set the admin status to up for the Interface 1/1/1 .EXAMPLE Get-ArubaCXInterfaces -interface 1/1/1 | Set-ArubaCXInterfaces -routing:$false Set the routing to disable for the Interface 1/1/1 .EXAMPLE Get-ArubaCXInterfaces -interface 1/1/1 | Set-ArubaCXInterfaces -vlan_mode access -vlan_tag 85 Set the interface 1/1/1 on access mode with vlan 85 .EXAMPLE Get-ArubaCXInterfaces -interface 1/1/1 | Set-ArubaCXInterfaces -vlan_mode native-untagged -vlan_tag 85 -vlan_trunks 44,45 Set the interface 1/1/1 on native-untagged mode with vlan 85 and tagged vlan 44 and 45 .EXAMPLE Get-ArubaCXInterfaces -interface 1/1/1 | Set-ArubaCXInterfaces -ip4_address 192.0.2.1 -ip4_mask 24 Set the interface 1/1/1 with IPv4 Address 192.0.2.1/24 .EXAMPLE Get-ArubaCXInterfaces -interface vlan85 | Set-ArubaCXInterfaces -ip4_address $null Remove IPv4 Address of interface vlan85 .EXAMPLE $int = Get-ArubaCXInterfaces -interface 1/1/1 -selector writable PS> $int.description = "My Vlan" PS> $int | Set-ArubaCXInterfaces -use_pipeline Configure some interfacevariable (description) no available on parameter using pipeline (can be only with selector equal writable) #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'medium')] Param( [Parameter (Mandatory = $true, ParameterSetName = "interface")] [String]$interface, [Parameter (Mandatory = $true, ValueFromPipeline = $true, Position = 1, ParameterSetName = "int")] [ValidateScript( { Confirm-ArubaCXInterfaces $_ })] [psobject]$int, [Parameter(Mandatory = $false)] [ValidateSet('up', 'down')] [string]$admin, [Parameter(Mandatory = $false)] [string]$description, [Parameter(Mandatory = $false)] [switch]$routing, [Parameter(Mandatory = $false)] [ValidateSet('access', 'native-untagged', 'native-tagged', IgnoreCase = $false)] [string]$vlan_mode, [Parameter(Mandatory = $false)] [ValidateRange(1, 4096)] [int]$vlan_tag, [Parameter(Mandatory = $false)] #[ValidateRange(1, 4096)] [int[]]$vlan_trunks, [Parameter(Mandatory = $false)] [ipaddress]$ip4_address, [Parameter(Mandatory = $false)] [ValidateRange(8, 32)] [int]$ip4_mask, [Parameter (Mandatory = $false)] [switch]$use_pipeline, [Parameter (Mandatory = $False)] [ValidateNotNullOrEmpty()] [PSObject]$connection = $DefaultArubaCXConnection ) Begin { } Process { $uri = "system/interfaces" #get interface name from int ps object if ($int) { $interface = $int.name } #Add interface to $uri $interface = $interface -replace '/', '%2F' $uri += "/$interface" if ($use_pipeline) { $_interface = $int } else { $_interface = Get-ArubaCXInterfaces $interface -selector writable -connection $connection } #Remove name from vlan (can not be modified) $_interface.psobject.Properties.remove("name") if ( $PsBoundParameters.ContainsKey('description') ) { $_interface.description = $description } if ( $PsBoundParameters.ContainsKey('admin') ) { if ($null -eq $_interface.user_config.admin) { $_interface.user_config | Add-member -name "admin" -membertype NoteProperty -Value "" } $_interface.user_config.admin = $admin } if ( $PsBoundParameters.ContainsKey('routing') ) { if ($routing) { $_interface.routing = $true } else { $_interface.routing = $false } } if ( $PsBoundParameters.ContainsKey('vlan_mode') ) { $_interface.vlan_mode = $vlan_mode } if ( $PsBoundParameters.ContainsKey('vlan_tag') ) { $_interface.vlan_tag = "/rest/" + $($connection.version) + "/system/vlans/" + $vlan_tag } if ( $PsBoundParameters.ContainsKey('vlan_trunks') ) { $trunks = @() foreach ($trunk in $vlan_trunks) { $trunks += "/rest/" + $($connection.version) + "/system/vlans/" + $trunk } $_interface.vlan_trunks = $trunks } if ( $PsBoundParameters.ContainsKey('ip4_address') ) { if ($ip4_address -eq $null ) { $_interface.ip4_address = $null } else { if ($ip4_mask -eq "0" ) { Throw "You need to set ip4_mask when use ipv4_address" } if ($_interface.routing -eq $false) { Throw "You need to enable routing mode for use ipv4_address" } if ( -not ($ip4_address.AddressFamily -eq "InterNetwork" )) { Throw "You need to specify a IPv4 Address" } $_interface.ip4_address = $ip4_address.ToString() + "/" + $ip4_mask } } if ($PSCmdlet.ShouldProcess($interface, 'Configure interface Settings')) { Invoke-ArubaCXRestMethod -uri $uri -method 'PUT' -body $_interface -connection $connection } Get-ArubaCXInterfaces $interface -connection $connection } End { } } function Remove-ArubaCXInterfacesVlanTrunks { <# .SYNOPSIS Remove vlan on an interface .DESCRIPTION Remove vlan (tagged) on an interface .EXAMPLE Get-ArubaCXInterfaces -interface 1/1/1 | Remove-ArubaCXInterfacesVlanTrunks -vlan_trunks 44 Remove vlan 44 to vlan trunks on interface 1/1/1 .EXAMPLE Get-ArubaCXInterfaces -interface 1/1/1 | Remove-ArubaCXInterfacesVlanTrunks -vlan_trunks 44, 45 Remove vlan 44 and 45 to vlan trunks on interface 1/1/1 #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'medium')] Param( [Parameter (Mandatory = $true, ValueFromPipeline = $true, Position = 1)] [ValidateScript( { Confirm-ArubaCXInterfaces $_ })] [psobject]$int, [Parameter(Mandatory = $true)] #[ValidateRange(1, 4096)] [int[]]$vlan_trunks, [Parameter (Mandatory = $False)] [ValidateNotNullOrEmpty()] [PSObject]$connection = $DefaultArubaCXConnection ) Begin { } Process { $uri = "system/interfaces" #get interface name from int ps object $interface = $int.name #Add interface to $uri $interface = $interface -replace '/', '%2F' $uri += "/$interface" $_interface = Get-ArubaCXInterfaces $interface -selector writable -connection $connection #Remove name from vlan (can not be modified) $_interface.psobject.Properties.remove("name") #get list of existant vlan and recreate $trunk $vlans = $_interface.vlan_trunks $trunks = @() if ($vlans) { foreach ($v in $vlans.psobject.Properties.Name) { #Remove vlan ($v) if it is on vlan_trunks list if ($vlan_trunks -contains $v) { continue } $trunks += "/rest/" + $($connection.version) + "/system/vlans/" + $v } } $_interface.vlan_trunks = $trunks if ($PSCmdlet.ShouldProcess($interface, 'Remove vlan tagged on interface')) { $response = Invoke-ArubaCXRestMethod -uri $uri -method 'PUT' -body $_interface -connection $connection } $response Get-ArubaCXInterfaces $interface -connection $connection } End { } } |