Retrieve UNIX groups for all SVMs
Retrieves the UNIX groups associated with all SVMs, including the UNIX users who are members of those groups.
HTTP method and endpoint
GET /name-services/unix-groups
Introduced in
ONTAP 9.9
Usage notes
Retrieves the UNIX groups for all of the SVMs. UNIX users who are the members of the group are also displayed.
Related ONTAP commands
-
vserver services name-service unix-group show
Learn more
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
id |
integer |
query |
False |
Filter by id |
users.name |
string |
query |
False |
Filter by users.name |
svm.name |
string |
query |
False |
Filter by svm.name |
svm.uuid |
string |
query |
False |
Filter by svm.uuid |
name |
string |
query |
False |
Filter by name |
fields |
array[string] |
query |
False |
Specify the fields to return. |
max_records |
integer |
query |
False |
Limit the number of records returned. |
return_records |
boolean |
query |
False |
The default is true for GET calls. When set to false, only the number of records is returned.
|
return_timeout |
integer |
query |
False |
The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.
|
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Status: 200, Ok
| Name | Type | Description |
|---|---|---|
_links |
||
current_count |
integer |
Number of UNIX groups and members. |
num_records |
integer |
Number of UNIX group records. |
records |
array[unix_group] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "group1",
"skip_name_validation": true,
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"users": [
{
"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 |
|---|---|---|
next |
||
self |
_links
| Name | Type | Description |
|---|---|---|
self |
svm
SVM, applies only to SVM-scoped objects.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
The name of the SVM. This field cannot be specified in a PATCH method. |
uuid |
string |
The unique identifier of the SVM. This field cannot be specified in a PATCH method. |
users
| Name | Type | Description |
|---|---|---|
name |
string |
UNIX user who belongs to the specified UNIX group and the SVM. |
unix_group
| Name | Type | Description |
|---|---|---|
_links |
||
id |
integer |
UNIX group ID of the specified user. |
name |
string |
UNIX group name to be added to the local database. |
svm |
SVM, applies only to SVM-scoped objects. |
|
users |
array[users] |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
returned_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. |