Changing the port attribute

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
The request below changes the value of the port attribute.
Note:

This API request can be used when the storage system is VSP 5000 series.

Execution permission

Storage Administrator (Provisioning)

Request line

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

Request message

Object ID

Specify the value of portId that was obtained by the processing to get information about ports.

Attribute

Type

Description

portId

string

(Required) Port number

Query parameters
None.
Body
{
  "portAttribute": "TAR"
}

Attribute

Type

Description

portAttribute

string

(Required) Port attribute

You can specify the following values:

  • TAR: Target port (Fibre Target port)
  • ALL: Bidirectional port

If the port is operating in NVMe mode and the storage system is a VSP 5000 series storage system, you must specify TAR.

This item is not case sensitive.

Response message

Body

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

Attribute

Description

affectedResources

URL of the changed port

Action template

None.

Status codes

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

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X PATCH --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/ports/CL1-A