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

Retrieves nis domain configurations of all the svms the bound_servers field indicates the successfully bound nis servers lookups and authentications fail if there are no bound servers

PDFs

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

  • vserver services name-service nis-domain show-bound-debug # learn more

  • [doc /name-services/nis](#docs-name-services-name-services_nis)

GET /name-services/nis

Introduced In: 9.6

Retrieves NIS domain configurations of all the SVMs. The bound_servers field indicates the successfully bound NIS servers. Lookups and authentications fail if there are no bound 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

domain

string

query

False

Filter by domain

  • maxLength: 64

  • minLength: 1

  • Introduced in: 9.7

servers

string

query

False

Filter by servers

  • maxLength: 255

  • minLength: 1

  • Introduced in: 9.7

svm.uuid

string

query

False

Filter by svm.uuid

  • Introduced in: 9.7

svm.name

string

query

False

Filter by svm.name

  • Introduced in: 9.7

bound_servers

string

query

False

Filter by bound_servers

  • maxLength: 255

  • minLength: 1

  • Introduced in: 9.7

binding_details.server

string

query

False

Filter by binding_details.server

  • maxLength: 255

  • minLength: 1

  • Introduced in: 9.11

binding_details.status.message

string

query

False

Filter by binding_details.status.message

  • Introduced in: 9.11

binding_details.status.code

string

query

False

Filter by binding_details.status.code

  • Introduced in: 9.11

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: 15

  • 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 NIS domain records.

records

array[nis_service]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "binding_details": [
        {
          "server": "string",
          "status": {
            "code": "string",
            "message": "string"
          }
        }
      ],
      "bound_servers": [
        "string"
      ],
      "domain": "string",
      "servers": [
        "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

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

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

nis_service

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

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.
Close
Try it out

Sign in with your NetApp Cloud Central credentials.

Try this API

Parameters

Headers

Body

Code

Response