Skip to main content

We've Moved!

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

Get a file system share

Retrieves a file system share.

HTTP request syntax (URI)
GET <base_URI>/v7/storage/filesystem-shares/{type}/{filesystemShareObjectId}
Parameters
Name Type Required Values Description
filesystemShareObjectId URI_PARAM Y string ID of the file system share object.
type URI_PARAM Y string Possible values are cifs or nfs.
Return codes
CodeDataDescription
200filesystemShareFile system share objects retrieved successfully
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 200 indicates that the API did not complete successfully.

Request example 1
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.57.75:8444/v7/storage/filesystem-shares/nfs/353a3a3a66366233396131652d303562362d313164302d393136382d356563303033373534353864
Response example 1
HTTP/1.1 200 OK
{
  "filesystemShare" : {
    "filesystemId" : "75412709E1CB9AAB0000000000000000",
    "objectId" : "353a3a3a66366233396131652d303562362d313164302d393136382d356563303033373534353864",
    "name" : "/xyz-docu-test-nfs",
    "path" : "/xyz/doc/test/path/0426",
    "settings" : {
      "accessConfig" : "*",
      "localReadCacheOption" : "DISABLED",
      "snapshotOption" : "SHOW_AND_ALLOW_ACCESS",
      "transferToReplicationTargetSetting" : "DO_NOT_TRANSFER"
    },   
    "shareId" : "91c13a68-54ba-11d1-911a-4bee3faaca3b",
    "virtualServerId" : 5
  }
}
Request example 2
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.57.75:8444/v7/storage/filesystem-shares/cifs/5/353a3a3a64383163313665382d313163642d313164312d393234352d346265653366616163613362
Response example 2
HTTP/1.1 200 OK
{ 
  "filesystemShare" :{
    "filesystemId" : "7547FEE51E4FEC080000000000000000",
    "objectId" :    "353a3a3a64383163313665382d313163642d313164312d393234352d346265653366616163613362",
    "name" : "xyz-test-cifs5",
    "path" : "\\",
    "settings" : {
      "shareId" : "91c13a68-54ba-11d1-911a-4bee3faaca3b",  	  
      "isABEEnabled" : false,
      "accessConfig" : "*",
      "cacheOption" : "MANUAL_CACHING_DOCS",
      "comment" : "xyz comment",
      "isFollowGlobalSymbolicLinks" : false,
      "isFollowSymbolicLinks" : false,
      "isForceFileNameToLowercase" : false,
      "maxConcurrentUsers" : 100,
      "isScanForVirusesEnabled" : false,
      "snapshotOption" : "SHOW_AND_ALLOW_ACCESS",
      "transferToReplicationTargetSetting" : "DO_NOT_TRANSFER",
      "userHomeDirectoryMode" : "OFF",
      "userHomeDirectoryPath" : "",
       "virtualServerId" : 5
    }
  }
}

 

  • Was this article helpful?