|
APIs in Category: kerberos |
Vserver API version 1.15 |
kerberos-config-get |
This set of ZAPIs allows Kerberos realm configuration and management. |
| kerberos-config-get | [top] |
Get Kerberos configuration information for a LIF.
Input Name Range Type Description desired-attributes kerberos-config-info
optional
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned. interface-name string
Logical interface. Output Name Range Type Description attributes kerberos-config-info
The attributes of the kerberos-config.
Errno Description EOBJECTNOTFOUND EINTERNALERROR
| kerberos-config-get-iter | [top] |
Get Kerberos configuration information for a group of LIFs.
Input Name Range Type Description desired-attributes kerberos-config-info
optional
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned. max-records [1..200] integer
optional
The maximum number of records to return in this call. Default: 50 query kerberos-config-info
optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the kerberos-config object. All kerberos-config objects matching this query up to 'max-records' will be returned. tag string
optional
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call. Output Name Range Type Description attributes-list kerberos-config-info[]
optional
The list of attributes of kerberos-config objects. next-tag string
optional
Tag for the next call. Not present when there are no more kerberos-config objects to return. num-records [0..200] integer
The number of records returned in this call.
Errno Description EINTERNALERROR
| kerberos-config-modify | [top] |
Modify Kerberos configuration informaiton for a LIF
Input Name Range Type Description admin-password string
optional
Administrator password. admin-user-name string
optional
Administrator username. interface-name string
Logical interface. is-kerberos-enabled boolean
optional
If 'true', then kerberos security is enabled. keytab-uri string
optional
Keytab to load the uri from. service-principal-name string
optional
Kerberos service principal name.
Errno Description EOBJECTNOTFOUND EINTERNALERROR
| Element definition: kerberos-config-info | [top] |
Kerberos configuration. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Name Range Type Description admin-password string
optional
Administrator password. Attributes: non-creatable, modifiable admin-user-name string
optional
Administrator username. Attributes: non-creatable, modifiable interface-name string
optional
Logical interface. Attributes: key, non-creatable, non-modifiable ip-address string
optional
Logical interface IP address. Attributes: non-creatable, non-modifiable is-kerberos-enabled boolean
optional
If 'true', then kerberos security is enabled. Attributes: non-creatable, modifiable keytab-uri string
optional
Load Keytab from URI. Attributes: non-creatable, modifiable service-principal-name string
optional
Kerberos service principal name. Attributes: non-creatable, modifiable vserver string
optional
Vserver name. Attributes: key, non-creatable, non-modifiable