Retrieve users for a UNIX group and SVM
- PDF of this doc site
Collection of separate PDF docs
Creating your file...
GET /name-services/unix-groups/{svm.uuid}/{unix_group.name}/users/{name}
Introduced In: 9.10
Retrieves users for the specified UNIX group and SVM.
Related ONTAP commands
-
vserver services name-service unix-group show
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
unix_group.name |
string |
path |
True |
UNIX group name. |
name |
string |
path |
True |
UNIX user to be retrieved from the group. |
fields |
array[string] |
query |
False |
Specify the fields to return. |
svm.uuid |
string |
path |
True |
UUID of the SVM to which this object belongs. |
Response
Status: 200, Ok
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
UNIX user who belongs to the specified UNIX group and the SVM. |
records |
array[records] |
An array of UNIX users specified to add multiple users to a UNIX group in a single API call.
Not allowed when the |
skip_name_validation |
boolean |
Indicates whether or not the validation for the specified UNIX user names is disabled. |
svm |
||
unix_group |
Example response
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "string",
"records": [
{
"name": "string"
}
],
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"unix_group": {
"name": "string"
}
}
Error
Status: Default, Error
Name | Type | Description |
---|---|---|
error |
Example error
{
"error": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist",
"target": "uuid"
}
}
Definitions
See Definitions
href
Name | Type | Description |
---|---|---|
href |
string |
_links
Name | Type | Description |
---|---|---|
self |
records
Name | Type | Description |
---|---|---|
name |
string |
UNIX user who belongs to the specified UNIX group and the SVM. |
svm
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
The name of the SVM. |
uuid |
string |
The unique identifier of the SVM. |
unix_group
Name | Type | Description |
---|---|---|
name |
string |
UNIX group name. |
error_arguments
Name | Type | Description |
---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
error
Name | Type | Description |
---|---|---|
arguments |
array[error_arguments] |
Message arguments |
code |
string |
Error code |
message |
string |
Error message |
target |
string |
The target parameter that caused the error. |