com.vmware.nsx.node.services

Interface NsxPlatformClient

All Superinterfaces:

NsxPlatformClientTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

NsxPlatformClientStub

public interface NsxPlatformClient
extends com.vmware.vapi.bindings.Service, NsxPlatformClientTypes

Field Summary

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

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
NodeServiceProperties	get() Read NSX Platform Client service properties
void	get(com.vmware.vapi.bindings.client.AsyncCallback<NodeServiceProperties> asyncCallback) Read NSX Platform Client service properties
void	get(com.vmware.vapi.bindings.client.AsyncCallback<NodeServiceProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Read NSX Platform Client service properties
NodeServiceProperties	get(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Read NSX Platform Client service properties
NodeServiceStatusProperties	restart() Restart, start or stop the NSX Platform Client service
void	restart(com.vmware.vapi.bindings.client.AsyncCallback<NodeServiceStatusProperties> asyncCallback) Restart, start or stop the NSX Platform Client service
void	restart(com.vmware.vapi.bindings.client.AsyncCallback<NodeServiceStatusProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Restart, start or stop the NSX Platform Client service
NodeServiceStatusProperties	restart(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Restart, start or stop the NSX Platform Client service
NodeServiceStatusProperties	start() Restart, start or stop the NSX Platform Client service
void	start(com.vmware.vapi.bindings.client.AsyncCallback<NodeServiceStatusProperties> asyncCallback) Restart, start or stop the NSX Platform Client service
void	start(com.vmware.vapi.bindings.client.AsyncCallback<NodeServiceStatusProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Restart, start or stop the NSX Platform Client service
NodeServiceStatusProperties	start(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Restart, start or stop the NSX Platform Client service
NodeServiceStatusProperties	stop() Restart, start or stop the NSX Platform Client service
void	stop(com.vmware.vapi.bindings.client.AsyncCallback<NodeServiceStatusProperties> asyncCallback) Restart, start or stop the NSX Platform Client service
void	stop(com.vmware.vapi.bindings.client.AsyncCallback<NodeServiceStatusProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Restart, start or stop the NSX Platform Client service
NodeServiceStatusProperties	stop(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Restart, start or stop the NSX Platform Client service

Method Detail

get

NodeServiceProperties get()

Read NSX Platform Client service properties

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

Returns:

com.vmware.nsx.model.NodeServiceProperties

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

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

Read NSX Platform Client 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.NodeServiceProperties

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<NodeServiceProperties> asyncCallback)

Read NSX Platform Client service properties

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

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

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<NodeServiceProperties> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Read NSX Platform Client 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.NodeServiceProperties

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.

restart

NodeServiceStatusProperties restart()

Restart, start or stop the NSX Platform Client 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 NSX Platform Client 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 NSX Platform Client 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 NSX Platform Client 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 NSX Platform Client 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 NSX Platform Client 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 NSX Platform Client 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 NSX Platform Client 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 NSX Platform Client 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 NSX Platform Client 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 NSX Platform Client 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 NSX Platform Client 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.