Fortinet white logo
Fortinet white logo

CLI Reference

profile ldap-mapping

profile ldap-mapping

Use this command to configure LDAP mapping profiles. These map LDAP attributes to the equivalent field of contacts in the FortiMail address book.

Before you configure the LDAP mapping, if required, on your LDAP server, configure the schema so that it works with a FortiMail LDAP profile query. For details, see the FortiMail Administration Guide. Also test the query results. If it contains data that you do not want to import into the address book, then you must configure filter <query-filter_str>.

To apply the LDAP attribute mapping, select it either while importing contacts on demand, or in a regularly scheduled address book synchronization.

This command is only available if either:

Syntax

config profile ldap-mapping

edit <profile_name>

[set comment "<comment_str>"]

set filter <query-filter_str>

config contact-attribute-mapping

edit <mapping_int>

set contact-attribute {email(WORK | display_name | ...}

set ldap-attribute <attribute_str>

next

end

next

end

Variable

Description

Default

<profile_name>

Enter the name of the profile.

contact-attribute {email(WORK | display_name | ...}

Select an attribute in FortiMail webmail address book contacts (such as display_name) that you want to map to ldap-attribute <attribute_str>.

Note: The email(WORK) attribute must be mapped because it identifies the entry in the address book. Other attributes may be required too, depending on which information you want to synchronize:

  • display_name
  • first_name
  • last_name
  • nick_name
  • company
  • job_title
  • phonenumbers
  • phone(MOBILE)
  • addresses
  • Any additional custom fields

comment "<comment_str>"

Enter a description or comment.

filter <query-filter_str>

If the query in the LDAP profile returns some results that you do not want to import into the address book, enter an LDAP query filter.

For example, to select only results that have an email address, the filter might be:

(mail=*)

ldap-attribute <attribute_str>

Select the name of the LDAP attribute on the directory server that corresponds to the contact-attribute {email(WORK | display_name | ...}.

For example, the cn (common name) LDAP attribute might be mapped to display_name.

<mapping_int>

Enter the number identifying the contact field that will be synchronized.

Related topics

profile ldap

profile ldap-sync

profile ldap-mapping

profile ldap-mapping

Use this command to configure LDAP mapping profiles. These map LDAP attributes to the equivalent field of contacts in the FortiMail address book.

Before you configure the LDAP mapping, if required, on your LDAP server, configure the schema so that it works with a FortiMail LDAP profile query. For details, see the FortiMail Administration Guide. Also test the query results. If it contains data that you do not want to import into the address book, then you must configure filter <query-filter_str>.

To apply the LDAP attribute mapping, select it either while importing contacts on demand, or in a regularly scheduled address book synchronization.

This command is only available if either:

Syntax

config profile ldap-mapping

edit <profile_name>

[set comment "<comment_str>"]

set filter <query-filter_str>

config contact-attribute-mapping

edit <mapping_int>

set contact-attribute {email(WORK | display_name | ...}

set ldap-attribute <attribute_str>

next

end

next

end

Variable

Description

Default

<profile_name>

Enter the name of the profile.

contact-attribute {email(WORK | display_name | ...}

Select an attribute in FortiMail webmail address book contacts (such as display_name) that you want to map to ldap-attribute <attribute_str>.

Note: The email(WORK) attribute must be mapped because it identifies the entry in the address book. Other attributes may be required too, depending on which information you want to synchronize:

  • display_name
  • first_name
  • last_name
  • nick_name
  • company
  • job_title
  • phonenumbers
  • phone(MOBILE)
  • addresses
  • Any additional custom fields

comment "<comment_str>"

Enter a description or comment.

filter <query-filter_str>

If the query in the LDAP profile returns some results that you do not want to import into the address book, enter an LDAP query filter.

For example, to select only results that have an email address, the filter might be:

(mail=*)

ldap-attribute <attribute_str>

Select the name of the LDAP attribute on the directory server that corresponds to the contact-attribute {email(WORK | display_name | ...}.

For example, the cn (common name) LDAP attribute might be mapped to display_name.

<mapping_int>

Enter the number identifying the contact field that will be synchronized.

Related topics

profile ldap

profile ldap-sync