configureSyslog command

Last Updated : Sep 09, 2021 |

With System Manager Release 8.1.3.3, you can configure, list, and delete the remote syslog server by using the configureSyslog command.

Syntax

configureSyslog -h [-e] [-s <syslog server destination> ""]
-h
Displays help for the command and also displays the required and optional parameters.
-e
Lists the currently configured remote syslog servers.
-s <syslog server destinations>
Configures one or more of the remote syslog server destinations.
When you run this command, System Manager replaces the existing remote syslog server configuration and does not add into it.
syslog server destinations is a pipe (‘|’) separated list of remote syslog destinations.

Where, the format for syslog server destinations is:

(transport_specifier)hostname_or_ip:port

  • transport_specifier can be:

    • @ for UDP

    • @@ for TCP

    • @@@ for one-way TLS (CA certificate only)

    • @@@@ for two-way TLS with client certificate authentication (Mutual TLS)

  • hostname_or_ip: The host name or IP address of the remote syslog server. The IP Address can be either in the IPv4 or IPv6 format. If you are using IPv6 then provide it in square brackets .

  • port: The port of the remote syslog server.

If you are using TLS, certificates for remote syslog server must be managed through the System Manager web console.

-s ""
Removes all the configured remote syslog servers.
When the -s is followed by an empty string with in double quotes (“”), System Manager deletes all the configured remote syslog server.