com.vmware.nsx.node.services

Interface Ssh

All Superinterfaces:

com.vmware.vapi.bindings.Service, SshTypes

All Known Implementing Classes:

SshStub

public interface Ssh
extends com.vmware.vapi.bindings.Service, SshTypes

Field Summary

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

_VAPI_SERVICE_ID

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.

Method Detail

get

NodeSshServiceProperties get()

Read ssh service properties

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

Returns:

com.vmware.nsx.model.NodeSshServiceProperties

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

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

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.

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeSshServiceProperties

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

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

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

Parameters:

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

get

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

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

Parameters:

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

invocationConfig - Configuration for the method invocation.

removehostfingerprint

void removehostfingerprint(KnownHostParameter knownHostParameter)

Remove a host's fingerprint from known hosts file

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

Parameters:

knownHostParameter - (required)

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

removehostfingerprint

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

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.

Parameters:

knownHostParameter - (required)

invocationConfig - Configuration for the method invocation.

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

removehostfingerprint

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

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

Parameters:

knownHostParameter - (required)

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

removehostfingerprint

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

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

Parameters:

knownHostParameter - (required)

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

invocationConfig - Configuration for the method invocation.

restart

NodeServiceStatusProperties restart()

Restart, start or stop the ssh service

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

Returns:

com.vmware.nsx.model.NodeServiceStatusProperties

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

restart

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

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.

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeServiceStatusProperties

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

restart

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

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

Parameters:

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

restart

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

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

Parameters:

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

invocationConfig - Configuration for the method invocation.

start

NodeServiceStatusProperties start()

Restart, start or stop the ssh service

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

Returns:

com.vmware.nsx.model.NodeServiceStatusProperties

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

start

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

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.

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeServiceStatusProperties

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

start

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

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

Parameters:

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

start

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

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

Parameters:

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

invocationConfig - Configuration for the method invocation.

stop

NodeServiceStatusProperties stop()

Restart, start or stop the ssh service

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

Returns:

com.vmware.nsx.model.NodeServiceStatusProperties

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

stop

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

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.

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeServiceStatusProperties

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

stop

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

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

Parameters:

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

stop

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

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

Parameters:

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

invocationConfig - Configuration for the method invocation.

update

NodeSshServiceProperties update(NodeSshServiceProperties nodeSshServiceProperties)

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.

Parameters:

nodeSshServiceProperties - (required)

Returns:

com.vmware.nsx.model.NodeSshServiceProperties

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

update

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

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.

Parameters:

nodeSshServiceProperties - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeSshServiceProperties

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

update

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

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

Parameters:

nodeSshServiceProperties - (required)

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

update

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

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

Parameters:

nodeSshServiceProperties - (required)

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

invocationConfig - Configuration for the method invocation.