New-PodeLogSplunkMethod
SYNOPSIS
Creates a new Splunk Log Method.
SYNTAX
New-PodeLogSplunkMethod [[-Id] <String>] [-BaseUrl] <String> [-Token] <String> [[-SourceType] <String>]
[[-Source] <String>] [[-Index] <String>] [[-BatchInfo] <Hashtable>] [-SkipCertificateCheck]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Creates a new Splunk Log Method for outputting log items to a Splunk HTTP Event Collector (HEC) endpoint.
EXAMPLES
EXAMPLE 1
' -Source 'my_source'
EXAMPLE 2
$batchInfo = New-PodeLogBatchInfo -Size 10 -Timeout 10
$methodId = New-PodeLogSplunkMethod -BaseUrl 'https://splunk.example.com:8088' -Token '<token>' -SourceType 'syslog' -BatchInfo $batchInfo
EXAMPLE 3
' -SkipCertificateCheck
PARAMETERS
-BaseUrl
The base URL of the Splunk HEC endpoint, e.g., 'https://splunk.example.com:8088'.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-BatchInfo
An optional hashtable containing batch configuration for writing log items in bulk. Should be created using New-PodeLogBatchInfo.
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Id
An optional ID to assign to the Log Method. If not supplied, a random ID will be generated.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Index
An optional index to include with the log items.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SkipCertificateCheck
If supplied, the API request will skip certificate validation checks.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Source
An optional source to include with the log items. (Default: the server's AppName)
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SourceType
An optional source type to include with the log items.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Token
The authentication token for the Splunk HEC endpoint.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
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.