Specifying Syslog Servers
Starting from Veeam Backup & Replication 12.1 (build 12.1.0.2131), you can use an external syslog server to manage events written by Veeam Backup & Replication.
How Integration with Syslog Server Works
When you add the syslog server in the Veeam Backup & Replication console, Veeam Backup & Replication sends a test event to check if it can communicate with the syslog server. Further, all events that Veeam Backup & Replication writes to Microsoft Windows Event Log will also be sent to the syslog server.
Each event contains a syslog message. The format of the message is defined by RFC 5424. For example:
2023-11-03T13:30:25.182677+01:00 <14> VBRSRV01 Veeam_MP [categoryId=0 instanceId=110 JobSessionID="58df29d6-a21b-43b2-a397-4c44ed1e05c1" JobID="cd13e656-8be9-445a-bf9e-513b24293d35" JobType="0" Platform="0" Flags="0" Version="1" Description="Backup job 'Backup Job 2' has been started."] |
Field | Description | Example |
|---|---|---|
TIMESTAMP | Date and time. For more information about the format, see RFC 3339. | 2023-10-23T15:23:23.259882+02:00 |
PRI | Message priority. | <14> |
HOSTNAME | Host name of the backup server. | VBRSRV01 |
APP-NAME | Name of the application that generates events. | Veeam_MP |
STRUCTURED-DATA | Event metadata. May include message details in the Description parameter. | [categoryId=0 instanceId=110 JobSessionID="58df29d6-a21b-43b2-a397-4c44ed1e05c1" JobID="cd13e656-8be9-445a-bf9e-513b24293d35" JobType="0" Platform="0" Flags="0" Version="1" Description="Backup job 'Backup Job 2' has been started."] |
MSG | Message details. May not be sent if message details are included in the STRUCTURED-DATA field. | Backup job 'Backup Job 2' has been started. |
Note |
The structure and the content of the syslog message may vary for different syslog servers. For the full list of fields that can be sent in a syslog message, see the Syslog Message Format section in RFC 5424. |
Requirements and Limitations
Integration with syslog servers has the following requirements and limitations:
- To use functionality, you must have a paid license.
- You can add only one syslog server.
Adding Syslog Server
To add a syslog server, do the following:
- From the main menu, select Options > Event Forwarding.
- In the Syslog servers window, click Add.
- In the Server field, specify the FQDN or IPv4 address of the server. You cannot specify the IPv6 address in this field.
- In the Transport field, specify the transport protocol: TCP, UDP or TLS. Default port numbers are 514 (for TCP and UDP) and 6514 (for TLS).
- Click OK.
Note |
If the syslog server is unavailable, the error message will be displayed. |
Tip |
If required, you can also configure the following specific parameters on the backup server:
To configure these parameters, see this Veeam KB article. |