Collect Support Bundles Collect

Collect support bundles from registered cluster and fabric nodes.

Request

URI

POST

https://nsxmanager.your.domain/api/v1/administration/support-bundles?action=collect

COPY

Query Parameters

boolean

override_async_response

Optional

Constraints: default: false

Override any existing support bundle async response

boolean

require_delete_or_override_async_response

Optional

Constraints: default: false

Suppress auto-deletion of generated support bundle

Request Body

SupportBundleRequest of type(s) application/json

Required

{
    "container_nodes": [
        {
            "container_type": "string"
        }
    ],
    "content_filters": [
        "string"
    ],
    "dynamic_content_filters": [
        "string"
    ],
    "log_age_limit": 0,
    "nodes": [
        "string"
    ],
    "remote_file_server": {
        "directory_path": "string",
        "manager_upload_only": false,
        "port": 0,
        "protocol": {
            "authentication_scheme": {
                "password": "string",
                "scheme_name": "string",
                "username": "string"
            },
            "name": "string",
            "ssh_fingerprint": "string"
        },
        "server": "string"
    }
}

array of object

container_nodes

Optional

Constraints: minItems: 1

List of container clusters and their nodes requiring support bundle collection

array of string

content_filters

Optional

Constraints: minItems: 1 default: DEFAULT

List of content filters that specify additional content or action when collecting support bundle.

Filter ALL includes core dumps and audit logs in support bundle
Filter REMOVE_CORE_FILES can optionally be in list with ALL, to remove core dump files after collected in support bundle
Filter EAL4_AUDIT can optionally be in list to collect pre-defined selective log files. The selected log files are deleted from the support bundle if the files have not been modified in the last 4 hours.

By default no core dumps and audit logs are included in support bundle with filter DEFAULT.

No other content-filters can be added along with EAL4_AUDIT content-filter

When content-filter EAL4_AUDIT is added, the log_age_limit field is disabled.

Note, REMOVE_CORE_FILES is limited to NSX appliance and ESXi nodes only.

Possible values are : ALL, DEFAULT, REMOVE_CORE_FILES, EAL4_AUDIT,

array of string

dynamic_content_filters

Optional

Constraints: default: ALL

List of dynamic content filters that specify additional content to include in the support bundle. The list of available filters available depends on your NSX-T deployment and can be determined by invoking the GET /api/v1/adminstration/support-bundles/dynamic-content-filters NSX API. For example, if NSX Intelligence is deployed, filters for collecting specific information about services are available.

integer As int64 As int64

log_age_limit

Optional

Constraints: minimum: 1 maximum: 365

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

array of string

nodes

Optional

Constraints: minItems: 1

List of cluster/fabric node UUIDs processed in specified order

object

remote_file_server

Optional

Remote file server

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns SupportBundleResult of type(s) application/json

"SupportBundleResult Object"

array of object

failed_nodes

Optional

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

array of object

remaining_nodes

Optional

Nodes where bundle generation is pending or in progress

object

request_properties

Optional

request_properties

array of object

success_nodes

Optional

Nodes whose bundles were successfully copied to remote file server

400

Returns BadRequest of type(s) application/json