Skip to main content

We've Moved!

Product Documentation has moved to
Hitachi Vantara Knowledge

Create a virtual server

Creates a virtual server on the storage system. The virtual server is assigned an IP address when you create the server. It uses the Ethernet link aggregation port available on the physical cluster node. The operation returns a URI you can access to retrieve a virtual server immediately after the operation returns.

HTTP request syntax (URI)
POST <base_URI>/v7/storage/virtual-servers
Name Type Required Values Description
name BODY Y string Name (only alphanumeric and "-") for the virtual server to be created.
clusterNodeId BODY Y number ID of the cluster node in which to create the virtual server.
ipAddress BODY Y string Either IPv4 or IPv6 address of the virtual server.
netmask BODY Y string Netmask must be of the form x.x.x.x for an IPv4 address or specify a prefix length for an IPv6 address.
ethernetLinkAggregation BODY Y string Name of the Ethernet link aggregation for the virtual server.
Return codes
Code Data Description
201 virtualServer Virtual server object successfully created.
400 No Data Missing or invalid request contents.
404 Error Message Requested resource not found.
500 Error message Error associated with the storage system.
501 No Data Server has not implemented the request operation on the resource.

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

Request example
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" –d ‘{"name":"TestEVS", "clusterNodeId":1, "ipAddress":"", "netmask":"", "ethernetLinkAggregation":"ag1"}’ -X POST
Response example
HTTP/1.1 201 OK
   "virtualServer" : {
      "UUID" : "b912ecdc-77df-11d0-958c-49e1bb864b23",
      "virtualServerId" : 7,
      "ipAddresses" : [ "" ],
      "isEnabled" : true,
      "name" : "TestEVS",
      "objectId" : "373a3a3a4f49445f24232140255f56",
      "status" : "ONLINE",
      "type" : "File services",
    "uri" : ""


  • Was this article helpful?