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

Retrieve Kerberos realms

Contributors
PDFs

GET /protocols/nfs/kerberos/realms

Introduced In: 9.6

Retrieves Kerberos realms.

  • vserver nfs kerberos realm show

Learn more

Parameters

Name Type In Required Description

password_server.port

integer

query

False

Filter by password_server.port

  • Introduced in: 9.13

password_server.address

string

query

False

Filter by password_server.address

  • Introduced in: 9.13

name

string

query

False

Filter by name

clock_skew

integer

query

False

Filter by clock_skew

  • Introduced in: 9.13

comment

string

query

False

Filter by comment

admin_server.address

string

query

False

Filter by admin_server.address

  • Introduced in: 9.13

admin_server.port

integer

query

False

Filter by admin_server.port

  • Introduced in: 9.13

ad_server.name

string

query

False

Filter by ad_server.name

ad_server.address

string

query

False

Filter by ad_server.address

encryption_types

string

query

False

Filter by encryption_types

kdc.vendor

string

query

False

Filter by kdc.vendor

kdc.ip

string

query

False

Filter by kdc.ip

kdc.port

integer

query

False

Filter by kdc.port

  • Max value: 65535

  • Min value: 1

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

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.

  • Max value: 120

  • Min value: 0

  • Default value: 1

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 records

records

array[kerberos_realm]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "ad_server": {
      "address": "1.2.3.4"
    },
    "admin_server": {
      "address": "1.2.3.4"
    },
    "comment": "string",
    "encryption_types": {
    },
    "kdc": {
      "ip": "1.2.3.4",
      "port": 88,
      "vendor": "microsoft"
    },
    "password_server": {
      "address": "1.2.3.4"
    },
    "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

ad_server

Name Type Description

address

string

Active Directory server IP address

name

string

Active Directory server name

admin_server

Name Type Description

address

string

Admin server IP address.

port

integer

Specifies the port number of admin server.

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

password_server

Name Type Description

address

string

Password server IP address.

port

integer

Specifies the port number of password server.

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

admin_server

admin_server

clock_skew

integer

Specifies the allowed time of clock-skew between the server and clients, in minutes.

comment

string

Comment

encryption_types

array[string]

kdc

kdc

name

string

Kerberos realm

password_server

password_server

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.