Skip to content

Latest commit

 

History

History
120 lines (91 loc) · 2.3 KB

Analyze-GLMessages.md

File metadata and controls

120 lines (91 loc) · 2.3 KB
external help file Module Name online version schema
PSGraylog-help.xml
PSGraylog
2.0.0

Analyze-GLMessages

SYNOPSIS

Analyze a message string

SYNTAX

Analyze-GLMessages [-Index] <String> [[-Analyzer] <String>] [-String] <String> [[-APIUrl] <String>]
 [[-Credential] <PSCredential>] [<CommonParameters>]

DESCRIPTION

Analyze a message string Returns what tokens/terms a message string (message or full_message) is split to.

For more information about this cmdlet - please search for /messages/{index}/analyze in the docs available at http(s)://your-graylog.fqdn/api/api-docs

EXAMPLES

EXAMPLE 1

-Analyzer <String> -String <String>

PARAMETERS

-Index

The index the message containing the string is stored in.

Type: String
Parameter Sets: (All)
Aliases:

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

-Analyzer

The analyzer to use.

Type: String
Parameter Sets: (All)
Aliases:

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

-String

The string to analyze.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
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: 4
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: 5
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