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

Create the NIS configuration for the cluster

Contributors
PDFs

POST /security/authentication/cluster/nis

Introduced In: 9.6

The cluster can have one NIS server configuration. Specify the NIS domain and NIS servers as input. The servers field cannot be empty. Both FQDNs and IP addresses are supported for the server property. IPv6 must be enabled if IPv6 family addresses are specified in the server property. A maximum of ten NIS servers are supported.

Required properties

  • domain - NIS domain to which this configuration belongs.

  • servers - List of hostnames or IP addresses of NIS servers used by the NIS domain configuration.

Request Body

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

Response

Status: 201, Created
Name Type Description

_links

_links

num_records

integer

Number of NIS domain records.

records

array[cluster_nis_service]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "binding_details": [
        {
          "server": "string",
          "status": {
            "code": "string",
            "message": "string"
          }
        }
      ],
      "bound_servers": [
        "string"
      ],
      "domain": "string",
      "servers": [
        "string"
      ]
    }
  ]
}

Headers

Name Description Type

Location

Useful for tracking the resource location

string

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

1966253

IPv6 is not enabled in the cluster.

3276964

The NIS domain name or NIS server domain is too long. The maximum supported for domain name is 64 characters and the maximum supported for NIS server domain is 255 characters.

3276933

A maximum of 10 NIS servers can be configured per SVM.

13434916

The SVM is in the process of being created. Wait a few minutes, and then try the command again.

23724109

DNS resolution failed for one or more specified servers.

23724112

DNS resolution failed due to an internal error. Contact technical support if this issue persists.

23724132

DNS resolution failed for all the specified servers.

23724130

Cannot use an IPv6 name server address because there are no IPv6 interfaces.

23724111

Invalid value specified for nis-servers. The value must be a valid hostname or IP address.

23724087

The specified IPv6 address is not supported because it is one of the following: ::, link-local, multicast, v4-compatible, v4-mapped, loopback.

23724086

The specified IPv4 address is not supported because it is one of the following: multicast, loopback, 0.0.0.0 or broadcast.
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

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

_links

Name Type Description

next

href

self

href

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.