Get-AuvikDeviceAvailabilityStatistics
SYNOPSIS
Provides historical device uptime and outage statistics.
SYNTAX
Get-AuvikDeviceAvailabilityStatistics -statId <String> [-tenants <String[]>] -filter_fromTime <DateTime>
[-filter_thruTime <DateTime>] -filter_interval <String> [-filter_deviceType <String>]
[-filter_deviceId <String>] [-page_first <Int64>] [-page_after <String>] [-page_last <Int64>]
[-page_before <String>] [-allPages] [<CommonParameters>]
DESCRIPTION
The Get-AuvikDeviceAvailabilityStatistics cmdlet provides historical device uptime and outage statistics.
EXAMPLES
EXAMPLE 1
Get-AuvikDeviceAvailabilityStatistics -statId uptime -filter_fromTime 2023-10-03 -filter_interval day
Provides the first 100 historical device uptime and outage statistics.
EXAMPLE 2
Get-AuvikDeviceAvailabilityStatistics -statId uptime -filter_fromTime 2023-10-03 -filter_interval day -page_first 1000 -allPages
Provides all historical device uptime and outage statistics.
PARAMETERS
-statId
ID of statistic to return
Allowed values: “uptime”, “outage”
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-tenants
Comma delimited list of tenant IDs to request info from
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-filter_fromTime
Timestamp from which you want to query
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-filter_thruTime
Timestamp to which you want to query (defaults to current time)
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-filter_interval
Statistics reporting interval
Allowed values: “minute”, “hour”, “day”
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-filter_deviceType
Filter by device type
Allowed values: “unknown”, “switch”, “l3Switch”, “router”, “accessPoint”, “firewall”, “workstation”, “server”, “storage”, “printer”, “copier”, “hypervisor”, “multimedia”, “phone”, “tablet”, “handheld”, “virtualAppliance”, “bridge”, “controller”, “hub”, “modem”, “ups”, “module”, “loadBalancer”, “camera”, “telecommunications”, “packetProcessor”, “chassis”, “airConditioner”, “virtualMachine”, “pdu”, “ipPhone”, “backhaul”, “internetOfThings”, “voipSwitch”, “stack”, “backupDevice”, “timeClock”, “lightingDevice”, “audioVisual”, “securityAppliance”, “utm”, “alarm”, “buildingManagement”, “ipmi”, “thinAccessPoint”, “thinClient”
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-filter_deviceId
Filter by device ID
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-page_first
For paginated responses, the first N elements will be returned Used in combination with page[after]
Default Value: 100
Type: Int64
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-page_after
Cursor after which elements will be returned as a page The page size is provided by page[first]
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-page_last
For paginated responses, the last N services will be returned Used in combination with page[before]
Default Value: 100
Type: Int64
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-page_before
Cursor before which elements will be returned as a page The page size is provided by page[last]
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-allPages
Returns all items from an endpoint
Highly recommended to only use with filters to reduce API errors\timeouts
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
OUTPUTS
NOTES
N\A