com.vmware.nsx.nvds_urt

Interface Precheck

All Superinterfaces:

PrecheckTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

PrecheckStub

public interface Precheck
extends com.vmware.vapi.bindings.Service, PrecheckTypes

Field Summary

Fields inherited from interface com.vmware.nsx.nvds_urt.PrecheckTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
NvdsUpgradePrecheckId	create(java.lang.Boolean tolerateDifferentConfigurations) Deprecated.
void	create(java.lang.Boolean tolerateDifferentConfigurations, com.vmware.vapi.bindings.client.AsyncCallback<NvdsUpgradePrecheckId> asyncCallback) Deprecated.
void	create(java.lang.Boolean tolerateDifferentConfigurations, com.vmware.vapi.bindings.client.AsyncCallback<NvdsUpgradePrecheckId> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
NvdsUpgradePrecheckId	create(java.lang.Boolean tolerateDifferentConfigurations, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
NvdsUpgradePrecheckId	get() Deprecated.
void	get(com.vmware.vapi.bindings.client.AsyncCallback<NvdsUpgradePrecheckId> asyncCallback) Deprecated.
void	get(com.vmware.vapi.bindings.client.AsyncCallback<NvdsUpgradePrecheckId> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
NvdsUpgradePrecheckId	get(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.

Method Detail

create

@Deprecated
NvdsUpgradePrecheckId create(java.lang.Boolean tolerateDifferentConfigurations)

Deprecated.

Precheck is peformed at a global level across all NVDSes present in the system. It is expected to check the status once the precheck API is invoked via GetNvdsUpgradeReadinessCheckSummary API. If NVDS configuration like HostSwitchProfiles differs across TransportNodes, precheck will fail and status will be FAILED and error will be reported via the status API. Once the reported errors are fixed, precheck API is expected to be invoked again to rerun precheck. Once NVDS configuration is consistent across all TransportNodes, precheck will pass and a topology will be generated and status will be PENDING_TOPOLOGY. Generated toplogy can be retrieved via GetRecommendedVdsTopology API. User can apply the recommended topology via SetTargetVdsTopology API.

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

Parameters:

tolerateDifferentConfigurations - tolerate differnet configurations (optional, default to true)

Returns:

com.vmware.nsx.model.NvdsUpgradePrecheckId

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

create

@Deprecated
NvdsUpgradePrecheckId create(java.lang.Boolean tolerateDifferentConfigurations,
                                         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Precheck is peformed at a global level across all NVDSes present in the system. It is expected to check the status once the precheck API is invoked via GetNvdsUpgradeReadinessCheckSummary API. If NVDS configuration like HostSwitchProfiles differs across TransportNodes, precheck will fail and status will be FAILED and error will be reported via the status API. Once the reported errors are fixed, precheck API is expected to be invoked again to rerun precheck. Once NVDS configuration is consistent across all TransportNodes, precheck will pass and a topology will be generated and status will be PENDING_TOPOLOGY. Generated toplogy can be retrieved via GetRecommendedVdsTopology API. User can apply the recommended topology via SetTargetVdsTopology API.

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:

tolerateDifferentConfigurations - tolerate differnet configurations (optional, default to true)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NvdsUpgradePrecheckId

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

create

@Deprecated
void create(java.lang.Boolean tolerateDifferentConfigurations,
                        com.vmware.vapi.bindings.client.AsyncCallback<NvdsUpgradePrecheckId> asyncCallback)

Deprecated.

Precheck is peformed at a global level across all NVDSes present in the system. It is expected to check the status once the precheck API is invoked via GetNvdsUpgradeReadinessCheckSummary API. If NVDS configuration like HostSwitchProfiles differs across TransportNodes, precheck will fail and status will be FAILED and error will be reported via the status API. Once the reported errors are fixed, precheck API is expected to be invoked again to rerun precheck. Once NVDS configuration is consistent across all TransportNodes, precheck will pass and a topology will be generated and status will be PENDING_TOPOLOGY. Generated toplogy can be retrieved via GetRecommendedVdsTopology API. User can apply the recommended topology via SetTargetVdsTopology API.

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

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

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

Parameters:

tolerateDifferentConfigurations - tolerate differnet configurations (optional, default to true)

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

create

@Deprecated
void create(java.lang.Boolean tolerateDifferentConfigurations,
                        com.vmware.vapi.bindings.client.AsyncCallback<NvdsUpgradePrecheckId> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Precheck is peformed at a global level across all NVDSes present in the system. It is expected to check the status once the precheck API is invoked via GetNvdsUpgradeReadinessCheckSummary API. If NVDS configuration like HostSwitchProfiles differs across TransportNodes, precheck will fail and status will be FAILED and error will be reported via the status API. Once the reported errors are fixed, precheck API is expected to be invoked again to rerun precheck. Once NVDS configuration is consistent across all TransportNodes, precheck will pass and a topology will be generated and status will be PENDING_TOPOLOGY. Generated toplogy can be retrieved via GetRecommendedVdsTopology API. User can apply the recommended topology via SetTargetVdsTopology API.

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

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

Parameters:

tolerateDifferentConfigurations - tolerate differnet configurations (optional, default to true)

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

invocationConfig - Configuration for the method invocation.

get

@Deprecated
NvdsUpgradePrecheckId get()

Deprecated.

Retrieve latest precheck ID of the N-VDS to VDS migration

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

Returns:

com.vmware.nsx.model.NvdsUpgradePrecheckId

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

@Deprecated
NvdsUpgradePrecheckId get(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Retrieve latest precheck ID of the N-VDS to VDS migration

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

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

@Deprecated
void get(com.vmware.vapi.bindings.client.AsyncCallback<NvdsUpgradePrecheckId> asyncCallback)

Deprecated.

Retrieve latest precheck ID of the N-VDS to VDS migration

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

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

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

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

Deprecated.

Retrieve latest precheck ID of the N-VDS to VDS migration

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

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.