@@ -488,49 +488,69 @@ OpenLDAP)
488488 :header-rows: 1
489489
490490 * - Setting
491- - OpenLDAP
492- - Active Directory
491+ - OpenLDAP / Active Directory
493492 - Description
494493 * - ``ldap.basedn ``
495- - `Ex: OU=APAC, DC=company, DC=com `
496- - `Ex: DC=company, DC=com `
497- - Sets the basedn for LDAP.
494+ - ``OU=APAC,DC=company,DC=com ``
495+ - Sets the base DN for LDAP searches.
498496 * - ``ldap.search.group.principle ``
499- - `Ex: CN=ACSGroup, DC=company, DC=com `
500- - `Ex: CN=ACSGroup, CN=Users, DC=company, DC=com `
501- - (optional) if set only Users from this group are listed.
497+ - ``CN=ACSGroup,DC=company,DC=com ``
498+ - *(Optional) * If set, only users belonging to this group are listed.
502499 * - ``ldap.bind.principal ``
503- - `Ex: CN=ACSServiceAccount, OU=APAC, DC=company, DC=com `
504- - ` Ex: CN=ACSServiceAccount, CN=Users, DC=company, DC=com `
505- - Service account that can list all the Users in the above basedn. Avoid using privileged account such as Administrator.
500+ - `` CN=ACSServiceAccount,OU=APAC,DC=company,DC=com ` `
501+ - Service account used to list users under the configured base DN.
502+ Avoid using privileged accounts such as `` Administrator `` .
506503 * - ``ldap.bind.password ``
507- - `****************** `
508- - `****************** `
509- - Password for a DN User. Is entered in plain text but gets stored encrypted.
504+ - ``**************** ``
505+ - Password for the bind DN. Entered in plain text but stored encrypted.
510506 * - ``ldap.user.object ``
511- - ` interorgperson `
512- - ` user `
513- - Object type of Users within LDAP .
507+ - * OpenLDAP: `` inetOrgPerson ` `
508+ * Active Directory: `` user ` `
509+ - LDAP object class representing user accounts .
514510 * - ``ldap.email.attribute ``
515- - `mail `
516- - `mail `
517- - Email attribute within ldap for a User.
511+ - ``mail ``
512+ - Attribute used to retrieve the user email address.
518513 * - ``ldap.firstname.attribute ``
519- - `givenname `
520- - `givenname `
521- - firstname attribute within ldap for a User.
514+ - ``givenName ``
515+ - Attribute used to retrieve the user first name.
522516 * - ``ldap.lastname.attribute ``
523- - `sn `
524- - `sn `
525- - lastname attribute within ldap for a User.
517+ - ``sn ``
518+ - Attribute used to retrieve the user last name.
526519 * - ``ldap.group.object ``
527- - ` groupOfUniqueNames `
528- - ` groupOfUniqueNames `
529- - Object type of groups within LDAP .
520+ - * OpenLDAP: `` groupOfUniqueNames ` `
521+ * Active Directory: `` group ` `
522+ - LDAP object class representing groups .
530523 * - ``ldap.group.user.uniquemember ``
531- - `uniquemember `
532- - `uniquemember `
533- - Attribute for uniquemembers within a group.
524+ - ``uniqueMember ``
525+ - Attribute defining user membership within a group.
526+ * - ``ldap.username.attribute ``
527+ - * OpenLDAP: ``uid ``
528+ * Active Directory: ``sAMAccountName ``
529+ - Sets the username attribute used within LDAP.
530+ * - ``ldap.nested.groups.enable ``
531+ - ``true ``
532+ - If true, nested groups will also be queried.
533+ * - ``ldap.provider ``
534+ - * OpenLDAP: ``openldap ``
535+ * Active Directory: ``microsftad ``
536+ - LDAP provider (e.g. ``openldap ``, ``microsoftad ``).
537+
538+
539+
540+ Restart CloudStack Management Services
541+
542+
543+ After updating the configuration, restart the CloudStack Management Server:
544+
545+ .. code-block :: bash
546+
547+ systemctl restart cloudstack-management
548+
549+ Notes
550+
551+
552+ * Configuration changes do not take effect until the management service is restarted.
553+
534554
535555 .. note :: ``ldap.search.group.principle`` is required when using ``linkaccounttoldap``.
536556
@@ -573,9 +593,6 @@ LDAP server. This trust is established by importing the LDAP server certificate
573593into a Java truststore and configuring CloudStack to use that truststore for LDAP
574594communication.
575595
576- This procedure uses the **manual certificate import method ** used for LDAP/LDAPS
577- integration in CloudStack and Microsoft AD.
578-
579596Retrieve the LDAP Server Certificate
580597
581598
@@ -653,51 +670,9 @@ Example path:
653670
654671 /etc/cloudstack/management/cloudstack-ldap-truststore.jks
655672
656- Configure CloudStack LDAP Settings
657673
658- Configure the following LDAP-related settings in the global settings:
659-
660- .. list-table :: LDAP Settings (Active Directory)
661- :header-rows: 1
662-
663- * - Setting
664- - Active Directory
665- - Description
666- * - ``ldap.basedn ``
667- - ``DC=company,DC=com ``
668- - Sets the base DN for LDAP searches.
669- * - ``ldap.search.group.principle ``
670- - ``CN=ACSGroup,CN=Users,DC=company,DC=com ``
671- - *(Optional) * If set, only users belonging to this group are listed.
672- * - ``ldap.bind.principle ``
673- - ``CN=ACSServiceAccount,CN=Users,DC=company,DC=com ``
674- - Service account used to list users under the configured base DN.
675- Avoid using privileged accounts such as ``Administrator ``.
676- * - ``ldap.bind.password ``
677- - ``**************** ``
678- - Password for the bind DN. Entered in plain text but stored encrypted.
679- * - ``ldap.user.object ``
680- - ``user ``
681- - LDAP object class representing user accounts.
682- * - ``ldap.email.attribute ``
683- - ``mail ``
684- - Attribute used to retrieve the user email address.
685- * - ``ldap.firstname.attribute ``
686- - ``givenName ``
687- - Attribute used to retrieve the user first name.
688- * - ``ldap.lastname.attribute ``
689- - ``sn ``
690- - Attribute used to retrieve the user last name.
691- * - ``ldap.group.object ``
692- - ``groupOfUniqueNames ``
693- - LDAP object class representing groups.
694- * - ``ldap.group.user.uniquemember ``
695- - ``uniqueMember ``
696- - Attribute defining user membership within a group.
697674
698-
699-
700- Restart CloudStack Management Services
675+ Restart CloudStack Management Services after updating the global settings.
701676
702677
703678After updating the configuration, restart the CloudStack Management Server:
@@ -710,14 +685,11 @@ Notes
710685
711686
712687* Configuration changes do not take effect until the management service is restarted.
713- * This procedure as it is applies to the **manual LDAP certificate import method ** used by
714- CloudStack bt can be referenced for other methods as well.
715688* Certificate renewal on the LDAP server requires repeating this procedure and
716689 redeploying the updated truststore.
717690
718691
719692
720-
721693Using a SAML 2.0 Identity Provider for User Authentication
722694----------------------------------------------------------
723695
0 commit comments