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

Post Support Bundle Collection

Description

Start a support-bundle collection operation for the chosen services.

Request

Request

URL

URL


post
https://{api_host}/napp/api/v1/platform/support-bundle/collection
Copy

Query Parameters

Query Parameters

string
action Required

Could be one of “collect” or “delete_async_response”

Parameter Serialization Style: form Explode:true

Request Body

Request Body

SupportBundleRequest of mimetype application/json Required

JSON object containing parameters for the support bundle collection.

{
	"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"
	}
}
array of string
content_filters Optional

Bundle should include content of specified type.


array of string
dynamic_content_filters Optional

Bundle should include content of specified type.


integer
log_age_limit Optional

Include log files with modified times not past the age limit in days


remote_file_server Optional

The file server the support bundle should be exported to.

Authentication

Authentication

This operation uses the following authentication methods.

x_nsx_roles

Scopes: enterprise_admin

Response

Response

Response Body

Response Body

200 OK returns SupportBundleResult of type application/json
{
	"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"
		}
	],
	"remoteTaskID": "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",
	"success_nodes": [
		{
			"bundle_name": "string",
			"bundle_size": 0,
			"node_display_name": "string",
			"node_id": "string",
			"sha256_thumbprint": "string"
		}
	]
}
failed_nodes Required

Nodes where bundles were not generated or not copied to remote server


remaining_nodes Required

Nodes whose bundle generation is in progress


string
remoteTaskID Required

remoteTaskID by which manager node will check on support bundle collection status


request_properties Required

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


string
status Required

Node will start with running

Possible values are: runningsuccesscancellingcancelled


success_nodes Required

Nodes whose bundles were successfully copied to remote file server

Response Headers
string
Vmw-Task-Id

string representing the task id

Errors

Errors

409

Conflict - collection in progress

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"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"}}' https://{api_host}/napp/api/v1/platform/support-bundle/collection?action=string


Feedback

Was this page helpful?