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

Retrieve all UNIX users for all SVMs

Contributors
PDFs

GET /name-services/unix-users

Introduced In: 9.9

Retrieves all of the UNIX users for all of the SVMs.

Important notes

  • The current UNIX users count can be retrieved from the num_records field by calling the API with the paramter "return_records=false".

  • vserver services name-service unix-user show

Parameters

Name Type In Required Description

name

string

query

False

Filter by name

full_name

string

query

False

Filter by full_name

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

id

integer

query

False

Filter by id

primary_gid

integer

query

False

Filter by primary_gid

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of UNIX user records.

records

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

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

next

href

self

href

_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.

unix_user

Name Type Description

_links

_links

full_name

string

User's full name.

id

integer

UNIX user ID of the specified user.

name

string

UNIX user name to be added to the local database.

primary_gid

integer

Primary group ID to which the user belongs.

skip_name_validation

boolean

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

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.