メンテナンス モード

メンテナンス モードを有効化して Orchestrator のアクティビティを停止し、メンテナンス前に IIS を安全にシャットダウンします

Maintenance Mode provides a simplified and pain-free solution for stopping all Orchestrator activity and shutting down IIS when needed, such as undertaking maintenance or upgrading your Orchestrator instance.

This is useful for all installations, but especially for large deployments with numerous active schedules and many jobs processing at all times.

注:

メンテナンス モードを使用できるのは host 組織だけであり、このモードには Orchestrator の API からしかアクセスできません。詳しくは、『 Orchestrator API ガイド』をご覧ください。

メンテナンス モードを使用するには:

1. /api/Maintenance/Start 呼び出しを使用し、phase パラメーターに Draining を選択して、Pending Maintenance モードを有効化します。その間の状態は次のとおりです。
   • Robot と Orchestrator の通信は引き続き有効です (つまり、ログがアップロードされ、キュー アイテムが追加されます)。
   • 新しいジョブは作成できません。
   • 実行中のすべてのジョブに Stop コマンドが送信されます。
   • すべてのスケジュールが一時停止します。
   • メンテナンス中は、Orchestrator のインターフェイスを誰も使用できなくなります。
     注:

     完了しないジョブや、完了するまでに非常に長い時間がかかるジョブがある場合は、それ以外のすべてのジョブに killJobs パラメーターを使用して Kill コマンドを送信する機能があります。

2. 実行中のすべてのジョブが停止したら、/api/Maintenance/Start 呼び出しを使用し、フェーズパラメーターで [中断] を選択して、メンテナンス モードを有効化します。その間、ロボットから Orchestrator への通信は、すべて停止します。
3. この段階で、IIS をシャットダウンして、メンテナンスや更新などの必要な作業を開始することができます。停止、再起動、アップグレードのいずれの操作を実行しても、メンテナンス モードは手動でオフに切り替えるまで維持されます。
4. メンテナンス作業がすべて完了したら、IIS と Orchestrator を再起動します。
5. /api/Maintenance/End エンドポイントを使用してメンテナンス モードを終了します。
   1. https://<orchestrator-url>/identity に移動し、ホスト管理者アカウントでサインインします。
   2. Orchestrator Swagger のページを開き [Authorize] を選択して、同じホスト管理者アカウントで認証します。
   3. /api/Maintenance/End エンドポイントを使用して、メンテナンス モードをオフにします。
   • メンテナンス モードで実行されるようにスケジュールされたジョブの実行はすべてスキップされます。
   • メンテナンス ログが各テナントに対して作成されます。ログには、すべての停止/強制終了されたジョブとスキップされたトリガーの実行に関する情報が要約されています。
     注:

     メンテナンス ログには、api/Maintenance/Get 呼び出しを使用してテナント レベルでしかアクセスできず、そのテナントに固有のジョブやスケジュールの詳細のみが記録されます。