Private/Helper/Start-iPerfTest.ps1

<#
Copyright © 2024 Integris. For internal company use only. All rights reserved.
#>


FUNCTION Start-iPerfTest {
    <#
    .SYNOPSIS
    Starts an iPerf3 test to a specified server.
 
    .DESCRIPTION
    This function initiates an iPerf3 network performance test to the specified server address.
 
    .PARAMETER ServerAddress
    The address of the iPerf3 server to connect to for testing.
 
    .EXAMPLE
    Start-iPerfTest -ServerAddress "192.168.1.1"
 
    .NOTES
    The function uses the Start-iPerf function to run the iPerf3 test.
    #>


    PARAM (
        [Parameter(Mandatory, ParameterSetName = 'ServerAddress')]
        [String]$ServerAddress
    )
    
    Start-iPerf -ServerAddress $ServerAddress
}