Skip to main content

Create a local UNIX group configuration for an SVM

Contributors
PDFs

POST /name-services/unix-groups

Introduced In: 9.9

Creates the local UNIX group configuration for the specified SVM.

Group name and group ID are mandatory parameters.

Important notes

  • The default limit for local UNIX groups and group members is 32768.

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

id

integer

UNIX group ID of the specified user.

name

string

UNIX group name to be added to the local database.

skip_name_validation

boolean

Indicates whether or not the validation for the specified UNIX group name is disabled.

svm

svm

SVM, applies only to SVM-scoped objects.

users

array[users]
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "name": "group1",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "users": {
  }
}

Response

Status: 201, Created

Headers

Name Description Type

Location

Useful for tracking the resource location

string

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

2621706

The specified SVM UUID is incorrect for the specified SVM name.

2621516

This operation is only supported on a data SVM.

3277025

Maximum supported limit of UNIX group count reached.

3277051

Invalid characters in group name. Valid characters are 0-9, A-Z, a-z, ".", "_" and "-". Names cannot start with "-".

23724067

Group name too long. Maximum supported length is 64 characters.

23724141

Duplicate group ID. Group ID must be unique.
Name Type Description

error

returned_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

svm

SVM, applies only to SVM-scoped objects.

Name Type Description

_links

_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

_links

id

integer

UNIX group ID of the specified user.

name

string

UNIX group name to be added to the local database.

skip_name_validation

boolean

Indicates whether or not the validation for the specified UNIX group name is disabled.

svm

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.