VMware vSphere Automation SDK for .NET 7.0.0.1
vmware::appliance::networking::Proxy Interface Reference

The Proxy interface provides methods Proxy configuration. More...

Inherited by vmware::appliance::networking::ProxyStub.

List of all members.

Public Member Functions

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

The Proxy interface provides methods Proxy configuration.

This interface was added in vSphere API 6.7.


Member Function Documentation

void vmware::appliance::networking::Proxy::Delete ( string  protocol)

Deletes a proxy configuration for a specific protocol.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error.
Parameters:
protocolID whose proxy is to be deleted.

Implemented in vmware::appliance::networking::ProxyStub.

void vmware::appliance::networking::Proxy::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.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error.
Parameters:
protocolID whose proxy is to be deleted.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::appliance::networking::ProxyStub.

global::System.Threading.Tasks.Task vmware::appliance::networking::Proxy::DeleteAsync ( string  protocol)

Deletes a proxy configuration for a specific protocol.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error.
Parameters:
protocolID whose proxy is to be deleted.

Implemented in vmware::appliance::networking::ProxyStub.

global::System.Threading.Tasks.Task vmware::appliance::networking::Proxy::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.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error.
Parameters:
protocolID whose proxy is to be deleted.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::appliance::networking::ProxyStub.

vmware.appliance.networking.ProxyTypes.Config vmware::appliance::networking::Proxy::Get ( string  protocol)

Gets the proxy configuration for a specific protocol.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error.
Parameters:
protocolThe protocol whose proxy configuration is requested.
Returns:
Proxy configuration for a specific protocol.

Implemented in vmware::appliance::networking::ProxyStub.

vmware.appliance.networking.ProxyTypes.Config vmware::appliance::networking::Proxy::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.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error.
Parameters:
protocolThe protocol whose proxy configuration is requested.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Proxy configuration for a specific protocol.

Implemented in vmware::appliance::networking::ProxyStub.

global::System.Threading.Tasks.Task<vmware.appliance.networking.ProxyTypes.Config> vmware::appliance::networking::Proxy::GetAsync ( string  protocol)

Gets the proxy configuration for a specific protocol.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error.
Parameters:
protocolThe protocol whose proxy configuration is requested.
Returns:
Proxy configuration for a specific protocol.

Implemented in vmware::appliance::networking::ProxyStub.

global::System.Threading.Tasks.Task<vmware.appliance.networking.ProxyTypes.Config> vmware::appliance::networking::Proxy::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.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error.
Parameters:
protocolThe protocol whose proxy configuration is requested.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Proxy configuration for a specific protocol.

Implemented in vmware::appliance::networking::ProxyStub.

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

Gets proxy configuration for all configured protocols.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error.
Returns:
Proxy configuration for all configured protocols.

Implemented in vmware::appliance::networking::ProxyStub.

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

Gets proxy configuration for all configured protocols.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error.
Returns:
Proxy configuration for all configured protocols.

Implemented in vmware::appliance::networking::ProxyStub.

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

Gets proxy configuration for all configured protocols.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error.
Returns:
Proxy configuration for all configured protocols.

Implemented in vmware::appliance::networking::ProxyStub.

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

Gets proxy configuration for all configured protocols.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error.
Returns:
Proxy configuration for all configured protocols.

Implemented in vmware::appliance::networking::ProxyStub.

void vmware::appliance::networking::Proxy::Set ( string  protocol,
vmware.appliance.networking.ProxyTypes.Config  config 
)

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.ErrorGeneric error.
Parameters:
protocolThe protocol for which proxy should be set.
configProxy configuration for the specific protocol.

Implemented in vmware::appliance::networking::ProxyStub.

void vmware::appliance::networking::Proxy::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.

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.ErrorGeneric error.
Parameters:
protocolThe protocol for which proxy should be set.
configProxy configuration for the specific protocol.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::appliance::networking::ProxyStub.

global::System.Threading.Tasks.Task vmware::appliance::networking::Proxy::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.

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.ErrorGeneric error.
Parameters:
protocolThe protocol for which proxy should be set.
configProxy configuration for the specific protocol.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::appliance::networking::ProxyStub.

global::System.Threading.Tasks.Task vmware::appliance::networking::Proxy::SetAsync ( string  protocol,
vmware.appliance.networking.ProxyTypes.Config  config 
)

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.ErrorGeneric error.
Parameters:
protocolThe protocol for which proxy should be set.
configProxy configuration for the specific protocol.

Implemented in vmware::appliance::networking::ProxyStub.

vmware.appliance.networking.ProxyTypes.TestResult vmware::appliance::networking::Proxy::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.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error.
Parameters:
hostA hostname, IPv4 or Ipv6 address.
protocolProtocol whose proxy is to be tested.
configProxy configuration to test.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Status of proxy settings.

Implemented in vmware::appliance::networking::ProxyStub.

vmware.appliance.networking.ProxyTypes.TestResult vmware::appliance::networking::Proxy::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.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error.
Parameters:
hostA hostname, IPv4 or Ipv6 address.
protocolProtocol whose proxy is to be tested.
configProxy configuration to test.
Returns:
Status of proxy settings.

Implemented in vmware::appliance::networking::ProxyStub.

global::System.Threading.Tasks.Task<vmware.appliance.networking.ProxyTypes.TestResult> vmware::appliance::networking::Proxy::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.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error.
Parameters:
hostA hostname, IPv4 or Ipv6 address.
protocolProtocol whose proxy is to be tested.
configProxy configuration to test.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Status of proxy settings.

Implemented in vmware::appliance::networking::ProxyStub.

global::System.Threading.Tasks.Task<vmware.appliance.networking.ProxyTypes.TestResult> vmware::appliance::networking::Proxy::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.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error.
Parameters:
hostA hostname, IPv4 or Ipv6 address.
protocolProtocol whose proxy is to be tested.
configProxy configuration to test.
Returns:
Status of proxy settings.

Implemented in vmware::appliance::networking::ProxyStub.


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