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

Retrieve UNIX group information for a group and SVM

Contributors
PDFs

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

Introduced In: 9.9

Retrieves UNIX group information for the specified group and SVM. UNIX users who are part of this group are also retrieved.

  • vserver services name-service unix-group show

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.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
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

users

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

Error

Status: Default, Error
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

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

users

Name Type Description

name

string

UNIX user who belongs to the specified UNIX group and 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.