New-PodeLogSyslogInfo
SYNOPSIS
Creates a new syslog information object.
SYNTAX
New-PodeLogSyslogInfo [[-Facility] <Int32>] [[-AppName] <String>] [[-Tags] <Hashtable>]
[[-Format] <PodeSyslogFormat>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
This function creates a new syslog information object with the specified parameters.
EXAMPLES
EXAMPLE 1
$info = New-PodeLogSyslogInfo -Format 'RFC3164'
EXAMPLE 2
$info = New-PodeLogSyslogInfo -Facility 18 -AppName 'MyApp' -Tags @{ Environment = 'Production'; Version = '1.0' } -Format 'RFC5424'
EXAMPLE 3
$info = New-PodeLogSyslogInfo -AppName 'MyApp'
PARAMETERS
-AppName
The name of the application generating the log message. (Default: the server's AppName)
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Facility
The syslog facility code. (Default: 16, which corresponds to local0 for web/app logs)
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: 16
Accept pipeline input: False
Accept wildcard characters: False
-Format
The syslog format to use. (Default: Server default, or 'RFC5424' if no default set)
Type: PodeSyslogFormat
Parameter Sets: (All)
Aliases:
Accepted values: RFC3164, RFC5424
Required: False
Position: 4
Default value: RFC5424
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
-Tags
An optional hashtable of tags to include in the syslog message.
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
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.