Changing the settings of a CLPR

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
Change the name, cache size, and other settings of a CLPR.
Note:

If you locked any resources of the target storage system by using the REST API, you will not be able to use this API function. In such cases, unlock the resources before running the API function.

Execution permission

Storage Administrator (System Resource Management)

Request line

PATCH base-URL/v1/objects/clprs/object-ID

Request message

Object ID

Specify the value of clprId that was obtained by the processing to get information about CLPRs.

Attribute

Type

Description

clprId

int

(Required) CLPR ID

Query parameters

None.

Body

The following is a coding example for changing the name of a CLPR:

{
  "clprName" : "CLPRGRP"
}

The following is a coding example for changing the total cache size of a CLPR:

{
  "cacheMemoryCapacity" : 24576
}

The following is a coding example for changing the name and total cache size of a CLPR:

{
  "clprName" : "CLPRGRP",
  "cacheMemoryCapacity" : 24576
}

Attribute

Type

Description

clprName

string

(Optional) CLPR name

Specify a name consisting of 1 to 16 characters.

Specify a name that is unique among the CLPRs on the target storage system.

cacheMemoryCapacity

long

(Optional) Total cache size of the CLPR (MB)

For VSP 5000 series storage systems, specify a multiple of 4096. For other storage systems, specify a multiple of 2048.

For details on the size that can be specified for the cache, see the Virtual Partition Manager manual.

Response message

Body

A job object is returned. For details on attributes other than affectedResources, see the description of job objects.

Attribute

Description

affectedResources

URL of the CLPR whose settings were changed

Action template

None.

Status codes

For details on the status codes of the request for this operation, see the description on HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X PATCH --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/clprs/2