SysLog Module
Properties Methods Events Configuration Settings Errors
The Syslog component is used to send and receive network system log packets.
Syntax
nsoftware.IPWorks.Syslog
Remarks
The Syslog class implements a lightweight BSD syslog client as specified in RFC 3164 (UDP), RFC 5425 (SSL/TLS), and RFC 6587 (TCP). The class is used to send and receive BSD system network logging packets.
The first step in using the Syslog class is to set LocalHost and LocalPort to the interface and port on which the host will be receiving syslog packets, then set Active to True. For each packet, the class will parse the headers and message and fire a PacketIn event.
Property List
The following is the full list of the properties of the module with short descriptions. Click on the links for further details.
Active | Enables or disables sending and receiving of data. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
LocalPort | The port in the local host where Syslog binds. |
RemoteHost | Sets a specific host for outgoing log packets. |
RemotePort | Sets a specific port for outgoing log packets. |
SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
SSLAuthenticateClients | If true, the server asks the client(s) for a certificate. |
SSLCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertStore | The name of the certificate store for the client certificate. |
SSLCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
SSLCertStoreType | The type of certificate store for this certificate. |
SSLCertSubject | The subject of the certificate used for client authentication. |
SSLEnabled | Whether TLS/SSL is enabled. |
SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
UseTCP | Whether to use TCP. |
Method List
The following is the full list of the methods of the module with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
DoEvents | Processes events from the internal message queue. |
Reset | Reset the component. |
SendPacket | Send a log packet to RemoteHost . |
Event List
The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.
Connected | Fired immediately after a connection completes (or fails). |
ConnectionStatus | TBD. |
Disconnected | TBD. |
Error | Information about errors during data delivery. |
PacketIn | Fires whenever a system log packet is received. |
SSLClientAuthentication | Fired when the client presents its credentials to the server. |
SSLServerAuthentication | Fires when connecting to the server. |
SSLStatus | Shows the progress of the secure connection. |
Configuration Settings
The following is a list of configuration settings for the module with short descriptions. Click on the links for further details.
AcceptData | Whether the component can accept/receive data. |
AppName | Sets the App-Name field in RFC 5424. |
MsgId | Sets the MsgId field in RFC 5424. |
ProcId | Sets the ProcId field in RFC 5424. |
ReceivedAppName | Returns the value of the App-Name field in RFC 5424. |
ReceivedMsgId | Returns the value of the MsgId field in RFC 5424. |
ReceivedProcId | Returns the value of the ProcId field in RFC 5424. |
ReceivedSDElementCount | Returns the number of Structured-data elements in RFC 5424. |
ReceivedSDElementId | Returns the Sd-Id value of the Sd-element with the specified SDElementIndex in RFC 5424. |
ReceivedSDElementIndex | Returns the index of the Structured-Data element in RFC 5424. |
ReceivedSDParamCount | Returns the number of the Sd-param values for the specified SDElementIndex in RFC 5424. |
ReceivedSDParamName | Returns the name of the SD-Param field in RFC 5424. |
ReceivedSDParamValue | Returns the value of the SD-Param field in RFC 5424. |
SDElementCount | Sets the number of Structured-data elements in RFC 5424. |
SDElementId | Sets the Sd-Id value of the Sd-element with the specified SDElementIndex in RFC 5424. |
SDElementIndex | Sets the index of the Structured-Data element in RFC 5424. |
SDParamCount | Sets the number of the Sd-param values for the specified SDElementIndex in RFC 5424. |
SDParamName | Sets the name of the SD-Param field in RFC 5424. |
SDParamValue | Sets the value of the SD-Param field in RFC 5424. |
TCPMessageDelimiter | The message delimiter to use (if any) when sending and receiving over TCP. |
UseHostname | Determines if the local host name or IP address is used in the Syslog header. |
UseLocalTime | Indicates whether to use local time or GMT time for packet timestamps. |
Version | Determines which Syslog version to use. |
CaptureIPPacketInfo | Used to capture the packet information. |
DestinationAddress | Used to get the destination address from the packet information. |
DontFragment | Used to set the Don't Fragment flag of outgoing packets. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the component binds. |
MaxPacketSize | The maximum length of the packets that can be received. |
QOSDSCPValue | Used to specify an arbitrary QOS/DSCP setting (optional). |
QOSTrafficType | Used to specify QOS/DSCP settings (optional). |
ShareLocalPort | If set to True, allows more than one instance of the component to be active on the same local port. |
UseConnection | Determines whether to use a connected socket. |
UseIPv6 | Whether or not to use IPv6. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |