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

Retrieve the NIS configuration for the cluster

Contributors
PDFs

GET /security/authentication/cluster/nis

Introduced In: 9.6

Retrieves the NIS configuration of the cluster. Both NIS domain and servers are displayed by default. The bound_servers property indicates the successfully bound NIS servers.

Parameters

Name Type In Required Description

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.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "binding_details": {
  },
  "bound_servers": {
  },
  "servers": {
  }
}

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

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

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.