ConfigureSyslogForwarding
This method sets syslog log forwarding. When enable is set to true, this method adds a rule to syslog 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, @optional LogLevelInfo[] logLevels)
ConfigureSyslogForwarding has the following parameters:
| Field | Description |
|---|---|
| enable | True to enable log forwarding, false to disable. |
| appNames | An array containing 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. |
| logLevels | An array containing information about the services syslog log levels. The last value of a duplicate service is taken. If a service is not specified, a default log level of info is set. Services need to be explicitly restarted in order for the changes to take effect. |
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. |
LogLevelInfo has the following fields:
| Field | Description |
|---|---|
| AppNames | Enumerates the application names available for syslog configuration. The values are srm, drconfigurator, hms, hbrsrv, drclient, and drconfigui. |
| VmacoreLogLevel | Enumerates the list of Vmacore log levels, which are none, quiet, panic, error, warning, info, verbose, and trivia. |
| JavaLogLevel | Enumerates the list of Java log levels, which are OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE, and ALL. |
| service | The service should correspond to one of the AppNames enum values. |
| logLevel | Specified log level. This should coresspond to one of the values in the VmacoreLogLevel or JavaLogLevel enum values. Srm, drconfigurator, and hbrsrv expect value from the VmacoreLogLevel. Hms, drclient, and drconfigui expect value from the JavaLogLevel enum. |
| restart | It is a boolean value. Specifies whether the service should be restarted for the log level configuration to take effect. |
Faults
- InvalidArgument
- RuntimeFault
- SystemError
For more information about the faults, see Faults in Site Recovery Manager Appliance Management API.