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

Update Kerberos realm properties

PDFs

PATCH /protocols/nfs/kerberos/realms/{svm.uuid}/{name}

Updates the properties of a Kerberos realm.

  • vserver nfs kerberos realm modify

Learn more

Parameters

Name Type In Required Description

svm.uuid

string

path

True

SVM UUID

name

string

path

True

Kerberos realm

Request Body

Name Type Description

_links

_links

ad_server

ad_server

comment

string

Comment

encryption_types

array[string]

kdc

kdc

name

string

Kerberos realm

svm

svm
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "ad_server": {
    "address": "1.2.3.4",
    "name": "string"
  },
  "comment": "string",
  "encryption_types": [
    "string"
  ],
  "kdc": {
    "ip": "1.2.3.4",
    "port": 88,
    "vendor": "string"
  },
  "name": "string",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response codes

Error codes Description

1966125

Failed to remove hosts entry.

1966126

Failed to lookup hosts entry.

1966131

Failed to create hosts entry.

1966132

Failed to modify hosts entry.

2949121

Active Directory server name required.

2949122

Active Directory server address required

2949123

Failed to create Kerberos realm.

2949124

Failed to create hosts file entry.

2949141

Failed to lookup Kerberos realm.

2949148

Failed to modify Kerberos realm.

3276976

"realm" is a required input

3276998

Only the data Vservers can own NFS Kerberos realms.
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

ad_server

Name Type Description

address

string

Active Directory server IP address

name

string

Active Directory server name

kdc

Name Type Description

ip

string

KDC IP address

port

integer

KDC port

vendor

string

Key Distribution Center (KDC) vendor. Following values are suported:

  • microsoft - Microsoft Active Directory KDC

  • other - MIT Kerberos KDC or other KDC

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

kerberos_realm

Name Type Description

_links

_links

ad_server

ad_server

comment

string

Comment

encryption_types

array[string]

kdc

kdc

name

string

Kerberos realm

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.