profile ldap-sync
Use this command to configure synchronization with your directory server via LDAP. Synchronization can be regularly scheduled, or on demand.
Each contact is identified by its email address. If a new contact is created on the directory server, then synchronization adds it to the address book. If the same contact already exists in the address book, then synchronization updates it with current data from the directory server. If the contact does not exist on the directory server, then synchronization deletes that contact from the address book.
|
This command is only available if either:
|
Syntax
config profile ldap-sync
edit <profile_name>
[set description "<description_str>"]
set domain <protected-domain_name>
set ldap-profile <profile_name>
set sync-mode {full | incremental}
set recurrence {daily | month | none | weekly}
{set schedule-weekday {monday | tuesday | wednesday | thursday | friday | saturday | sunday}
set schedule-date {1..31} }
end
|
Variable |
Description |
Default |
|
Enter the name of the profile. |
|
|
|
Enter a description or comment. |
|
|
|
Select the protected domain whose address book you want to synchronize, or leave this setting empty to synchronize the global address book ( Note: Once the LDAP synchronization task is created, this selection cannot be changed. |
|
|
|
Select an LDAP profile that defines the base query and connection to the directory server. |
|
|
|
Select an LDAP attribute-to-address-book mapping that defines which contact information will be synchronized. |
|
|
|
Select the time interval between each LDAP synchronization. If you select Otherwise, select when FortiMail automatically synchronizes: also configure schedule-hour {0..23}, schedule-weekday {monday | tuesday | wednesday | thursday | friday | saturday | sunday}, and schedule-date {1..31}. |
none |
|
|
Enter the day of the month when LDAP synchronization will occur. This setting is available only when recurrence {daily | month | none | weekly} is |
|
|
|
Enter the hour of the day, according to a 24-hour clock, when LDAP synchronization will occur. |
1 |
|
|
schedule-weekday {monday | tuesday | wednesday | thursday | friday | saturday | sunday} |
Enter the day of the week when LDAP synchronization will occur. This setting is available only when recurrence {daily | month | none | weekly} is |
|
|
Enable or disable this LDAP synchronization task. |
enable |
|
|
Select how much to synchronize from the directory to the address book, either:
For example, you might have both a daily incremental sync task (it's smaller, so it can run every night), and also a full sync task (it runs every weekend). |
incremental |