NAME

vicfg-syslog - get and set syslog server configuration

SYNOPSIS

 vicfg-syslog [<connection_options>]
   [--help |
    --setport <port> |
    --setserver <name_or_ip> |
    --show |
    --vihost <esx_host> ]

DESCRIPTION

The vicfg-syslog command specifies a remote syslog server for an ESXi host.

You cannot run this command against an ESX host. ESX administrators can edit the syslog configuration file to customize the syslog server.

The Basic System Administration manual discusses system logs in more detail and explains how to set them up using the vSphere Client

OPTIONS

connection_options: Specifies the target server and authentication information if required. Run vicfg-syslog --help for a list of all connection options.
--help: Prints a help message for each command-specific and each connection option. Calling the script with no arguments or with --help has the same effect.
--setport | -p <port>: Sets the port number for the syslog server. Can be used with --setserver.
--setserver | -s <host_or_IP>: Set the host name or IP address of the syslog server. Can be used with --setport>.
--show | -i: Displays the syslog server configuration if a syslog server has been set up.
--vihost | -h <esx_host>: When you run a vSphere CLI command with the --server option pointing to a vCenter Server system, use --vihost to specify the ESX/ESXi host to run the command against.

EXAMPLES

The following examples assume you are specifying connection options, either explicitly or, for example, by specifying the server, user name, and password. Run vicfg-syslog --help for a list of common options including connection options.

Display the syslog server configuration:

 vicfg-syslog <conn_options> -i

Set the host name of the syslog server:

 vicfg-syslog <conn_options> -s <syslog server>

Set the port used by the syslog server:

 vicfg-syslog <conn_options> -p <port>