ConfigureSyslogForwarding

This method sets syslog log forwarding. When enable is set to true, this method adds a rule to rsyslog configuration for given apps and restarts rsyslog service. With this rule, all the logs written by these apps to syslog are forwarded to the specified server. Note that the rule will be either appended or updated in the syslog configuration file and this does not remove any existing rules for other apps. When enable is set to false, the existing rules for given apps added with this method are deleted.

Synopsis

void configureSyslogForwarding(boolean enable, @optional String[] appNames, SyslogForwardInfo info)

ConfigureSyslogForwarding has the following parameters:

Field Description
enable True to enable log forwarding, false to disable.
appNames List of application names for which log forwarding should be configured. Values must be one of the enums AppName. This value is not used since @version3.
info Structure that holds log forwarding information.

SyslogForwardInfo contains information for syslog log forwarding. It has the following fields:

Field Description
Protocol Enumerates the list of available protocols to use. The available constants are tcp, udp, and relp.
host IP address or FQDN of the syslog server to which the logs will be forwarded.
port Port of the syslog server to which the logs will be forwarded.
protocol Protocol to use for log forwarding. The value must be one of the Protocol enums.

Faults

  • SystemError
  • RuntimeFault

For more information about the faults, see Faults in Site Recovery Manager Appliance Management API.