com.vmware.nsx.node.services

Class SshStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.node.services.SshStub

All Implemented Interfaces:

Ssh, SshTypes, com.vmware.vapi.bindings.Service

public class SshStub
extends com.vmware.vapi.internal.bindings.Stub
implements Ssh

Remote stub implementation of the Ssh API service.

WARNING: Internal class, subject to change in future versions.

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.nsx.node.services.SshTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
SshStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
SshStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, com.vmware.vapi.bindings.StubConfigurationBase config)

Method Summary

Modifier and Type	Method and Description
NodeSshServiceProperties	get() Read ssh service properties
void	get(com.vmware.vapi.bindings.client.AsyncCallback<NodeSshServiceProperties> asyncCallback) Read ssh service properties
void	get(com.vmware.vapi.bindings.client.AsyncCallback<NodeSshServiceProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Read ssh service properties
NodeSshServiceProperties	get(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Read ssh service properties
void	removehostfingerprint(KnownHostParameter knownHostParameter) Remove a host's fingerprint from known hosts file
void	removehostfingerprint(KnownHostParameter knownHostParameter, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Remove a host's fingerprint from known hosts file
void	removehostfingerprint(KnownHostParameter knownHostParameter, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Remove a host's fingerprint from known hosts file
void	removehostfingerprint(KnownHostParameter knownHostParameter, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Remove a host's fingerprint from known hosts file
NodeServiceStatusProperties	restart() Restart, start or stop the ssh service
void	restart(com.vmware.vapi.bindings.client.AsyncCallback<NodeServiceStatusProperties> asyncCallback) Restart, start or stop the ssh service
void	restart(com.vmware.vapi.bindings.client.AsyncCallback<NodeServiceStatusProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Restart, start or stop the ssh service
NodeServiceStatusProperties	restart(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Restart, start or stop the ssh service
NodeServiceStatusProperties	start() Restart, start or stop the ssh service
void	start(com.vmware.vapi.bindings.client.AsyncCallback<NodeServiceStatusProperties> asyncCallback) Restart, start or stop the ssh service
void	start(com.vmware.vapi.bindings.client.AsyncCallback<NodeServiceStatusProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Restart, start or stop the ssh service
NodeServiceStatusProperties	start(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Restart, start or stop the ssh service
NodeServiceStatusProperties	stop() Restart, start or stop the ssh service
void	stop(com.vmware.vapi.bindings.client.AsyncCallback<NodeServiceStatusProperties> asyncCallback) Restart, start or stop the ssh service
void	stop(com.vmware.vapi.bindings.client.AsyncCallback<NodeServiceStatusProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Restart, start or stop the ssh service
NodeServiceStatusProperties	stop(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Restart, start or stop the ssh service
NodeSshServiceProperties	update(NodeSshServiceProperties nodeSshServiceProperties) Update ssh service properties.
void	update(NodeSshServiceProperties nodeSshServiceProperties, com.vmware.vapi.bindings.client.AsyncCallback<NodeSshServiceProperties> asyncCallback) Update ssh service properties.
void	update(NodeSshServiceProperties nodeSshServiceProperties, com.vmware.vapi.bindings.client.AsyncCallback<NodeSshServiceProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Update ssh service properties.
NodeSshServiceProperties	update(NodeSshServiceProperties nodeSshServiceProperties, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Update ssh service properties.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, invokeStreamMethod, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SshStub

public SshStub(com.vmware.vapi.core.ApiProvider apiProvider,
               com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
               com.vmware.vapi.bindings.StubConfigurationBase config)

SshStub

public SshStub(com.vmware.vapi.core.ApiProvider apiProvider,
               com.vmware.vapi.bindings.StubConfigurationBase config)

Method Detail

get

public NodeSshServiceProperties get()

Description copied from interface: Ssh

Read ssh service properties

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

Specified by:

get in interface Ssh

Returns:

com.vmware.nsx.model.NodeSshServiceProperties

get

public NodeSshServiceProperties get(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Ssh

Read ssh service properties

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

get in interface Ssh

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeSshServiceProperties

get

public void get(com.vmware.vapi.bindings.client.AsyncCallback<NodeSshServiceProperties> asyncCallback)

Description copied from interface: Ssh

Read ssh service properties

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

Invocation Result:
com.vmware.nsx.model.NodeSshServiceProperties

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

get in interface Ssh

Parameters:

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

get

public void get(com.vmware.vapi.bindings.client.AsyncCallback<NodeSshServiceProperties> asyncCallback,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Ssh

Read ssh service properties

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

Invocation Result:
com.vmware.nsx.model.NodeSshServiceProperties

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

get in interface Ssh

Parameters:

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

invocationConfig - Configuration for the method invocation.

removehostfingerprint

public void removehostfingerprint(KnownHostParameter knownHostParameter)

Description copied from interface: Ssh

Remove a host's fingerprint from known hosts file

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

Specified by:

removehostfingerprint in interface Ssh

Parameters:

knownHostParameter - (required)

removehostfingerprint

public void removehostfingerprint(KnownHostParameter knownHostParameter,
                                  com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Ssh

Remove a host's fingerprint from known hosts file

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

removehostfingerprint in interface Ssh

Parameters:

knownHostParameter - (required)

invocationConfig - Configuration for the method invocation.

removehostfingerprint

public void removehostfingerprint(KnownHostParameter knownHostParameter,
                                  com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Ssh

Remove a host's fingerprint from known hosts file

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

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

removehostfingerprint in interface Ssh

Parameters:

knownHostParameter - (required)

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

removehostfingerprint

public void removehostfingerprint(KnownHostParameter knownHostParameter,
                                  com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                                  com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Ssh

Remove a host's fingerprint from known hosts file

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:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

removehostfingerprint in interface Ssh

Parameters:

knownHostParameter - (required)

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

invocationConfig - Configuration for the method invocation.

restart

public NodeServiceStatusProperties restart()

Description copied from interface: Ssh

Restart, start or stop the ssh service

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

Specified by:

restart in interface Ssh

Returns:

com.vmware.nsx.model.NodeServiceStatusProperties

restart

public NodeServiceStatusProperties restart(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Ssh

Restart, start or stop the ssh service

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

restart in interface Ssh

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeServiceStatusProperties

restart

public void restart(com.vmware.vapi.bindings.client.AsyncCallback<NodeServiceStatusProperties> asyncCallback)

Description copied from interface: Ssh

Restart, start or stop the ssh service

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

Invocation Result:
com.vmware.nsx.model.NodeServiceStatusProperties

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

restart in interface Ssh

Parameters:

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

restart

public void restart(com.vmware.vapi.bindings.client.AsyncCallback<NodeServiceStatusProperties> asyncCallback,
                    com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Ssh

Restart, start or stop the ssh service

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

Invocation Result:
com.vmware.nsx.model.NodeServiceStatusProperties

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

restart in interface Ssh

Parameters:

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

invocationConfig - Configuration for the method invocation.

start

public NodeServiceStatusProperties start()

Description copied from interface: Ssh

Restart, start or stop the ssh service

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

Specified by:

start in interface Ssh

Returns:

com.vmware.nsx.model.NodeServiceStatusProperties

start

public NodeServiceStatusProperties start(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Ssh

Restart, start or stop the ssh service

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

start in interface Ssh

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeServiceStatusProperties

start

public void start(com.vmware.vapi.bindings.client.AsyncCallback<NodeServiceStatusProperties> asyncCallback)

Description copied from interface: Ssh

Restart, start or stop the ssh service

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

Invocation Result:
com.vmware.nsx.model.NodeServiceStatusProperties

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

start in interface Ssh

Parameters:

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

start

public void start(com.vmware.vapi.bindings.client.AsyncCallback<NodeServiceStatusProperties> asyncCallback,
                  com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Ssh

Restart, start or stop the ssh service

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

Invocation Result:
com.vmware.nsx.model.NodeServiceStatusProperties

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

start in interface Ssh

Parameters:

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

invocationConfig - Configuration for the method invocation.

stop

public NodeServiceStatusProperties stop()

Description copied from interface: Ssh

Restart, start or stop the ssh service

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

Specified by:

stop in interface Ssh

Returns:

com.vmware.nsx.model.NodeServiceStatusProperties

stop

public NodeServiceStatusProperties stop(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Ssh

Restart, start or stop the ssh service

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

stop in interface Ssh

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeServiceStatusProperties

stop

public void stop(com.vmware.vapi.bindings.client.AsyncCallback<NodeServiceStatusProperties> asyncCallback)

Description copied from interface: Ssh

Restart, start or stop the ssh service

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

Invocation Result:
com.vmware.nsx.model.NodeServiceStatusProperties

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

stop in interface Ssh

Parameters:

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

stop

public void stop(com.vmware.vapi.bindings.client.AsyncCallback<NodeServiceStatusProperties> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Ssh

Restart, start or stop the ssh service

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

Invocation Result:
com.vmware.nsx.model.NodeServiceStatusProperties

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

stop in interface Ssh

Parameters:

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

invocationConfig - Configuration for the method invocation.

update

public NodeSshServiceProperties update(NodeSshServiceProperties nodeSshServiceProperties)

Description copied from interface: Ssh

Update ssh service properties. If the start_on_boot property is updated to true, existing ssh sessions if any are stopped and the ssh service is restarted.

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

Specified by:

update in interface Ssh

Parameters:

nodeSshServiceProperties - (required)

Returns:

com.vmware.nsx.model.NodeSshServiceProperties

update

public NodeSshServiceProperties update(NodeSshServiceProperties nodeSshServiceProperties,
                                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Ssh

Update ssh service properties. If the start_on_boot property is updated to true, existing ssh sessions if any are stopped and the ssh service is restarted.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

update in interface Ssh

Parameters:

nodeSshServiceProperties - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeSshServiceProperties

update

public void update(NodeSshServiceProperties nodeSshServiceProperties,
                   com.vmware.vapi.bindings.client.AsyncCallback<NodeSshServiceProperties> asyncCallback)

Description copied from interface: Ssh

Update ssh service properties. If the start_on_boot property is updated to true, existing ssh sessions if any are stopped and the ssh service is restarted.

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

Invocation Result:
com.vmware.nsx.model.NodeSshServiceProperties

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

update in interface Ssh

Parameters:

nodeSshServiceProperties - (required)

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

update

public void update(NodeSshServiceProperties nodeSshServiceProperties,
                   com.vmware.vapi.bindings.client.AsyncCallback<NodeSshServiceProperties> asyncCallback,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Ssh

Update ssh service properties. If the start_on_boot property is updated to true, existing ssh sessions if any are stopped and the ssh service is restarted.

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

Invocation Result:
com.vmware.nsx.model.NodeSshServiceProperties

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

update in interface Ssh

Parameters:

nodeSshServiceProperties - (required)

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

invocationConfig - Configuration for the method invocation.