Get-AuvikInterfaceStatistics

SYNOPSIS

Provides historical interface statistics such as bandwidth and packet loss.

SYNTAX

Get-AuvikInterfaceStatistics -statId <String> [-tenants <String[]>] -filter_fromTime <DateTime>
 [-filter_thruTime <DateTime>] -filter_interval <String> [-filter_interfaceType <String>]
 [-filter_interfaceId <String>] [-filter_parentDevice <String>] [-page_first <Int64>] [-page_after <String>]
 [-page_last <Int64>] [-page_before <String>] [-allPages] [<CommonParameters>]

DESCRIPTION

The Get-AuvikInterfaceStatistics cmdlet provides historical interface statistics such as bandwidth and packet loss.

EXAMPLES

EXAMPLE 1

Get-AuvikInterfaceStatistics -statId bandwidth -filter_fromTime 2023-10-03 -filter_interval day

Provides the first 100 historical interface statistics such as bandwidth and packet loss.

EXAMPLE 2

Get-AuvikInterfaceStatistics -statId bandwidth -filter_fromTime 2023-10-03 -filter_interval day -page_first 1000 -allPages

Provides all historical interface statistics such as bandwidth and packet loss.

PARAMETERS

-statId

ID of statistic to return

Allowed values: “bandwidth”, “utilization”, “packetLoss”, “packetDiscard”, “packetMulticast”, “packetUnicast”, “packetBroadcast”

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_interfaceType

Filter by interface type

Allowed values: “ethernet”, “wifi”, “bluetooth”, “cdma”, “coax”, “cpu”, “distributedVirtualSwitch”, “firewire”, “gsm”, “ieee8023AdLag”, “inferredWired”, “inferredWireless”, “interface”, “linkAggregation”, “loopback”, “modem”, “wimax”, “optical”, “other”, “parallel”, “ppp”, “radiomac”, “rs232”, “tunnel”, “unknown”, “usb”, “virtualBridge”, “virtualNic”, “virtualSwitch”, “vlan”

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-filter_interfaceId

Filter by interface ID

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-filter_parentDevice

Filter by the entity’s parent 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

RELATED LINKS

https://celerium.github.io/Auvik-PowerShellWrapper/site/statistics/Get-AuvikInterfaceStatistics.html