PowerArubaSW

1.0.0

Public/RADIUSServer.ps1

#
# Copyright 2019, Alexis La Goutte <alexis dot lagoutte at gmail dot com>
# Copyright 2019, Cedric Moreau <moreaucedric0 at gmail dot com>
#
# SPDX-License-Identifier: Apache-2.0
#

function Get-ArubaSWRadiusServer {

    <#
        .SYNOPSIS
        Get RADIUS Server information.

        .DESCRIPTION
        Get RADIUS Server information configured on the device.

        .EXAMPLE
        Get-ArubaSWRadiusServer

        This function give you all the informations about the radius servers parameters configured on the switch.

        .EXAMPLE
        Get-ArubaSWRadiusServer -address 192.0.2.1

        This function give you all the informations about the radius server with address 192.0.2.1 configured on the switch.

        .EXAMPLE
        Get-ArubaSWRadiusServer -id 1

        Get Radius servers parameters where the id equal 1
    #>

    [CmdletBinding(DefaultParameterSetName = "default")]
    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', 'address', Justification = 'False positive see PSSA #1472')]
    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', 'id', Justification = 'False positive see PSSA #1472')]
    Param(
        [Parameter (Mandatory = $false)]
        [Parameter (ParameterSetName = "address")]
        [ipaddress]$address,
        [Parameter (Mandatory = $false)]
        [Parameter (ParameterSetName = "id")]
        [string]$id,
        [Parameter (Mandatory = $False)]
        [ValidateNotNullOrEmpty()]
        [PSObject]$connection = $DefaultArubaSWConnection
    )

    Begin {
    }

    Process {
        $uri = "radius_servers"

        $response = Invoke-ArubaSWWebRequest -method "GET" -uri $uri -connection $connection

        $run = ($response | ConvertFrom-Json).radius_server_element

        switch ( $PSCmdlet.ParameterSetName ) {
            "id" {
                $run | Where-Object { $_.radius_server_id -eq $id }
            }
            "address" {
                $run | Where-Object { $_.address.octets -eq $address.ToString() }
            }
            default {
                $run
            }
        }
    }

    End {
    }
}

function Add-ArubaSWRadiusServer {

    <#
        .SYNOPSIS
        Add a RADIUS server

        .DESCRIPTION
        Add a RADIUS server parameters

        .EXAMPLE
        Add-ArubaSWRadiusServer -address 192.0.2.1 -shared_secret powerarubasw

        Add this server with the mandatory parameters for a radius server.

        .EXAMPLE
        Add-ArubaSWRadiusServer -address 192.0.2.2 -shared_secret powerarubasw -authentication_port 1645 -accounting_port 1646 -is_dyn_authorization_enabled -time_window_type TW_PLUS_OR_MINUS_TIME_WINDOW -time_window 0 -is_oobm

        Add all the parameters for a radius server, with dynamic autorization and oobm enable.
    #>

    Param(
        [Parameter (Mandatory = $true)]
        [ipaddress]$address,
        [Parameter (Mandatory = $true)]
        [string]$shared_secret,
        [Parameter (Mandatory = $false)]
        [int]$authentication_port,
        [Parameter (Mandatory = $false)]
        [int]$accounting_port,
        [Parameter (Mandatory = $false)]
        [switch]$is_dyn_authorization_enabled,
        [Parameter (Mandatory = $false)]
        [ValidateSet ("TW_POSITIVE_TIME_WINDOW", "TW_PLUS_OR_MINUS_TIME_WINDOW")]
        [string]$time_window_type,
        [Parameter (Mandatory = $false)]
        [ValidateRange (0, 65535)]
        [int]$time_window,
        [Parameter (Mandatory = $false)]
        [switch]$is_oobm,
        [Parameter (Mandatory = $False)]
        [ValidateNotNullOrEmpty()]
        [PSObject]$connection = $DefaultArubaSWConnection
    )

    Begin {
    }

    Process {

        $uri = "radius_servers"

        $conf = New-Object -TypeName PSObject

        $ip = New-Object -TypeName PSObject

        $ip | Add-Member -name "version" -MemberType NoteProperty -Value "IAV_IP_V4"

        $ip | Add-Member -name "octets" -MemberType NoteProperty -Value $address.ToString()

        $conf | Add-Member -name "address" -membertype NoteProperty -Value $ip

        $conf | Add-Member -name "shared_secret" -MemberType NoteProperty -Value $shared_secret

        if ($PsBoundParameters.ContainsKey('authentication_port')) {
            $conf | Add-Member -name "authentication_port" -membertype NoteProperty -Value $authentication_port
        }

        if ($PsBoundParameters.ContainsKey('accounting_port')) {
            $conf | Add-Member -name "accounting_port" -membertype NoteProperty -Value $accounting_port
        }

        if ( $PsBoundParameters.ContainsKey('is_dyn_authorization_enabled') ) {
            if ( $is_dyn_authorization_enabled ) {
                $conf | Add-Member -name "is_dyn_authorization_enabled" -membertype NoteProperty -Value $true
            }
            else {
                $conf | Add-Member -name "is_dyn_authorization_enabled" -membertype NoteProperty -Value $false
            }
        }

        if ($PsBoundParameters.ContainsKey('time_window_type')) {
            $conf | Add-Member -name "time_window_type" -membertype NoteProperty -Value $time_window_type
        }

        if ($PsBoundParameters.ContainsKey('time_window')) {
            $conf | Add-Member -name "time_window" -membertype NoteProperty -Value $time_window
        }

        if ( $PsBoundParameters.ContainsKey('is_oobm') ) {
            if ( $is_oobm ) {
                $conf | Add-Member -name "is_oobm" -membertype NoteProperty -Value $true
            }
            else {
                $conf | Add-Member -name "is_oobm" -membertype NoteProperty -Value $false
            }
        }

        $response = Invoke-ArubaSWWebRequest -method "POST" -body $conf -uri $uri -connection $connection

        $run = $response | ConvertFrom-Json

        $run
    }

    End {
    }
}

function Set-ArubaSWRadiusServer {

    <#
        .SYNOPSIS
        Set a RADIUS server.

        .DESCRIPTION
        Set a RADIUS server parameters.

        .EXAMPLE
        Get-ArubaSWRadiusServer -id 1 | Set-ArubaSWRadiusServer -shared_secret powerarubasw

        Change shared secret of RADIUS Server id 1

        .EXAMPLE
        Get-ArubaSWRadiusServer -address 192.2.0.2 | Set-ArubaSWRadiusServer -shared_secret powerarubasw -authentication_port 1812 -accounting_port 1813 -is_dyn_authorization_enabled -time_window_type TW_PLUS_OR_MINUS_TIME_WINDOW -time_window 0 -is_oobm

        Change all the parameters for a radius server with ip address 192.2.0.2, with dynamic autorization and oobm enable.

        .EXAMPLE
        Set-ArubaSWRadiusServer -id 3 -is_oobm

        Enable OOBM on RADIUS Server id 3
    #>

    [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'medium')]
    Param(
        [Parameter (Mandatory = $true, ValueFromPipeline = $true, ParameterSetName = "id")]
        [ValidateRange (1, 15)]
        [int]$id,
        [Parameter (Mandatory = $true, ValueFromPipeline = $true, ParameterSetName = "id_server")]
        [psobject]$id_server,
        [Parameter (Mandatory = $false)]
        [string]$shared_secret,
        [Parameter (Mandatory = $false)]
        [int]$authentication_port,
        [Parameter (Mandatory = $false)]
        [int]$accounting_port,
        [Parameter (Mandatory = $false)]
        [switch]$is_dyn_authorization_enabled,
        [Parameter (Mandatory = $false)]
        [ValidateSet ("TW_POSITIVE_TIME_WINDOW", "TW_PLUS_OR_MINUS_TIME_WINDOW")]
        [string]$time_window_type,
        [Parameter (Mandatory = $false)]
        [ValidateRange (0, 65535)]
        [int]$time_window,
        [Parameter (Mandatory = $false)]
        [switch]$is_oobm,
        [Parameter (Mandatory = $False)]
        [ValidateNotNullOrEmpty()]
        [PSObject]$connection = $DefaultArubaSWConnection
    )

    Begin {
    }

    Process {
        if ($id_server) {
            $id = $id_server.radius_server_id
        }

        $uri = "radius_servers/${id}"

        $conf = New-Object -TypeName PSObject

        if ($PsBoundParameters.ContainsKey('id')) {
            $address = Get-ArubaSWRadiusServer -id $id
            $conf | Add-Member -name "address" -MemberType NoteProperty -Value $address.address
        }
        else {
            $conf | Add-Member -name "address" -MemberType NoteProperty -Value $id_server.address
        }

        if ($PsBoundParameters.ContainsKey('shared_secret')) {
            $conf | Add-Member -name "shared_secret" -MemberType NoteProperty -Value $shared_secret
        }

        if ($PsBoundParameters.ContainsKey('authentication_port')) {
            $conf | Add-Member -name "authentication_port" -membertype NoteProperty -Value $authentication_port
        }

        if ($PsBoundParameters.ContainsKey('accounting_port')) {
            $conf | Add-Member -name "accounting_port" -membertype NoteProperty -Value $accounting_port
        }

        if ( $PsBoundParameters.ContainsKey('is_dyn_authorization_enabled') ) {
            if ( $is_dyn_authorization_enabled ) {
                $conf | Add-Member -name "is_dyn_authorization_enabled" -membertype NoteProperty -Value $true
            }
            else {
                $conf | Add-Member -name "is_dyn_authorization_enabled" -membertype NoteProperty -Value $false
            }
        }

        if ($PsBoundParameters.ContainsKey('time_window_type')) {
            $conf | Add-Member -name "time_window_type" -membertype NoteProperty -Value $time_window_type
        }

        if ($PsBoundParameters.ContainsKey('time_window')) {
            $conf | Add-Member -name "time_window" -membertype NoteProperty -Value $time_window
        }

        if ( $PsBoundParameters.ContainsKey('is_oobm') ) {
            if ( $is_oobm ) {
                $conf | Add-Member -name "is_oobm" -membertype NoteProperty -Value $true
            }
            else {
                $conf | Add-Member -name "is_oobm" -membertype NoteProperty -Value $false
            }
        }

        if ($PSCmdlet.ShouldProcess($id, 'Configure RADIUS Server')) {
            $response = Invoke-ArubaSWWebRequest -method "PUT" -body $conf -uri $uri -connection $connection

            $run = $response | ConvertFrom-Json

            $run
        }
    }

    End {
    }
}


function Remove-ArubaSWRadiusServer {

    <#
        .SYNOPSIS
        Remove a RADIUS server.

        .DESCRIPTION
        Remove a RADIUS server parameters.

        .EXAMPLE
        Get-ArubaSWRadiusServer -address 192.0.2.2 | Remove-ArubaSWRadiusServer

        Remove the RADIUS server with IP Address 192.0.2.2

        .EXAMPLE
        Remove-ArubaSWRadiusServer -id 1 -confirm:$false

        Remove the RADIUS server with id 1 without confirmation
    #>

    [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'high')]
    Param(
        [Parameter (Mandatory = $true, ValueFromPipeline = $true, ParameterSetName = "id")]
        [ValidateRange (1, 15)]
        [int]$id,
        [Parameter (Mandatory = $true, ValueFromPipeline = $true, ParameterSetName = "id_server")]
        [psobject]$id_server,
        [ValidateNotNullOrEmpty()]
        [PSObject]$connection = $DefaultArubaSWConnection
    )

    Begin {
    }

    Process {

        if ($id_server) {
            $id = $id_server.radius_server_id
        }

        $uri = "radius_servers/${id}"

        if ($PSCmdlet.ShouldProcess($id, 'Remove RADIUS Server')) {
            $null = Invoke-ArubaSWWebRequest -method "DELETE" -uri $uri -connection $connection
        }
    }


    End {
    }
}