Add node syslog exporter

Adds a rule for exporting syslog information to a specified server. The
required parameters are the rule name (exporter_name); severity level
(emerg, alert, crit, and so on); transmission protocol (TCP or UDP); and
server IP address or hostname. The optional parameters are the syslog port
number, which can be 1 through 65,535 (514, by default); facility level to
use when logging messages to syslog (kern, user, mail, and so on); and
message IDs (msgids), which identify the types of messages to export.

Request:

Method:

POST

URI Path(s):

/api/v1/node/services/syslog/exporters
/api/v1/transport-nodes/<transport-node-id>/node/services/syslog/exporters
/api/v1/cluster/<cluster-node-id>/node/services/syslog/exporters

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

NodeSyslogExporterProperties+

NodeSyslogExporterProperties (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
exporter_name	Syslog exporter name	string	Required
facilities	Facilities to export	array of SyslogFacility
level	Logging level to export	string	Required Enum: EMERG, ALERT, CRIT, ERR, WARNING, NOTICE, INFO, DEBUG
msgids	MSGIDs to export	array of string
port	Port to export to	integer	Minimum: 1 Maximum: 65535 Default: "514"
protocol	Export protocol	string	Required Enum: TCP, TLS, UDP, LI, LI-TLS
server	IP address or hostname of server to export to	HostnameOrIPv4Address	Required
structured_data	Structured data to export	array of string
tls_ca_pem	CA certificate PEM of TLS server to export to	string
tls_cert_pem	Certificate PEM of the rsyslog client	string
tls_client_ca_pem	CA certificate PEM of the rsyslog client	string
tls_key_pem	Private key PEM of the rsyslog client	string

Example Request:

POST https://<nsx-mgr>/api/v1/node/services/syslog/exporters { "exporter_name": "syslog4", "facilities": ["KERN", "USER"], "level": "INFO", "msgids": ["tcpin", "tcpout"], "port": 514, "protocol": "TCP", "server": "192.168.0.4" }

Successful Response:

Response Code:

201 Created

Response Headers:

Content-type: application/json

Response Body:

NodeSyslogExporterProperties+

NodeSyslogExporterProperties (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
exporter_name	Syslog exporter name	string	Required
facilities	Facilities to export	array of SyslogFacility
level	Logging level to export	string	Required Enum: EMERG, ALERT, CRIT, ERR, WARNING, NOTICE, INFO, DEBUG
msgids	MSGIDs to export	array of string
port	Port to export to	integer	Minimum: 1 Maximum: 65535 Default: "514"
protocol	Export protocol	string	Required Enum: TCP, TLS, UDP, LI, LI-TLS
server	IP address or hostname of server to export to	HostnameOrIPv4Address	Required
structured_data	Structured data to export	array of string
tls_ca_pem	CA certificate PEM of TLS server to export to	string
tls_cert_pem	Certificate PEM of the rsyslog client	string
tls_client_ca_pem	CA certificate PEM of the rsyslog client	string
tls_key_pem	Private key PEM of the rsyslog client	string

Example Response:

{ "exporter_name": "syslog4", "facilities": [ "KERN", "USER" ], "level": "INFO", "msgids": [ "tcpin", "tcpout" ], "port": 514, "protocol": "TCP", "server": "192.168.0.4" }

Add node syslog exporter

Request:

NodeSyslogExporterProperties (schema)

Example Request:

Successful Response:

NodeSyslogExporterProperties (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: