Retrieve Kerberos realms
Retrieves Kerberos realms to access the configuration details necessary for managing authentication services. Use this endpoint when you need to view the Kerberos realm settings associated with your ONTAP system.
HTTP method and endpoint
GET /protocols/nfs/kerberos/realms
Introduced in
ONTAP 9.6
Related ONTAP commands
-
vserver nfs kerberos realm show
Learn more
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
clock_skew |
integer |
query |
False |
Filter by clock_skew
|
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
|
name |
string |
query |
False |
Filter by name |
ad_server.address |
string |
query |
False |
Filter by ad_server.address |
ad_server.name |
string |
query |
False |
Filter by ad_server.name |
svm.name |
string |
query |
False |
Filter by svm.name |
svm.uuid |
string |
query |
False |
Filter by svm.uuid |
encryption_types |
string |
query |
False |
Filter by encryption_types |
password_server.address |
string |
query |
False |
Filter by password_server.address
|
password_server.port |
integer |
query |
False |
Filter by password_server.port
|
comment |
string |
query |
False |
Filter by comment |
admin_server.address |
string |
query |
False |
Filter by admin_server.address
|
admin_server.port |
integer |
query |
False |
Filter by admin_server.port
|
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.
|
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.
|
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Status: 200, Ok
| Name | Type | Description |
|---|---|---|
_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",
"name": "string"
},
"admin_server": {
"address": "1.2.3.4"
},
"comment": "string",
"encryption_types": [
"string"
],
"kdc": {
"ip": "1.2.3.4",
"port": 88,
"vendor": "string"
},
"name": "string",
"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 |
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 |
||
self |
_links
| Name | Type | Description |
|---|---|---|
self |
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 supported:
|
password_server
| Name | Type | Description |
|---|---|---|
address |
string |
Password server IP address. |
port |
integer |
Specifies the port number of password server. |
svm
SVM, applies only to SVM-scoped objects.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
The name of the SVM. This field cannot be specified in a PATCH method. |
uuid |
string |
The unique identifier of the SVM. This field cannot be specified in a PATCH method. |
kerberos_realm
| Name | Type | Description |
|---|---|---|
_links |
||
ad_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 |
||
name |
string |
Kerberos realm |
password_server |
||
svm |
SVM, applies only to SVM-scoped objects. |
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. |