/scalemgmt/v3/{nsd_name}: PATCH

Updates an existing NSD.

Availability

Available on all IBM Storage Scale editions.

Description

The PATCH {nsd_name} request updates an existing NSD. To run this command, you must have the RBAC permission for the patch action on the /scalemgmt/v3/nsds resource.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v3/{nsd_name}

where

{nsd_name}: Specifies the name of the NSD.

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
nsd_name	The name of the NSD.	Required.
nsd	The servers that are assigned to NSD.	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.

{
  "dev_type": "SUBTYPE_DASD_DISK",
  "device_name": "string",
  "disk_subtype": "SUBTYPE_PR_DISK",
  "disk_usage": "DATA_AND_METADATA",
  "domain_id": 0,
  "failure_group": "string",
  "file_system": "string",
  "local_disk_name": "string",
  "name": "string",
  "node_name": "string",
  "nsd_servers": [
    "string"
  ],
  "nsd_version": "string",
  "partition_type": "string",
  "remarks": "string",
  "size": "string",
  "storage_pool": "string",
  "thin_disk": "THIN_DISK_NO",
  "volume_id": "string"
}

default: An unexpected error response.

{
  "code": 0,
  "details": [
    {
      "@type": "string",
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  ],
  "message": "string"
}

Examples

The following example updates the failure group for the nsd_1 NSD:

Request data:

curl  -n -k -X PATCH  https://localhost:46443/scalemgmt/v3/nsds/nsd_1 -H 'accept: application/json'   -H 'Content-Type: application/json' \
 -d ' {
   "failure_group": "1"
 }'

Response data:

{
"name":  "nsd_1",
"volume_id":  "0A00641167EAF2E7",
"file_system":  "(free disk)",
"size":  "4294967296",
"dev_type":  "SUBTYPE_GENERIC_DISK",
"local_disk_name":  "/dev/vdb"
}