/scalemgmt/v3/config/cluster:batchUpdate: PATCH

Updates the configuration value of an IO daemon.

Availability

Available on all IBM Storage Scale editions.

Description

The PATCH config/cluster:batchUpdate request updates the configuration value of an IO daemon.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v3/config/cluster:batchUpdate

Request headers

Accept: application/json

Parameters

The following parameters can be used in the request URL to customize the request:
Table 1. List of parameters
Parameter name Description and applicable keywords Required/optional
body The body of the request that contains the parameters that are sent to IBM Storage Scale to perform the requested operation. Required.
X-StorageScaleDomain The domain to be authorized against for the request. The default value is StorageScaleDomain. Optional.

Request data

No request data.

Response data

  • 200: A successful response.
    {
  "failed": [
    {
      "config": {
        "name": "string",
        "node_id": "string",
        "node_name": "string",
        "value": "string"
      },
      "error": {
        "details": [
          {
            "@type": "string",
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          }
        ],
        "httpcode": 0,
        "message": "string",
        "status": "CANCELLED"
      }
    }
  ],
  "succeeded": [
    {
      "config": {
        "name": "string",
        "node_id": "string",
        "node_name": "string",
        "value": "string"
      },
      "error": {
        "details": [
          {
            "@type": "string",
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          }
        ],
        "httpcode": 0,
        "message": "string",
        "status": "CANCELLED"
      }
    }
  ]
}
  • default: An unexpected error response.
    {
  "code": 0,
  "details": [
    {
      "@type": "string",
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  ],
  "message": "string"
}

Examples

The following example updates the configuration value of an IO daemon:

Request data: 
curl -k -n -X PATCH 'https://localhost:8001/scalemgmt/v3/config/cluster:batchUpdate'   -H 'Content-Type: application/json'   -H 'X-StorageScaleDomain: StorageScaleDomain'   -d '{
    "attributes": [
      " defaultmountdir=DEFAULT"
    ],
    "immediate": true
  }'
Response data: 
{
	"succeeded": [
		{
			"config": {
				"name": " defaultmountdir",
				"value": "/ gpfs"
			}
		}
	]
}