Send-Syslog Cmdlet

Parameters   Output Objects   Configuration Settings  

The Send-Syslog cmdlet is used to send network system log packets.

Syntax

Send-Syslog [parameters]

Remarks

This cmdlet implements a lightweight BSD syslog client as specified in RFC 3164. The cmdlet is used to send BSD system network logging packets.

To use the cmdlet, first set the destination Server. Put the text you wish to send in Message, indicate the type of message you're sending with Facility, and set the importance of the message with Severity. Any response received will be returned in one or more Syslog objects.

The cmdlets support pipeline input for some of their parameters. Prebuilding an object and piping it to the cmdlet is very useful, but should be used with caution to prevent security conflicts. Steps have been taken to decrease the risk of a possibly accidental pipe to the cmdlet, for instance, the Credential parameter cannot be piped to the cmdlet and must be specified manually.


# send a syslog message with default severity (alert) and default type (user-level)
send-syslog 10.0.1.173 -message "test from NetCmdlets"

Parameter List


The following is the full list of the parameters of the cmdlet with short descriptions. Click on the links for further details.

LogFileThe location of a file to which debug information is written.
ConfigSpecifies one or more configuration settings.
FacilityType of message to be sent.
LocalIPThe IP address of the local interface to use.
LocalPortThe local port that the cmdlet should use.
LogFileThe location of a file to which debug information is written.
MessageSyslog message to send.
RemotePortThe remote port to send the message to.
ServerThe address of the Server.
SeverityImportance of message.
TimeoutThe maximum time allowed for the operation.

Output Objects


The following is the full list of the output objects returned by the cmdlet with short descriptions. Click on the links for further details.

SyslogCreated whenever a system log packet is sent.

Configuration Settings


The following is a list of configuration settings for the cmdlet with short descriptions. Click on the links for further details.

AcceptDataWhether the component can accept/receive data.
AppNameSets the App-Name field in RFC 5424.
MsgIdSets the MsgId field in RFC 5424.
ProcIdSets the ProcId field in RFC 5424.
SDElementCountReturns the number of Structured-data elements in RFC 5424.
SDElementIdReturns the Sd-Id value of the Sd-element with the specified SDElementIndex in RFC 5424.
SDElementIndexSets the index of the Structured-Data element in RFC 5424.
SDParamCountReturns the number of the Sd-param values for the specified SDParamIndex in RFC 5424.
SDParamIndexSets the index of the Structured-Data element in RFC 5424.
SDParamNameSets the name of the SD-Param field in RFC 5424.
SDParamValueSets the value of the SD-Param field in RFC 5424.
StructDataSets the Structured-Data field in RFC 5424.
TCPMessageDelimiterThe message delimiter to use (if any) when sending and receiving over TCP.
UseHostnameDetermines if the local host name or IP address is used in the Syslog header.
UseLocalTimeIndicates whether to use local time or GMT time for packet timestamps.
VersionDetermines which Syslog version to use.
CaptureIPPacketInfoUsed to capture the packet information.
DestinationAddressUsed to get the destination address from the packet information.
DontFragmentUsed to set the Don't Fragment flag of outgoing packets.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the cmdlet binds.
MaxPacketSizeThe maximum length of the packets that can be received.
QOSDSCPValueUsed to specify an arbitrary QOS/DSCP setting (optional).
QOSTrafficTypeUsed to specify QOS/DSCP settings (optional).
ShareLocalPortIf set to True, allows more than one instance of the cmdlet to be active on the same local port.
UseConnectionDetermines whether to use a connected socket.
UseIPv6Whether or not to use IPv6.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
UseInternalSecurityAPITells the cmdlet whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
NetCmdlets 2020 - Version 20.0 [Build 7877]