Try SpotterConfiguration for LDAP parameter resource.
| "added in version" 2.0.0 of netscaler.adc"
Authors: Sumanth Lingappa (@sumanth-lingappa)
preview | supported by community
Install with ansible-galaxy collection install netscaler.adc:==2.5.1
collections:
- name: netscaler.adc
version: 2.5.1Configuration for LDAP parameter resource.
nsip:
description:
- 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.
required: true
type: str
state:
choices:
- present
- unset
default: present
description:
- The state of the resource being configured by the module on the NetScaler ADC node.
- When C(present), the resource will be added/updated configured according to the
module's parameters.
- When C(unset), the resource will be unset on the NetScaler ADC node.
type: str
sectype:
choices:
- PLAINTEXT
- TLS
- SSL
description:
- Type of security used for communications between the Citrix ADC and the LDAP server.
For the C(PLAINTEXT) setting, no encryption is required.
type: str
svrtype:
choices:
- AD
- NDS
description:
- The type of LDAP server.
type: str
api_path:
default: nitro/v1/config
description:
- Base NITRO API path.
- Define only in case of an ADM service proxy call
type: str
ldapbase:
description:
- Base (the server and location) from which LDAP search commands should start.
- If the LDAP server is running locally, the default value of base is dc=netscaler,
dc=com.
type: str
serverip:
description:
- IP address of your LDAP server.
type: str
ldapbinddn:
description:
- Complete distinguished name (DN) string used for binding to the LDAP server.
type: str
nitro_pass:
description:
- The password with which to authenticate to the NetScaler ADC node.
required: false
type: str
nitro_user:
description:
- The username with which to authenticate to the NetScaler ADC node.
required: false
type: str
serverport:
description:
- Port number on which the LDAP server listens for connections.
type: int
authtimeout:
description:
- Maximum number of seconds that the Citrix ADC waits for a response from the LDAP
server.
type: float
save_config:
default: false
description:
- If C(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.
type: bool
passwdchange:
choices:
- ENABLED
- DISABLED
description:
- Accept password change requests.
type: str
searchfilter:
description:
- String to be combined with the default LDAP user search string to form the value
to use when executing an LDAP search.
- 'For example, the following values:'
- vpnallowed=true,
- ldaploginame=""samaccount""
- 'when combined with the user-supplied username ""bob"", yield the following LDAP
search string:'
- '""(&(vpnallowed=true)(samaccount=bob)""'
type: str
groupattrname:
description:
- Attribute name used for group extraction from the LDAP server.
type: str
ldaploginname:
description:
- Name attribute that the Citrix ADC uses to query the external LDAP server or an
Active Directory.
type: str
nitro_protocol:
choices:
- http
- https
default: https
description:
- Which protocol to use when accessing the nitro API objects.
type: str
validate_certs:
default: true
description:
- If C(false), SSL certificates will not be validated. This should only be used on
personally controlled sites using self-signed certificates.
required: false
type: bool
maxnestinglevel:
description:
- Number of levels up to which the system can query nested LDAP groups.
type: float
nitro_auth_token:
description:
- The authentication token provided by a login operation.
type: str
version_added: 2.6.0
version_added_collection: netscaler.adc
ssonameattribute:
description:
- Attribute used by the Citrix ADC to query an external LDAP server or Active Directory
for an alternative username.
- This alternative username is then used for single sign-on (SSO).
type: str
subattributename:
description:
- Subattribute name used for group extraction from the LDAP server.
type: str
groupsearchfilter:
description:
- Search-expression that can be specified for sending group-search requests to the
LDAP server.
type: str
ldapbinddnpassword:
description:
- Password for binding to the LDAP server.
type: str
groupnameidentifier:
description:
- LDAP-group attribute that uniquely identifies the group. No two groups on one LDAP
server can have the same group name identifier.
type: str
groupsearchattribute:
description:
- LDAP-group attribute that designates the parent group of the specified group. Use
this attribute to search for a group's parent group.
type: str
nestedgroupextraction:
choices:
- 'ON'
- 'OFF'
description:
- Queries the external LDAP server to determine whether the specified group belongs
to another group.
type: str
groupsearchsubattribute:
description:
- LDAP-group subattribute that designates the parent group of the specified group.
Use this attribute to search for a group's parent group.
type: str
defaultauthenticationgroup:
description:
- This is the default group that is chosen when the authentication succeeds in addition
to extracted groups.
type: str
changed:
description: Indicates if any change is made by the module
returned: always
sample: true
type: bool
diff:
description: Dictionary of before and after changes
returned: always
sample:
after:
key2: pqr
before:
key1: xyz
prepared: changes done
type: dict
diff_list:
description: 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'
type: list
failed:
description: Indicates if the module failed or not
returned: always
sample: false
type: bool
loglines:
description: list of logged messages by the module
returned: always
sample:
- message 1
- message 2
type: list