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

Retrieve a Kerberos interface

Contributors
PDFs

GET /protocols/nfs/kerberos/interfaces/{interface.uuid}

Introduced In: 9.6

Retrieves a Kerberos interface.

  • vserver nfs kerberos interface show

Learn more

Parameters

Name Type In Required Description

interface.uuid

string

path

True

Network interface UUID

  • Introduced in: 9.7

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

enabled

boolean

Specifies if Kerberos is enabled.

encryption_types

array[string]

force

boolean

Specifies whether the server should ignore any error encountered while deleting the corresponding machine account on the KDC and also disables Kerberos on the LIF.

interface

interface

Network interface

keytab_uri

string

Load keytab from URI

machine_account

string

Specifies the machine account to create in Active Directory.

organizational_unit

string

Organizational unit

password

string

Account creation password

spn

string

Service principal name. Valid in PATCH.

svm

svm

user

string

Account creation user name
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "encryption_types": [
    "string"
  ],
  "interface": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "ip": {
      "address": "10.10.10.7"
    },
    "name": "lif1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "keytab_uri": "string",
  "machine_account": "string",
  "organizational_unit": "string",
  "password": "string",
  "spn": "string",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "user": "string"
}

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

self

href

ip

IP information

Name Type Description

address

string

IPv4 or IPv6 address

interface

Network interface

Name Type Description

_links

_links

ip

ip

IP information

name

string

The name of the interface. If only the name is provided, the SVM scope must be provided by the object this object is embedded in.

uuid

string

The UUID that uniquely identifies the interface.

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the 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.