vmware::appliance::networking::ProxyStub Class Reference

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

Inherits vmware::appliance::networking::Proxy.

List of all members.

Public Member Functions
	ProxyStub (vmware.vapi.core.IApiProvider iApiProvider, vmware.vapi.bindings.TypeConverter typeConverter, vmware.vapi.bindings.IStubConfiguration config)
	ProxyStub (vmware.vapi.core.IApiProvider iApiProvider, vmware.vapi.bindings.IStubConfiguration config)
vmware.appliance.networking.ProxyTypes.TestResult	Test (string host, string protocol, vmware.appliance.networking.ProxyTypes.Config config)
	Tests a proxy configuration by testing the connection to the proxy server and test host.
vmware.appliance.networking.ProxyTypes.TestResult	Test (string host, string protocol, vmware.appliance.networking.ProxyTypes.Config config, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Tests a proxy configuration by testing the connection to the proxy server and test host.
global::System.Threading.Tasks.Task < vmware.appliance.networking.ProxyTypes.TestResult >	TestAsync (string host, string protocol, vmware.appliance.networking.ProxyTypes.Config config)
	Tests a proxy configuration by testing the connection to the proxy server and test host.
global::System.Threading.Tasks.Task < vmware.appliance.networking.ProxyTypes.TestResult >	TestAsync (string host, string protocol, vmware.appliance.networking.ProxyTypes.Config config, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Tests a proxy configuration by testing the connection to the proxy server and test host.
void	Set (string protocol, vmware.appliance.networking.ProxyTypes.Config config)
	Configures which proxy server to use for the specified protocol.
void	Set (string protocol, vmware.appliance.networking.ProxyTypes.Config config, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Configures which proxy server to use for the specified protocol.
global::System.Threading.Tasks.Task	SetAsync (string protocol, vmware.appliance.networking.ProxyTypes.Config config)
	Configures which proxy server to use for the specified protocol.
global::System.Threading.Tasks.Task	SetAsync (string protocol, vmware.appliance.networking.ProxyTypes.Config config, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Configures which proxy server to use for the specified protocol.
void	Delete (string protocol)
	Deletes a proxy configuration for a specific protocol.
void	Delete (string protocol, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Deletes a proxy configuration for a specific protocol.
global::System.Threading.Tasks.Task	DeleteAsync (string protocol)
	Deletes a proxy configuration for a specific protocol.
global::System.Threading.Tasks.Task	DeleteAsync (string protocol, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Deletes a proxy configuration for a specific protocol.
global::System.Collections.Generic.Dictionary < vmware.appliance.networking.ProxyTypes.Protocol, vmware.appliance.networking.ProxyTypes.Config >	List ()
	Gets proxy configuration for all configured protocols.
global::System.Collections.Generic.Dictionary < vmware.appliance.networking.ProxyTypes.Protocol, vmware.appliance.networking.ProxyTypes.Config >	List (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Gets proxy configuration for all configured protocols.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.Dictionary < vmware.appliance.networking.ProxyTypes.Protocol, vmware.appliance.networking.ProxyTypes.Config > >	ListAsync ()
	Gets proxy configuration for all configured protocols.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.Dictionary < vmware.appliance.networking.ProxyTypes.Protocol, vmware.appliance.networking.ProxyTypes.Config > >	ListAsync (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Gets proxy configuration for all configured protocols.
vmware.appliance.networking.ProxyTypes.Config	Get (string protocol)
	Gets the proxy configuration for a specific protocol.
vmware.appliance.networking.ProxyTypes.Config	Get (string protocol, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Gets the proxy configuration for a specific protocol.
global::System.Threading.Tasks.Task < vmware.appliance.networking.ProxyTypes.Config >	GetAsync (string protocol)
	Gets the proxy configuration for a specific protocol.
global::System.Threading.Tasks.Task < vmware.appliance.networking.ProxyTypes.Config >	GetAsync (string protocol, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Gets the proxy configuration for a specific protocol.

---

Detailed Description

Remote stub implementation of the Proxy API service.

---

Constructor & Destructor Documentation

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

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

---

Member Function Documentation

void vmware::appliance::networking::ProxyStub::Delete

(

string

protocol

)

[inline]

Deletes a proxy configuration for a specific protocol.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error

Generic error.

Parameters:

protocol

ID whose proxy is to be deleted.

Implements vmware::appliance::networking::Proxy.

void vmware::appliance::networking::ProxyStub::Delete	(	string	protocol,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Deletes a proxy configuration for a specific protocol.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error

Generic error.

Parameters:

protocol	ID whose proxy is to be deleted.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implements vmware::appliance::networking::Proxy.

global::System.Threading.Tasks.Task vmware::appliance::networking::ProxyStub::DeleteAsync

(

string

protocol

)

[inline]

Deletes a proxy configuration for a specific protocol.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error

Generic error.

Parameters:

protocol

ID whose proxy is to be deleted.

Implements vmware::appliance::networking::Proxy.

global::System.Threading.Tasks.Task vmware::appliance::networking::ProxyStub::DeleteAsync	(	string	protocol,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Deletes a proxy configuration for a specific protocol.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error

Generic error.

Parameters:

protocol	ID whose proxy is to be deleted.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implements vmware::appliance::networking::Proxy.

vmware.appliance.networking.ProxyTypes.Config vmware::appliance::networking::ProxyStub::Get

(

string

protocol

)

[inline]

Gets the proxy configuration for a specific protocol.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error

Generic error.

Parameters:

protocol

The protocol whose proxy configuration is requested.

Returns:

Proxy configuration for a specific protocol.

Implements vmware::appliance::networking::Proxy.

vmware.appliance.networking.ProxyTypes.Config vmware::appliance::networking::ProxyStub::Get	(	string	protocol,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Gets the proxy configuration for a specific protocol.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error

Generic error.

Parameters:

protocol	The protocol whose proxy configuration is requested.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Proxy configuration for a specific protocol.

Implements vmware::appliance::networking::Proxy.

global::System.Threading.Tasks.Task<vmware.appliance.networking.ProxyTypes.Config> vmware::appliance::networking::ProxyStub::GetAsync

(

string

protocol

)

[inline]

Gets the proxy configuration for a specific protocol.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error

Generic error.

Parameters:

protocol

The protocol whose proxy configuration is requested.

Returns:

Proxy configuration for a specific protocol.

Implements vmware::appliance::networking::Proxy.

global::System.Threading.Tasks.Task<vmware.appliance.networking.ProxyTypes.Config> vmware::appliance::networking::ProxyStub::GetAsync	(	string	protocol,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Gets the proxy configuration for a specific protocol.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error

Generic error.

Parameters:

protocol	The protocol whose proxy configuration is requested.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Proxy configuration for a specific protocol.

Implements vmware::appliance::networking::Proxy.

global::System.Collections.Generic.Dictionary<vmware.appliance.networking.ProxyTypes.Protocol, vmware.appliance.networking.ProxyTypes.Config> vmware::appliance::networking::ProxyStub::List

(

)

[inline]

Gets proxy configuration for all configured protocols.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error

Generic error.

Returns:

Proxy configuration for all configured protocols.

Implements vmware::appliance::networking::Proxy.

global::System.Collections.Generic.Dictionary<vmware.appliance.networking.ProxyTypes.Protocol, vmware.appliance.networking.ProxyTypes.Config> vmware::appliance::networking::ProxyStub::List	(	global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Gets proxy configuration for all configured protocols.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error

Generic error.

Returns:

Proxy configuration for all configured protocols.

Implements vmware::appliance::networking::Proxy.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.Dictionary<vmware.appliance.networking.ProxyTypes.Protocol, vmware.appliance.networking.ProxyTypes.Config> > vmware::appliance::networking::ProxyStub::ListAsync	(	global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Gets proxy configuration for all configured protocols.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error

Generic error.

Returns:

Proxy configuration for all configured protocols.

Implements vmware::appliance::networking::Proxy.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.Dictionary<vmware.appliance.networking.ProxyTypes.Protocol, vmware.appliance.networking.ProxyTypes.Config> > vmware::appliance::networking::ProxyStub::ListAsync

(

)

[inline]

Gets proxy configuration for all configured protocols.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error

Generic error.

Returns:

Proxy configuration for all configured protocols.

Implements vmware::appliance::networking::Proxy.

void vmware::appliance::networking::ProxyStub::Set	(	string	protocol,
		vmware.appliance.networking.ProxyTypes.Config	config
	)		[inline]

Configures which proxy server to use for the specified protocol.

This operation sets environment variables for using proxy. In order for this configuration to take effect a logout / service restart is required. This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error

Generic error.

Parameters:

protocol	The protocol for which proxy should be set.
config	Proxy configuration for the specific protocol.

Implements vmware::appliance::networking::Proxy.

void vmware::appliance::networking::ProxyStub::Set	(	string	protocol,
		vmware.appliance.networking.ProxyTypes.Config	config,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Configures which proxy server to use for the specified protocol.

This operation sets environment variables for using proxy. In order for this configuration to take effect a logout / service restart is required. This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error

Generic error.

Parameters:

protocol	The protocol for which proxy should be set.
config	Proxy configuration for the specific protocol.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implements vmware::appliance::networking::Proxy.

global::System.Threading.Tasks.Task vmware::appliance::networking::ProxyStub::SetAsync	(	string	protocol,
		vmware.appliance.networking.ProxyTypes.Config	config,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Configures which proxy server to use for the specified protocol.

This operation sets environment variables for using proxy. In order for this configuration to take effect a logout / service restart is required. This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error

Generic error.

Parameters:

protocol	The protocol for which proxy should be set.
config	Proxy configuration for the specific protocol.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implements vmware::appliance::networking::Proxy.

global::System.Threading.Tasks.Task vmware::appliance::networking::ProxyStub::SetAsync	(	string	protocol,
		vmware.appliance.networking.ProxyTypes.Config	config
	)		[inline]

Configures which proxy server to use for the specified protocol.

This operation sets environment variables for using proxy. In order for this configuration to take effect a logout / service restart is required. This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error

Generic error.

Parameters:

protocol	The protocol for which proxy should be set.
config	Proxy configuration for the specific protocol.

Implements vmware::appliance::networking::Proxy.

vmware.appliance.networking.ProxyTypes.TestResult vmware::appliance::networking::ProxyStub::Test	(	string	host,
		string	protocol,
		vmware.appliance.networking.ProxyTypes.Config	config,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Tests a proxy configuration by testing the connection to the proxy server and test host.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error

Generic error.

Parameters:

host	A hostname, IPv4 or Ipv6 address.
protocol	Protocol whose proxy is to be tested.
config	Proxy configuration to test.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Status of proxy settings.

Implements vmware::appliance::networking::Proxy.

vmware.appliance.networking.ProxyTypes.TestResult vmware::appliance::networking::ProxyStub::Test	(	string	host,
		string	protocol,
		vmware.appliance.networking.ProxyTypes.Config	config
	)		[inline]

Tests a proxy configuration by testing the connection to the proxy server and test host.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error

Generic error.

Parameters:

host	A hostname, IPv4 or Ipv6 address.
protocol	Protocol whose proxy is to be tested.
config	Proxy configuration to test.

Returns:

Status of proxy settings.

Implements vmware::appliance::networking::Proxy.

global::System.Threading.Tasks.Task<vmware.appliance.networking.ProxyTypes.TestResult> vmware::appliance::networking::ProxyStub::TestAsync	(	string	host,
		string	protocol,
		vmware.appliance.networking.ProxyTypes.Config	config,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Tests a proxy configuration by testing the connection to the proxy server and test host.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error

Generic error.

Parameters:

host	A hostname, IPv4 or Ipv6 address.
protocol	Protocol whose proxy is to be tested.
config	Proxy configuration to test.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Status of proxy settings.

Implements vmware::appliance::networking::Proxy.

global::System.Threading.Tasks.Task<vmware.appliance.networking.ProxyTypes.TestResult> vmware::appliance::networking::ProxyStub::TestAsync	(	string	host,
		string	protocol,
		vmware.appliance.networking.ProxyTypes.Config	config
	)		[inline]

Tests a proxy configuration by testing the connection to the proxy server and test host.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error

Generic error.

Parameters:

host	A hostname, IPv4 or Ipv6 address.
protocol	Protocol whose proxy is to be tested.
config	Proxy configuration to test.

Returns:

Status of proxy settings.

Implements vmware::appliance::networking::Proxy.

---

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

• ProxyStub.cs