Configuring syslog on ESXi (2003322)
VMware vSphere ESXi 5.0 and higher hosts run a syslog service (
vmsyslogd) that provides a standard mechanism for logging messages from the VMkernel and other system components. By default in ESXi, these logs are placed on a local scratch volume or a ramdisk. To preserve the logs further, ESXi can be configured to place these logs to an alternate storage location on disk and to send the logs across the network to a syslog server.
Retention, rotation, and splitting of logs received and managed by a syslog server are fully controlled by that syslog server. ESXi cannot configure or control log management on a remote syslog server. For more information, see the documentation for the syslog server.
Earlier versions of vSphere ESXi are configured differently. For more information, see Enabling syslog on ESXi 3.5 - 4.1 (1016621).
Regardless of the additional syslog configuration specified using these options, logs continue to be placed on the default locations on the ESXi host. For more information, see Location of ESXi 3.5 - 4.1 log files (1021801) or Location of ESXi log files (2032076).
If vSphere Syslog Collector is used to receive logs from ESXi hosts, see Install or Upgrade vSphere Syslog Collector section of the vSphere Installation and Setup Guide. or the VMware Syslog Service section of the ESXi and vCenter Server 6.0 Documentation Guide.
Configuration of the Syslog service on ESXi 5.x and 6.0 can be performed using Host Profiles, the vCLI, or the Advanced Configuration options in the vSphere Client. Select the most appropriate method for your environment. Configuration cannot be performed by running the
There are five configurable options:
Syslog.global.logDir- Location on a local or remote datastore (VMFS, NFS, FAT) and path where logs should be saved to. Has the format
[DatastoreName] DirectoryNamewhich maps to
/vmfs/volumes/DatastoreName/DirectoryName/. If the specified
DirectoryNamedoes not exist, it will be created. If
/scratchis defined, the default is
/scratch/log. For more information on scratch, see Creating a persistent scratch location for ESXi (1033696).
Syslog.global.logHost- Comma-delimited list of remote servers where logs are sent using the syslog protocol. If the
logHostfield is blank, no logs are forwarded. Include the protocol and port, similar to
Syslog.global.logDirUnique- A boolean option which controls whether a host-specific directory is created within the configured
logDir. The directory name is the hostname of the ESXi host. A unique directory is useful if the same shared directory is used by multiple ESXi hosts. Defaults to
Syslog.global.defaultRotate- The maximum number of log files to keep locally on the ESXi host in the configured logDir. Does not affect remote syslog server retention. Defaults to
Syslog.global.defaultSize- The maximum size, in kilobytes, of each local log file before it is rotated. Does not affect remote syslog server retention. Defaults to
1024 KB. For more information on sizing, see Providing Sufficient Space for System Logging.
Configuring Local and Remote Logging using the
Local and Remote syslog functionality can be configured for a host using the
esxcli command line utility, which can be used at the console of an ESXi host, in the vCLI, or in the vMA.
For more information regarding the use of
esxcli, see the vSphere Command-Line Interface Documentation.
- Open a ESXi Shell console session where the
esxclicommand is available, such as the vCLI or on the ESXi host directly.
- Display the existing five configuration options on the host by running the command:
esxcli system syslog config get
- Set new host configuration, specifying options to change, by running a command:
Caution: Entering incorrect information for the logging path can cause the destination system to become unmanageable.
esxcli system syslog config set --logdir=/path/to/vmfs/directory/ --loghost=RemoteHostname --logdir-unique=true|false --default-rotate=NNN --default-size=NNN
To configure remote syslog using TCP on port 514:
esxcli system syslog config set --loghost='tcp://10.11.12.13:514'
Note: When using Syslog with UDP on ESXi 5.0, you must download and install the patch VMware ESXi 5.0, Patch ESXi-5.0.0-20120704001-standard (2019113).
- After making configuration changes, load the new configuration by running the command:
esxcli system syslog reload
- Run this command to test if the port is reachable from the ESXi host:
nc -z RemoteHostname 514
nc -z 10.11.12.13 514
Configuring Local and Remote logging using Host ProfilesLocal and Remote syslog functionality can be configured for a cluster of similar hosts using Host Profiles. For more information, see the Set Up Syslog from the Host Profiles Interface section of the vSphere Installation and Setup Guide.
- Connect to the vCenter Server using the vSphere Client.
- Click Home.
- Under the Management section, click Host Profiles.
- Create a new profile or edit an existing profile.
- In the Edit Profile dialog, set one or more of the five configuration options.
- If you configured syslog using
esxclior advanced configuration options and captured this as a reference host, the 5 configuration options are already visible under the Advanced Configuration option section.
- If syslog has not been previously configured, right-click the Advanced Configuration options section and add a profile for each of the five configuration options.
- If you configured syslog using
- Save the profile and assign it to hosts.
Configuring Local and Remote Logging using Advanced Configuration options
Local and Remote syslog functionality can be configured for a host using advanced configuration options, which can be set using the vSphere Client, PowerCLI, or vCLI.
For more information, see the Configure Syslog on ESXi Hosts section of the vSphere Single Host Management Guide.
This configuration cannot be performed using the local console's
esxcfg-advcfg command. For more information on setting advanced configuration options using each method, see Configuring advanced options for ESXi/ESX (1038578).
Note: If the ESXi host loses communication with the remote syslog server, logging Logging stops being pushed to the syslog server. You see the "
failed to write log" error in the
/var/log/.vmsyslogd.err file. Nothing is sent to the remote syslog server until the
syslogd service is restarted.
Configuring ESXi Firewall Exception using the
Note: You may need to manually open the Firewall rule set for syslog when redirecting logs. For UDP traffic, this firewall rule has no effect in ESXi 5.0 build 456551 and the UDP port 514 traffic flows regardless.
To open outbound traffic through the ESXi Firewall on UDP port 514 and TCP ports 514 and 1514, run these commands:
esxcli network firewall ruleset set --ruleset-id=syslog --enabled=true
esxcli network firewall refresh