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

Retrieve the NIS domain and server configurations for an SVM

PDFs

GET /name-services/nis/{svm.uuid}

Introduced In: 9.6

Retrieves NIS domain and server configurations of an SVM. Both NIS domain and servers are displayed by default. The bound_servers field indicates the successfully bound NIS servers.

  • vserver services name-service nis-domain show

  • vserver services name-service nis-domain show-bound

  • vserver services name-service nis-domain show-bound-debug

Learn more

Parameters

Name Type In Required Description

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

binding_details

array[binding_details]

An array of objects where each object represents the NIS server and it's status for a given NIS domain. It is an advanced field.

bound_servers

array[string]

domain

string

The NIS domain to which this configuration belongs.

servers

array[string]

A list of hostnames or IP addresses of NIS servers used by the NIS domain configuration.

svm

svm

SVM, applies only to SVM-scoped objects.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "binding_details": [
    {
      "server": "string",
      "status": {
        "code": "string",
        "message": "string"
      }
    }
  ],
  "bound_servers": [
    "string"
  ],
  "domain": "domainA.example.com",
  "servers": [
    "10.10.10.10",
    "example.com"
  ],
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

Error

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

binding_status

Name Type Description

code

string

Code corresponding to the server's binding status.

message

string

Detailed description of the server's binding status.

binding_details

Name Type Description

server

string

Hostname/IP address of the NIS server in the domain.

status

binding_status

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.

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.