NSX-T Data Center REST API

SupportBundleRequest (schema)

Name Description Type Notes
container_nodes List of container clusters and their nodes requiring support bundle collection array of SupportBundleContainerNode
(Abstract type: pass one of the following concrete types)
AntreaSupportBundleContainerNode
Minimum items: 1
content_filters Bundle should include content of specified type

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.

array of ContentFilterValue Minimum items: 1
Default: "['DEFAULT']"
dynamic_content_filters List of content filters that decide the additional content that go into the support bundle

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.
array of DynamicContentFilterValue Default: "['ALL']"
log_age_limit Include log files with modified times not past the age limit in days integer Minimum: 1
Maximum: 365
nodes List of cluster/fabric node UUIDs processed in specified order array of string Minimum items: 1
remote_file_server Remote file server to copy bundles to, bundle in response body if not specified SupportBundleRemoteFileServer