com.vmware.vcenter.namespace_management

Interface SupportBundle

All Superinterfaces:

Service, SupportBundleTypes

All Known Implementing Classes:

SupportBundleStub

public interface SupportBundle
extends Service, SupportBundleTypes

The SupportBundle interface provides methods to retrieve the cluster's Namespaces-related support bundle download location.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.namespace_management.SupportBundleTypes

SupportBundleTypes.Location, SupportBundleTypes.Token

Field Summary

Fields inherited from interface com.vmware.vcenter.namespace_management.SupportBundleTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
SupportBundleTypes.Location	create(java.lang.String cluster) Returns the location SupportBundleTypes.Location information for downloading the Namespaces-related support bundle for the specified cluster.
void	create(java.lang.String cluster, AsyncCallback<SupportBundleTypes.Location> asyncCallback) Returns the location SupportBundleTypes.Location information for downloading the Namespaces-related support bundle for the specified cluster.
void	create(java.lang.String cluster, AsyncCallback<SupportBundleTypes.Location> asyncCallback, InvocationConfig invocationConfig) Returns the location SupportBundleTypes.Location information for downloading the Namespaces-related support bundle for the specified cluster.
SupportBundleTypes.Location	create(java.lang.String cluster, InvocationConfig invocationConfig) Returns the location SupportBundleTypes.Location information for downloading the Namespaces-related support bundle for the specified cluster.

Method Detail

create

SupportBundleTypes.Location create(java.lang.String cluster)

Returns the location SupportBundleTypes.Location information for downloading the Namespaces-related support bundle for the specified cluster.

Retrieving a support bundle involves two steps:

• Step 1: Invoke method to provision a token and a URI.
• Step 2: Make an HTTP GET request using URI and one time used token returned in step 1 to generate the support bundle and return it.

There can only be one valid token per cluster at any given time. If this method is invoked again for the same cluster identifier while a token still valid, the API will return the same SupportBundleTypes.Location response.

The HTTP GET request will:

• return 401 (Not Authorized) if the download URL is recognized, but the token is invalid.
• otherwise return 200 (OK), mark the token used (invalidating it for any future use), open a application/tar download stream for the client, and start the bundle process. As part of its work, the API will orchestrate support bundling on the worker nodes of a cluster. If a failure occurs during the collection of support bundle from worker node, the API will not abort the request, but will log a warning and move on to processing other worker nodes' bundles. The API will only abort its operation if the content of the stream has been corrupted. When the API has to abort its operation (and the response stream), it will not provide any indication of failures to the client. The client will need to verify validity of the resultant file based on the format specified in the response's Content-Disposition header.

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

Parameters:

cluster - Identifier of cluster for which the Namespaces-related support bundle should be generated. The parameter must be an identifier for the resource type: ClusterComputeResource.

Returns:

the download location of the support bundle for the cluster.

Throws:

NotFound - if the specified cluster is not registered on this vCenter server.

Error - if the system reports an error while responding to the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have System.Read privilege.

create

SupportBundleTypes.Location create(java.lang.String cluster,
                                   InvocationConfig invocationConfig)

Returns the location SupportBundleTypes.Location information for downloading the Namespaces-related support bundle for the specified cluster.

Retrieving a support bundle involves two steps:

• Step 1: Invoke method to provision a token and a URI.
• Step 2: Make an HTTP GET request using URI and one time used token returned in step 1 to generate the support bundle and return it.

There can only be one valid token per cluster at any given time. If this method is invoked again for the same cluster identifier while a token still valid, the API will return the same SupportBundleTypes.Location response.

The HTTP GET request will:

• return 401 (Not Authorized) if the download URL is recognized, but the token is invalid.
• otherwise return 200 (OK), mark the token used (invalidating it for any future use), open a application/tar download stream for the client, and start the bundle process. As part of its work, the API will orchestrate support bundling on the worker nodes of a cluster. If a failure occurs during the collection of support bundle from worker node, the API will not abort the request, but will log a warning and move on to processing other worker nodes' bundles. The API will only abort its operation if the content of the stream has been corrupted. When the API has to abort its operation (and the response stream), it will not provide any indication of failures to the client. The client will need to verify validity of the resultant file based on the format specified in the response's Content-Disposition header.

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:

cluster - Identifier of cluster for which the Namespaces-related support bundle should be generated. The parameter must be an identifier for the resource type: ClusterComputeResource.

invocationConfig - Configuration for the method invocation.

Returns:

the download location of the support bundle for the cluster.

Throws:

NotFound - if the specified cluster is not registered on this vCenter server.

Error - if the system reports an error while responding to the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have System.Read privilege.

create

void create(java.lang.String cluster,
            AsyncCallback<SupportBundleTypes.Location> asyncCallback)

Returns the location SupportBundleTypes.Location information for downloading the Namespaces-related support bundle for the specified cluster.

Retrieving a support bundle involves two steps:

• Step 1: Invoke method to provision a token and a URI.
• Step 2: Make an HTTP GET request using URI and one time used token returned in step 1 to generate the support bundle and return it.

There can only be one valid token per cluster at any given time. If this method is invoked again for the same cluster identifier while a token still valid, the API will return the same SupportBundleTypes.Location response.

The HTTP GET request will:

• return 401 (Not Authorized) if the download URL is recognized, but the token is invalid.
• otherwise return 200 (OK), mark the token used (invalidating it for any future use), open a application/tar download stream for the client, and start the bundle process. As part of its work, the API will orchestrate support bundling on the worker nodes of a cluster. If a failure occurs during the collection of support bundle from worker node, the API will not abort the request, but will log a warning and move on to processing other worker nodes' bundles. The API will only abort its operation if the content of the stream has been corrupted. When the API has to abort its operation (and the response stream), it will not provide any indication of failures to the client. The client will need to verify validity of the resultant file based on the format specified in the response's Content-Disposition header.

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

Invocation Result:
the download location of the support bundle for the cluster.

Operation Errors:
NotFound - if the specified cluster is not registered on this vCenter server.
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have System.Read privilege.

Parameters:

cluster - Identifier of cluster for which the Namespaces-related support bundle should be generated. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

create

void create(java.lang.String cluster,
            AsyncCallback<SupportBundleTypes.Location> asyncCallback,
            InvocationConfig invocationConfig)

Returns the location SupportBundleTypes.Location information for downloading the Namespaces-related support bundle for the specified cluster.

Retrieving a support bundle involves two steps:

• Step 1: Invoke method to provision a token and a URI.
• Step 2: Make an HTTP GET request using URI and one time used token returned in step 1 to generate the support bundle and return it.

There can only be one valid token per cluster at any given time. If this method is invoked again for the same cluster identifier while a token still valid, the API will return the same SupportBundleTypes.Location response.

The HTTP GET request will:

• return 401 (Not Authorized) if the download URL is recognized, but the token is invalid.
• otherwise return 200 (OK), mark the token used (invalidating it for any future use), open a application/tar download stream for the client, and start the bundle process. As part of its work, the API will orchestrate support bundling on the worker nodes of a cluster. If a failure occurs during the collection of support bundle from worker node, the API will not abort the request, but will log a warning and move on to processing other worker nodes' bundles. The API will only abort its operation if the content of the stream has been corrupted. When the API has to abort its operation (and the response stream), it will not provide any indication of failures to the client. The client will need to verify validity of the resultant file based on the format specified in the response's Content-Disposition header.

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:
the download location of the support bundle for the cluster.

Operation Errors:
NotFound - if the specified cluster is not registered on this vCenter server.
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have System.Read privilege.

Parameters:

cluster - Identifier of cluster for which the Namespaces-related support bundle should be generated. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

invocationConfig - Configuration for the method invocation.