getaaaldapparamsResult Structure Definition

The getaaaldapparamsResult structure defines the return type for getaaaldapparams API.

Syntax



Members

rc

If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings.

message

If the method succeeds, message is NULL else message contains Error/Warning message.

aaaldapparamsList

List of aaaldapparamss


aaaldapparams Structure Definition

The aaaldapparams structure defines the actual return type values for getaaaldapparams API.

Syntax



Members

serverip

The IP address of the LDAP server.

serverport

Port number on which the LDAP server listens for connections.

authtimeout

Maximum number of seconds that the Citrix ADC waits for a response from the LDAP server.

ldapbinddn

The full distinguished name used to bind to the LDAP server.

ldaploginname

The name attribute used by the system to query the external LDAP server, or an Active Directory.

ldapbase

The base or node where the ldapsearch should start. If the LDAP server is running locally, the default value of base is dc=netscaler, dc=com.

sectype

The communication type between the system and the LDAP server.

svrtype

LDAP server.

ssonameattribute

The attribute used by the system to query the external LDAP server, or an Active Directory, for an alternate username to be used in Single Sign-On.

searchfilter

The String to be combined with the default LDAP user search string to form the value. For example, vpnallowed=true with ldaploginame "samaccount" and the user-supplied username "bob" would yield the LDAP search string "(&(vpnallowed=true)(samaccount=bob)".

groupattrname

The Attribute name for group extraction from the LDAP server.

subattributename

Subattribute name used for group extraction from the LDAP server.

groupauthname

To associate AAA users with an AAA group, use the method "bind AAA group ... -username ...". You can bind different policies to each AAA group. Use the method "bind AAA group ... -policy ..."

passwdchange

Accept password change requests.

nestedgroupextraction

Queries the external LDAP server to determine whether the specified group belongs to another group.

maxnestinglevel

Number of levels up to which the system can query nested LDAP groups.

groupnameidentifier

LDAP-group attribute that uniquely identifies the group. No two groups on one LDAP server can have the same group name identifier.

groupsearchattribute

LDAP-group attribute that designates the parent group of the specified group. Use this attribute to search for a group's parent group.

groupsearchsubattribute

LDAP-group subattribute that designates the parent group of the specified group. Use this attribute to search for a group's parent group.

groupsearchfilter

Search-expression that can be specified for sending group-search requests to the LDAP server.

defaultauthenticationgroup

This is the default group that is chosen when the authentication succeeds in addition to extracted groups.

builtin

Indicates that a variable is a built-in (SYSTEM INTERNAL) type.

_nextgenapiresource


See Also