使用命令行进行同步

您可以使用 sync-cmd 命令和 Google Cloud Directory Sync (GCDS) 来通过命令行运行同步。

何时使用命令行进行同步

设置或修改配置时,您应该通过配置管理器执行一次手动同步,以便检查已同步的数据并确保其准确无误。有关详情,请参阅执行手动同步

更改完配置之后,您就可以使用命令行完成自动同步流程。您可以在任何要使用的调度脚本和批处理脚本中加入同步命令。您也可以使用第三方工具安排自动同步。有关详情,请参阅安排自动同步

使用命令行

请在 GCDS 安装目录中运行 sync-cmd 命令,而且该命令需在单独的一行内输入。您可以使用下文所列的命令参数执行一系列操作,例如:

  • 应用所检测到的任何更改
  • 读取指定的文件。
  • 设置日志的详细程度。

提示:您可以输入 sync-cmd -h,查看可用命令参数的相关信息。

命令参数和示例

全部展开  |  全部收起并转至页首

命令参数
参数(使用任一选项) 说明
-a
--apply
应用检测到的任何更改。

注意:如果您没有使用此参数,则系统只会以测试的方式运行同步,不会对您的 Google 网域进行任何更改。为了获得最佳效果,请先在不使用此参数的情况下运行测试性同步,然后再使用此参数运行完整同步。

-c
--config
file-name
指定要加载的 XML 配置文件。

重要提示:您必须使用此参数添加有效的 XML 文件。有关详情,请参阅使用配置文件

-cs
--customschemas
排除自定义架构。

如果您不想为用户同步自定义架构数据,请使用此选项。

-d
--deletelimits
忽略已配置的删除限制。
-f
--flush
在运行同步之前,清除 Google 帐号数据的缓存副本。

重要提示:使用不当可能会导致性能下降。除非支持团队引导您使用此选项,否则请勿使用。

-g
--groups
排除群组。

如果您想同步用户(而不是群组),请使用此选项。

-h
--help
显示帮助信息和退出。
-l
--loglevel
使用特定值覆盖默认或已配置的日志等级。有效的值为 FATAL、ERROR、WARN、INFO、DEBUG 和 TRACE(按照详细程度递增排列)。

在大多数情况下,我们建议您将日志级别设置为“INFO”。

-lic
--license
排除许可。

如果您不希望为用户同步许可数据,请使用此选项。

-o
--oneinstance

将正在运行的任意同步限制为每个 XML 配置文件只有一个实例。这样可以防止多个实例意外运行(例如通过调度程序或 Cron 作业运行)。此参数仅在使用 -a 参数时有效。

要排查问题,请参阅 GCDS 为什么没有按照命令行运行同步?

-ou
--orgunit
排除组织部门。
-r
--report-out
除日志外,也会将报告写入指定的输出文件中。
-s
--sharedcontacts
排除共享联系人。
-u
--users
排除用户。

如果您想要同步群组(而不是用户),请使用此选项。

-v 显示简要的应用版本信息。
-V 显示详细的应用版本信息,但不进行同步。
示例

Windows

示例 1:使用 XML 配置文件 (C:\Users\user\gdcs-config.xml) 运行模拟同步:

sync-cmd -c C:\Users\user\gdcs-config.xml

示例 2:使用 XML 配置文件 (C:\Users\user\gdcs-config.xml) 运行完整同步,包括应用所检测到的任何更改:

sync-cmd -a -c C:\Users\user\gdcs-config.xml

Linux

示例 1:使用 XML 配置文件 (/path/gcds-config.xml) 运行模拟同步:

sync-cmd -c /path/gcds-config.xml

示例 2:使用 XML 配置文件 (/path/gcds-config.xml) 运行完整同步,包括应用所检测到的任何更改:

sync-cmd -a -c /path/gcds-config.xml

查看退出代码

从命令行运行同步或模拟后,您会获得以下某个退出代码:

  • 0 - 同步已完成,且没有任何同步问题,所有修改均不超过配置的限制。
  • 255 - 模拟已完成。或者,同步已完成,但存在同步问题,例如超出配置限制的修改或用户同步失败。

后续步骤

您应该定期检查通知邮件,从而监控所有同步。有关详情,请参阅设置通知


“Google”、Google Workspace 以及相关标志和徽标是 Google LLC 的商标。其他所有公司名和产品名是其各自相关公司的商标。

该内容对您有帮助吗?

您有什么改进建议?
搜索
清除搜索内容
关闭搜索框
主菜单
1088661076910358857
true
搜索支持中心
true
true
true
false
false