Retrieve local group information for a group and SVM
- PDF of this doc site
Collection of separate PDF docs
Creating your file...
GET /protocols/cifs/local-groups/{svm.uuid}/{sid}
Introduced In: 9.10
Retrieves local group information for the specified group and SVM.
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 |
path |
True |
Local group SID |
svm.uuid |
string |
path |
True |
UUID of the SVM to which this object belongs. |
fields |
array[string] |
query |
False |
Specify the fields to return. |
Response
Status: 200, Ok
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 |
Example response
{
"_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 |
---|---|---|
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
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
The name of the SVM. |
uuid |
string |
The unique identifier of the SVM. |
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. |