Patch

/kerberos/{id}/

This endpoint modifies a specified Kerberos Provider.

Security

HTTP

Type basic

Basic authentication using VMS user name and password

API Key: ApiToken

Header parameter nameApiToken

Send current valid API token in an Authorization header with format Api-Token .

Path parameters

id

integerRequired

Kerberos Provider ID

Body parameters

object

realm

string

The realm for the Kerberos provider. A realm is the administrative domain that defines the boundary for Kerberos authentication. It typically maps to an organization or network and includes a Key Distribution Center (KDC) that manages all principals (users, services) within it. For example, in a company with domain example.com, the Kerberos realm is often written in uppercase as EXAMPLE.COM. All authentications for users and services like alice@EXAMPLE.COM or host/server.example.com@EXAMPLE.COM are handled by the KDC for that realm.

kdc

Array of string

A list of IP addresses or FQDNs for the Key Distribution Center (KDC)

string

kadmin_servers

Array of string

A list of IP addresses or FQDNs for the Kerberos kadmin server

string

enabled

boolean

Enable/disable the Kerberos provider

service_principals

Array of string

A list of service principals (for NFS) in the Kerberos realm. These are used by NFS clients in the authentication process. For example, nfs/vippool.mydomain.com, where vippool represents a CNode in a cluster (and whose DNS name resolves to the cluster).

string

Responses

200

KerberosProvider updated successfully

Expand All

object

id

integer

ID of the Kerberos provider

guid

string

Global unique ID for the Kerberos provider.

enabled

boolean

If true, the Kerberos provider is enabled.

realm

string

The realm for the Kerberos provider. A realm is the administrative domain that defines the boundary for Kerberos authentication. It typically maps to an organization or network and includes a Key Distribution Center (KDC) that manages all principals (users, services) within it. For example, in a company with domain example.com, the Kerberos realm is often written in uppercase as EXAMPLE.COM. All authentications for users and services like alice@EXAMPLE.COM or host/server.example.com@EXAMPLE.COM are handled by the KDC for that realm.

kdc

Array of string

A list of IP addresses or FQDNs for the Key Distribution Center (KDC).

string

kadmin_servers

Array of string

A list of IP addresses or FQDNs for the Kerberos kadmin server.

string

service_principals

Array of string

A list of service principals (for NFS) in the Kerberos realm. These are used by NFS clients in the authentication process. For example, nfs/vippool.mydomain.com, where vippool represents a CNode in a cluster (and whose DNS name resolves to the cluster).

string

state

object (KerberosStateInfo)

kdc

Array of object (KerberosServerInfo)

object

status

string

Valid values[ "SUCCESS", "PINGED_ONLY", "PARSED_ONLY", "FAILURE" ]

location

string

message

string

kadmin_servers

Array of object (KerberosServerInfo)

object

status

string

Valid values[ "SUCCESS", "PINGED_ONLY", "PARSED_ONLY", "FAILURE" ]

location

string

message

string

service_principals

Array of object (KerberosPrincipalInfo)

object

status

string

Valid values[ "SUCCESS", "NO_KEYTAB_ENTRY", "NOT_AUTHENTICATED", "FAILURE" ]

name

string

message

string

400

Bad request

404

KerberosProvider not found

Modify Kerberos Provider