Search the VMware Knowledge Base (KB)
View by Article ID

Configuring syslog server for VMware NSX for vSphere 6.x controllers (2092228)

  • 2 Ratings

Purpose

This article provides information about the supported method for configuring syslog server for VMware NSX for vSphere 6.x controllers.

Resolution

The only supported method on configuring the syslog server on the NSX controllers is through the NSX API.

Note: It is important that the encoding specified on the headers are configured with application/xml and not application/json. Specifying application/json may result in HTTP Status errors.

To configure the Syslog server:

Enabling or querying or disabling syslog On NSX Manager using NSX API

Working with Syslog Servers
If you specify a syslog server, NSX Manager sends all audit logs and system events from NSX Manager to the syslog server.

Configure syslog servers

Request:
PUT https://<nsxmgr-ip>/api/1.0/appliance-management/system/syslogserver
Request Body
<syslogserver>
<syslogServer></syslogServer>
<port></port>
<protocol></protocol>
</syslogserver>

Query syslog servers
Retrieves syslog servers.

Request:
GET https://<nsxmgr-ip>/api/1.0/appliance-management/system/syslogserver
Response Body
<syslogserver>
<syslogServer></syslogServer>
<port></port>
<protocol></protocol>
</syslogserver>


Delete syslog servers
Deletes syslog servers.

Request:
DELETE https://<nsxmgr-ip>/api/1.0/appliance-management/system/syslogserver


Enabling or querying or disabling Syslog On NSX controller using NSX API

Add controller syslog exporter
Configures a syslog exporter on the specified controller node.

Request
POST https://<nsxmgr-ip>/api/2.0/vdn/controller/{controller-id}/syslog
Request Body:
<controllerSyslogServer>
<syslogServer>10.135.14.236</syslogServer>
<port>514</port>
<protocol>UDP</protocol>
<level>INFO</level>
</controllerSyslogServer>


Query controller syslog exporter
Retrieves details about the configured syslog exporter on the specified controller node.

Request
GET https://<nsxmgr-ip>/api/2.0/vdn/controller/{controller-id}/syslog
Response Body:
<?xml version="1.0" encoding="UTF-8"?>
<controllerSyslogServer>
<syslogServer>10.135.14.236</syslogServer>
<port>514</port>
<protocol>UDP</protocol>
<level>INFO</level>
</controllerSyslogServer>


Delete controller syslog exporter
Deletes syslog exporter on the specified controller node.

Request
DELETE https://<nsxmgr-ip>/api/2.0/vdn/controller/{controller-id}/syslog


For more information, see the NSX for vSphere API Reference Guide.

Additional Information

To be alerted when this article is updated, click Subscribe to Document in the Actions box.

Request a Product Feature

To request a new product feature or to provide feedback on a VMware product, please visit the Request a Product Feature page.

Feedback

  • 2 Ratings

Did this article help you?
This article resolved my issue.
This article did not resolve my issue.
This article helped but additional information was required to resolve my issue.

What can we do to improve this information? (4000 or fewer characters)




Please enter the Captcha code before clicking Submit.
  • 2 Ratings
Actions
KB: