Skip to main content
A newer release of this product is available.

Create a local group configuration for an SVM

Contributors
PDFs

POST /protocols/cifs/local-groups

Introduced In: 9.9

Creates the local group configuration for the specified SVM.

Important notes

  • The group name can contain up to 256 characters.

  • The group name cannot be terminated by a period.

  • The group name does not support any of the following characters: " / ? [ ] , : \| < > + = ; ? * @ or ASCII characters in the range 1-31.

Required properties

  • svm.uuid or svm.name - Existing SVM in which to create the local group.

  • name - Name of the local group.

  • vserver cifs users-and-groups local-group create

Learn more

Parameters

Name Type In Required Description

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

Request Body

Name Type Description

_links

_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
Example request 
{
  "_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"
  }
}

Response

Status: 201, Created

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

262278

Name is a required field.

655399

CIFS server must exist to create a local group.

655660

The operation is allowed only on data SVMs.

655661

The group name and description should not exceed 256 characters.

655668

The specified group name contains illegal characters.

655675

The local domain name specified in the group name does not exist.

655677

This operation does not allow for the creation of a group in the BUILTIN domain.

655682

The group name cannot be blank.

655717

The specified group name already exists.

2621706

The specified SVM UUID is incorrect for the specified SVM name.
Name Type Description

error

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

href

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

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

local_cifs_group

Name Type Description

_links

_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

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.