sync-cmd
コマンドと Google Cloud Directory Sync (GCDS) を使用して、コマンドラインから同期を実行できます。
コマンドラインから同期を実行するタイミング
設定または設定変更を行うときは、最初に設定マネージャーから手動による同期を実行する必要があります。この操作により、データが適切に同期され、正しい状態にあることを確認することができます。詳しくは、手動による同期の実行をご覧ください。
設定変更が完了したら、コマンドラインを使用して同期プロセスを自動化できます。任意のスケジュール設定や必要なバッチ スクリプトに同期を組み込むことができます。また、サードパーティ製ツールを使用して同期を自動化することもできます。詳しくは、自動同期のスケジュール設定をご覧ください。
コマンドラインを使用する
GCDS のインストール ディレクトリから、sync-cmd
コマンドを 1 行で入力して実行します。以下に示すコマンド引数を使用して、次のような一連のアクションを実行できます。
- 検出されたすべての変更を適用します。
- 指定したファイルを読み込む。
- ロギングの詳細レベルを設定する。
ヒント: 使用できるコマンド引数に関する情報を表示するには、sync-cmd -h
コマンドを実行します。
コマンドの引数と例
コマンドの引数引数(いずれかのオプションを使用) | 説明 |
---|---|
-a |
検出されたすべての変更を適用します。
注: この引数を使用しない場合、同期はテストとしてのみ実行され、Google アカウントに変更は加えられません。最適な結果を得るには、この引数を使用せずにテスト同期を実行してから、この引数を使用して完全な同期を実行します。 |
-c |
読み込む XML 構成ファイルを指定します。
重要: この引数には、有効な XML ファイルを含める必要があります。詳しくは、設定ファイルの使い方をご覧ください。 |
-cs |
カスタム スキーマを除外します。
この引数は、ユーザーのカスタム スキーマデータを同期しない場合に使用します。 |
-d |
設定されている削除制限を無視します。 |
-f |
同期を実行する前に、Google アカウントのデータのキャッシュを消去します。
重要: 適切に使用しないと、パフォーマンスの低下を招くことがあります。この引数は、サポートチームから指示されない限り使用しないでください。 |
-g |
グループを除外します。
ユーザーは同期対象にするものの、グループは対象から除外する場合にこの引数を使用してください。 |
-h |
ヘルプ情報を表示した後、終了します。 |
-l |
デフォルトのログレベルまたは設定されているログレベルを、指定した値でオーバーライドします。有効な値は、ログレベルが高い(情報量が少ない)ものから順に FATAL、ERROR、WARN、INFO、DEBUG、TRACE です。
ログレベルは、ほとんどの場合、INFO に設定することをおすすめします。 |
-lic |
ライセンスを除外します。
この引数は、ユーザーのライセンス データを同期しない場合に使用します。 |
-o |
すべての同期の実行を、XML 構成ファイル 1 つにつき 1 インスタンスに制限します。これにより、スケジューラや cron ジョブなどで複数のインスタンスが誤って実行されるのを防ぎます。引数は、 トラブルシューティングを行うには、GCDS でコマンドラインから同期できない理由についての記事をご覧ください。 |
-ou |
組織部門を除外します。 |
-r |
レポートをログに書き込むほか、指定した出力ファイルに書き込みます。 |
-s |
共有の連絡先を除外します。 |
-u |
ユーザーを除外します。
グループは同期対象にするものの、ユーザーは対象から除外する場合にこの引数を使用してください。 |
-v |
アプリケーションの簡単なバージョン情報を表示します。 |
-V |
アプリケーションの詳細なバージョン情報を表示します。ただし、同期は行いません。 |
窓
例 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 の商標です。その他すべての企業名および商品名は、関連各社の商標または登録商標です。