SysLog Class
Properties Methods Events Config Settings Errors
The Syslog class is used to send and receive network system log packets.
Syntax
class 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 local_host and local_port 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 on_packet_in event.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
active | Indicates whether the class is active. |
local_host | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
local_port | The port in the local host where Syslog binds. |
remote_host | Sets a specific host for outgoing log packets. |
remote_port | Sets a specific port for outgoing log packets. |
ssl_accept_server_cert_encoded | This is the certificate (PEM/base64 encoded). |
ssl_authenticate_clients | If set to True, the server asks the client(s) for a certificate. |
ssl_cert_encoded | This is the certificate (PEM/base64 encoded). |
ssl_cert_store | This is the name of the certificate store for the client certificate. |
ssl_cert_store_password | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
ssl_cert_store_type | This is the type of certificate store for this certificate. |
ssl_cert_subject | This is the subject of the certificate used for client authentication. |
ssl_enabled | Whether TLS/SSL is enabled. |
ssl_server_cert_encoded | This is the certificate (PEM/base64 encoded). |
use_tcp | Whether to use TCP. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
activate | Enables sending and receiving of data. |
config | Sets or retrieves a configuration setting. |
deactivate | Disables sending and receive of data. |
do_events | Processes events from the internal message queue. |
reset | Reset the class. |
resolve_remote_host | Resolves the hostname in RemoteHost to an IP address. |
send_packet | Send a log packet to RemoteHost . |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
on_connected | Fired immediately after a connection completes (or fails). |
on_connection_status | Fired to indicate changes in a connection state. |
on_disconnected | Fired when a connection is closed. |
on_error | Information about errors during data delivery. |
on_packet_in | Fires whenever a system log packet is received. |
on_ssl_client_authentication | Fired when the client presents its credentials to the server. |
on_ssl_server_authentication | Fires when connecting to the server. |
on_ssl_status | Shows the progress of the secure connection. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
AcceptData | Whether the class can accept/receive data. |
AppName | Sets the App-Name field in RFC 5424. |
DelayHostResolution | Whether the hostname is resolved when RemoteHost is set. |
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. |
DelayHostResolution | Whether the hostname is resolved when RemoteHost is set. |
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 class 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 class to be active on the same local port. |
SourceIPAddress | Used to set the source IP address used when sending a packet. |
SourceMacAddress | Used to set the source MAC address used when sending a packet. |
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. |
MaskSensitive | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |
active Property
Indicates whether the class is active.
Syntax
def get_active() -> bool: ... def set_active(value: bool) -> None: ...
active = property(get_active, set_active)
Default Value
FALSE
Remarks
This property indicates whether the class is currently active and can send or receive data.
Note: Use the activate or deactivate method to control whether the class is active.
local_host Property
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
def get_local_host() -> str: ... def set_local_host(value: str) -> None: ...
local_host = property(get_local_host, set_local_host)
Default Value
""
Remarks
The local_host property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the local_host property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).
NOTE: local_host is not persistent. You must always set it in code, and never in the property window.
local_port Property
The port in the local host where Syslog binds.
Syntax
def get_local_port() -> int: ... def set_local_port(value: int) -> None: ...
local_port = property(get_local_port, set_local_port)
Default Value
514
Remarks
The local_port property must be set before Syslog is activated (active is set to True). It instructs the class to bind to a specific port (or communication endpoint) in the local machine.
Setting it to 0 (default) enables the TCP/IP stack to choose a port at random. The chosen port will be shown by the local_port property after the connection is established.
local_port cannot be changed once the class is active. Any attempt to set the local_port property when the class is active will generate an error.
The local_port property is useful when trying to connect to services that require a trusted port in the client side.
remote_host Property
Sets a specific host for outgoing log packets.
Syntax
def get_remote_host() -> str: ... def set_remote_host(value: str) -> None: ...
remote_host = property(get_remote_host, set_remote_host)
Default Value
"255.255.255.255"
Remarks
When a call is made to the send_packet method, the class will send it to whatever value is in remote_host. The default value is the broadcast address, "255.255.255.255".
remote_port Property
Sets a specific port for outgoing log packets.
Syntax
def get_remote_port() -> int: ... def set_remote_port(value: int) -> None: ...
remote_port = property(get_remote_port, set_remote_port)
Default Value
514
Remarks
When a call is made to the send_packet method, the class will send to remote_host on remote_port. The default value is 514, the standard port as defined in the BSD syslog RFC 3164.
ssl_accept_server_cert_encoded Property
This is the certificate (PEM/base64 encoded).
Syntax
def get_ssl_accept_server_cert_encoded() -> bytes: ... def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...
ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.
When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.
ssl_authenticate_clients Property
If set to True, the server asks the client(s) for a certificate.
Syntax
def get_ssl_authenticate_clients() -> bool: ... def set_ssl_authenticate_clients(value: bool) -> None: ...
ssl_authenticate_clients = property(get_ssl_authenticate_clients, set_ssl_authenticate_clients)
Default Value
FALSE
Remarks
This property is used in conjunction with the on_ssl_client_authentication event. Please refer to the documentation of the on_ssl_client_authentication event for details.
ssl_cert_encoded Property
This is the certificate (PEM/base64 encoded).
Syntax
def get_ssl_cert_encoded() -> bytes: ... def set_ssl_cert_encoded(value: bytes) -> None: ...
ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.
When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.
ssl_cert_store Property
This is the name of the certificate store for the client certificate.
Syntax
def get_ssl_cert_store() -> bytes: ... def set_ssl_cert_store(value: bytes) -> None: ...
ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password protected, specify the password in ssl_cert_store_password.
ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
ssl_cert_store_password Property
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
def get_ssl_cert_store_password() -> str: ... def set_ssl_cert_store_password(value: str) -> None: ...
ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
ssl_cert_store_type Property
This is the type of certificate store for this certificate.
Syntax
def get_ssl_cert_store_type() -> int: ... def set_ssl_cert_store_type(value: int) -> None: ...
ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS11 interface.
To use a security key the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS11 dll. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ssl_cert_store and set ssl_cert_store_password to the PIN. Code Example: SSH Authentication with Security Key
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
ssl_cert_subject Property
This is the subject of the certificate used for client authentication.
Syntax
def get_ssl_cert_subject() -> str: ... def set_ssl_cert_subject(value: str) -> None: ...
ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.
Field | Meaning |
CN | Common Name. This is commonly a host name like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma it must be quoted.
ssl_enabled Property
Whether TLS/SSL is enabled.
Syntax
def get_ssl_enabled() -> bool: ... def set_ssl_enabled(value: bool) -> None: ...
ssl_enabled = property(get_ssl_enabled, set_ssl_enabled)
Default Value
FALSE
Remarks
This setting specifies whether TLS/SSL is enabled in the class. When False (default) the class operates in plaintext mode. When True TLS/SSL is enabled.
Note: TLS/SSL can only be used when use_tcp is True.
ssl_server_cert_encoded Property
This is the certificate (PEM/base64 encoded).
Syntax
def get_ssl_server_cert_encoded() -> bytes: ...
ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.
When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.
This property is read-only.
use_tcp Property
Whether to use TCP.
Syntax
def get_use_tcp() -> bool: ... def set_use_tcp(value: bool) -> None: ...
use_tcp = property(get_use_tcp, set_use_tcp)
Default Value
FALSE
Remarks
This property specifies whether TCP is used. By default this proprety is False and UDP is used. When set to True TCP will be used as the underlying protocol.
When set to True the following additional settings are also applicable:
- ssl_authenticate_clients
- ssl_enabled
- SSLAcceptServerCert*
- SSLCert*
- SSLServerCert*
- TCPMessageDelimiter
activate Method
Enables sending and receiving of data.
Syntax
def activate() -> None: ...
Remarks
This method enables sending and receiving of data. When called the class will create a communication endpoint (socket) which can be used for sending and receiving UDP messages. This method must be called before using the class to send and receive data.
If the UseConnection configuration setting is set to True, then a local association (connection) to the remote host is also created.
config Method
Sets or retrieves a configuration setting.
Syntax
def config(configuration_string: str) -> str: ...
Remarks
config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
deactivate Method
Disables sending and receive of data.
Syntax
def deactivate() -> None: ...
Remarks
This method disables sending and receiving of data. When called the class will destroy the existing socket and disable data communications.
do_events Method
Processes events from the internal message queue.
Syntax
def do_events() -> None: ...
Remarks
When do_events is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
reset Method
Reset the class.
Syntax
def reset() -> None: ...
Remarks
This method will reset the class's properties to their default values.
resolve_remote_host Method
Resolves the hostname in RemoteHost to an IP address.
Syntax
def resolve_remote_host() -> None: ...
Remarks
This method resolves the hostname specified by remote_host to an IP address. The resolved value is available in the remote_host property after this method returns.
In most cases calling this method is not necessary, the class will resolve the hostname automatically when necessary. If DelayHostResolution is True this method may be called to manually resolve remote_host if desired.
send_packet Method
Send a log packet to RemoteHost .
Syntax
def send_packet(facility: int, severity: int, message: str) -> None: ...
Remarks
System log packets are composed of three main sections, each of which can be broken down into two smaller pieces.
The first section is the PRI, which contains the originating Facility and Severity of the Message. Facility is a value from 0 to 23, with each value being a different part of the system:
0 | Kernel messages |
1 | User-level messages |
2 | Mail system |
3 | System daemons |
4 | Security/authorization messages |
5 | Messages generated internally by syslogd |
6 | Line printer subsystem |
7 | Network news subsystem |
8 | UUCP subsystem |
9 | Clock daemon |
10 | Security/authorization messages |
11 | FTP daemon |
12 | NTP subsystem |
13 | Log audit |
14 | Log alert |
15 | Clock daemon |
16 | Local use |
17 | Local use |
18 | Local use |
19 | Local use |
20 | Local use |
21 | Local use |
22 | Local use |
23 | Local use |
Severity is a value from 0 to 7 using the following convention:
0 | Emergency - the system is unusable |
1 | Alert - action must be taken immediately |
2 | Critical - critical conditions exist |
3 | Error - error conditions exist |
4 | Warning - warning conditions exist |
5 | Notice - normal but significant condition |
6 | Informational - informative message |
7 | Debug - debug-level messages |
The section sections contains a timestamp and hostname, both of which are automatically generated by the class. The third section is the Message itself.
on_connected Event
Fired immediately after a connection completes (or fails).
Syntax
class SysLogConnectedEventParams(object): @property def remote_address() -> str: ... @property def remote_port() -> int: ... @property def status_code() -> int: ... @property def description() -> str: ... # In class SysLog: @property def on_connected() -> Callable[[SysLogConnectedEventParams], None]: ... @on_connected.setter def on_connected(event_hook: Callable[[SysLogConnectedEventParams], None]) -> None: ...
Remarks
This event fires after a connection completes or fails.
StatusCode is the value returned by the system TCP/IP stack. This will be 0 if the connection was successful.
Description contains a human readable description of the status. This will be "OK" if the connection was successful.
RemoteAddress is the IP address of the remote host.
RemotePort is the port on the remote host.
on_connection_status Event
Fired to indicate changes in a connection state.
Syntax
class SysLogConnectionStatusEventParams(object): @property def connection_event() -> str: ... @property def status_code() -> int: ... @property def description() -> str: ... # In class SysLog: @property def on_connection_status() -> Callable[[SysLogConnectionStatusEventParams], None]: ... @on_connection_status.setter def on_connection_status(event_hook: Callable[[SysLogConnectionStatusEventParams], None]) -> None: ...
Remarks
The on_connection_status event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.
The ConnectionEvent parameter indicates the type of connection event. Values may include the following:
Firewall connection complete. | |
Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable). | |
Remote host connection complete. | |
Remote host disconnected. | |
SSL or S/Shell connection broken. | |
Firewall host disconnected. |
on_disconnected Event
Fired when a connection is closed.
Syntax
class SysLogDisconnectedEventParams(object): @property def remote_address() -> str: ... @property def remote_port() -> int: ... @property def status_code() -> int: ... @property def description() -> str: ... # In class SysLog: @property def on_disconnected() -> Callable[[SysLogDisconnectedEventParams], None]: ... @on_disconnected.setter def on_disconnected(event_hook: Callable[[SysLogDisconnectedEventParams], None]) -> None: ...
Remarks
This event fires when a connection is closed.
StatusCode is the value returned by the system TCP/IP stack. This will be 0 if the connection was successful.
Description contains a human readable description of the status. This will be "OK" if the connection was successful.
RemoteAddress is the IP address of the remote host.
RemotePort is the port on the remote host.
on_error Event
Information about errors during data delivery.
Syntax
class SysLogErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class SysLog: @property def on_error() -> Callable[[SysLogErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[SysLogErrorEventParams], None]) -> None: ...
Remarks
The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
on_packet_in Event
Fires whenever a system log packet is received.
Syntax
class SysLogPacketInEventParams(object): @property def facility_code() -> int: ... @property def facility() -> str: ... @property def severity_code() -> int: ... @property def severity() -> str: ... @property def timestamp() -> str: ... @property def hostname() -> str: ... @property def message() -> str: ... @property def conforms() -> bool: ... @property def packet() -> bytes: ... @property def source_address() -> str: ... @property def source_port() -> int: ... # In class SysLog: @property def on_packet_in() -> Callable[[SysLogPacketInEventParams], None]: ... @on_packet_in.setter def on_packet_in(event_hook: Callable[[SysLogPacketInEventParams], None]) -> None: ...
Remarks
System log packets are composed of three main sections, each of which can be broken down into two smaller pieces.
The first section is the PRI, which contains the originating FacilityCode and SeverityCode of the Message. FacilityCode is a value from 0 to 23, with each value being a different part of the system. Facility is a string representation of FacilityCode based on the following convention:
0 | Kernel messages |
1 | User-level messages |
2 | Mail system |
3 | System daemons |
4 | Security/authorization messages |
5 | Messages generated internally by syslogd |
6 | Line printer subsystem |
7 | Network news subsystem |
8 | UUCP subsystem |
9 | Clock daemon |
10 | Security/authorization messages |
11 | FTP daemon |
12 | NTP subsystem |
13 | Log audit |
14 | Log alert |
15 | Clock daemon |
16 | Local use |
17 | Local use |
18 | Local use |
19 | Local use |
20 | Local use |
21 | Local use |
22 | Local use |
23 | Local use |
0 | Emergency - the system is unusable. |
1 | Alert - action must be taken immediately. |
2 | Critical - critical conditions exist. |
3 | Error - error conditions exist. |
4 | Warning - warning conditions exist. |
5 | Notice - normal but significant condition. |
6 | Informational - informative message. |
7 | Debug - debug-level messages. |
The second section contains the Timestamp and Hostname. Timestamp is a string that should conform to the standard structure "MMM DD, HH:MM:SS". The class will search for the Timestamp and verify that it conforms. If it conforms, the class will set Hostname, otherwise, everything after the PRI will be placed in Message.
If Conforms is TRUE, then the original syslog packet conforms to the syslog RFC and Timestamp, Hostname, and Message will all have valid values. Otherwise, you should parse the contents of Packet to verify the fields manually.
SourceAddress and SourcePort are the address and port from which Packet was sent. This can be an intermediate syslog server that is simply forwarding packets from the original host.
on_ssl_client_authentication Event
Fired when the client presents its credentials to the server.
Syntax
class SysLogSSLClientAuthenticationEventParams(object): @property def remote_address() -> str: ... @property def remote_port() -> int: ... @property def cert_encoded() -> bytes: ... @property def cert_subject() -> str: ... @property def cert_issuer() -> str: ... @property def status() -> str: ... @property def accept() -> bool: ... @accept.setter def accept(value) -> None: ... # In class SysLog: @property def on_ssl_client_authentication() -> Callable[[SysLogSSLClientAuthenticationEventParams], None]: ... @on_ssl_client_authentication.setter def on_ssl_client_authentication(event_hook: Callable[[SysLogSSLClientAuthenticationEventParams], None]) -> None: ...
Remarks
This event fires when a client connects to the class and presents a certificate for authentication. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK").
RemoteAddress is the IP address of the connecting client.
RemotePort is the source port of the connecting client.
CertEncoded is the base64 encoded certificate presented by the client.
CertSubject is the subject of the certificate presented by the client.
CertIssuer is the subject of the issuer of the certificate presented by the client.
Status is the stauts of the certificate.
Accept defines whether the certificate is accepted.
on_ssl_server_authentication Event
Fires when connecting to the server.
Syntax
class SysLogSSLServerAuthenticationEventParams(object): @property def remote_address() -> str: ... @property def remote_port() -> int: ... @property def cert_encoded() -> bytes: ... @property def cert_subject() -> str: ... @property def cert_issuer() -> str: ... @property def status() -> str: ... @property def accept() -> bool: ... @accept.setter def accept(value) -> None: ... # In class SysLog: @property def on_ssl_server_authentication() -> Callable[[SysLogSSLServerAuthenticationEventParams], None]: ... @on_ssl_server_authentication.setter def on_ssl_server_authentication(event_hook: Callable[[SysLogSSLServerAuthenticationEventParams], None]) -> None: ...
Remarks
This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
RemoteAddress is the IP address of the server.
RemotePort is the source port of the server.
CertEncoded is the base64 encoded certificate presented by the server.
CertSubject is the subject of the certificate presented by the server.
CertIssuer is the subject of the issuer of the certificate presented by the server.
Status is the stauts of the certificate.
Accept defines whether the certificate is accepted.
on_ssl_status Event
Shows the progress of the secure connection.
Syntax
class SysLogSSLStatusEventParams(object): @property def remote_address() -> str: ... @property def remote_port() -> int: ... @property def message() -> str: ... # In class SysLog: @property def on_ssl_status() -> Callable[[SysLogSSLStatusEventParams], None]: ... @on_ssl_status.setter def on_ssl_status(event_hook: Callable[[SysLogSSLStatusEventParams], None]) -> None: ...
Remarks
The event is fired for informational and logging purposes only. It is used to track the progress of the connection.
RemoteAddress is the IP address of the remote machine.
RemotePort is the port of the remote machine.
Message is the log message.
SysLog Config Settings
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.Syslog Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AcceptData:
Whether the component can accept/receive data.When set to false the class will no longer be able to accept any data. The on_packet_in event will not fire.
The default is true. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AppName:
Sets the App-Name field in RFC 5424.This setting specifies the App-Name field of the message as defined in RFC 5424
Note: This setting is only applicable when Version is set to 1 (RFC 5424) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DelayHostResolution:
Whether the hostname is resolved when RemoteHost is set.This setting specifies whether a hostname is resolved immediately when remote_host is set. If True the class will resolve the hostname and the IP address will be present in the remote_host property.
If False, the hostname is not resolved until needed by the component when a method to connect or send data is called. If desired, resolve_remote_host may called to manually resolve the value in remote_host at any time.
The default value is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MsgId:
Sets the MsgId field in RFC 5424.This setting specifies the MsgId field as defined in RFC 5424.
Note: This setting is only applicable when Version is set to 1 (RFC 5424) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProcId:
Sets the ProcId field in RFC 5424.This setting specifies the ProcId field as defined in RFC 5424.
Note: This setting is only applicable when Version is set to 1 (RFC 5424) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReceivedAppName:
Returns the value of the App-Name field in RFC 5424.This setting returns the value of the App-Name field in RFC 5424.
This setting is applicable when receiving messages. Note: This setting is only applicable when Version is set to 1 (RFC 5424) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReceivedMsgId:
Returns the value of the MsgId field in RFC 5424.This setting returns the value of the MsgId field in RFC 5424.
This setting is applicable when receiving messages. Note: This setting is only applicable when Version is set to 1 (RFC 5424) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReceivedProcId:
Returns the value of the ProcId field in RFC 5424.This setting returns the value of the ProcId field in RFC 5424.
This setting is applicable when receiving messages. Note: This setting is only applicable when Version is set to 1 (RFC 5424) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReceivedSDElementCount:
Returns the number of Structured-data elements in RFC 5424.This setting returns the number of Structured-data elements in RFC 5424.
This setting is applicable when receiving messages. Note: This setting is only applicable when Version is set to 1 (RFC 5424) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReceivedSDElementId:
Returns the Sd-Id value of the Sd-element with the specified SDElementIndex in RFC 5424.This setting returns the Sd-Id value of the SD-element with the specified SDElementIndex.
This setting is applicable when receiving messages. Note: This setting is only applicable when Version is set to 1 (RFC 5424) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReceivedSDElementIndex:
Returns the index of the Structured-Data element in RFC 5424.This setting returns the index of the Structured-Data element as defined in RFC 5424.
This setting is applicable when receiving messages. Note: This setting is only applicable when Version is set to 1 (RFC 5424) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReceivedSDParamCount:
Returns the number of the Sd-param values for the specified SDElementIndex in RFC 5424.This setting returns the number of the SD-param values for the specified SDElementIndex.
This setting is applicable when receiving messages. Note: This setting is only applicable when Version is set to 1 (RFC 5424) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReceivedSDParamName:
Returns the name of the SD-Param field in RFC 5424.This setting returns the name of the SD-Param field as defined in RFC 5424. Append the index in square brackets to refer to the SD-Param field in the specified index: SDParamName[index]
This setting is applicable when receiving messages. Note: This setting is only applicable when Version is set to 1 (RFC 5424) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReceivedSDParamValue:
Returns the value of the SD-Param field in RFC 5424.This setting returns the value of the SD-Param field as defined in RFC 5424. Append the index in square brackets to refer to the SD-Param field in the specified index: SDParamValue[index]
This setting is applicable when receiving messages. Note: This setting is only applicable when Version is set to 1 (RFC 5424) The example below demonstrates how to obtain the structured data information from a received message:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SDElementCount:
Sets the number of Structured-data elements in RFC 5424.This setting specifies the number of Structured-data elements in RFC 5424.
Note: This setting is only applicable when Version is set to 1 (RFC 5424) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SDElementId:
Sets the Sd-Id value of the Sd-element with the specified SDElementIndex in RFC 5424.This setting specifies the Sd-Id value of the SD-element with the specified SDElementIndex.
Note: This setting is only applicable when Version is set to 1 (RFC 5424) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SDElementIndex:
Sets the index of the Structured-Data element in RFC 5424.This setting specifies the index of the Structured-Data element as defined in RFC 5424.
Note: This setting is only applicable when Version is set to 1 (RFC 5424) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SDParamCount:
Sets the number of the Sd-param values for the specified SDElementIndex in RFC 5424.This setting specifies the number of the SD-param values for the specified SDElementIndex.
Note: This setting is only applicable when Version is set to 1 (RFC 5424) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SDParamName:
Sets the name of the SD-Param field in RFC 5424.This setting specifies the name of the SD-Param field as defined in RFC 5424. Append the index in square brackets to refer to the SD-Param field in the specified index: SDParamName[index]
Note: This setting is only applicable when Version is set to 1 (RFC 5424) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SDParamValue:
Sets the value of the SD-Param field in RFC 5424.This setting specifies the value of the SD-Param field as defined in RFC 5424. Append the index in square brackets to refer to the SD-Param field in the specified index: SDParamValue[index]
Note: This setting is only applicable when Version is set to 1 (RFC 5424) The example below demonstrates how to set the Struct-Data configs:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TCPMessageDelimiter:
The message delimiter to use (if any) when sending and receiving over TCP.When use_tcp is set to True messages may be sent and received using either Octet Counting or Non-Transparent-Framing schemes to separate mesagges sent over the wire. This setting defines the delimiter to use in the Non-Transparent-Framing scheme when sending messages. Possible values are:
This setting is only applicable when sending a message and use_tcp is set to True. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseHostname: Determines if the local host name or IP address is used in the Syslog header. If set to false the class will use the IP address of the local host name in the header of the Syslog packet. The default value is true. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseLocalTime: Indicates whether to use local time or GMT time for packet timestamps.Setting this to True will generate timestamps based on the time in your locality, taking into account your time zone. When this option is False (default), GMT timestamps are generated. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Version:
Determines which Syslog version to use.
Note: This setting should be set before setting any of the AppName, MsgId, ProcId |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UDP Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CaptureIPPacketInfo:
Used to capture the packet information.If this is set to true, the component will capture the IP packet information.
The default value for this setting is False. Note: This setting is only available in Windows. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DelayHostResolution:
Whether the hostname is resolved when RemoteHost is set.This setting specifies whether a hostname is resolved immediately when remote_host is set. If True the class will resolve the hostname and the IP address will be present in the remote_host property.
If False, the hostname is not resolved until needed by the component when a method to connect or send data is called. If desired, resolve_remote_host may called to manually resolve the value in remote_host at any time.
The default value is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DestinationAddress:
Used to get the destination address from the packet information.If CaptureIPPacketInfo is set to true, then this will be populated with the packet's destination address when a packet is received.
This information will be accessible in the DataIn event.
Note: This setting is only available in Windows. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DontFragment: Used to set the Don't Fragment flag of outgoing packets.When set to True, packets sent by the class will have the Don't Fragment flag set. The default value is False. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LocalHost:
The name of the local host through which connections are initiated or accepted.
The local_host setting contains the name of the local host
as obtained by the gethostname() system call, or if the
user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. If the class is connected, the local_host setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LocalPort:
The port in the local host where the class binds.
This must be set before a connection is
attempted. It instructs the class to bind to a specific
port (or communication endpoint) in the local machine.
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by local_port after the connection is established. local_port cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxPacketSize: The maximum length of the packets that can be received.This setting specifies the maximum size of the datagrams that the class will accept without truncation. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
QOSDSCPValue:
Used to specify an arbitrary QOS/DSCP setting (optional).UseConnection must be True to use this setting. This option allows you to specify an arbitrary DSCP value
between 0 and 63. The default is 0. When set to the default value the component will not set a DSCP value.
Note: This setting uses the qWAVE API is only available on Windows 7, Windows Server 2008 R2, and later. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
QOSTrafficType:
Used to specify QOS/DSCP settings (optional).UseConnection must be True to use this setting.
You may specify either the text or integer values: BestEffort (0), Background (1), ExcellentEffort (2), AudioVideo (3), Voice (4), and Control (5).
Note: This setting uses the qWAVE API which is only available on Windows Vista and Windows Server 2008 or above. Note: QOSTrafficType must be set before setting active to true. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ShareLocalPort:
If set to True, allows more than one instance of the class to be active on the same local port.This option must be set before the class is activated through
the active property or it will have no effect.
The default value for this setting is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SourceIPAddress:
Used to set the source IP address used when sending a packet.This configuration setting can be used to override the source IP address when sending a packet.
Note: This setting is only available in Windows and requires that the winpcap library be installed (or npcap with winpcap compatibility). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SourceMacAddress:
Used to set the source MAC address used when sending a packet.This configuration setting can be used to override the source MAC address when sending a packet.
Note: This setting is only available in Windows and requires that the winpcap library be installed (or npcap with winpcap compatibility). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseConnection:
Determines whether to use a connected socket.UseConnection specifies whether the class
should use a connected socket or not. The connection is
defined as an association in between the local address/port
and the remote address/port. As such, this
is not a connection in the traditional TCP sense. What it
means is only that the class will send and receive data
only to and from the specified destination.
The default value for this setting is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseIPv6: Whether or not to use IPv6.By default, the component expects an IPv4 address for local and remote host properties, and will create an IPv4 socket. To use IPv6 instead, set this to True. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Socket Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AbsoluteTimeout:
Determines whether timeouts are inactivity timeouts or absolute timeouts.If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds
will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.
Note: This option is not valid for UDP ports. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallData: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
InBufferSize:
The size in bytes of the incoming queue of the socket.
This is the size of an internal queue in the TCP/IP stack.
You can increase or decrease its size depending on the amount
of data that you will be receiving. Increasing the value of the
InBufferSize setting can provide significant improvements in
performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OutBufferSize:
The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack.
You can increase or decrease its size depending on the amount
of data that you will be sending. Increasing the value of the
OutBufferSize setting can provide significant improvements in
performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Base Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BuildInfo: Information about the product's build.When queried, this setting will return a string containing information about the product's build. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CodePage:
The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).
The following is a list of valid code page identifiers:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LicenseInfo:
Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaskSensitive:
Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to True to mask sensitive data. The default is False.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when do_events is called, the class will wait for the amount of time specified here before returning. The default value is 20. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseInternalSecurityAPI:
Tells the class whether or not to use the system security libraries or an internal implementation.
When set to False, the class will use the system security libraries by default to perform cryptographic functions where applicable.
Setting this setting to True tells the class to use the internal implementation instead of using the system security libraries. On Windows, this setting is set to False by default. On Linux/macOS, this setting is set to True by default. To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section. |
SysLog Errors
SysLog Errors
451 Unable to acquire valid system time. |
UDP Errors
104 UDP is already active. | |
106 You cannot change the local_port while the class is active. | |
107 You cannot change the local_host at this time. A connection is in progress. | |
109 The class must be active for this operation. | |
112 Cannot change MaxPacketSize while the class is active. | |
113 Cannot change ShareLocalPort option while the class is active. | |
114 Cannot change remote_host when UseConnection is set and the class active. | |
115 Cannot change remote_port when UseConnection is set and the class is active. | |
116 remote_port can't be zero when UseConnection is set. Please specify a valid service port number. | |
117 Cannot change UseConnection while the class is active. | |
118 Message can't be longer than MaxPacketSize. | |
119 Message too short. | |
434 Unable to convert string to selected CodePage |
SSL Errors
270 Cannot load specified security library. | |
271 Cannot open certificate store. | |
272 Cannot find specified certificate. | |
273 Cannot acquire security credentials. | |
274 Cannot find certificate chain. | |
275 Cannot verify certificate chain. | |
276 Error during handshake. | |
280 Error verifying certificate. | |
281 Could not find client certificate. | |
282 Could not find server certificate. | |
283 Error encrypting data. | |
284 Error decrypting data. |
TCP/IP Errors
10004 [10004] Interrupted system call. | |
10009 [10009] Bad file number. | |
10013 [10013] Access denied. | |
10014 [10014] Bad address. | |
10022 [10022] Invalid argument. | |
10024 [10024] Too many open files. | |
10035 [10035] Operation would block. | |
10036 [10036] Operation now in progress. | |
10037 [10037] Operation already in progress. | |
10038 [10038] Socket operation on non-socket. | |
10039 [10039] Destination address required. | |
10040 [10040] Message too long. | |
10041 [10041] Protocol wrong type for socket. | |
10042 [10042] Bad protocol option. | |
10043 [10043] Protocol not supported. | |
10044 [10044] Socket type not supported. | |
10045 [10045] Operation not supported on socket. | |
10046 [10046] Protocol family not supported. | |
10047 [10047] Address family not supported by protocol family. | |
10048 [10048] Address already in use. | |
10049 [10049] Can't assign requested address. | |
10050 [10050] Network is down. | |
10051 [10051] Network is unreachable. | |
10052 [10052] Net dropped connection or reset. | |
10053 [10053] Software caused connection abort. | |
10054 [10054] Connection reset by peer. | |
10055 [10055] No buffer space available. | |
10056 [10056] Socket is already connected. | |
10057 [10057] Socket is not connected. | |
10058 [10058] Can't send after socket shutdown. | |
10059 [10059] Too many references, can't splice. | |
10060 [10060] Connection timed out. | |
10061 [10061] Connection refused. | |
10062 [10062] Too many levels of symbolic links. | |
10063 [10063] File name too long. | |
10064 [10064] Host is down. | |
10065 [10065] No route to host. | |
10066 [10066] Directory not empty | |
10067 [10067] Too many processes. | |
10068 [10068] Too many users. | |
10069 [10069] Disc Quota Exceeded. | |
10070 [10070] Stale NFS file handle. | |
10071 [10071] Too many levels of remote in path. | |
10091 [10091] Network subsystem is unavailable. | |
10092 [10092] WINSOCK DLL Version out of range. | |
10093 [10093] Winsock not loaded yet. | |
11001 [11001] Host not found. | |
11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
11004 [11004] Valid name, no data record (check DNS setup). |