Skip to content

ldap_server

Configuration for LDAP Server resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
auth_timeout<Integer>Read-writeThe maximum number of seconds the system will wait for a response from the LDAP server.
group_search_subattribute<String>Read-writeLDAP group search subattribute. Used to determine to which groups a group belongs..
Maximum length = 32
follow_referrals<Boolean>Read-writeEnable following LDAP referrals received from LDAP server.
search_filter<String>Read-writeThe String to be combined with the default LDAP user search string to form the value.
Maximum length = 256
group_attr_name<String>Read-writeThe Attribute name for group extraction from the LDAP server.
Maximum length = 32
authentication<Boolean>Read-writeSet to false for public key Authentication.
ldap_host_name<String>Read-writeHost Name on the certificate from LDAP Server.
Maximum length = 128
change_password<Boolean>Read-writeEnable change of the user.
default_authentication_group<String>Read-writeThis is the default group.
Maximum length = 64
max_nesting_level<Integer>Read-writeNumber of levels at which group extraction is allowed.
Maximum value =
login_name<String>Read-writeThe name attribute used by the system to query the external LDAP server.
Maximum length = 32
id<String>Read-writeId is system generated key for all the ldap servers.
ip_address<String>Read-writeThe IP address of the LDAP server..
Minimum length = 1
Maximum length = 64
nested_group_extraction<Boolean>Read-writeEnable Nested Group Extraction.
group_search_attribute<String>Read-writeLDAP group search attribute. Used to determine to which groups a group belongs.
Maximum length = 32
ssh_public_key<String>Read-writeSSH public key attribute holds the public keys of the user.
Maximum length = 64
group_name_identifier<String>Read-writeName that uniquely identifies a group in LDAP server.
Maximum length = 32
subattribute_name<String>Read-writeThe Sub-Attribute name for group extraction from LDAP server.
Maximum length = 32
name<String>Read-writeName of LDAP server.
Minimum length = 1
Maximum length = 128
validate_ldap_server_certs<Boolean>Read-writeValidate LDAP Server Certificate.
group_search_filter<String>Read-writeString to be combined with the default LDAP group search string to form the search value.
Maximum length = 128
bind_dn<String>Read-writeThe full distinguished name used to bind to the LDAP server.
Maximum length = 128
port<Integer>Read-writeThe port number on which the LDAP server is running.
Maximum value =
base_dn<String>Read-writeThe base or node where the ldapsearch should start.
Maximum length = 128
sec_type<String>Read-writeThe communication type between the system and the LDAP server.
max_ldap_referrals<Integer>Read-writeMaximum number of ldap referrals to follow.
type<String>Read-writeThe type of LDAP server.
Minimum length = 2
Maximum length = 64
bind_passwd<String>Read-writeThe password used to bind to the LDAP server.
Maximum length = 128
address_type<Integer>Read-onlyConfiguration Type. Values: 0: IPv4, 1: IPv6, -1: Hostname.

Operations

(click to see Properties)

ADD| DELETE| GET (ALL)| GET| UPDATE

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>

Note:

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

add

URL: https://<MGMT-IP>/nitro/v1/config/ldap_server?onerror=<String_value>

HTTP Method: null

Request Payload:

{ldap_server: {
<b>"ip_address":<String_value></b>,
<b>"name":<String_value></b>,
<b>"type":<String_value></b>,
"auth_timeout":<Integer_value>,
"search_filter":<String_value>,
"ldap_host_name":<String_value>,
"authentication":<Boolean_value>,
"change_password":<Boolean_value>,
"default_authentication_group":<String_value>,
"id":<String_value>,
"login_name":<String_value>,
"group_name_identifier":<String_value>,
"bind_dn":<String_value>,
"port":<Integer_value>,
"sec_type":<String_value>,
"base_dn":<String_value>,
"bind_passwd":<String_value>,
"group_search_subattribute":<String_value>,
"follow_referrals":<Boolean_value>,
"group_attr_name":<String_value>,
"max_nesting_level":<Integer_value>,
"nested_group_extraction":<Boolean_value>,
"group_search_attribute":<String_value>,
"ssh_public_key":<String_value>,
"subattribute_name":<String_value>,
"validate_ldap_server_certs":<Boolean_value>,
"group_search_filter":<String_value>,
"max_ldap_referrals":<Integer_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ldap_server":[{
"auth_timeout":<Integer_value>,
"group_search_subattribute":<String_value>,
"follow_referrals":<Boolean_value>,
"search_filter":<String_value>,
"group_attr_name":<String_value>,
"authentication":<Boolean_value>,
"ldap_host_name":<String_value>,
"change_password":<Boolean_value>,
"default_authentication_group":<String_value>,
"max_nesting_level":<Integer_value>,
"login_name":<String_value>,
"id":<String_value>,
"ip_address":<String_value>,
"nested_group_extraction":<Boolean_value>,
"group_search_attribute":<String_value>,
"ssh_public_key":<String_value>,
"group_name_identifier":<String_value>,
"subattribute_name":<String_value>,
"name":<String_value>,
"validate_ldap_server_certs":<Boolean_value>,
"group_search_filter":<String_value>,
"bind_dn":<String_value>,
"port":<Integer_value>,
"base_dn":<String_value>,
"sec_type":<String_value>,
"max_ldap_referrals":<Integer_value>,
"type":<String_value>,
"bind_passwd":<String_value>,
"address_type":<Integer_value>}]}

delete

URL: https://<MGMT-IP>/nitro/v1/config/ldap_server/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value> }

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/ldap_server

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ldap_server":[{
"auth_timeout":<Integer_value>,
"group_search_subattribute":<String_value>,
"follow_referrals":<Boolean_value>,
"search_filter":<String_value>,
"group_attr_name":<String_value>,
"authentication":<Boolean_value>,
"ldap_host_name":<String_value>,
"change_password":<Boolean_value>,
"default_authentication_group":<String_value>,
"max_nesting_level":<Integer_value>,
"login_name":<String_value>,
"id":<String_value>,
"ip_address":<String_value>,
"nested_group_extraction":<Boolean_value>,
"group_search_attribute":<String_value>,
"ssh_public_key":<String_value>,
"group_name_identifier":<String_value>,
"subattribute_name":<String_value>,
"name":<String_value>,
"validate_ldap_server_certs":<Boolean_value>,
"group_search_filter":<String_value>,
"bind_dn":<String_value>,
"port":<Integer_value>,
"base_dn":<String_value>,
"sec_type":<String_value>,
"max_ldap_referrals":<Integer_value>,
"type":<String_value>,
"bind_passwd":<String_value>,
"address_type":<Integer_value>}]}

get

URL: https://<MGMT-IP>/nitro/v1/config/ldap_server/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ldap_server":[{
"auth_timeout":<Integer_value>,
"group_search_subattribute":<String_value>,
"follow_referrals":<Boolean_value>,
"search_filter":<String_value>,
"group_attr_name":<String_value>,
"authentication":<Boolean_value>,
"ldap_host_name":<String_value>,
"change_password":<Boolean_value>,
"default_authentication_group":<String_value>,
"max_nesting_level":<Integer_value>,
"login_name":<String_value>,
"id":<String_value>,
"ip_address":<String_value>,
"nested_group_extraction":<Boolean_value>,
"group_search_attribute":<String_value>,
"ssh_public_key":<String_value>,
"group_name_identifier":<String_value>,
"subattribute_name":<String_value>,
"name":<String_value>,
"validate_ldap_server_certs":<Boolean_value>,
"group_search_filter":<String_value>,
"bind_dn":<String_value>,
"port":<Integer_value>,
"base_dn":<String_value>,
"sec_type":<String_value>,
"max_ldap_referrals":<Integer_value>,
"type":<String_value>,
"bind_passwd":<String_value>,
"address_type":<Integer_value>}]}

update

URL: https://<MGMT-IP>/nitro/v1/config/ldap_server/id_value<String>

HTTP Method: null

Request Payload:

{ldap_server:{
<b>"id":<String_value></b>,
<b>"ip_address":<String_value></b>,
<b>"name":<String_value></b>,
"auth_timeout":<Integer_value>,
"search_filter":<String_value>,
"ldap_host_name":<String_value>,
"authentication":<Boolean_value>,
"change_password":<Boolean_value>,
"default_authentication_group":<String_value>,
"login_name":<String_value>,
"group_name_identifier":<String_value>,
"bind_dn":<String_value>,
"port":<Integer_value>,
"sec_type":<String_value>,
"base_dn":<String_value>,
"bind_passwd":<String_value>,
"type":<String_value>,
"group_search_subattribute":<String_value>,
"follow_referrals":<Boolean_value>,
"group_attr_name":<String_value>,
"max_nesting_level":<Integer_value>,
"nested_group_extraction":<Boolean_value>,
"group_search_attribute":<String_value>,
"ssh_public_key":<String_value>,
"subattribute_name":<String_value>,
"validate_ldap_server_certs":<Boolean_value>,
"group_search_filter":<String_value>,
"max_ldap_referrals":<Integer_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ldap_server":[{
"auth_timeout":<Integer_value>,
"group_search_subattribute":<String_value>,
"follow_referrals":<Boolean_value>,
"search_filter":<String_value>,
"group_attr_name":<String_value>,
"authentication":<Boolean_value>,
"ldap_host_name":<String_value>,
"change_password":<Boolean_value>,
"default_authentication_group":<String_value>,
"max_nesting_level":<Integer_value>,
"login_name":<String_value>,
"id":<String_value>,
"ip_address":<String_value>,
"nested_group_extraction":<Boolean_value>,
"group_search_attribute":<String_value>,
"ssh_public_key":<String_value>,
"group_name_identifier":<String_value>,
"subattribute_name":<String_value>,
"name":<String_value>,
"validate_ldap_server_certs":<Boolean_value>,
"group_search_filter":<String_value>,
"bind_dn":<String_value>,
"port":<Integer_value>,
"base_dn":<String_value>,
"sec_type":<String_value>,
"max_ldap_referrals":<Integer_value>,
"type":<String_value>,
"bind_passwd":<String_value>,
"address_type":<Integer_value>}]}