We've Moved! Product Documentation has moved to docs.hitachivantara.com

Get domain mappings associated with a virtual server

Last updated
Save as PDF

Gets domain mappings associated with a virtual server.

If the virtual server is configured in the global security context, the mappings retrieved will be those from the global context. Specify a virtual server ID of 0 to ensure the global mappings are retrieved. If the virtual server is configured to have an individual security context, the mappings will only be associated with the specified virtual server.

HTTP request syntax (URI)

GET <base_URI>/v8/storage/virtual-servers/{virtualServerId}/mappings/domain

Parameters

Name	Type	Required	Values	Description
virtualServerId	URI_PARAM	Y	string/number	Specifies either the virtual server object ID or the HNAS storage virtual server ID.

Return codes

Code	Data	Description
200	domainMappings	List of domain mappings retrieved successfully.
400	Error Message	Missing or invalid request contents.
404	Error Message	Requested resource not found.
500	Error message	Error associated with the storage system.

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

Request example

curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v8/storage/virtual-servers/1/mappings/domain

Response example

HTTP/1.1 200 OK
{
  "domainMappings": [
    {
      "canMapUnixNames": false,
      "kerberosRealm": "",
      "nfs4Domain": "test.example.com",
      "ntDomain": "test",
      "objectId": "303a3a3a6e74446f6d61696e3a3a3a756b746573743a3a3a303a3a3a4f49445f24232140255f56"
    },
    {
      "canMapUnixNames": true,
      "kerberosRealm": "realm",
      "nfs4Domain": "localhost",
      "ntDomain": "PROTOCOLS",
      "objectId": "303a3a3a6e74446f6d61696e3a3a3a50524f544f434f4c533a3a3a303a3a3a4f49445f24232140255f56"
    }
  ]
}

Quick Links