Retrieve local groups for all SVMs
Accesses the local groups for all SVMs, which is useful when managing or auditing group configurations across your storage environment.
HTTP method and endpoint
GET /protocols/cifs/local-groups
Introduced in
ONTAP 9.9
Usage notes
Retrieves the local groups for all of the SVMs.
Advanced properties
-
members
Related ONTAP commands
-
vserver cifs users-and-groups local-group show -
vserver cifs users-and-groups local-group show-members
Learn more
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
sid |
string |
query |
False |
Filter by sid
|
members.name |
string |
query |
False |
Filter by members.name |
name |
string |
query |
False |
Filter by name
|
svm.uuid |
string |
query |
False |
Filter by svm.uuid |
svm.name |
string |
query |
False |
Filter by svm.name |
description |
string |
query |
False |
Filter by description
|
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 |
||
num_records |
integer |
Number of local group records. |
records |
array[local_cifs_group] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"description": "This is a local group",
"members": [
{
"name": "string"
}
],
"name": "SMB_SERVER01\\group",
"sid": "S-1-5-21-256008430-3394229847-3930036330-1001",
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
}
}
]
}
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 |
members
| Name | Type | Description |
|---|---|---|
name |
string |
Local user, Active Directory user, or Active Directory group which is a member of the specified local group. |
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. |
local_cifs_group
| Name | Type | Description |
|---|---|---|
_links |
||
description |
string |
Description for the local group. |
members |
array[members] |
|
name |
string |
Local group name. The maximum supported length of a group name is 256 characters. |
sid |
string |
The security ID of the local group which uniquely identifies the group. The group SID is automatically generated in POST and it is retrieved using the GET method. |
svm |
SVM, applies only to SVM-scoped objects. |
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. |