com.vmware.nsx.node.services.syslog

Interface Exporters

All Superinterfaces:

ExportersTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

ExportersStub

public interface Exporters
extends com.vmware.vapi.bindings.Service, ExportersTypes

Field Summary

Fields inherited from interface com.vmware.nsx.node.services.syslog.ExportersTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
NodeSyslogExporterProperties	create(NodeSyslogExporterProperties nodeSyslogExporterProperties) Adds a rule for exporting syslog information to a specified server.
void	create(NodeSyslogExporterProperties nodeSyslogExporterProperties, com.vmware.vapi.bindings.client.AsyncCallback<NodeSyslogExporterProperties> asyncCallback) Adds a rule for exporting syslog information to a specified server.
void	create(NodeSyslogExporterProperties nodeSyslogExporterProperties, com.vmware.vapi.bindings.client.AsyncCallback<NodeSyslogExporterProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Adds a rule for exporting syslog information to a specified server.
NodeSyslogExporterProperties	create(NodeSyslogExporterProperties nodeSyslogExporterProperties, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Adds a rule for exporting syslog information to a specified server.
void	delete() Removes all syslog exporter rules.
void	delete(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Removes all syslog exporter rules.
void	delete(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Removes all syslog exporter rules.
void	delete(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Removes all syslog exporter rules.
void	delete0(java.lang.String exporterName) Removes a specified rule from the collection of syslog exporter rules.
void	delete0(java.lang.String exporterName, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Removes a specified rule from the collection of syslog exporter rules.
void	delete0(java.lang.String exporterName, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Removes a specified rule from the collection of syslog exporter rules.
void	delete0(java.lang.String exporterName, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Removes a specified rule from the collection of syslog exporter rules.
NodeSyslogExporterProperties	get(java.lang.String exporterName) Returns information about a specific syslog collection point.
void	get(java.lang.String exporterName, com.vmware.vapi.bindings.client.AsyncCallback<NodeSyslogExporterProperties> asyncCallback) Returns information about a specific syslog collection point.
void	get(java.lang.String exporterName, com.vmware.vapi.bindings.client.AsyncCallback<NodeSyslogExporterProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about a specific syslog collection point.
NodeSyslogExporterProperties	get(java.lang.String exporterName, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about a specific syslog collection point.
NodeSyslogExporterPropertiesListResult	list() Returns the collection of registered syslog exporter rules, if any.
void	list(com.vmware.vapi.bindings.client.AsyncCallback<NodeSyslogExporterPropertiesListResult> asyncCallback) Returns the collection of registered syslog exporter rules, if any.
void	list(com.vmware.vapi.bindings.client.AsyncCallback<NodeSyslogExporterPropertiesListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the collection of registered syslog exporter rules, if any.
NodeSyslogExporterPropertiesListResult	list(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the collection of registered syslog exporter rules, if any.
void	verify() Collect iptables rules needed for all existing syslog exporters and verify if the existing iptables rules are the same.
void	verify(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Collect iptables rules needed for all existing syslog exporters and verify if the existing iptables rules are the same.
void	verify(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Collect iptables rules needed for all existing syslog exporters and verify if the existing iptables rules are the same.
void	verify(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Collect iptables rules needed for all existing syslog exporters and verify if the existing iptables rules are the same.

Method Detail

create

NodeSyslogExporterProperties create(NodeSyslogExporterProperties nodeSyslogExporterProperties)

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.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

nodeSyslogExporterProperties - (required)

Returns:

com.vmware.nsx.model.NodeSyslogExporterProperties

Throws:

com.vmware.vapi.std.errors.ConcurrentChange - Conflict

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

create

NodeSyslogExporterProperties create(NodeSyslogExporterProperties nodeSyslogExporterProperties,
                                    com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

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.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

nodeSyslogExporterProperties - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeSyslogExporterProperties

Throws:

com.vmware.vapi.std.errors.ConcurrentChange - Conflict

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

create

void create(NodeSyslogExporterProperties nodeSyslogExporterProperties,
            com.vmware.vapi.bindings.client.AsyncCallback<NodeSyslogExporterProperties> asyncCallback)

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.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
com.vmware.nsx.model.NodeSyslogExporterProperties

Operation Errors:
ConcurrentChange - Conflict
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

nodeSyslogExporterProperties - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

create

void create(NodeSyslogExporterProperties nodeSyslogExporterProperties,
            com.vmware.vapi.bindings.client.AsyncCallback<NodeSyslogExporterProperties> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

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.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
com.vmware.nsx.model.NodeSyslogExporterProperties

Operation Errors:
ConcurrentChange - Conflict
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

nodeSyslogExporterProperties - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

delete

void delete()

Removes all syslog exporter rules.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

delete

void delete(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Removes all syslog exporter rules.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

invocationConfig - Configuration for the method invocation.

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

delete

void delete(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Removes all syslog exporter rules.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

delete

void delete(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Removes all syslog exporter rules.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

delete0

void delete0(java.lang.String exporterName)

Removes a specified rule from the collection of syslog exporter rules.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

exporterName - Name of syslog exporter to delete (required)

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

delete0

void delete0(java.lang.String exporterName,
             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Removes a specified rule from the collection of syslog exporter rules.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

exporterName - Name of syslog exporter to delete (required)

invocationConfig - Configuration for the method invocation.

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

delete0

void delete0(java.lang.String exporterName,
             com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Removes a specified rule from the collection of syslog exporter rules.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

exporterName - Name of syslog exporter to delete (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

delete0

void delete0(java.lang.String exporterName,
             com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Removes a specified rule from the collection of syslog exporter rules.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

exporterName - Name of syslog exporter to delete (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

get

NodeSyslogExporterProperties get(java.lang.String exporterName)

Returns information about a specific syslog collection point.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

exporterName - Name of syslog exporter (required)

Returns:

com.vmware.nsx.model.NodeSyslogExporterProperties

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

NodeSyslogExporterProperties get(java.lang.String exporterName,
                                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about a specific syslog collection point.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

exporterName - Name of syslog exporter (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeSyslogExporterProperties

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

void get(java.lang.String exporterName,
         com.vmware.vapi.bindings.client.AsyncCallback<NodeSyslogExporterProperties> asyncCallback)

Returns information about a specific syslog collection point.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
com.vmware.nsx.model.NodeSyslogExporterProperties

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

exporterName - Name of syslog exporter (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(java.lang.String exporterName,
         com.vmware.vapi.bindings.client.AsyncCallback<NodeSyslogExporterProperties> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about a specific syslog collection point.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
com.vmware.nsx.model.NodeSyslogExporterProperties

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

exporterName - Name of syslog exporter (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

list

NodeSyslogExporterPropertiesListResult list()

Returns the collection of registered syslog exporter rules, if any. The rules specify the collector IP address and port, and the protocol to use.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Returns:

com.vmware.nsx.model.NodeSyslogExporterPropertiesListResult

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

NodeSyslogExporterPropertiesListResult list(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns the collection of registered syslog exporter rules, if any. The rules specify the collector IP address and port, and the protocol to use.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeSyslogExporterPropertiesListResult

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

void list(com.vmware.vapi.bindings.client.AsyncCallback<NodeSyslogExporterPropertiesListResult> asyncCallback)

Returns the collection of registered syslog exporter rules, if any. The rules specify the collector IP address and port, and the protocol to use.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
com.vmware.nsx.model.NodeSyslogExporterPropertiesListResult

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

list

void list(com.vmware.vapi.bindings.client.AsyncCallback<NodeSyslogExporterPropertiesListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns the collection of registered syslog exporter rules, if any. The rules specify the collector IP address and port, and the protocol to use.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
com.vmware.nsx.model.NodeSyslogExporterPropertiesListResult

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

verify

void verify()

Collect iptables rules needed for all existing syslog exporters and verify if the existing iptables rules are the same. If not, remove the stale rules and add the new rules to make sure all exporters work properly.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

verify

void verify(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Collect iptables rules needed for all existing syslog exporters and verify if the existing iptables rules are the same. If not, remove the stale rules and add the new rules to make sure all exporters work properly.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

invocationConfig - Configuration for the method invocation.

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

verify

void verify(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Collect iptables rules needed for all existing syslog exporters and verify if the existing iptables rules are the same. If not, remove the stale rules and add the new rules to make sure all exporters work properly.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

verify

void verify(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Collect iptables rules needed for all existing syslog exporters and verify if the existing iptables rules are the same. If not, remove the stale rules and add the new rules to make sure all exporters work properly.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.