Global System Log
You can configure the integration settings with communication with Syslog servers for Mojo to communicate and send log messages to Syslog servers.
If Syslog integration is enabled, the system sends messages to the configured Syslog servers. Otherwise, Syslog integration services are shut off. Apart from events, you can also send audit logs from Mojo to a Syslog server.
JSON Table
Attribute | Data Type | Description |
---|---|---|
policyCreatedAtLocId | application/json | The location ID where policy was created. The value is of the type Location ID JSON. |
policyType | String | A read-only field for internal use. |
integrationEnabled | boolean | A true or false value indicating whether the syslog server integration is enabled or disabled. |
syslogServers | application/json | |
syslogServers/enabled | boolean | A true or false value indicating whether to Enable or Disable sending events and/or audit logs to this Syslog server. |
syslogServers/ipAddress | String | Syslog Server IP Address or Hostname. |
syslogServers/trapPort | int | Port number of the Syslog server to which the system sends events. |
syslogServers/appendBOMHeader | boolean | A true or false value indicating whether to append the byte order mark to the syslog server entry or not. |
syslogServers/forwardEvents | boolean | A true or false value indicating whether to send events to the Syslog server or not. A true value sends events to the Syslog server. |
syslogServers/forwardAuditLogs | boolean | A true or false value indicating whether to send audit logs to the Syslog server or not. A true value sends audit logs to the Syslog server. |
syslogServers/forwardSubEvents | boolean | A true or false value indicating whether to send sub-events to the Syslog server. A true value sends sub-events to the Syslog server. |
syslogServers/ciepMacaddress | ||
syslogServers/ciepName | ||
syslogServers/messageFormat | enum | Format in which the event is sent. Applicable values are:
Forward Sub Events and Forward Audit Logs are not available in case you select IDMEF message format. |
Copy Sample JSON
Sample JSON
{ "policyCreatedAtLocId": { "type": "locallocationid", "id": 0 }, "policyType": "SYSLOG_POLICY", "integrationEnabled": false, "syslogServers": [{ "enabled": false, "ipAddress": null, "trapPort": 0, "appendBOMHeader": false, "forwardEvents": true, "forwardAuditLogs": false, "forwardSubEvents": false, "ciepMacaddress": null, "ciepName": null, "messageFormat": null }] }
API Calls
/V5/configuration/global/syslog
/V5/configuration/global/syslog