安装和使用 ADSync 实用工具

本文包含以下主题：

通过本文可快速了解安装、配置和运行 ADSync 实用工具的过程。要将 ADSync 实用工具与 ServiceAide Cloud Service Management 应用程序相集成，请执行本文中介绍的任务。

先决条件

在 ServiceAide Cloud Service Management 中创建纪录的组织结构，然后再开始使用 ADSync 实用工具。如果缺少组织结构，不会将用户映射到其相应的组织。
在安装 ADSync 实用工具的系统上安装最新版本的 Java（版本 8 或更高版本）。
系统具有与 Active Directory（可以安装在 AD 服务器本身）的网络连接。

安装

请执行以下步骤：

在 ServiceAide Cloud Service Management 中的“下载”部分下载 ADSync 实用工具。导航到“管理”、“管理”、“工具”、“下载”。
在 Active Directory (AD) 上创建可以访问 Active Directory 服务器并在其上运行查询的帐户。
解压缩 ADSync 文件夹。
在解压缩 ADSync 实用工具的系统上，修改环境变量路径。导航到“我的电脑”、“高级设置”、“环境变量”、“路径”。
将路径设置为 JRE 安装的安装 bin 目录。

任何情况下都不要修改文件夹结构。

有关更多详细信息，请参阅“ADSync 实用工具入门”。

配置

要配置 ADSync 实用工具，请执行以下步骤：

配置文件

ADSync 实用工具在安装目录 \AdsyncUtility\ad-user-sync\conf 文件夹中包含三个配置文件。文件包括：

sync.properties：

该文件包含承租人信息。更新以下参数：

LDAP GC 和 LDAP DC：这些值通常相同。将这些值更改为您的 AD 服务器或域控制器。
示例：
# 全局目录服务器
ldap.gc=ldap://localhost:3268
# 域控制器服务器
ldap.dc=ldap://localhost:389
Authtoken 和 slicetoken：当您下载 ADSync 实用工具时，这些值会自动填充。请勿编辑该值。如果不慎编辑这些值，则请重新下载 ADSync 实用工具。
action.url：该 action.url 是应用程序实例的 URL。下载 ADSync 实用工具时将自动填充该值。请勿编辑该值。如果不慎编辑该值，则请重新下载 ADSync 实用工具。
注意：对于大型事务，支持团队可为您提供应用程序的直接 URL 来解决超时问题。仅当出现此类情况时，方可手动更新该属性。
LDAP 绑定凭据 = LDAP 绑定凭据是您在 AD 中创建的服务帐户。
send.data：此参数确定是否将数据传送到 Cloud Service Management.。将此值设置为 Yes。但是，运行 ADSync 实用工具进行诊断时可以将其设置为 No。

有关 sync.properties 文件的详细信息，请参阅“配置 ADSync 实用工具”并查找 sync.properties。

searchBase.list：

应用程序依次浏览每个组织单位 (OU)，并根据搜索条件查找用户。输入您想进行同步的容器的 DN。
示例：
OU=HR,DC=ForwardInc,DC=ca,DC=com
ADSync 实用工具将 HR 组织中的用户同步到具有以下搜索基础的应用程序。
如果该文件为空，实用工具会提取 LDAP 服务器中的所有数据。

attribute_map.list：

此文件用于将 AD 中的字段与 ServiceAide Cloud Service Management 中的字段相映射。采用以下格式，通过将应用程序属性与其相应的 AD 属性相映射来配置它：
CSM 属性 = AD 属性

有关这些文件和属性的详细信息，请参阅“配置 ADSync 实用工具”并查找 attribute_map.list。

为 ADSync 配置 SSL

要为 ADSync 实用工具启用 SSL 环境，请执行以下步骤：

在浏览器地址栏中单击应用程序 URL 旁的“查看站点信息”图标（锁状图标）。
导航到“证书”、“详细信息”，然后单击“复制到文件”。
单击“下一步”，然后将格式设为“.DER 编码二进制 X.509 (.CER)”。
单击“下一步”，输入文件名称，然后保存该文件。
单击“下一步”，验证路径，然后单击“完成”。
将保存的证书文件复制到 ADSync 根 (ad-user-sync\) 位置。
导航到 ad-user-sync\ 位置。
通过在 ad-user-sync 位置运行以下命令，将已保存的证书文件导入到 ADSync 本地 keystore si：
Keytool –import –trustcacerts –alias aliasname –keystore si –file saved_certificate_file_name.cer
1. 提示输入密码时，请使用 itmaas。
2. 别名名称可以是任何内容，例如，CSM-AD-connection。
3. 命令成功运行后，ad-user-sync 位置中会创建文件名称 si。

有关详细的配置信息，请参阅“配置 ADSync 实用工具”。

运行 ADSync 实用工具

您可以测试 ADSync 实用工具，而无需实际将数据发送到 ServiceAide Cloud Service Management。将 sync.properties 文件中的 send.data 属性设置为 No。

从 <安装目录>\ADSyncUtility\ad-user-sync\script\sync.bat 运行批处理文件。

该命令的输出会在 <安装目录>\ADSyncUtility\ad-user-sync\sync\logs 的 sync_data.log 文件中显示。

您可以查看这些日志，以验证 ADSync 是否按预期运行。测试结束后，请将 send.data 属性重置为 Yes。

可以使用 Microsoft Windows 任务计划程序将该实用工具排定为每日运行。

下图说明了 ADSync 实用工具的工作方式：

有关更多详细信息，请参阅“ADSync 实用工具入门”。

故障排除信息

可在以下文档中确定并解决同步故障：

同步数据日志文件：完成同步后，CSM 会生成写入到 <安装目录>\sync\logs\sync_data.log.0 的 XML 文件。可以在此处查看同步期间发生的任何错误。
备份文件：在以下位置生成备份文件：
<安装目录>\sync\backup
备份文件存储了上次成功同步之后写入数据中的更改。

有关故障排除提示的详细信息，请参阅“ADSync 实用工具错误故障排除”。