vmware::appliance::logging::Forwarding Interface Reference

The Forwarding interface provides methods to manage forwarding of log messages to remote logging servers. More...

Inherited by vmware::appliance::logging::ForwardingStub.

List of all members.

Public Member Functions
global::System.Collections.Generic.List < vmware.appliance.logging.ForwardingTypes.ConnectionStatus >	Test (bool?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.
global::System.Collections.Generic.List < vmware.appliance.logging.ForwardingTypes.ConnectionStatus >	Test (bool?sendTestMessage, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.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.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.List < vmware.appliance.logging.ForwardingTypes.ConnectionStatus > >	TestAsync (bool?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.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.List < vmware.appliance.logging.ForwardingTypes.ConnectionStatus > >	TestAsync (bool?sendTestMessage, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.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.
void	Set (global::System.Collections.Generic.List< vmware.appliance.logging.ForwardingTypes.Config > cfgList)
	Sets the configuration for forwarding log messages to remote log servers.
void	Set (global::System.Collections.Generic.List< vmware.appliance.logging.ForwardingTypes.Config > cfgList, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Sets the configuration for forwarding log messages to remote log servers.
global::System.Threading.Tasks.Task	SetAsync (global::System.Collections.Generic.List< vmware.appliance.logging.ForwardingTypes.Config > cfgList)
	Sets the configuration for forwarding log messages to remote log servers.
global::System.Threading.Tasks.Task	SetAsync (global::System.Collections.Generic.List< vmware.appliance.logging.ForwardingTypes.Config > cfgList, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Sets the configuration for forwarding log messages to remote log servers.
global::System.Collections.Generic.List < vmware.appliance.logging.ForwardingTypes.Config >	Get ()
	Returns the configuration for forwarding log messages to remote logging servers.
global::System.Collections.Generic.List < vmware.appliance.logging.ForwardingTypes.Config >	Get (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns the configuration for forwarding log messages to remote logging servers.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.List < vmware.appliance.logging.ForwardingTypes.Config > >	GetAsync ()
	Returns the configuration for forwarding log messages to remote logging servers.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.List < vmware.appliance.logging.ForwardingTypes.Config > >	GetAsync (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns the configuration for forwarding log messages to remote logging servers.

---

Detailed Description

The Forwarding interface provides methods to manage forwarding of log messages to remote logging servers.

This interface was added in vSphere API 6.7.

---

Member Function Documentation

global::System.Collections.Generic.List<vmware.appliance.logging.ForwardingTypes.Config> vmware::appliance::logging::Forwarding::Get

(

)

Returns the configuration for forwarding log messages to remote logging servers.

This method was added in vSphere API 6.7.

Returns:

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

Implemented in vmware::appliance::logging::ForwardingStub.

global::System.Collections.Generic.List<vmware.appliance.logging.ForwardingTypes.Config> vmware::appliance::logging::Forwarding::Get	(	global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns the configuration for forwarding log messages to remote logging servers.

This method was added in vSphere API 6.7.

Returns:

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

Implemented in vmware::appliance::logging::ForwardingStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.appliance.logging.ForwardingTypes.Config> > vmware::appliance::logging::Forwarding::GetAsync

(

)

Returns the configuration for forwarding log messages to remote logging servers.

This method was added in vSphere API 6.7.

Returns:

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

Implemented in vmware::appliance::logging::ForwardingStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.appliance.logging.ForwardingTypes.Config> > vmware::appliance::logging::Forwarding::GetAsync	(	global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns the configuration for forwarding log messages to remote logging servers.

This method was added in vSphere API 6.7.

Returns:

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

Implemented in vmware::appliance::logging::ForwardingStub.

void vmware::appliance::logging::Forwarding::Set

(

global::System.Collections.Generic.List< vmware.appliance.logging.ForwardingTypes.Config >

cfgList

)

Sets the configuration for forwarding log messages to remote log servers.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	if an invalid configuration is provided.
vmware.vapi.std.errors.UnableToAllocateResource	if the number of configurations exceeds the maximum number of supported configurations.
vmware.vapi.std.errors.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.

Implemented in vmware::appliance::logging::ForwardingStub.

void vmware::appliance::logging::Forwarding::Set	(	global::System.Collections.Generic.List< vmware.appliance.logging.ForwardingTypes.Config >	cfgList,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Sets the configuration for forwarding log messages to remote log servers.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	if an invalid configuration is provided.
vmware.vapi.std.errors.UnableToAllocateResource	if the number of configurations exceeds the maximum number of supported configurations.
vmware.vapi.std.errors.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.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::appliance::logging::ForwardingStub.

global::System.Threading.Tasks.Task vmware::appliance::logging::Forwarding::SetAsync	(	global::System.Collections.Generic.List< vmware.appliance.logging.ForwardingTypes.Config >	cfgList,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Sets the configuration for forwarding log messages to remote log servers.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	if an invalid configuration is provided.
vmware.vapi.std.errors.UnableToAllocateResource	if the number of configurations exceeds the maximum number of supported configurations.
vmware.vapi.std.errors.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.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::appliance::logging::ForwardingStub.

global::System.Threading.Tasks.Task vmware::appliance::logging::Forwarding::SetAsync

(

global::System.Collections.Generic.List< vmware.appliance.logging.ForwardingTypes.Config >

cfgList

)

Sets the configuration for forwarding log messages to remote log servers.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	if an invalid configuration is provided.
vmware.vapi.std.errors.UnableToAllocateResource	if the number of configurations exceeds the maximum number of supported configurations.
vmware.vapi.std.errors.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.

Implemented in vmware::appliance::logging::ForwardingStub.

global::System.Collections.Generic.List<vmware.appliance.logging.ForwardingTypes.ConnectionStatus> vmware::appliance::logging::Forwarding::Test	(	bool?	sendTestMessage,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.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.

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.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

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

Implemented in vmware::appliance::logging::ForwardingStub.

global::System.Collections.Generic.List<vmware.appliance.logging.ForwardingTypes.ConnectionStatus> vmware::appliance::logging::Forwarding::Test

(

bool?

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.

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.

Implemented in vmware::appliance::logging::ForwardingStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.appliance.logging.ForwardingTypes.ConnectionStatus> > vmware::appliance::logging::Forwarding::TestAsync

(

bool?

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.

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.

Implemented in vmware::appliance::logging::ForwardingStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.appliance.logging.ForwardingTypes.ConnectionStatus> > vmware::appliance::logging::Forwarding::TestAsync	(	bool?	sendTestMessage,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.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.

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.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

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

Implemented in vmware::appliance::logging::ForwardingStub.

---

The documentation for this interface was generated from the following file:

• Forwarding.cs