supportbundle create

--prefix PREFIX

Enter an identifying label to include in the bundle file name.

The prefix can contain up to 64 characters. Special characters are not allowed (except _ and -). The first character must be a letter or digit.

The name of the bundle will be bundle-<preset>-<cluster name>-<prefix>-<timestamp>.tar, where <prefix> is the prefix specified here. If the bundle is obfuscated (--obfuscate option, below), <cluster-name> is omitted.

For example, if the prefix is MyUrgentIssue, a bundle using the mini preset created at exactly 7:45 am UTC on September 3rd, 2020 on a cluster called cluster1 would be named bundle-mini-cluster1-MyUrgentIssue-2020-09-03-074500.tar.

--preset PRESET

Specify a category (or categories) that best suits the issue for which you are creating the support bundle.

Each category includes a predefined set of data objects in the support bundle. Verify with your support engineer which category is suitable for your needs.

If no categories are specified, only management logs are collected.

Specify one or more of the following categories as PRESET:

--start-time TIME

Sets the start time from which to collect information.

Specify TIME in UTC+0 in the format YYYY-MM-DD hh:mm:ss.

--end-time TIME

Sets the end time for the period to collect information.

Specify TIME in UTC+0 in the format YYYY-MM-DD hh:mm:ss.

It's usually advisable to consult with the support engineer on the time frame so that you can make it as short as possible and minimize the size of the bundle.

--obfuscated

Converts all bundled objects to text and obfuscates them. Any data that cannot be converted to text is not included in the bundle. The following types of information are replaced with a non-reversible hash: file and directory names, IP addresses, host names, user names, passwords, MAC addresses.

If this option is not specified (default), the information is not obfuscated.

--cnodes-only

Specify this option to collect data from CNodes only. This blocks DNode options.

--dnodes-only

Specify this option to collect data from DNodes only. This blocks CNode options.

--cnode-ids CNODE_IDs

Specify a comma-separated list of CNode IDs to collect data from.

By default, all CNodes are included.

This option cannot be used together with --dnodes-only.

Note

If you specified the metadata preset, you can specify only one CNode.

--dnode-ids DNODE_IDs

Specify a comma-separated list of DNode IDs to collect data from.

By default, all DNodes are included.

This option cannot be used together with --cnodes-only.

--cnode-names CNODE_NAMEs

Specify a comma-separated list of CNode names to collect data from.

--dnode-names DNODE_NAMEs

Specify a comma-separated list of DNode names to collect data from.

--dbox-ids DBOX_IDs

Specify a comma-separated list of DBox IDs to collect data from.

--dbox-names DBOX_NAMEs

Specify a comma-separated list of DBox names to collect data from.

--dtray-ids DTRAY_IDs

Specify a comma-separated list of DTray IDs to collect data from.

--dtray-names DTRAY_NAMEs

Specify a comma-separated list of DTray names to collect data from.

--all-cnodes

Specify this option to collect data from all CNodes.

--all-dnodes

Specify this option to collect data from all DNodes.

--vippool-ids POOL_IDs

Specify a comma-separated list of virtual IP pools to collect data only from CNodes that are included in these virtual IP pools.

--vip-ids VIP_IDs

Collect support bundle from CNodes hosting specified VIPs. Specify VIPs as a comma separated list of VIP IDs. Includes historical CNodes that hosted these VIPs during the time range.

--hubble-args ARGs

Enter any arguments to pass to Hubble, per instructions from the support engineer.

--astron-args ARGs

Enter any arguments to pass to Astron, per instructions from the support engineer.

--luna-args ARGs

Specify internal arguments for the luna analyzing tool tool mapping to performance dashboards or specific component failures.

--max-size SIZE

Enter a maximum data limit to apply to the collection of binary trace files, in GB.

--text

Converts all bundled objects to a text format. Any data that cannot be converted to text is not included in the bundle.

This setting is enabled automatically if --obfuscated is specified.

--send-now

Sends the support bundle immediately after it is created.

--upload-via-vms

Uploads a support bundle via VMS. Otherwise, the upload is done from each node.

This option is available only if --send-now is specified.

--bucket-name NAME

Specifies the S3 bucket name of the destination S3 bucket.

--access-key KEY

Specifies the access key of a valid key pair to access the destination S3 bucket.

--secret-key KEY

Specifies the secret key of a valid key pair to access the destination S3 bucket.

--bucket-subdir DIR

Specifies the subdirectory in the destination S3 bucket to which to upload the support bundle.

--delete-after-send

Deletes the support bundle immediately after it has been sent successfully.

--split-time SECONDS

Time interval in seconds for splitting large bundles when uploading. Used with --send-now and --delete-after-send to create multiple smaller bundles instead of one large bundle. Maximum: 1800s.