Post Support Bundle Collection

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

Request

URI

POST

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

COPY

Query Parameters

string

action

Required

Could be one of "collect" or "delete_async_response"

Request Body

JSON object containing parameters for the support bundle collection.

SupportBundleRequest of type(s) application/json

Required

{
    "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
}

SupportBundleRemoteFileServer

remote_file_server

Optional

The file server the support bundle should be exported to.

array of ContentFilterValue

dynamic_content_filters

Optional

A subset of the array returned in http://{api_host}/napp/api/v1/platform/support-bundle/dynamic-content-filters API.

array of ContentFilterValue

content_filters

Optional

Bundle should include content of specified type. Could be one of ALL or DEFAULT

integer

log_age_limit

Optional

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

Authentication

This operation uses the following authentication methods.

x_nsx_roles

Responses

200

Returns SupportBundleResult of type(s) application/json

{
    "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": {
        "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",
    "remoteTaskID": "string"
}

array of FailedNodeSupportBundleResult

failed_nodes

Required

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

array of SuccessNodeSupportBundleResult

success_nodes

Required

Nodes whose bundles were successfully copied to remote file server

array of RemainingNodeSupportBundleResult

remaining_nodes

Required

Nodes whose bundle generation is in progress