vmware::appliance::logging::ForwardingStub Class Reference

Remote stub implementation of the Forwarding API service. More...

Inherits vmware::appliance::logging::Forwarding.

List of all members.

Public Member Functions
	ForwardingStub (vmware.vapi.core.IApiProvider iApiProvider, vmware.vapi.bindings.TypeConverter typeConverter, vmware.vapi.bindings.IStubConfiguration config)
	ForwardingStub (vmware.vapi.core.IApiProvider iApiProvider, vmware.vapi.bindings.IStubConfiguration config)
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

Remote stub implementation of the Forwarding API service.

---

Constructor & Destructor Documentation

vmware::appliance::logging::ForwardingStub::ForwardingStub	(	vmware.vapi.core.IApiProvider	iApiProvider,
		vmware.vapi.bindings.TypeConverter	typeConverter,
		vmware.vapi.bindings.IStubConfiguration	config
	)		[inline]

vmware::appliance::logging::ForwardingStub::ForwardingStub	(	vmware.vapi.core.IApiProvider	iApiProvider,
		vmware.vapi.bindings.IStubConfiguration	config
	)		[inline]

---

Member Function Documentation

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

(

)

[inline]

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.

Implements vmware::appliance::logging::Forwarding.

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

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.

Implements vmware::appliance::logging::Forwarding.

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

(

)

[inline]

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.

Implements vmware::appliance::logging::Forwarding.

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

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.

Implements vmware::appliance::logging::Forwarding.

void vmware::appliance::logging::ForwardingStub::Set

(

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

cfgList

)

[inline]

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.

Implements vmware::appliance::logging::Forwarding.

void vmware::appliance::logging::ForwardingStub::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
	)		[inline]

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

Implements vmware::appliance::logging::Forwarding.

global::System.Threading.Tasks.Task vmware::appliance::logging::ForwardingStub::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
	)		[inline]

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

Implements vmware::appliance::logging::Forwarding.

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

(

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

cfgList

)

[inline]

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.

Implements vmware::appliance::logging::Forwarding.

global::System.Collections.Generic.List<vmware.appliance.logging.ForwardingTypes.ConnectionStatus> vmware::appliance::logging::ForwardingStub::Test	(	bool?	sendTestMessage,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

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.

Implements vmware::appliance::logging::Forwarding.

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

(

bool?

sendTestMessage

)

[inline]

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.

Implements vmware::appliance::logging::Forwarding.

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

(

bool?

sendTestMessage

)

[inline]

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.

Implements vmware::appliance::logging::Forwarding.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.appliance.logging.ForwardingTypes.ConnectionStatus> > vmware::appliance::logging::ForwardingStub::TestAsync	(	bool?	sendTestMessage,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

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.

Implements vmware::appliance::logging::Forwarding.

---

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

• ForwardingStub.cs