Changing the nickname of an external volume

Execution permission

Storage Administrator (Provisioning)

Request line

PATCH base-URL/simple/v1/objects/external-volumes/object-ID

Request message

Object ID

Specify the id value obtained by getting information about external volumes.

Attribute	Type	Description
id	int	(Required) External volume ID

Query parameters

None.

Body

{
  "nickname": "externalVolumeForQuorum2"
}

Attribute	Type	Description
nickname	string	(Optional) Specify a new nickname consisting of 1 through 32 characters. You can use alphanumeric characters (0 through 9, A through Z, a through z), space characters, and the following symbols: Exclamation mark (!), hash mark (#), dollar sign ($), percent sign (%), ampersand (&), single quotation mark ('), left parenthesis ((), right parenthesis ()), plus sign (+), comma (,), hyphen (-), period (.), forward slash (/), colon (:), equal sign (=), at sign (@), left square bracket ([), back slash (\), right square bracket (]), caret (^), underscore (_), grave accent mark (`), left curly bracket ({), right curly bracket (}), tilde (~) This attribute is case-sensitive. You can use a space character between usable characters, but cannot use it at the beginning or end of the nickname.

Response message

Body

Attribute	Type	Type
affectedResources	string[]	List of URLs for referencing information about the changed external volume
operationDetails	object[]	Details about the changed External volume For details, see the description of the operationDetails attribute of the commandStatus object.

Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X PATCH --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/simple/v1/objects/external-volumes/3