Skip to content

ldap_server

Configuration for LDAP Server resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
auth_timeout <Integer> Read-write The maximum number of seconds the system will wait for a response from the LDAP server.
group_search_subattribute <String> Read-write LDAP group search subattribute. Used to determine to which groups a group belongs..

Maximum length = 32
follow_referrals <Boolean> Read-write Enable following LDAP referrals received from LDAP server.
search_filter <String> Read-write The String to be combined with the default LDAP user search string to form the value.

Maximum length = 256
group_attr_name <String> Read-write The Attribute name for group extraction from the LDAP server.

Maximum length = 32
authentication <Boolean> Read-write Set to false for public key Authentication.
ldap_host_name <String> Read-write Host Name on the certificate from LDAP Server.

Maximum length = 128
change_password <Boolean> Read-write Enable change of the user.
default_authentication_group <String> Read-write This is the default group.

Maximum length = 64
max_nesting_level <Integer> Read-write Number of levels at which group extraction is allowed.

Maximum value =
login_name <String> Read-write The name attribute used by the system to query the external LDAP server.

Maximum length = 32
id <String> Read-write Id is system generated key for all the ldap servers.
ip_address <String> Read-write The IP address of the LDAP server..

Minimum length = 1

Maximum length = 64
nested_group_extraction <Boolean> Read-write Enable Nested Group Extraction.
group_search_attribute <String> Read-write LDAP group search attribute. Used to determine to which groups a group belongs.

Maximum length = 32
ssh_public_key <String> Read-write SSH public key attribute holds the public keys of the user.

Maximum length = 64
group_name_identifier <String> Read-write Name that uniquely identifies a group in LDAP server.

Maximum length = 32
subattribute_name <String> Read-write The Sub-Attribute name for group extraction from LDAP server.

Maximum length = 32
name <String> Read-write Name of LDAP server.

Minimum length = 1

Maximum length = 128
validate_ldap_server_certs <Boolean> Read-write Validate LDAP Server Certificate.
group_search_filter <String> Read-write String to be combined with the default LDAP group search string to form the search value.

Maximum length = 128
bind_dn <String> Read-write The full distinguished name used to bind to the LDAP server.

Maximum length = 128
port <Integer> Read-write The port number on which the LDAP server is running.

Maximum value =
base_dn <String> Read-write The base or node where the ldapsearch should start.

Maximum length = 128
sec_type <String> Read-write The communication type between the system and the LDAP server.
max_ldap_referrals <Integer> Read-write Maximum number of ldap referrals to follow.
type <String> Read-write The type of LDAP server.

Minimum length = 2

Maximum length = 64
bind_passwd <String> Read-write The password used to bind to the LDAP server.

Maximum length = 128
address_type <Integer> Read-only Configuration 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

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

add

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

HTTPS Method: POST

Request Headers:

Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"ldap_server": {
<b>      "ip_address":<String_value></b>,
<b>      "name":<String_value></b>,
<b>      "type":<String_value></b>,
      "search_filter":<String_value>,
      "ldap_host_name":<String_value>,
      "bind_passwd":<String_value>,
      "group_search_subattribute":<String_value>,
      "group_attr_name":<String_value>,
      "nested_group_extraction":<Boolean_value>,
      "group_search_attribute":<String_value>,
      "subattribute_name":<String_value>,
      "group_search_filter":<String_value>,
      "auth_timeout":<Integer_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>,
      "follow_referrals":<Boolean_value>,
      "max_nesting_level":<Integer_value>,
      "ssh_public_key":<String_value>,
      "validate_ldap_server_certs":<Boolean_value>,
      "max_ldap_referrals":<Integer_value>}}

Response:

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

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "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/v2/config/ldap_server/id_value<String>

HTTPS Method: DELETE

Request Headers:

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

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

Response Payload:

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

get (all)

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

Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/ldap_server ?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of ldap_server resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/ldap_server ?pagesize=#no;pageno=#no

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

count https://<MGMT-IP>/nitro/v2/config/ldap_server ?count=yes

Use this query-parameter to get the count of ldap_server resources.

HTTPS Method: GET

Request Headers:

Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

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

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "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/v2/config/ldap_server/id_value<String>

HTTPS Method: GET

Request Headers:

Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

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

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "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/v2/config/ldap_server/id_value<String>

HTTPS Method: PUT

Request Headers:

Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"ldap_server":{
<b>      "id":<String_value></b>,
<b>      "ip_address":<String_value></b>,
<b>      "name":<String_value></b>,
      "search_filter":<String_value>,
      "ldap_host_name":<String_value>,
      "bind_passwd":<String_value>,
      "group_search_subattribute":<String_value>,
      "group_attr_name":<String_value>,
      "nested_group_extraction":<Boolean_value>,
      "group_search_attribute":<String_value>,
      "subattribute_name":<String_value>,
      "group_search_filter":<String_value>,
      "auth_timeout":<Integer_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>,
      "type":<String_value>,
      "follow_referrals":<Boolean_value>,
      "max_nesting_level":<Integer_value>,
      "ssh_public_key":<String_value>,
      "validate_ldap_server_certs":<Boolean_value>,
      "max_ldap_referrals":<Integer_value>}}

Response:

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

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "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>}]}
Was this article helpful?