API cookbook: KerberosConfig
This API cookbook recipe describes how to configure Kerberos using the Delphix Engine API.
CODE
{
name: "KerberosConfig",
description: "Kerberos Client Configuration.",
root: "/resources/json/delphix/service/kerberos",
singleton: true,
cliVisibility: [ "DOMAIN", "SYSTEM" ],
extends: {
$ref: "/delphix-user-object.json"
},
properties: {
realm: {
description: "Kerberos Realm name.",
type: "string",
create: "required",
update: "optional"
},
kdcs: {
description: "One of more KDC servers.",
type: "array",
create: "required",
update: "optional",
minItems: 1,
items: {
type: "object",
$ref: "/delphix-kerberos-kdc.json"
}
},
keytab: {
description: "Kerberos keytab file data in base64 encoding.",
type: "string",
format: "password",
create: "required",
update: "optional"
},
principal: {
description: "Kerberos principal name.",
type: "string",
create: "required",
update: "optional"
},
enabled: {
description: "Indicates whether kerberos has been configured or not.",
type: "boolean"
}
},
read: {
description: "Retrieve the specified KerberosConfig object.",
return: {
type: "object",
$ref: "/delphix-kerberos-config.json"
}
},
update: {
description: "Update the specified KerberosConfig object.",
payload: {
type: "object",
$ref: "/delphix-kerberos-config.json"
}
},
rootOperations: {
reset: {
description: "Reset kerberos configuration and disable the feature.",
payload: {}
}
}
}