-
Notifications
You must be signed in to change notification settings - Fork 4
Get UnifiSpeedTestResult
external help file: UniFiTooling-help.xml HelpVersion: 1.1.0 Locale: en-US Module Guid: 7fff91a0-02eb-4df2-84d5-c7d3cd7f7a5d Module Name: UniFiTooling online version: https://github.com/Enatec/UniFiTooling/raw/master/docs/Get-UnifiSpeedTestResult.md schema: 2.0.0
Get USG speed test results via API on the UniFi SDN Controller.
Get-UnifiSpeedTestResult [[-StartDate] <DateTime>] [[-EndDate] <DateTime>] [[-UnifiSite] <String>] [-all]
[-UniFiValues] [-last] [<CommonParameters>]
Get-UnifiSpeedTestResult [[-StartDate] <DateTime>] [[-Timeframe] <Int32>] [[-UnifiSite] <String>] [-all]
[-UniFiValues] [-last] [<CommonParameters>]
Get UniFi Security Gateway (USG) speed test results via Ubiquiti (UBNT) UniFi RESTful API request on the UniFi SDN Controller.
Get-UnifiSpeedTestResult -last
Only test latest Speed Test Result will be displayed
Get-UnifiSpeedTestResult -all
Get all the UniFi Security Gateway (USG) Speed Test results
Get-UnifiSpeedTestResult -all | Sort-Object -Property time
Get all the UniFi Security Gateway (USG) Speed Test results, sorted by date
Get-UnifiSpeedTestResult | Select-Object -Property *
Get the UniFi Security Gateway (USG) Speed Test results from the last 24 hours (default), returns all values
Get-UnifiSpeedTestResult -UnifiSite 'Contoso'
Get the UniFi Security Gateway (USG) Speed Test results from the last 24 hours (default)
Get-UnifiSpeedTestResult -Timeframe 48
Get the UniFi Security Gateway (USG) Speed Test results of the last 48 hours
Get-UnifiSpeedTestResult -StartDate '1/16/2019 12:00 AM' -EndDate '1/16/2019 11:59:59 PM'
Get the UniFi Security Gateway (USG) Speed Test results for a given time/date In the example, all results from 1/16/2019 (all day) will be returned
Start date (valid Date String) Default is now
Type: DateTime
Parameter Sets: (All)
Aliases: Start
Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: FalseTimeframe in hours, default is 24
Type: Int32
Parameter Sets: TimeFrameSet
Aliases: hours
Required: False
Position: 2
Default value: 0
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: FalseEnd date (valid Date String), default is now minus 24 hours
Type: DateTime
Parameter Sets: DateSet
Aliases:
Required: False
Position: 2
Default value: (Get-Date)
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: FalseUniFi Site as configured. The default is: default
Type: String
Parameter Sets: (All)
Aliases: Site
Required: False
Position: 3
Default value: Default
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: FalseGet all existing Speed Test Results
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: False
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: FalseShow results without modifications, like the UniFi Controller creates them
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: False
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: FalseOnly test latest Speed Test Result will be displayed
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: False
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
Initial version that makes it more human readable.
The filetring needs a few more tests.
A UniFi Security Gateway (USG) is required in the UniFi site!