com.vmware.appliance.logging

Interface Forwarding

All Superinterfaces:

ForwardingTypes, Service

All Known Implementing Classes:

ForwardingStub

public interface Forwarding
extends Service, ForwardingTypes

The Forwarding interface provides methods to manage forwarding of log messages to remote logging servers. This interface was added in vSphere API 6.7.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.appliance.logging.ForwardingTypes

ForwardingTypes.Config, ForwardingTypes.ConnectionStatus, ForwardingTypes.Protocol

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<ForwardingTypes.Config>	get() Returns the configuration for forwarding log messages to remote logging servers.
void	get(AsyncCallback<java.util.List<ForwardingTypes.Config>> asyncCallback) Returns the configuration for forwarding log messages to remote logging servers.
void	get(AsyncCallback<java.util.List<ForwardingTypes.Config>> asyncCallback, InvocationConfig invocationConfig) Returns the configuration for forwarding log messages to remote logging servers.
java.util.List<ForwardingTypes.Config>	get(InvocationConfig invocationConfig) Returns the configuration for forwarding log messages to remote logging servers.
void	set(java.util.List<ForwardingTypes.Config> cfgList) Sets the configuration for forwarding log messages to remote log servers.
void	set(java.util.List<ForwardingTypes.Config> cfgList, AsyncCallback<java.lang.Void> asyncCallback) Sets the configuration for forwarding log messages to remote log servers.
void	set(java.util.List<ForwardingTypes.Config> cfgList, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Sets the configuration for forwarding log messages to remote log servers.
void	set(java.util.List<ForwardingTypes.Config> cfgList, InvocationConfig invocationConfig) Sets the configuration for forwarding log messages to remote log servers.
java.util.List<ForwardingTypes.ConnectionStatus>	test(java.lang.Boolean sendTestMessage) Validates the current log forwarding configuration by checking the liveness of the remote machine and optionally sending a test diagnostic log message from the appliance to all configured logging servers to allow manual end-to-end validation.
void	test(java.lang.Boolean sendTestMessage, AsyncCallback<java.util.List<ForwardingTypes.ConnectionStatus>> asyncCallback) Validates the current log forwarding configuration by checking the liveness of the remote machine and optionally sending a test diagnostic log message from the appliance to all configured logging servers to allow manual end-to-end validation.
void	test(java.lang.Boolean sendTestMessage, AsyncCallback<java.util.List<ForwardingTypes.ConnectionStatus>> asyncCallback, InvocationConfig invocationConfig) Validates the current log forwarding configuration by checking the liveness of the remote machine and optionally sending a test diagnostic log message from the appliance to all configured logging servers to allow manual end-to-end validation.
java.util.List<ForwardingTypes.ConnectionStatus>	test(java.lang.Boolean sendTestMessage, InvocationConfig invocationConfig) Validates the current log forwarding configuration by checking the liveness of the remote machine and optionally sending a test diagnostic log message from the appliance to all configured logging servers to allow manual end-to-end validation.

Method Detail

test

java.util.List<ForwardingTypes.ConnectionStatus> test(java.lang.Boolean sendTestMessage)

Validates the current log forwarding configuration by checking the liveness of the remote machine and optionally sending a test diagnostic log message from the appliance to all configured logging servers to allow manual end-to-end validation. The message that is sent is: "This is a diagnostic log test message from vCenter Server.". This method was added in vSphere API 6.7.

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

Parameters:

sendTestMessage - Flag specifying whether a default test message should be sent to the configured logging servers. If null, no test message will be sent to the configured remote logging servers.

Returns:

Information about the status of the connection to each of the remote logging servers.

test

java.util.List<ForwardingTypes.ConnectionStatus> test(java.lang.Boolean sendTestMessage,
                                                    InvocationConfig invocationConfig)

Validates the current log forwarding configuration by checking the liveness of the remote machine and optionally sending a test diagnostic log message from the appliance to all configured logging servers to allow manual end-to-end validation. The message that is sent is: "This is a diagnostic log test message from vCenter Server.". This method was added in vSphere API 6.7.

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:

sendTestMessage - Flag specifying whether a default test message should be sent to the configured logging servers. If null, no test message will be sent to the configured remote logging servers.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the status of the connection to each of the remote logging servers.

test

void test(java.lang.Boolean sendTestMessage,
        AsyncCallback<java.util.List<ForwardingTypes.ConnectionStatus>> asyncCallback)

Validates the current log forwarding configuration by checking the liveness of the remote machine and optionally sending a test diagnostic log message from the appliance to all configured logging servers to allow manual end-to-end validation. The message that is sent is: "This is a diagnostic log test message from vCenter Server.". This method was added in vSphere API 6.7.

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

Operation Result:
Information about the status of the connection to each of the remote logging servers.

Parameters:

sendTestMessage - Flag specifying whether a default test message should be sent to the configured logging servers. If null, no test message will be sent to the configured remote logging servers.

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

test

void test(java.lang.Boolean sendTestMessage,
        AsyncCallback<java.util.List<ForwardingTypes.ConnectionStatus>> asyncCallback,
        InvocationConfig invocationConfig)

Validates the current log forwarding configuration by checking the liveness of the remote machine and optionally sending a test diagnostic log message from the appliance to all configured logging servers to allow manual end-to-end validation. The message that is sent is: "This is a diagnostic log test message from vCenter Server.". This method was added in vSphere API 6.7.

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

Operation Result:
Information about the status of the connection to each of the remote logging servers.

Parameters:

sendTestMessage - Flag specifying whether a default test message should be sent to the configured logging servers. If null, no test message will be sent to the configured remote logging servers.

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

invocationConfig - Configuration for the method invocation.

set

void set(java.util.List<ForwardingTypes.Config> cfgList)

Sets the configuration for forwarding log messages to remote log servers. This method was added in vSphere API 6.7.

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

Parameters:

cfgList - The cfgList is a list of Config structure that contains the log message forwarding rules in terms of the host, port, protocol of the log message.

Throws:

InvalidArgument - if an invalid configuration is provided.

UnableToAllocateResource - if the number of configurations exceeds the maximum number of supported configurations.

Error - if there is any internal error during the execution of the operation.

set

void set(java.util.List<ForwardingTypes.Config> cfgList,
       InvocationConfig invocationConfig)

Sets the configuration for forwarding log messages to remote log servers. This method was added in vSphere API 6.7.

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:

cfgList - The cfgList is a list of Config structure that contains the log message forwarding rules in terms of the host, port, protocol of the log message.

invocationConfig - Configuration for the method invocation.

Throws:

InvalidArgument - if an invalid configuration is provided.

UnableToAllocateResource - if the number of configurations exceeds the maximum number of supported configurations.

Error - if there is any internal error during the execution of the operation.

set

void set(java.util.List<ForwardingTypes.Config> cfgList,
       AsyncCallback<java.lang.Void> asyncCallback)

Sets the configuration for forwarding log messages to remote log servers. This method was added in vSphere API 6.7.

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

Operation Errors:
InvalidArgument - if an invalid configuration is provided.
UnableToAllocateResource - if the number of configurations exceeds the maximum number of supported configurations.
Error - if there is any internal error during the execution of the operation.

Parameters:

cfgList - The cfgList is a list of Config structure that contains the log message forwarding rules in terms of the host, port, protocol of the log message.

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

set

void set(java.util.List<ForwardingTypes.Config> cfgList,
       AsyncCallback<java.lang.Void> asyncCallback,
       InvocationConfig invocationConfig)

Sets the configuration for forwarding log messages to remote log servers. This method was added in vSphere API 6.7.

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:
InvalidArgument - if an invalid configuration is provided.
UnableToAllocateResource - if the number of configurations exceeds the maximum number of supported configurations.
Error - if there is any internal error during the execution of the operation.

Parameters:

cfgList - The cfgList is a list of Config structure that contains the log message forwarding rules in terms of the host, port, protocol of the log message.

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

invocationConfig - Configuration for the method invocation.

get

java.util.List<ForwardingTypes.Config> get()

Returns the configuration for forwarding log messages to remote logging servers. This method was added in vSphere API 6.7.

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

Returns:

Information about the configuration for forwarding log messages to remote logging servers.

get

java.util.List<ForwardingTypes.Config> get(InvocationConfig invocationConfig)

Returns the configuration for forwarding log messages to remote logging servers. This method was added in vSphere API 6.7.

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:

Information about the configuration for forwarding log messages to remote logging servers.

get

void get(AsyncCallback<java.util.List<ForwardingTypes.Config>> asyncCallback)

Returns the configuration for forwarding log messages to remote logging servers. This method was added in vSphere API 6.7.

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

Operation Result:
Information about the configuration for forwarding log messages to remote logging servers.

Parameters:

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

get

void get(AsyncCallback<java.util.List<ForwardingTypes.Config>> asyncCallback,
       InvocationConfig invocationConfig)

Returns the configuration for forwarding log messages to remote logging servers. This method was added in vSphere API 6.7.

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

Operation Result:
Information about the configuration for forwarding log messages to remote logging servers.

Parameters:

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

invocationConfig - Configuration for the method invocation.