apsyslog command reference

You use the apsyslog command to configure control nodes logs forwarding and monitoring on the external log server.
Command syntax:
apsyslog <operation> --server <RemoteServerIP:port> --nodes <all | e1n1,e2n1> --mode <append|overwrite>
The following operations are available:
apsyslog enable --server <RemoteServerIP:port> --nodes <all | e1n1,e2n1>
Enables the feature on the selected nodes.
apsyslog show --nodes <all | e1n1,e2n1>
Shows the list of configured forwarding rules for the selected nodes.
apsyslog unset --fwdRule <facility.priority> --nodes <all | e1n1,e2n1>
Deletes the existing forwarding rules on the selected nodes.
apsyslog set --diskSpace <2g> --nodes <all | e1n1,e2n1>
Sets the disk space limit on the selected nodes.
apsyslog set --retryCount <5> --nodes <all | e1n1,e2n1>
Sets the retry count if remote logging server is unreachable.
apsyslog disable -nodes <all | e1n1,e2n1>
Restores the rsyslog and syslogconfig file on the enabled nodes.
Optional arguments:
-h, --help
Shows this help message and exits.
--server <RemoteServerIP:Port>
Remote server logging details.
--fwdRule <facility.priority>
Specify the unique forwarding rule that you want to define for the nodes. Each forwarding rule consists of a pair of the following parameters:
The facility is used to specify what type of program is generating the message. The Syslog daemon can then be configured to handle messages from different sources differently. Examples:
auth/authpriv, cron, daemon, kern, ocal0 – local7, lpr, mail, news, syslog, user, uucp
The priority, or level, of a message is intended to determine the importance of a message. Examples:
emerg, alert, crit, err, warning, notice, info, debug
For example: auth.alert , cron.err.
--nodes <all |e1n1,e2n1>
List of nodes to be configured. Use comma (,) to separate the nodes.
--diskSpace <1g>
Disk space limit for queue. Default is 1g.
--retryCount <n>
A number of retries if the remote server logging host is unreachable. Default value is 1.
--mode <append|overwrite>
Specifies whether the newly configured rule is to be appended or overwritten. The default value is append.
  • In the append mode, the utility adds the new rule to the existing forwarding rules.
  • In the overwrite mode, the utility overwrites the existing forwarding rules with the new rule.