netscaler.adc.authenticationldapaction module – Configuration for LDAP action resource.

Note

This module is part of the netscaler.adc collection (version 2.6.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install netscaler.adc.

To use it in a playbook, specify: netscaler.adc.authenticationldapaction.

New in netscaler.adc 2.0.0

Synopsis

  • Configuration for LDAP action resource.

Parameters

Parameter

Comments

alternateemailattr

any

The NetScaler appliance uses the alternateive email attribute to query the Active Directory for the alternative email id of a user

api_path

string

Base NITRO API path.

Define only in case of an ADM service proxy call

Default: "nitro/v1/config"

attribute1

any

Expression that would be evaluated to extract attribute1 from the ldap response

attribute10

any

Expression that would be evaluated to extract attribute10 from the ldap response

attribute11

any

Expression that would be evaluated to extract attribute11 from the ldap response

attribute12

any

Expression that would be evaluated to extract attribute12 from the ldap response

attribute13

any

Expression that would be evaluated to extract attribute13 from the ldap response

attribute14

any

Expression that would be evaluated to extract attribute14 from the ldap response

attribute15

any

Expression that would be evaluated to extract attribute15 from the ldap response

attribute16

any

Expression that would be evaluated to extract attribute16 from the ldap response

attribute2

any

Expression that would be evaluated to extract attribute2 from the ldap response

attribute3

any

Expression that would be evaluated to extract attribute3 from the ldap response

attribute4

any

Expression that would be evaluated to extract attribute4 from the ldap response

attribute5

any

Expression that would be evaluated to extract attribute5 from the ldap response

attribute6

any

Expression that would be evaluated to extract attribute6 from the ldap response

attribute7

any

Expression that would be evaluated to extract attribute7 from the ldap response

attribute8

any

Expression that would be evaluated to extract attribute8 from the ldap response

attribute9

any

Expression that would be evaluated to extract attribute9 from the ldap response

attributes

any

List of attribute names separated by ‘,’ which needs to be fetched from ldap server.

Note that preceeding and trailing spaces will be removed.

Attribute name can be 127 bytes and total length of this string should not cross 2047 bytes.

These attributes have multi-value support separated by ‘,’ and stored as key-value pair in AAA session

authentication

any

Perform LDAP authentication.

If authentication is disabled, any LDAP authentication attempt returns authentication success if the user is found.

CAUTION! Authentication should be disabled only for authorization group extraction or where other (non-LDAP) authentication methods are in use and either bound to a primary list or flagged as secondary.

Choices:

  • "ENABLED"

  • "DISABLED"

authtimeout

any

Number of seconds the Citrix ADC waits for a response from the RADIUS server.

cloudattributes

any

The Citrix ADC uses the cloud attributes to extract additional attributes from LDAP servers required for Citrix Cloud operations

Choices:

  • "ENABLED"

  • "DISABLED"

defaultauthenticationgroup

any

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

email

any

The Citrix ADC uses the email attribute to query the Active Directory for the email id of a user

followreferrals

any

Setting this option to ON enables following LDAP referrals received from the LDAP server.

Choices:

  • "ON"

  • "OFF"

groupattrname

any

LDAP group attribute name.

Used for group extraction on the LDAP server.

groupnameidentifier

any

Name that uniquely identifies a group in LDAP or Active Directory.

groupsearchattribute

any

LDAP group search attribute.

Used to determine to which groups a group belongs.

groupsearchfilter

any

String to be combined with the default LDAP group search string to form the search value. For example, the group search filter “”vpnallowed=true”” when combined with the group identifier “”samaccount”” and the group name “”g1”” yields the LDAP search string “”(&(vpnallowed=true)(samaccount=g1)””. If nestedGroupExtraction is ENABLED, the filter is applied on the first level group search as well, otherwise first level groups (of which user is a direct member of) will be fetched without applying this filter. (Be sure to enclose the search string in two sets of double quotation marks; both sets are needed.)

groupsearchsubattribute

any

LDAP group search subattribute.

Used to determine to which groups a group belongs.

kbattribute

any

KnowledgeBasedAuthentication(KBA) attribute on AD. This attribute is used to store and retrieve preconfigured Question and Answer knowledge base used for KBA authentication.

ldapbase

any

Base (node) from which to start LDAP searches.

If the LDAP server is running locally, the default value of base is dc=netscaler, dc=com.

ldapbinddn

any

Full distinguished name (DN) that is used to bind to the LDAP server.

Default: cn=Manager,dc=netscaler,dc=com

ldapbinddnpassword

any

Password used to bind to the LDAP server.

ldaphostname

any

Hostname for the LDAP server. If -validateServerCert is ON then this must be the host name on the certificate from the LDAP server.

A hostname mismatch will cause a connection failure.

ldaploginname

any

LDAP login name attribute.

The Citrix ADC uses the LDAP login name to query external LDAP servers or Active Directories.

managed_netscaler_instance_id

string

added in netscaler.adc 2.6.0

The ID of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_ip

string

added in netscaler.adc 2.6.0

The IP of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_name

string

added in netscaler.adc 2.6.0

The name of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_password

string

added in netscaler.adc 2.6.0

The password of the managed NetScaler instance.

Define only in case of an ADM service proxy call

In Settings > Administration > System Configurations > Basic Settings,

if you select Prompt Credentials for Instance Login,

ensure to configure username and password of a managed instance.

managed_netscaler_instance_username

string

added in netscaler.adc 2.6.0

The username of the managed NetScaler instance.

Define only in case of an ADM service proxy call

In Settings > Administration > System Configurations > Basic Settings,

if you select Prompt Credentials for Instance Login,

ensure to configure username and password of a managed instance.

maxldapreferrals

any

Specifies the maximum number of nested referrals to follow.

maxnestinglevel

any

If nested group extraction is ON, specifies the number of levels up to which group extraction is performed.

mssrvrecordlocation

any

MSSRV Specific parameter. Used to locate the DNS node to which the SRV record pertains in the domainname. The domainname is appended to it to form the srv record.

Example : For “dc._msdcs”, the srv record formed is _ldap._tcp.dc._msdcs.<domainname>.

name

any

Name for the new LDAP action.

Must begin with a letter, number, or the underscore character (_), and must contain only letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at (@), equals (=), colon (:), and underscore characters. Cannot be changed after the LDAP action is added.

The following requirement applies only to the Citrix ADC CLI:

If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my authentication action” or ‘my authentication action’).

nestedgroupextraction

any

Allow nested group extraction, in which the Citrix ADC queries external LDAP servers to determine whether a group is part of another group.

Choices:

  • "ON"

  • "OFF"

netscaler_console_as_proxy_server

boolean

added in netscaler.adc 2.6.0

The IP address of the NetScaler ADC appliance acting as a proxy server.

Define only in case of an ADM service proxy call

Choices:

  • false ← (default)

  • true

nitro_auth_token

string

The authentication token provided by a login operation.

nitro_pass

string

The password with which to authenticate to the NetScaler ADC node.

nitro_protocol

string

Which protocol to use when accessing the nitro API objects.

Choices:

  • "http"

  • "https" ← (default)

nitro_user

string

The username with which to authenticate to the NetScaler ADC node.

nsip

string / required

The ip address of the NetScaler ADC appliance where the nitro API calls will be made.

The port can be specified with the colon (:). E.g. 192.168.1.1:555.

otpsecret

any

OneTimePassword(OTP) Secret key attribute on AD. This attribute is used to store and retrieve secret key used for OTP check

passwdchange

any

Allow password change requests.

Choices:

  • "ENABLED"

  • "DISABLED"

pushservice

any

Name of the service used to send push notifications

referraldnslookup

any

Specifies the DNS Record lookup Type for the referrals

Choices:

  • "A-REC"

  • "SRV-REC"

  • "MSSRV-REC"

requireuser

any

Require a successful user search for authentication.

CAUTION! This field should be set to NO only if usersearch not required [Both username validation as well as password validation skipped] and (non-LDAP) authentication methods are in use and either bound to a primary list or flagged as secondary.

Choices:

  • "YES"

  • "NO"

save_config

boolean

If true the module will save the configuration on the NetScaler ADC node if it makes any changes.

The module will not save the configuration on the NetScaler ADC node if it made no changes.

Choices:

  • false ← (default)

  • true

searchfilter

any

String to be combined with the default LDAP user search string to form the search value. For example, if the search filter “vpnallowed=true” is combined with the LDAP login name “samaccount” and the user-supplied username is “bob”, the result is the LDAP search string “”&(vpnallowed=true)(samaccount=bob)”” (Be sure to enclose the search string in two sets of double quotation marks; both sets are needed.).

sectype

any

Type of security used for communications between the Citrix ADC and the LDAP server. For the PLAINTEXT setting, no encryption is required.

Choices:

  • "PLAINTEXT"

  • "TLS"

  • "SSL"

serverip

string

IP address assigned to the LDAP server.

servername

string

LDAP server name as a FQDN. Mutually exclusive with LDAP IP address.

serverport

any

Port on which the LDAP server accepts connections.

sshpublickey

string

SSH PublicKey is attribute on AD. This attribute is used to retrieve ssh PublicKey for RBA authentication

ssonameattribute

any

LDAP single signon (SSO) attribute.

The Citrix ADC uses the SSO name attribute to query external LDAP servers or Active Directories for an alternate username.

state

string

The state of the resource being configured by the module on the NetScaler ADC node.

When present, the resource will be added/updated configured according to the module’s parameters.

When absent, the resource will be deleted from the NetScaler ADC node.

When unset, the resource will be unset on the NetScaler ADC node.

Choices:

  • "present" ← (default)

  • "absent"

  • "unset"

subattributename

any

LDAP group sub-attribute name.

Used for group extraction from the LDAP server.

svrtype

any

The type of LDAP server.

Choices:

  • "AD"

  • "NDS"

validate_certs

boolean

If false, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Choices:

  • false

  • true ← (default)

validateservercert

any

When to validate LDAP server certs

Choices:

  • "YES"

  • "NO"

Notes

Note

Examples

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

changed

boolean

Indicates if any change is made by the module

Returned: always

Sample: true

diff

dictionary

Dictionary of before and after changes

Returned: always

Sample: {"after": {"key2": "pqr"}, "before": {"key1": "xyz"}, "prepared": "changes done"}

diff_list

list / elements=string

List of differences between the actual configured object and the configuration specified in the module

Returned: when changed

Sample: ["Attribute `key1` differs. Desired: (<class 'str'>) XYZ. Existing: (<class 'str'>) PQR"]

failed

boolean

Indicates if the module failed or not

Returned: always

Sample: false

loglines

list / elements=string

list of logged messages by the module

Returned: always

Sample: ["message 1", "message 2"]

Authors

  • Sumanth Lingappa (@sumanth-lingappa)