CreateSupportBundle

You can use the CreateSupportBundle to create a support bundle file under the node's directory. After creation, the bundle is stored on the node as a tar.gz file.

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 This parameter is passed to the sf_make_support_bundle script. This parameter should be used only at the request of NetApp Support. 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 CreateSupportBundle API 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": {} 
 },
"id": 1
}

Response example

This method returns a response similar to the following example:

{
"id": 1,
"result": {
  "details": {
    "bundleName": "supportbundle",  
    "extraArgs": "",
    "files": [
         "supportbundle.SF-D220.tar.gz"
     ],
     "output": "timeout -s KILL 1500s /sf/scripts/sf_make_support_bundle --quiet /tmp/solidfire- dtemp.bYRag7/supportbundle timeout -s KILL 1500s pigz --verbose --fast \"/tmp/solidfire-dtemp.bYRag7/supportbundle.*.tar\" /tmp/solidfire-dtemp.bYRag7/supportbundle.SF-D220.tar to /tmp/solidfire-dtemp.bYRag7/supportbundle.SF-D220.tar.gz Moved '/tmp/solidfire-dtemp.bYRag7/supportbundle.SF-D220.tar.gz' to /tmp/supportbundles",
      "timeoutSec": 1500,
      "url": [
          "https://192.168.130.155:442/config/supportbundles/supportbundle.SF-D220.tar.gz"
      ]
    },
    "duration": "00:00:21.166692",
    "result": "Passed"
  }
}