Skip to main content

We've Moved!

Product Documentation has moved to docs.hitachivantara.com
Hitachi Vantara Knowledge

Set host port

Sets parameters for a specific host port. In the case of this API call, the port index associated with the object ID is used to set the same details on all cluster nodes – this is required for clustering to function successfully.

Some hardware platforms do not support setting all parameters, and different speed parameters are supported on different platforms – see the Get host port supported speeds API call for a list of supported speeds.

HTTP request syntax (URI)
PATCH <base_URI>/v8/storage/nodes/host-ports/{hostPortId}
Parameters
Name Type Required Values Description
hostPortIdURI_PARAMYstringSpecifies the host port object ID.
isEnabled BODYNbooleanWhether the specified port is enabled or not
speedBODYNIntegerSpeed the port should operate at. Accepted values are different depending on the platform.
typeBODYNStringLink type – either N or NL.
Return codes
Code Data Description
204 No DataHost port successfully updated.
400 Error Message Missing or invalid request contents.
403Error MessageOperation forbidden by access level.
404 Error Message Requested resource not found.
500 Error message Error associated with the storage system.

Any HTTP status code other than 201 indicates that the API did not complete successfully.

Request example: Enable host port, and set the speed to 8Gbps
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v8/storage/nodes/host-ports/323a3a3a313a3a3a303a3a3a4f49445f24232140255f56 -X PATCH -d '{"speed":8, "isEnabled":true}'
Response example
HTTP/1.1 204 No Content

 

  • Was this article helpful?