Configuring syslog server for VMware NSX for vSphere 6.x controllers

Products

• VMware NSX Networking

Issue/Introduction

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

Environment

VMware NSX for vSphere 6.2.x
VMware NSX for vSphere 6.0.x
VMware NSX for vSphere 6.1.x

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 document is updated, click the Subscribe to Article link in the Actions box