Get Support Bundle Status
Returns the current status of a support-bundle collection operation (Running/Success/Cancelling/Cancelled).
Request
URI
GET
https://{api_host}/napp/api/v1/platform/support-bundle/status/{task_id}
COPY
Path Parameters
string
task_id
Required
task id returned in /support-bundle/collection
Responses
200
OK
Returns SupportBundleStatus of type(s) application/json
{
"request_properties": {
"remote_file_server": {
"directory_path": "/home/support_bundles",
"port": 22,
"protocol": {
"name": "SCP",
"ssh_fingerprint": "00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff",
"authentication_scheme": {
"username": "admin",
"password": "somePassword123",
"scheme_name": "PASSWORD"
}
},
"server": "ftp.vmware.com"
},
"dynamic_content_filters": [
"NAPP:SERVICE:MESSAGING"
],
"content_filters": [
"DEFAULT"
],
"log_age_limit": 0
},
"status": "string",
"details": {
"failed_nodes": [
{
"node_display_name": "string",
"node_id": "string",
"error_message": "string",
"error_code": "string"
}
],
"success_nodes": [
{
"node_display_name": "string",
"node_id": "string",
"sha256_thumbprint": "string",
"bundle_name": "string",
"bundle_size": 0
}
],
"remaining_nodes": [
{
"node_display_name": "string",
"node_id": "string",
"status": "string"
}
]
}
}
request_properties
Required
Object representing support bundle collection request.
string
status
Required
The current status of the support bundle task.
Possible values are : running, success, cancelling, cancelled,
details
Required
Contains details of successful, failed and remaining nodes
Response Headers
string
Vmw-Task-Id
string representing the task id
404
The task id is not found
Operation doesn't return any data structure
Deprecated
Availability
Deprecated in 4.2
Clusterapi Operations
GET
Get External Syslog Server
Deprecated
GET
Get Support Bundle Dynamic Content Filters
Deprecated
GET
Get Support Bundle Status
Deprecated
POST
Post External Syslog Server
Deprecated
POST
Post Support Bundle Collection
Deprecated