CreateSupportBundle

Contributors netapp-mwallis netapp-dbagwell ntap-bmegan Download PDF of this page

You can use CreateSupportBundle to create a support bundle file under the node’s directory. After creation, the bundle is stored on the node as a tar file (gz compression option is available via the extraArgs parameter.)

Parameters

This method has the following input parameters:

Name Description Type Default value Required

bundleName

Unique name for the support bundle. If no name is provided, then "supportbundle" and the node name are used as the file name.

string

None

No

extraArgs

Use '--compress gz' to create the support bundle as a tar.gz file.

string

None

No

timeoutSec

The number of seconds the support bundle script runs.

integer

1500

No

Return values

This method has the following return values:

Name

Description

Type

details

The details of the support bundle. Possible values:

  • bundleName: The name specified in the CreateSupportBundleAPI method. If no name was specified, "supportbundle" is used.

  • extraArgs: The arguments passed with this method.

  • files: A list of the support bundle files that the system created.

  • output: The command line output from the script that created the support bundle.

  • timeoutSec: The number of seconds the support bundle script runs before stopping.

  • url: URL to the support bundle created.

JSON object

duration

The time used to create the support bundle in the format: HH:MM:SS.ssssss.

string

result

The success or failure of the support bundle operation.

string

Request example

Requests for this method are similar to the following example:

{
 "method": "CreateSupportBundle",
"params": {
  "extraArgs": "--compress gz"
 },
"id": 1
}

Response example

This method returns a response similar to the following example:

{
"id": 1,
"result": {
  "details": {
    "bundleName": "supportbundle",
    "extraArgs": "--compress gz",
    "files": [
         "supportbundle.nodehostname.tar.gz"
     ],
     "output": "timeout -s KILL 1500s /sf/scripts/sfsupportbundle --quiet --compress gz /tmp/solidfire-dtemp.1L6bdX/supportbundle<br><br>Moved '/tmp/solidfire-dtemp.1L6bdX/supportbundle.nodehostname.tar.gz' to /tmp/supportbundles",
      "timeoutSec": 1500,
      "url": [
          "https://nodeIP:442/config/supportbundles/supportbundle.nodehostname.tar.gz"
      ]
    },
    "duration": "00:00:43.101627",
    "result": "Passed"
  }
}

New since version

9.6