Get group mappings associated with a virtual server
Get the group mappings associated with a specific 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.
The number of groups present can potentially be very large, so additional filters are provided to allow the number returned to be restricted to specific types.
HTTP request syntax (URI)
GET <base_URI>/v8/storage/virtual-servers/{virtualServerId}/mappings/group
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. |
| includeFixed | BODY | N | boolean | Include all fixed mappings |
| includeFixedUnix | BODY | N | boolean | Include all fixed Unix mappings |
| includeFixedNt | BODY | N | boolean | Include all fixed NT mappings |
| includeFixedNfs4 | BODY | N | boolean | Include all fixed NFSv4 mappings |
| includeInvalid | BODY | N | boolean | Include all invalid mappings |
| includeInvalidUnix | BODY | N | boolean | Include all invalid Unix mappings |
| includeInvalidNt | BODY | N | boolean | Include all invalid NT mappings |
| includeInvalidNfs4 | BODY | N | boolean | Include all invalid NFSv4 mappings |
Return codes
| Code | Data | Description |
| 200 | groupMappings | List of group 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: Get group mappings where ntName contains “Domain Users”
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v8/storage/virtual-servers/1/mappings/group?ntName=*Domain%20Users
Response example
HTTP/1.1 200 OK
{
"groupMappings": [
{
"isNfs4NameFixed": false,
"isNfs4NameValid": true,
"isNtIdFixed": false,
"isNtIdValid": true,
"isNtNameFixed": false,
"isNtNameValid": true,
"isUnixIdFixed": false,
"isUnixIdValid": false,
"isUnixNameFixed": false,
"isUnixNameValid": true,
"nfs4Name": "Domain Users@localhost",
"ntId": "S-1-5-21-2890616873-2892883911-788580134-513",
"ntName": "EXAMPLE\\Domain Users",
"objectId": "303a3a3a313a3a3a37353435316663322d303839352d313164382d393238612d3963353534373037356537353a3a3a303a3a3a4f49445f24232140255f56",
"unixId": 0,
"unixName": "Domain Users"
}
]
}
Request example: Get group mappings that include Fixed NT details
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v8/storage/virtual-servers/1/1/mappings/group?includeFixedNt=true
Response example
HTTP/1.1 200 OK
{
"groupMappings": [
{
"isNfs4NameFixed": true,
"isNfs4NameValid": false,
"isNtIdFixed": true,
"isNtIdValid": true,
"isNtNameFixed": false,
"isNtNameValid": true,
"isUnixIdFixed": true,
"isUnixIdValid": false,
"isUnixNameFixed": true,
"isUnixNameValid": false,
"nfs4Name": "",
"ntId": "S-1-5-32-551",
"ntName": "BUILTIN\\Backup Operators",
"objectId": "303a3a3a313a3a3a65313666373365632d616662362d313164372d393931322d3963353534373037356537353a3a3a303a3a3a4f49445f24232140255f56",
"unixId": 0,
"unixName": ""
},
{
"isNfs4NameFixed": true,
"isNfs4NameValid": true,
"isNtIdFixed": false,
"isNtIdValid": false,
"isNtNameFixed": true,
"isNtNameValid": true,
"isUnixIdFixed": false,
"isUnixIdValid": true,
"isUnixNameFixed": true,
"isUnixNameValid": true,
"nfs4Name": "root@localdomain",
"ntId": "",
"ntName": "EXAMPLE\\root",
"objectId": "303a3a3a313a3a3a65316134636561322d616662362d313164372d393933622d3963353534373037356537353a3a3a303a3a3a4f49445f24232140255f56",
"unixId": 0,
"unixName": "root"
}
]
}