[{"label":"Latest (v1.0)","version":"latest"}]
nsx-intelligence-and-application-platform

Get Support Bundle Status

Description

Returns the current status of a support-bundle collection operation (Running/Success/Cancelling/Cancelled).

Request

Request

URL

URL


get
https://{api_host}/napp/api/v1/platform/support-bundle/status/{task_id}
Copy

Path Parameters

Path Parameters

string
task_id Required

task id returned in /support-bundle/collection


Authentication

Authentication

This operation uses the following authentication methods.

x_nsx_roles

Scopes: enterprise_admin, auditor

Response

Response

Response Body

Response Body

200 OK returns SupportBundleStatus of type application/json
{
	"details": {
		"failed_nodes": [
			{
				"error_code": "string",
				"error_message": "string",
				"node_display_name": "string",
				"node_id": "string"
			}
		],
		"remaining_nodes": [
			{
				"node_display_name": "string",
				"node_id": "string",
				"status": "PENDING"
			}
		],
		"success_nodes": [
			{
				"bundle_name": "string",
				"bundle_size": 0,
				"node_display_name": "string",
				"node_id": "string",
				"sha256_thumbprint": "string"
			}
		]
	},
	"request_properties": {
		"content_filters": [
			"DEFAULT"
		],
		"dynamic_content_filters": [
			"NAPP:SERVICE:MESSAGING"
		],
		"log_age_limit": 0,
		"remote_file_server": {
			"directory_path": "/home/support_bundles",
			"port": 22,
			"protocol": {
				"authentication_scheme": {
					"password": "somePassword123",
					"scheme_name": "PASSWORD",
					"username": "admin"
				},
				"name": "SCP",
				"ssh_fingerprint": "00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff"
			},
			"server": "ftp.vmware.com"
		}
	},
	"status": "running"
}
details Required

Contains details of successful, failed and remaining nodes


request_properties Required

The support bundle collection request for which the current operation is running.


string
status Required

The current status of the support bundle task.

Possible values are: runningsuccesscancellingcancelled

Response Headers
string
Vmw-Task-Id

string representing the task id

Errors

Errors

404

The task id is not found

Code Samples

Code Samples

cURL Command

curl https://{api_host}/napp/api/v1/platform/support-bundle/status/{task_id}


[{"label":"Latest (v1.0)","version":"latest"}]
nsx-intelligence-and-application-platform
Feedback

Was this page helpful?