NAME
Set-DcsSyslogSettings
SYNOPSIS
Adds Syslog settings for the server group used for sending log messages to the Syslog server.
SYNTAX
Set-DcsSyslogSettings [ -SyslogServer <String> ] [ -UDPPort <Int32> ] [ -Level <String[]> ] [ -AllLevels <Boolean> ] [ -SourceType <String[]> ] [ -AllSources <Boolean> ]
DESCRIPTION
Adds Syslog settings for the server group used for sending log messages to the Syslog server. To send the log messages, the Syslog Server IP, port number, and other settings must be configured. The value of the parameters can be set to the default value or changed to a specific value.
PARAMETERS
- -SyslogServer<String>
- Name, ID, or address that identifies the Syslog server.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -UdpPort<Int32>
- This parameter is used to set the UDP port of the Syslog server. If not specified, the default port number, that is, 514 will be used.
-
- Required: false
- Position: named
- Default value: 514
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -Level<String[]>
- This parameter is used to filter log messages. Log messages will be sent only when the Log Level matches with one of the specified values of the Level field. By default, all the messages will be sent.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -AllLevels<Boolean>
- This parameter, when set to true, sets the value of the Level parameter to include all Log Levels.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
- -SourceType<String[]>
- This parameter is used to filter log messages. Log messages will be sent if the Log Source matches with one of the specified values of the Level field. By default, all messages will be sent.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -AllSources<Boolean>
- This parameter, when set to true, sets the value of the Level parameter to include all Log Levels.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
INPUTS
OUTPUTS
SyslogServerSettings : Object that contains the Syslog settings for the server group.
NOTES
-
Also see: Get-DcsSyslogSettings, Reset-DcsSyslogSettings, and Test-DcsSyslogSettings.
-
SourceType and AllSources are two different parameter sets, which means both cannot be specified at the same time, and they must be used in separate queries.
-
Level and AllLevels are two different parameter sets, which means both cannot be specified at the same time, and they must be used in separate queries.
EXAMPLES
Set-DcsSyslogSettings -SyslogServer 10.111.0.181 -Level "Info", "Error" -SourceType "Ports", "VirtualDisks"
Syslog Server for sending log messages is set as "10.111.0.181". The Level filter is set to "Info" and "Error". The SourceType filter is set to "Ports" and "VirtualDisks". The UDP port was not specified, so the default setting of 514 is used.
| SyslogServer | : | 10.111.0.181 |
| UdpPort | : | 514 |
| SyslogLogLevel | : | {Info, Error} |
| SyslogAllLevels | : | False |
| SyslogSourceType | : | {Ports, VirtualDisks} |
| SyslogAllSources | : | False |
Set-DcsSyslogSettings -SyslogServer 10.111.0.181 -AllSources $true -AllLevels $true
Syslog Server for sending log messages is set as "10.111.0.181". AllSources and AllLevels parameters are set to true. SyslogLogLevel and SyslogSourceType parameter changes to includes all the Levels and SourceTypes.
| SyslogServer | : | 10.111.0.181 |
| UdpPort | : | 514 |
| SyslogLogLevel | : | {Trace, Info, Warning, Error...} |
| SyslogAllLevels | : | True |
| SyslogSourceType | : | {General, DiskPools, Mirrors, Monitors...} |
| SyslogAllSources | : | True |