vmware::vcenter::namespace_management::SupportBundleStub Class Reference

Remote stub implementation of the SupportBundle API service. More...

Inherits vmware::vcenter::namespace_management::SupportBundle.

List of all members.

Public Member Functions
	SupportBundleStub (vmware.vapi.core.IApiProvider iApiProvider, vmware.vapi.bindings.TypeConverter typeConverter, vmware.vapi.bindings.IStubConfiguration config)
	SupportBundleStub (vmware.vapi.core.IApiProvider iApiProvider, vmware.vapi.bindings.IStubConfiguration config)
vmware.vcenter.namespace_management.SupportBundleTypes.Location	Create (string cluster)
	Returns the location SupportBundle.Location information for downloading the Namespaces-related support bundle for the specified cluster.
vmware.vcenter.namespace_management.SupportBundleTypes.Location	Create (string cluster, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns the location SupportBundle.Location information for downloading the Namespaces-related support bundle for the specified cluster.
global::System.Threading.Tasks.Task < vmware.vcenter.namespace_management.SupportBundleTypes.Location >	CreateAsync (string cluster)
	Returns the location SupportBundle.Location information for downloading the Namespaces-related support bundle for the specified cluster.
global::System.Threading.Tasks.Task < vmware.vcenter.namespace_management.SupportBundleTypes.Location >	CreateAsync (string cluster, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns the location SupportBundle.Location information for downloading the Namespaces-related support bundle for the specified cluster.

---

Detailed Description

Remote stub implementation of the SupportBundle API service.

---

Constructor & Destructor Documentation

vmware::vcenter::namespace_management::SupportBundleStub::SupportBundleStub	(	vmware.vapi.core.IApiProvider	iApiProvider,
		vmware.vapi.bindings.TypeConverter	typeConverter,
		vmware.vapi.bindings.IStubConfiguration	config
	)		[inline]

vmware::vcenter::namespace_management::SupportBundleStub::SupportBundleStub	(	vmware.vapi.core.IApiProvider	iApiProvider,
		vmware.vapi.bindings.IStubConfiguration	config
	)		[inline]

---

Member Function Documentation

vmware.vcenter.namespace_management.SupportBundleTypes.Location vmware::vcenter::namespace_management::SupportBundleStub::Create

(

string

cluster

)

[inline]

Returns the location SupportBundle.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 SupportBundle.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.

Exceptions:

vmware.vapi.std.errors.NotFound	if the specified cluster is not registered on this vCenter server.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.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 .

Returns:

the download location of the support bundle for the cluster.

Implements vmware::vcenter::namespace_management::SupportBundle.

vmware.vcenter.namespace_management.SupportBundleTypes.Location vmware::vcenter::namespace_management::SupportBundleStub::Create	(	string	cluster,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Returns the location SupportBundle.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 SupportBundle.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.

Exceptions:

vmware.vapi.std.errors.NotFound	if the specified cluster is not registered on this vCenter server.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.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 .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

the download location of the support bundle for the cluster.

Implements vmware::vcenter::namespace_management::SupportBundle.

global::System.Threading.Tasks.Task<vmware.vcenter.namespace_management.SupportBundleTypes.Location> vmware::vcenter::namespace_management::SupportBundleStub::CreateAsync

(

string

cluster

)

[inline]

Returns the location SupportBundle.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 SupportBundle.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.

Exceptions:

vmware.vapi.std.errors.NotFound	if the specified cluster is not registered on this vCenter server.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.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 .

Returns:

the download location of the support bundle for the cluster.

Implements vmware::vcenter::namespace_management::SupportBundle.

global::System.Threading.Tasks.Task<vmware.vcenter.namespace_management.SupportBundleTypes.Location> vmware::vcenter::namespace_management::SupportBundleStub::CreateAsync	(	string	cluster,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Returns the location SupportBundle.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 SupportBundle.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.

Exceptions:

vmware.vapi.std.errors.NotFound	if the specified cluster is not registered on this vCenter server.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.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 .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

the download location of the support bundle for the cluster.

Implements vmware::vcenter::namespace_management::SupportBundle.

---

The documentation for this class was generated from the following file:

• SupportBundleStub.cs