com.vmware.nsx

Interface Node

All Superinterfaces:

NodeTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

NodeStub

public interface Node
extends com.vmware.vapi.bindings.Service, NodeTypes

Field Summary

Fields inherited from interface com.vmware.nsx.NodeTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
NodeProperties	get() Returns information about the NSX appliance.
void	get(com.vmware.vapi.bindings.client.AsyncCallback<NodeProperties> asyncCallback) Returns information about the NSX appliance.
void	get(com.vmware.vapi.bindings.client.AsyncCallback<NodeProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about the NSX appliance.
NodeProperties	get(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about the NSX appliance.
void	restart() Restarts or shuts down the NSX appliance.
void	restart(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Restarts or shuts down the NSX appliance.
void	restart(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Restarts or shuts down the NSX appliance.
void	restart(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Restarts or shuts down the NSX appliance.
void	setcoredumpconfig(CoreDumpConfig coreDumpConfig) Update node configuration for core dump generation and rotation policy
void	setcoredumpconfig(CoreDumpConfig coreDumpConfig, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Update node configuration for core dump generation and rotation policy
void	setcoredumpconfig(CoreDumpConfig coreDumpConfig, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Update node configuration for core dump generation and rotation policy
void	setcoredumpconfig(CoreDumpConfig coreDumpConfig, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Update node configuration for core dump generation and rotation policy
void	setsystemtime(NodeTime nodeTime) Set the node system time to the given time in UTC in the RFC3339 format 'yyyy-mm-ddThh:mm:ssZ'.
void	setsystemtime(NodeTime nodeTime, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Set the node system time to the given time in UTC in the RFC3339 format 'yyyy-mm-ddThh:mm:ssZ'.
void	setsystemtime(NodeTime nodeTime, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Set the node system time to the given time in UTC in the RFC3339 format 'yyyy-mm-ddThh:mm:ssZ'.
void	setsystemtime(NodeTime nodeTime, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Set the node system time to the given time in UTC in the RFC3339 format 'yyyy-mm-ddThh:mm:ssZ'.
void	shutdown() Restarts or shuts down the NSX appliance.
void	shutdown(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Restarts or shuts down the NSX appliance.
void	shutdown(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Restarts or shuts down the NSX appliance.
void	shutdown(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Restarts or shuts down the NSX appliance.
NodeProperties	update(NodeProperties nodeProperties) Modifies NSX appliance properties.
void	update(NodeProperties nodeProperties, com.vmware.vapi.bindings.client.AsyncCallback<NodeProperties> asyncCallback) Modifies NSX appliance properties.
void	update(NodeProperties nodeProperties, com.vmware.vapi.bindings.client.AsyncCallback<NodeProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Modifies NSX appliance properties.
NodeProperties	update(NodeProperties nodeProperties, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Modifies NSX appliance properties.

Method Detail

get

NodeProperties get()

Returns information about the NSX appliance. Information includes release number, time zone, system time, kernel version, message of the day (motd), and host name.

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

Returns:

com.vmware.nsx.model.NodeProperties

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

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

Returns information about the NSX appliance. Information includes release number, time zone, system time, kernel version, message of the day (motd), and host name.

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.NodeProperties

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

Returns information about the NSX appliance. Information includes release number, time zone, system time, kernel version, message of the day (motd), and host name.

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

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

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

Returns information about the NSX appliance. Information includes release number, time zone, system time, kernel version, message of the day (motd), and host name.

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.NodeProperties

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

void restart()

Restarts or shuts down the NSX appliance.

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

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.InvocationConfig invocationConfig)

Restarts or shuts down the NSX appliance.

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.

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<java.lang.Void> asyncCallback)

Restarts or shuts down the NSX appliance.

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:

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

restart

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

Restarts or shuts down the NSX appliance.

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:

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

invocationConfig - Configuration for the method invocation.

setcoredumpconfig

void setcoredumpconfig(CoreDumpConfig coreDumpConfig)

Update node configuration for core dump generation and rotation policy

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

Parameters:

coreDumpConfig - (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

setcoredumpconfig

void setcoredumpconfig(CoreDumpConfig coreDumpConfig,
                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Update node configuration for core dump generation and rotation policy

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:

coreDumpConfig - (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

setcoredumpconfig

void setcoredumpconfig(CoreDumpConfig coreDumpConfig,
                       com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Update node configuration for core dump generation and rotation policy

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:

coreDumpConfig - (required)

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

setcoredumpconfig

void setcoredumpconfig(CoreDumpConfig coreDumpConfig,
                       com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Update node configuration for core dump generation and rotation policy

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:

coreDumpConfig - (required)

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

invocationConfig - Configuration for the method invocation.

setsystemtime

void setsystemtime(NodeTime nodeTime)

Set the node system time to the given time in UTC in the RFC3339 format 'yyyy-mm-ddThh:mm:ssZ'.

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

Parameters:

nodeTime - (required)

Throws:

com.vmware.vapi.std.errors.ConcurrentChange - Conflict

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

setsystemtime

void setsystemtime(NodeTime nodeTime,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Set the node system time to the given time in UTC in the RFC3339 format 'yyyy-mm-ddThh:mm:ssZ'.

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:

nodeTime - (required)

invocationConfig - Configuration for the method invocation.

Throws:

com.vmware.vapi.std.errors.ConcurrentChange - Conflict

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

setsystemtime

void setsystemtime(NodeTime nodeTime,
                   com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Set the node system time to the given time in UTC in the RFC3339 format 'yyyy-mm-ddThh:mm:ssZ'.

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

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

Parameters:

nodeTime - (required)

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

setsystemtime

void setsystemtime(NodeTime nodeTime,
                   com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Set the node system time to the given time in UTC in the RFC3339 format 'yyyy-mm-ddThh:mm:ssZ'.

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

Parameters:

nodeTime - (required)

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

invocationConfig - Configuration for the method invocation.

shutdown

void shutdown()

Restarts or shuts down the NSX appliance.

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

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

shutdown

void shutdown(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Restarts or shuts down the NSX appliance.

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.

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

shutdown

void shutdown(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Restarts or shuts down the NSX appliance.

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:

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

shutdown

void shutdown(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Restarts or shuts down the NSX appliance.

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:

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

invocationConfig - Configuration for the method invocation.

update

NodeProperties update(NodeProperties nodeProperties)

Modifies NSX appliance properties. Modifiable properties include the timezone, message of the day (motd), and hostname. The NSX appliance node_version, system_time, and kernel_version are read only and cannot be modified with this method.

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

Parameters:

nodeProperties - (required)

Returns:

com.vmware.nsx.model.NodeProperties

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

NodeProperties update(NodeProperties nodeProperties,
                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Modifies NSX appliance properties. Modifiable properties include the timezone, message of the day (motd), and hostname. The NSX appliance node_version, system_time, and kernel_version are read only and cannot be modified with this method.

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:

nodeProperties - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeProperties

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(NodeProperties nodeProperties,
            com.vmware.vapi.bindings.client.AsyncCallback<NodeProperties> asyncCallback)

Modifies NSX appliance properties. Modifiable properties include the timezone, message of the day (motd), and hostname. The NSX appliance node_version, system_time, and kernel_version are read only and cannot be modified with this method.

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

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

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

Parameters:

nodeProperties - (required)

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

update

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

Modifies NSX appliance properties. Modifiable properties include the timezone, message of the day (motd), and hostname. The NSX appliance node_version, system_time, and kernel_version are read only and cannot be modified with this method.

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.NodeProperties

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

Parameters:

nodeProperties - (required)

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

invocationConfig - Configuration for the method invocation.