com.vmware.nsx

Interface Upgrade

All Superinterfaces:

com.vmware.vapi.bindings.Service, UpgradeTypes

All Known Implementing Classes:

UpgradeStub

public interface Upgrade
extends com.vmware.vapi.bindings.Service, UpgradeTypes

Field Summary

Fields inherited from interface com.vmware.nsx.UpgradeTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
void	abortpreupgradechecks() Aborts execution of pre-upgrade checks if already in progress.
void	abortpreupgradechecks(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Aborts execution of pre-upgrade checks if already in progress.
void	abortpreupgradechecks(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Aborts execution of pre-upgrade checks if already in progress.
void	abortpreupgradechecks(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Aborts execution of pre-upgrade checks if already in progress.
void	executepostupgradechecks(java.lang.String componentType) Run pre-defined checks to identify issues after upgrade of a component.
void	executepostupgradechecks(java.lang.String componentType, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Run pre-defined checks to identify issues after upgrade of a component.
void	executepostupgradechecks(java.lang.String componentType, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Run pre-defined checks to identify issues after upgrade of a component.
void	executepostupgradechecks(java.lang.String componentType, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Run pre-defined checks to identify issues after upgrade of a component.
void	executepreupgradechecks(java.lang.String componentType, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) Run pre-defined checks to identify potential issues which can be encountered during an upgrade or can cause an upgrade to fail.
void	executepreupgradechecks(java.lang.String componentType, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Run pre-defined checks to identify potential issues which can be encountered during an upgrade or can cause an upgrade to fail.
void	executepreupgradechecks(java.lang.String componentType, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Run pre-defined checks to identify potential issues which can be encountered during an upgrade or can cause an upgrade to fail.
void	executepreupgradechecks(java.lang.String componentType, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Run pre-defined checks to identify potential issues which can be encountered during an upgrade or can cause an upgrade to fail.
void	upgradeuc() Upgrade the upgrade coordinator module itself.
void	upgradeuc(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Upgrade the upgrade coordinator module itself.
void	upgradeuc(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Upgrade the upgrade coordinator module itself.
void	upgradeuc(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Upgrade the upgrade coordinator module itself.

Method Detail

abortpreupgradechecks

void abortpreupgradechecks()

Aborts execution of pre-upgrade checks if already in progress. Halts the execution of checks awaiting execution at this point and makes best-effort attempts to stop checks already in execution. Returns without action if execution of pre-upgrade checks is not in progress.

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

abortpreupgradechecks

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

Aborts execution of pre-upgrade checks if already in progress. Halts the execution of checks awaiting execution at this point and makes best-effort attempts to stop checks already in execution. Returns without action if execution of pre-upgrade checks is not in progress.

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

abortpreupgradechecks

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

Aborts execution of pre-upgrade checks if already in progress. Halts the execution of checks awaiting execution at this point and makes best-effort attempts to stop checks already in execution. Returns without action if execution of pre-upgrade checks is not in progress.

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.

abortpreupgradechecks

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

Aborts execution of pre-upgrade checks if already in progress. Halts the execution of checks awaiting execution at this point and makes best-effort attempts to stop checks already in execution. Returns without action if execution of pre-upgrade checks is not in progress.

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.

executepostupgradechecks

void executepostupgradechecks(java.lang.String componentType)

Run pre-defined checks to identify issues after upgrade of a component. The results of the checks are added to the respective upgrade units aggregate-info. The progress and status of post-upgrade checks is part of aggregate-info of individual upgrade unit groups. Returns HTTP status 500 with error code 30953 if execution of post-upgrade checks is already in progress.

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

Parameters:

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

executepostupgradechecks

void executepostupgradechecks(java.lang.String componentType,
                              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Run pre-defined checks to identify issues after upgrade of a component. The results of the checks are added to the respective upgrade units aggregate-info. The progress and status of post-upgrade checks is part of aggregate-info of individual upgrade unit groups. Returns HTTP status 500 with error code 30953 if execution of post-upgrade checks is already in progress.

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:

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

executepostupgradechecks

void executepostupgradechecks(java.lang.String componentType,
                              com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Run pre-defined checks to identify issues after upgrade of a component. The results of the checks are added to the respective upgrade units aggregate-info. The progress and status of post-upgrade checks is part of aggregate-info of individual upgrade unit groups. Returns HTTP status 500 with error code 30953 if execution of post-upgrade checks is already in progress.

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:

componentType - (required)

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

executepostupgradechecks

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

Run pre-defined checks to identify issues after upgrade of a component. The results of the checks are added to the respective upgrade units aggregate-info. The progress and status of post-upgrade checks is part of aggregate-info of individual upgrade unit groups. Returns HTTP status 500 with error code 30953 if execution of post-upgrade checks is already in progress.

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:

componentType - (required)

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

invocationConfig - Configuration for the method invocation.

executepreupgradechecks

void executepreupgradechecks(java.lang.String componentType,
                             java.lang.String cursor,
                             java.lang.String includedFields,
                             java.lang.Long pageSize,
                             java.lang.Boolean sortAscending,
                             java.lang.String sortBy)

Run pre-defined checks to identify potential issues which can be encountered during an upgrade or can cause an upgrade to fail. The results of the checks are added to the respective upgrade units aggregate-info. The progress and status of operation is part of upgrade status summary of individual components. Returns HTTP status 500 with error code 30953 if execution of pre-upgrade checks is already in progress.

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

Parameters:

componentType - Component type on which the action is performed or on which the results are filtered (optional)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

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

executepreupgradechecks

void executepreupgradechecks(java.lang.String componentType,
                             java.lang.String cursor,
                             java.lang.String includedFields,
                             java.lang.Long pageSize,
                             java.lang.Boolean sortAscending,
                             java.lang.String sortBy,
                             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Run pre-defined checks to identify potential issues which can be encountered during an upgrade or can cause an upgrade to fail. The results of the checks are added to the respective upgrade units aggregate-info. The progress and status of operation is part of upgrade status summary of individual components. Returns HTTP status 500 with error code 30953 if execution of pre-upgrade checks is already in progress.

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:

componentType - Component type on which the action is performed or on which the results are filtered (optional)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

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

executepreupgradechecks

void executepreupgradechecks(java.lang.String componentType,
                             java.lang.String cursor,
                             java.lang.String includedFields,
                             java.lang.Long pageSize,
                             java.lang.Boolean sortAscending,
                             java.lang.String sortBy,
                             com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Run pre-defined checks to identify potential issues which can be encountered during an upgrade or can cause an upgrade to fail. The results of the checks are added to the respective upgrade units aggregate-info. The progress and status of operation is part of upgrade status summary of individual components. Returns HTTP status 500 with error code 30953 if execution of pre-upgrade checks is already in progress.

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:

componentType - Component type on which the action is performed or on which the results are filtered (optional)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

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

executepreupgradechecks

void executepreupgradechecks(java.lang.String componentType,
                             java.lang.String cursor,
                             java.lang.String includedFields,
                             java.lang.Long pageSize,
                             java.lang.Boolean sortAscending,
                             java.lang.String sortBy,
                             com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Run pre-defined checks to identify potential issues which can be encountered during an upgrade or can cause an upgrade to fail. The results of the checks are added to the respective upgrade units aggregate-info. The progress and status of operation is part of upgrade status summary of individual components. Returns HTTP status 500 with error code 30953 if execution of pre-upgrade checks is already in progress.

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:

componentType - Component type on which the action is performed or on which the results are filtered (optional)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

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

invocationConfig - Configuration for the method invocation.

upgradeuc

void upgradeuc()

Upgrade the upgrade coordinator module itself. This call is invoked after user uploads an upgrade bundle. Once this call is invoked, upgrade coordinator stops and gets restarted and target version upgrade coordinator module comes up after restart.

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

upgradeuc

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

Upgrade the upgrade coordinator module itself. This call is invoked after user uploads an upgrade bundle. Once this call is invoked, upgrade coordinator stops and gets restarted and target version upgrade coordinator module comes up after restart.

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

upgradeuc

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

Upgrade the upgrade coordinator module itself. This call is invoked after user uploads an upgrade bundle. Once this call is invoked, upgrade coordinator stops and gets restarted and target version upgrade coordinator module comes up after restart.

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.

upgradeuc

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

Upgrade the upgrade coordinator module itself. This call is invoked after user uploads an upgrade bundle. Once this call is invoked, upgrade coordinator stops and gets restarted and target version upgrade coordinator module comes up after restart.

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.