.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.ise.ldap_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.ise.ldap module -- Resource module for Ldap +++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.ise collection `_ (version 3.0.0). To install it, use: :code:`ansible-galaxy collection install cisco.ise`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.ise.ldap`. .. version_added .. rst-class:: ansible-version-added New in cisco.ise 1.0.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operation create of the resource Ldap. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.ise.ldap_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - ciscoisesdk \>= 2.0.1 - python \>= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-attributes: .. rst-class:: ansible-option-title **attributes** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Ldap's attributes. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-attributes/attributes: .. rst-class:: ansible-option-title **attributes** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
List of Attributes. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings: .. rst-class:: ansible-option-title **connectionSettings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Ldap's connectionSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/alwaysaccessprimaryfirst: .. rst-class:: ansible-option-title **alwaysAccessPrimaryFirst** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
AlwaysAccessPrimaryFirst. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/failbackretrydelay: .. rst-class:: ansible-option-title **failbackRetryDelay** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
FailbackRetryDelay. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/failovertosecondary: .. rst-class:: ansible-option-title **failoverToSecondary** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
FailoverToSecondary. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/ldapnodedata: .. rst-class:: ansible-option-title **ldapNodeData** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
LdapNodeData. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/primaryserver: .. rst-class:: ansible-option-title **primaryServer** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Ldap's primaryServer. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/primaryserver/admindn: .. rst-class:: ansible-option-title **adminDN** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
AdminDN. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/primaryserver/adminpassword: .. rst-class:: ansible-option-title **adminPassword** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
AdminPassword. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/primaryserver/enableforcereconnect: .. rst-class:: ansible-option-title **enableForceReconnect** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
EnableForceReconnect. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/primaryserver/enablesecureconnection: .. rst-class:: ansible-option-title **enableSecureConnection** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
EnableSecureConnection. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/primaryserver/enableserveridentitycheck: .. rst-class:: ansible-option-title **enableServerIdentityCheck** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
EnableServerIdentityCheck. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/primaryserver/forcereconnecttime: .. rst-class:: ansible-option-title **forceReconnectTime** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
ForceReconnectTime. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/primaryserver/hostname: .. rst-class:: ansible-option-title **hostName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
HostName. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/primaryserver/issuercacertificate: .. rst-class:: ansible-option-title **issuerCACertificate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IssuerCACertificate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/primaryserver/maxconnections: .. rst-class:: ansible-option-title **maxConnections** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
MaxConnections. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/primaryserver/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
Port. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/primaryserver/servertimeout: .. rst-class:: ansible-option-title **serverTimeout** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
ServerTimeout. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/primaryserver/trustcertificate: .. rst-class:: ansible-option-title **trustCertificate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
TrustCertificate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/primaryserver/useadminaccess: .. rst-class:: ansible-option-title **useAdminAccess** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
UseAdminAccess. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/secondaryserver: .. rst-class:: ansible-option-title **secondaryServer** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Ldap's secondaryServer. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/secondaryserver/admindn: .. rst-class:: ansible-option-title **adminDN** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
AdminDN. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/secondaryserver/adminpassword: .. rst-class:: ansible-option-title **adminPassword** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
AdminPassword. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/secondaryserver/enableforcereconnect: .. rst-class:: ansible-option-title **enableForceReconnect** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
EnableForceReconnect. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/secondaryserver/enablesecureconnection: .. rst-class:: ansible-option-title **enableSecureConnection** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
EnableSecureConnection. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/secondaryserver/enableserveridentitycheck: .. rst-class:: ansible-option-title **enableServerIdentityCheck** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
EnableServerIdentityCheck. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/secondaryserver/forcereconnecttime: .. rst-class:: ansible-option-title **forceReconnectTime** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
ForceReconnectTime. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/secondaryserver/hostname: .. rst-class:: ansible-option-title **hostName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
HostName. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/secondaryserver/issuercacertificate: .. rst-class:: ansible-option-title **issuerCACertificate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IssuerCACertificate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/secondaryserver/maxconnections: .. rst-class:: ansible-option-title **maxConnections** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
MaxConnections. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/secondaryserver/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
Port. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/secondaryserver/servertimeout: .. rst-class:: ansible-option-title **serverTimeout** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
ServerTimeout. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/secondaryserver/trustcertificate: .. rst-class:: ansible-option-title **trustCertificate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
TrustCertificate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/secondaryserver/useadminaccess: .. rst-class:: ansible-option-title **useAdminAccess** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
UseAdminAccess. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-connectionsettings/specifyserverforeachisenode: .. rst-class:: ansible-option-title **specifyServerForEachISENode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
SpecifyServerForEachISENode. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Description. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-directoryorganization: .. rst-class:: ansible-option-title **directoryOrganization** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Ldap's directoryOrganization. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-directoryorganization/groupdirectorysubtree: .. rst-class:: ansible-option-title **groupDirectorySubtree** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
GroupDirectorySubtree. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-directoryorganization/macformat: .. rst-class:: ansible-option-title **macFormat** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
MacFormat. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-directoryorganization/prefixseparator: .. rst-class:: ansible-option-title **prefixSeparator** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
PrefixSeparator. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-directoryorganization/stripprefix: .. rst-class:: ansible-option-title **stripPrefix** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
StripPrefix. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-directoryorganization/stripsuffix: .. rst-class:: ansible-option-title **stripSuffix** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
StripSuffix. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-directoryorganization/suffixseparator: .. rst-class:: ansible-option-title **suffixSeparator** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SuffixSeparator. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-directoryorganization/userdirectorysubtree: .. rst-class:: ansible-option-title **userDirectorySubtree** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
UserDirectorySubtree. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-enablepasswordchangeldap: .. rst-class:: ansible-option-title **enablePasswordChangeLDAP** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
EnablePasswordChangeLDAP. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-generalsettings: .. rst-class:: ansible-option-title **generalSettings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Ldap's generalSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-generalsettings/certificate: .. rst-class:: ansible-option-title **certificate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Certificate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-generalsettings/groupmapattributename: .. rst-class:: ansible-option-title **groupMapAttributeName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
GroupMapAttributeName. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-generalsettings/groupmemberreference: .. rst-class:: ansible-option-title **groupMemberReference** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
GroupMemberReference. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-generalsettings/groupnameattribute: .. rst-class:: ansible-option-title **groupNameAttribute** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
GroupNameAttribute. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-generalsettings/groupobjectclass: .. rst-class:: ansible-option-title **groupObjectClass** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
GroupObjectClass. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-generalsettings/schema: .. rst-class:: ansible-option-title **schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Schema. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-generalsettings/userinfoattributes: .. rst-class:: ansible-option-title **userInfoAttributes** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Ldap's userInfoAttributes. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-generalsettings/userinfoattributes/additionalattribute: .. rst-class:: ansible-option-title **additionalAttribute** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
AdditionalAttribute. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-generalsettings/userinfoattributes/country: .. rst-class:: ansible-option-title **country** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Country. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-generalsettings/userinfoattributes/department: .. rst-class:: ansible-option-title **department** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Department. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-generalsettings/userinfoattributes/email: .. rst-class:: ansible-option-title **email** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Email. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-generalsettings/userinfoattributes/firstname: .. rst-class:: ansible-option-title **firstName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
FirstName. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-generalsettings/userinfoattributes/jobtitle: .. rst-class:: ansible-option-title **jobTitle** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
JobTitle. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-generalsettings/userinfoattributes/lastname: .. rst-class:: ansible-option-title **lastName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
LastName. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-generalsettings/userinfoattributes/locality: .. rst-class:: ansible-option-title **locality** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Locality. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-generalsettings/userinfoattributes/organizationalunit: .. rst-class:: ansible-option-title **organizationalUnit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
OrganizationalUnit. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-generalsettings/userinfoattributes/stateorprovince: .. rst-class:: ansible-option-title **stateOrProvince** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
StateOrProvince. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-generalsettings/userinfoattributes/streetaddress: .. rst-class:: ansible-option-title **streetAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
StreetAddress. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-generalsettings/userinfoattributes/telephone: .. rst-class:: ansible-option-title **telephone** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Telephone. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-generalsettings/usernameattribute: .. rst-class:: ansible-option-title **userNameAttribute** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
UserNameAttribute. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-generalsettings/userobjectclass: .. rst-class:: ansible-option-title **userObjectClass** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
UserObjectClass. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-groups: .. rst-class:: ansible-option-title **groups** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Ldap's groups. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-groups/groupsnames: .. rst-class:: ansible-option-title **groupsNames** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
List of groups. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-ise_debug: .. rst-class:: ansible-option-title **ise_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Identity Services Engine SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-ise_hostname: .. rst-class:: ansible-option-title **ise_hostname** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Identity Services Engine hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-ise_password: .. rst-class:: ansible-option-title **ise_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Identity Services Engine password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-ise_single_request_timeout: .. rst-class:: ansible-option-title **ise_single_request_timeout** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` :ansible-option-versionadded:`added in cisco.ise 3.0.0` .. raw:: html
- .. raw:: html
Timeout (in seconds) for RESTful HTTP requests. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`60` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-ise_username: .. rst-class:: ansible-option-title **ise_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Identity Services Engine username to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-ise_uses_api_gateway: .. rst-class:: ansible-option-title **ise_uses_api_gateway** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` :ansible-option-versionadded:`added in cisco.ise 1.1.0` .. raw:: html
- .. raw:: html
Flag that informs the SDK whether to use the Identity Services Engine's API Gateway to send requests. If it is true, it uses the ISE's API Gateway and sends requests to https://{{ise\_hostname}}. If it is false, it sends the requests to https://{{ise\_hostname}}:{{port}}, where the port value depends on the Service used (ERS, Mnt, UI, PxGrid). .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-ise_uses_csrf_token: .. rst-class:: ansible-option-title **ise_uses_csrf_token** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` :ansible-option-versionadded:`added in cisco.ise 3.0.0` .. raw:: html
- .. raw:: html
Flag that informs the SDK whether we send the CSRF token to ISE's ERS APIs. If it is True, the SDK assumes that your ISE CSRF Check is enabled. If it is True, it assumes you need the SDK to manage the CSRF token automatically for you. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-ise_verify: .. rst-class:: ansible-option-title **ise_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-ise_version: .. rst-class:: ansible-option-title **ise_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Identity Services Engine to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"3.1\_Patch\_1"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-ise_wait_on_rate_limit: .. rst-class:: ansible-option-title **ise_wait_on_rate_limit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Identity Services Engine SDK to enable automatic rate-limit handling. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__parameter-name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name. .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are ldap.Ldap.create\_ldap, - Paths used are post /ldap/, - Does not support \ :literal:`check\_mode`\ - The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco ISE SDK - The parameters starting with ise\_ are used by the Cisco ISE Python SDK to establish the connection .. Seealso .. Examples Examples -------- .. code-block:: yaml+jinja - name: Create cisco.ise.ldap: ise_hostname: "{{ise_hostname}}" ise_username: "{{ise_username}}" ise_password: "{{ise_password}}" ise_verify: "{{ise_verify}}" state: present attributes: attributes: - defaultValue: ' ' internalName: whenChanged name: whenChanged type: STRING connectionSettings: alwaysAccessPrimaryFirst: true failbackRetryDelay: 5 failoverToSecondary: true ldapNodeData: - name: ise222 primaryHostname: ipAddress primaryPort: 389 secondaryHostname: ipAddress secondaryPort: 389 - name: ise223 primaryHostname: ipAddress primaryPort: 389 secondaryHostname: ipAddress secondaryPort: 389 primaryServer: adminDN: cn=administrator,cn=users,dc=ise,dc=com adminPassword: Lab@123 enableForceReconnect: false enableSecureConnection: false enableServerIdentityCheck: false forceReconnectTime: 20 hostName: '' issuerCACertificate: '' maxConnections: 20 port: 389 serverTimeout: 10 trustCertificate: '' useAdminAccess: true secondaryServer: adminDN: cn=administrator,cn=users,dc=ise,dc=com adminPassword: Lab@123 enableForceReconnect: false enableSecureConnection: false enableServerIdentityCheck: false forceReconnectTime: 20 hostName: '' issuerCACertificate: '' maxConnections: 20 port: 389 serverTimeout: 10 trustCertificate: '' useAdminAccess: true specifyServerForEachISENode: true description: Description directoryOrganization: groupDirectorySubtree: groupDirectorySubtree macFormat: DASH prefixSeparator: \ stripPrefix: false stripSuffix: false suffixSeparator: ' ' userDirectorySubtree: userDirectorySubtree enablePasswordChangeLDAP: false generalSettings: certificate: userCertificate groupMapAttributeName: memberOf groupMemberReference: USERNAME groupNameAttribute: dn groupObjectClass: Group groupReference: GROUP_TO_USER schema: ACTIVE_DIRECTORY userInfoAttributes: country: co department: department email: email firstName: givenName lastName: sn locality: l organizationalUnit: company stateOrProvince: st streetAddress: streetAddress telephone: telephoneNumber userNameAttribute: userPrincipalName userObjectClass: Person groups: groupsNames: - CN=TestLDAP,CN=Users,DC=ISE,DC=COM name: sample .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.ise.ldap_module__return-ise_response: .. rst-class:: ansible-option-title **ise_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco ISE Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"[\\n {\\n \\"id\\": \\"string\\",\\n \\"name\\": \\"string\\",\\n \\"description\\": \\"string\\",\\n \\"link\\": {\\n \\"rel\\": \\"string\\",\\n \\"href\\": \\"string\\",\\n \\"type\\": \\"string\\"\\n }\\n }\\n]\\n"` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors