Product Documentation

aaakcdaccount

Sep 01, 2016

Configuration for Kerberos constrained delegation account resource.

Properties (click to see Operations)

Name Data Type Permissions Description
kcdaccount
<String>
Read-write
The name of the KCD account.
Minimum length = 1
keytab
<String>
Read-write
The path to the keytab file. If specified other parameters in this command need not be given.
realmstr
<String>
Read-write
Kerberos Realm.
delegateduser
<String>
Read-write
Username that can perform kerberos constrained delegation.
kcdpassword
<String>
Read-write
Password for Delegated User.
usercert
<String>
Read-write
SSL Cert (including private key) for Delegated User.
cacert
<String>
Read-write
CA Cert for UserCert or when doing PKINIT backchannel.
userrealm
<String>
Read-write
Realm of the user.
enterpriserealm
<String>
Read-write
Enterprise Realm of the user. This should be given only in certain KDC deployments where KDC expects Enterprise username instead of Principal Name.
servicespn
<String>
Read-write
Service SPN. When specified, this will be used to fetch kerberos tickets. If not specified, Netscaler will construct SPN using service fqdn.
principle
<String>
Read-only
SPN extracted from keytab file.
kcdspn
<String>
Read-only
Host SPN extracted from keytab file.
__count
<Double>
Read-only
count parameter

Operations (click to see Properties)

Some options that you can use for each operations:

  • Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http://<netscaler-ip-address>/nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".

  • Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER:<username>

    X-NITRO-PASS:<password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

메모

Mandatory parameters are marked in red and placeholder content is marked in <green>.

add

URL: http://<netscaler-ip-address>/nitro/v1/config/aaakcdaccount

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"aaakcdaccount":{
      "kcdaccount":<String_value>,
      "keytab":<String_value>,
      "realmstr":<String_value>,
      "delegateduser":<String_value>,
      "kcdpassword":<String_value>,
      "usercert":<String_value>,
      "cacert":<String_value>,
      "userrealm":<String_value>,
      "enterpriserealm":<String_value>,
      "servicespn":<String_value>
}}

Response:

HTTP Status Code on Success: 201 Created
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

delete

URL: http://<netscaler-ip-address>/nitro/v1/config/aaakcdaccount/kcdaccount_value<String>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

update

URL: http://<netscaler-ip-address>/nitro/v1/config/aaakcdaccount

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"aaakcdaccount":{
      "kcdaccount":<String_value>,
      "keytab":<String_value>,
      "realmstr":<String_value>,
      "delegateduser":<String_value>,
      "kcdpassword":<String_value>,
      "usercert":<String_value>,
      "cacert":<String_value>,
      "userrealm":<String_value>,
      "enterpriserealm":<String_value>,
      "servicespn":<String_value>
}}

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

unset

URL: http://<netscaler-ip-address>/nitro/v1/config/aaakcdaccount?action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"aaakcdaccount":{
      "kcdaccount":<String_value>,
      "keytab":true,
      "usercert":true,
      "cacert":true,
      "userrealm":true,
      "enterpriserealm":true,
      "servicespn":true
}}

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http://<netscaler-ip-address>/nitro/v1/config/aaakcdaccount

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/aaakcdaccount?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http://<netscaler-ip-address>/nitro/v1/config/aaakcdaccount?filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of aaakcdaccount resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http://<netscaler-ip-address>/nitro/v1/config/aaakcdaccount?view=summary

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http://<netscaler-ip-address>/nitro/v1/config/aaakcdaccount?pagesize=#no&pageno=#no

Use this query-parameter to get the aaakcdaccount resources in chunks.

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Accept:application/json

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "aaakcdaccount": [ {
      "kcdaccount":<String_value>,
      "keytab":<String_value>,
      "principle":<String_value>,
      "kcdspn":<String_value>,
      "realmstr":<String_value>,
      "delegateduser":<String_value>,
      "kcdpassword":<String_value>,
      "usercert":<String_value>,
      "cacert":<String_value>,
      "userrealm":<String_value>,
      "enterpriserealm":<String_value>,
      "servicespn":<String_value>
}]}

get

URL: http://<netscaler-ip-address>/nitro/v1/config/aaakcdaccount/kcdaccount_value<String>

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/aaakcdaccount/kcdaccount_value<String>?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http://<netscaler-ip-address>/nitro/v1/config/aaakcdaccount/kcdaccount_value<String>?view=summary

Note: By default, the retrieved results are displayed in detail view (?view=detail).

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Accept:application/json

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "aaakcdaccount": [ {
      "kcdaccount":<String_value>,
      "keytab":<String_value>,
      "principle":<String_value>,
      "kcdspn":<String_value>,
      "realmstr":<String_value>,
      "delegateduser":<String_value>,
      "kcdpassword":<String_value>,
      "usercert":<String_value>,
      "cacert":<String_value>,
      "userrealm":<String_value>,
      "enterpriserealm":<String_value>,
      "servicespn":<String_value>
}]}

count

URL: http://<netscaler-ip-address>/nitro/v1/config/aaakcdaccount?count=yes

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Accept:application/json

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "aaakcdaccount": [ { "__count": "#no"} ] }