This operation creates a syslog server.
Request
Syntax
POST <webservice>/V4/syslogServer/config
Host: <host name>
Accept: application/json
Authtoken: <authentication token>
Content-type: application/json
where <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Headers
|
Name |
Description |
|---|---|
|
Host |
The host name of the Web Server or the Web Console that is used in the API request. |
|
Accept |
The format of the response. Valid values are: application/xml or application/json. |
|
Authtoken |
The authentication token that you receive after successfully logging on. For information about receiving an authentication token, see Authentication. |
|
Content-type |
The media type that is contained in the request body. |
Request Body
Download the JSON file required for this request: create_syslog_server_template.json
|
Parameter |
Description and Parameter Values |
|---|---|
|
hostname |
The hostname or the IP address of the syslog server. |
|
port |
The port that the syslog server accepts the logs on. |
|
secureMessaging |
The option to use TLS encryption for the logs. Valid values are True/False. |
|
certificateAuthorityName |
The file name of the certificate. Note This parameter is not required if the secureMessaging parameter is false. |
|
certificateAuthorityContent |
The certificate string in base64 format. Note This parameter is not required if the secureMessaging parameter is false. |
|
alerts |
The option to send alerts to the syslog server. Valid values are True/False. |
|
audit |
The option to send the audit to the syslog server. Valid values are True/False. |
|
events |
The option to send events to the syslog server. Valid values are True/False. |
Response
Response Parameters
|
Parameter |
Description |
Element |
|---|---|---|
|
errorCode |
The error code. Valid values are:
|
response |
|
errorMessage |
The error message, if any. |
response |
Examples
Sample Request
This request creates a syslog server.
GET <webservice>/logmonitoring/Syslog/Config
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-Type: application/xml
<LogMonitoring_SyslogStatus hostname="sujeethsyslog" port="514" enabled="1"> <syslogPolicy name="Alerts" enabled="0" /> <syslogPolicy name="Audit" enabled="1" /> <syslogPolicy name="Events" enabled="0" />
</LogMonitoring_SyslogStatus>
Sample Response
<TMMsg_GenericResp errorMessage="" errorCode="0" />
