-
Notifications
You must be signed in to change notification settings - Fork 4
Get UnifiHourlyApStats
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-UnifiHourlyApStats.md schema: 2.0.0
Get hourly statistics for all or a given access point via API on the UniFi SDN Controller.
Get-UnifiHourlyApStats [[-UnifiSite] <String>] [[-Mac] <String>] [[-Start] <String>] [[-End] <String>]
[<CommonParameters>]
Get hourly statistics for all or a given access point via Ubiquiti (UBNT) UniFi RESTful API request on the UniFi SDN Controller.
For convenience, we return the traffic Megabytes and not in bytes (as the UniFi does it).
We also return real timestamps instead of the epoc/unix timestaps that the UniFi API returns.
Get-UnifiHourlyApStats
Get hourly stats for all or just one access points in the default site
Get-UnifiHourlyApStats -Mac '78:8a:20:59:e6:88'
Get hourly stats for a given (78:8a:20:59:e6:88) access point in the default site
(Get-UnifiHourlyApStats -Start '1548971935421' -End '1548975579019')
Get the statistics for a given time period.
(Get-UnifiHourlyApStats -Start '1548971935421')
Get hourly stats for the last 2 hours (was the timestamp while the sample was created)
Get-UnifiHourlyApStats -UnifiSite 'contoso' | Where-Object { ($_.ConnectedClients -ne '0') -and ($_.Traffic -ne '0.00') }
Get hourly stats for all access points in the site 'contoso', results are filtered and display only if clients are connected and traffic is generated.
(Get-UnifiHourlyApStats -UnifiSite 'contoso')[-1]
Get hourly stats for all access points in the site 'contoso'
ID of the client-device to be modified
Type: String
Parameter Sets: (All)
Aliases: Site
Required: False
Position: 1
Default value: Default
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: FalseClient MAC address
Type: String
Parameter Sets: (All)
Aliases: UniFiMac, MacAddress
Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: FalseStartpoint in UniFi Unix timestamp in milliseconds
Type: String
Parameter Sets: (All)
Aliases: Startpoint, StartTime
Required: False
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: FalseEndpoint in UniFi Unix timestamp in milliseconds
Type: String
Parameter Sets: (All)
Aliases: EndPoint, EndTime
Required: False
Position: 4
Default value: None
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).
Defaults to the past 7 days (7*24 hours) UniFi controller older then 4.6.6 keeps the statistics only for 5 hours. And it depends on your controller settings (Setup in "Settings/Maintenance" in the "DATA RETENTION" Block)