Skip to main content

Update UNIX group information for a group in an SVM

Contributors
PDFs

PATCH /name-services/unix-groups/{svm.uuid}/{name}

Introduced In: 9.9

Updates the UNIX group information of the specified group in the specified SVM.

Learn more

Parameters

Name Type In Required Description

name

string

path

True

UNIX group name.

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

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": [
    {
      "name": "string"
    }
  ]
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

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.