Skip to content

Latest commit

 

History

History
152 lines (117 loc) · 2.98 KB

Find-GLSearchAbsoluteStatsAbsolute.md

File metadata and controls

152 lines (117 loc) · 2.98 KB
external help file Module Name online version schema
PSGraylog-help.xml
PSGraylog
2.0.0

Find-GLSearchAbsoluteStatsAbsolute

SYNOPSIS

Field statistics for a query using an absolute timerange.

SYNTAX

Find-GLSearchAbsoluteStatsAbsolute [-Field] <String> [-Query] <String> [-From] <DateTime> [-To] <DateTime>
 [[-Filter] <String>] [[-APIUrl] <String>] [[-Credential] <PSCredential>] [<CommonParameters>]

DESCRIPTION

Field statistics for a query using an absolute timerange. Returns statistics like min/max or standard deviation of numeric fields over the whole query result set.

For more information about this cmdlet - please search for /search/universal/absolute/stats in the docs available at http(s)://your-graylog.fqdn/api/api-docs

EXAMPLES

EXAMPLE 1

-Query <String> -FromString <DateTime> -ToString <DateTime> -Filter <String>

PARAMETERS

-Field

Message field of numeric type to return statistics for

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Query

Query (Lucene syntax)

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-From

Timerange start. See search method description for date format

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-To

Timerange end. See search method description for date format

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: True
Position: 4
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Filter

Filter

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-APIUrl

Base url for the API, normally https://<grayloghost>:<port>/api

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: $Global:GLApiUrl
Accept pipeline input: False
Accept wildcard characters: False

-Credential

Graylog credentials as username:password or use Convert-GLTokenToCredential for token usage

Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: $Global:GLCredential
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 (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

Auto generated

RELATED LINKS