com.vmware.nsx_global_policy.global_infra.sites

Interface Onboarding

All Superinterfaces:

OnboardingTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

OnboardingStub

public interface Onboarding
extends com.vmware.vapi.bindings.Service, OnboardingTypes

Field Summary

Fields inherited from interface com.vmware.nsx_global_policy.global_infra.sites.OnboardingTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
ConfigOnboardingConflictStatus	checkconflict(java.lang.String siteId, ConfigOnboardingConflictRequest configOnboardingConflictRequest) Verifies and reports conflicting onboarding feature for a site.
void	checkconflict(java.lang.String siteId, ConfigOnboardingConflictRequest configOnboardingConflictRequest, com.vmware.vapi.bindings.client.AsyncCallback<ConfigOnboardingConflictStatus> asyncCallback) Verifies and reports conflicting onboarding feature for a site.
void	checkconflict(java.lang.String siteId, ConfigOnboardingConflictRequest configOnboardingConflictRequest, com.vmware.vapi.bindings.client.AsyncCallback<ConfigOnboardingConflictStatus> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Verifies and reports conflicting onboarding feature for a site.
ConfigOnboardingConflictStatus	checkconflict(java.lang.String siteId, ConfigOnboardingConflictRequest configOnboardingConflictRequest, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Verifies and reports conflicting onboarding feature for a site.
ConfigOnboardingStatus	startonboarding(java.lang.String siteId, ConfigOnboardingRequest configOnboardingRequest) Initiate config on-boarding of a Site.
void	startonboarding(java.lang.String siteId, ConfigOnboardingRequest configOnboardingRequest, com.vmware.vapi.bindings.client.AsyncCallback<ConfigOnboardingStatus> asyncCallback) Initiate config on-boarding of a Site.
void	startonboarding(java.lang.String siteId, ConfigOnboardingRequest configOnboardingRequest, com.vmware.vapi.bindings.client.AsyncCallback<ConfigOnboardingStatus> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Initiate config on-boarding of a Site.
ConfigOnboardingStatus	startonboarding(java.lang.String siteId, ConfigOnboardingRequest configOnboardingRequest, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Initiate config on-boarding of a Site.

Method Detail

checkconflict

ConfigOnboardingConflictStatus checkconflict(java.lang.String siteId,
                                             ConfigOnboardingConflictRequest configOnboardingConflictRequest)

Verifies and reports conflicting onboarding feature for a site. The response will contain first conflicting feature for the site configuration compared to corresponding global manager configuration.

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

Parameters:

siteId - (required)

configOnboardingConflictRequest - (required)

Returns:

com.vmware.nsx_global_policy.model.ConfigOnboardingConflictStatus

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

checkconflict

ConfigOnboardingConflictStatus checkconflict(java.lang.String siteId,
                                             ConfigOnboardingConflictRequest configOnboardingConflictRequest,
                                             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Verifies and reports conflicting onboarding feature for a site. The response will contain first conflicting feature for the site configuration compared to corresponding global manager configuration.

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:

siteId - (required)

configOnboardingConflictRequest - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_global_policy.model.ConfigOnboardingConflictStatus

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

checkconflict

void checkconflict(java.lang.String siteId,
                   ConfigOnboardingConflictRequest configOnboardingConflictRequest,
                   com.vmware.vapi.bindings.client.AsyncCallback<ConfigOnboardingConflictStatus> asyncCallback)

Verifies and reports conflicting onboarding feature for a site. The response will contain first conflicting feature for the site configuration compared to corresponding global manager configuration.

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

Invocation Result:
com.vmware.nsx_global_policy.model.ConfigOnboardingConflictStatus

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

Parameters:

siteId - (required)

configOnboardingConflictRequest - (required)

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

checkconflict

void checkconflict(java.lang.String siteId,
                   ConfigOnboardingConflictRequest configOnboardingConflictRequest,
                   com.vmware.vapi.bindings.client.AsyncCallback<ConfigOnboardingConflictStatus> asyncCallback,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Verifies and reports conflicting onboarding feature for a site. The response will contain first conflicting feature for the site configuration compared to corresponding global manager configuration.

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_global_policy.model.ConfigOnboardingConflictStatus

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

Parameters:

siteId - (required)

configOnboardingConflictRequest - (required)

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

invocationConfig - Configuration for the method invocation.

startonboarding

ConfigOnboardingStatus startonboarding(java.lang.String siteId,
                                       ConfigOnboardingRequest configOnboardingRequest)

Initiate config on-boarding of a Site. The entire on-boarding is async workflow controlled by API.

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

Parameters:

siteId - (required)

configOnboardingRequest - (required)

Returns:

com.vmware.nsx_global_policy.model.ConfigOnboardingStatus

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

startonboarding

ConfigOnboardingStatus startonboarding(java.lang.String siteId,
                                       ConfigOnboardingRequest configOnboardingRequest,
                                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Initiate config on-boarding of a Site. The entire on-boarding is async workflow controlled by 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:

siteId - (required)

configOnboardingRequest - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_global_policy.model.ConfigOnboardingStatus

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

startonboarding

void startonboarding(java.lang.String siteId,
                     ConfigOnboardingRequest configOnboardingRequest,
                     com.vmware.vapi.bindings.client.AsyncCallback<ConfigOnboardingStatus> asyncCallback)

Initiate config on-boarding of a Site. The entire on-boarding is async workflow controlled by API.

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

Invocation Result:
com.vmware.nsx_global_policy.model.ConfigOnboardingStatus

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

Parameters:

siteId - (required)

configOnboardingRequest - (required)

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

startonboarding

void startonboarding(java.lang.String siteId,
                     ConfigOnboardingRequest configOnboardingRequest,
                     com.vmware.vapi.bindings.client.AsyncCallback<ConfigOnboardingStatus> asyncCallback,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Initiate config on-boarding of a Site. The entire on-boarding is async workflow controlled by 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_global_policy.model.ConfigOnboardingStatus

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

Parameters:

siteId - (required)

configOnboardingRequest - (required)

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

invocationConfig - Configuration for the method invocation.