リモートメンテナンス

概要

デバイス(エージェント実行環境として利用する環境も含む)のメンテナンスを行うために、enebular-agentをインストールしたデバイスにSSHログインを可能とする機能を提供します。
本機能を利用するとデバイスがローカルネットワークに存在している場合であってもローカルネットワークの外からSSHログインできるようになります。

リモートメンテナンスを行う際に必要となる構成要素を下表に示します。

要素 説明
デバイス リモートメンテナンスの対象となるデバイスです。
enebular-agentのVer 2.9.0以上が稼働している必要があります。
作業用PC ユーザがデバイスに対してSSH接続するために利用するPCです。
SSH Clientがインストール済みである必要があります。
中継サーバ グローバルIPを持ち、SSHサーバが稼働するサーバです。
作業用PCからデバイスへのSSH接続を中継するために利用します。
本サーバは、リモートメンテナンスをオンにしたときにenebularが準備します。

本機能は有料プロジェクトでのみ利用できます。

説明

前提条件

リモートメンテナンスの前提条件を列挙します。

  • リモートメンテナンスの対象デバイスにライセンスが付与されていること
  • リモートメンテナンスの対象デバイスのステータスが接続中であること

環境構築

SSHのキーを生成

enebularの画面からリモートメンテナンス用のキーを作成します。
キーを作成できるのは、プロジェクトの所有者のみです。
キーを作成したときに、プロジェクトの所有者へキーを作成したことを知らせるメールが送信されます。

  1. enebular画面の左側のメニューにある設定をクリックします
  2. リモートメンテナンスの欄に表示するキーペアの生成ボタンを押下します
  3. 確認ダイアログを表示するのでキーを作成してもよろしければ作成ボタンを押下します
  4. 以下のキーのダウンロードリンクを表示しますので、ダウンロードします
    • device-<id>.key: 作業用PCでSSH接続時に利用するデバイスの秘密鍵

ダウンロードしたキーは、リモートメンテナンスで必要となるため、関係者以外への漏洩や紛失に注意して大切に保管してください。
キーの漏洩が疑われる場合は、再度キーを作成することで、現行のキーを無効化できます。

作業用PCへのキーの配置

作業用PCにdevice-<id>.keyをコピーします。
作業用PCにはSSH Clientをインストール済みであることが前提であり、コピーしたファイルはSSH Clientが利用します。

メンテナンス手順

リモートメンテナンスを行うときの手順を説明します。
リモートメンテナンスのオン/オフの切り替えは、プロジェクトの所有者および管理者のみ実施できます。

まず、enebularの画面からリモートメンテナンス可能な状態に切り替えます。コネクション経由で接続したデバイスの場合とエージェント実行環境の場合で手順が異なります。

コネクション経由で接続したデバイスの場合

  1. enebular画面の左側に表示されているサイドメニューのデバイスをクリックします
  2. メンテナンスしたいデバイスが含まれるコネクション名をクリックします
  3. 表示したデバイス一覧からメンテナンス対象のデバイスを探し、クリックします
  4. 表示されたデバイス詳細画面のリモートメンテナンス欄のトグルボタンを押下します
  5. トグルボタンがオンの状態(緑)に変わり、SSH接続用のコマンドが表示されたら作業用PCからSSH接続可能な状態になったことを表します

エージェント実行環境の場合

  1. enebular画面の左側に表示されているサイドメニューのエージェント実行環境をクリックします
  2. メンテナンスしたいエージェント実行環境をクリックします
  3. エージェント実行環境の設定タブをクリックします
  4. リモートメンテナンス欄のトグルボタンを押下します
  5. トグルボタンがオンの状態(緑)に変わり、SSH接続用のコマンドが表示されたら作業用PCからSSH接続可能な状態になったことを表します

次に、作業用PCからデバイスに対して画面に表示されるコマンドでSSH接続を行います。
作業用PCへのキーの配置の手順で、作業用PCへコピーした有効なdevice-<id>.keyをSSH接続で利用します。 SSH接続で利用する鍵は、環境構築時に作業用PCへコピーしたdevice-<id>.keyを利用します。
以下でSSH接続用のコマンドについて説明します。

ssh -i <path to key>*1 [email protected]<IP Address>*2 -p <Port Numbar>*3

*1: device-<id>.keyの配置場所を指定してください。作業用PCのホームディレクトリにdevice-<id>.keyを置いた場合、<path to key>~/device-<id>.keyを指定してください
*2: 中継サーバのIPアドレスが表示されます
*3: 中継サーバへの接続で利用するポート番号(49152~65535のうち、1つ)が表示されます

device-<id>.keyの権限設定や配置場所によっては、SSH接続コマンド実行時に権限エラーが発生します。
権限エラーが発生した場合、以下を確認してください。

  • 作業用PCがWindowsの場合、ユーザーフォルダー(%UserProfile%)配下にdevice-<id>.keyを配置するようにしてください
  • 作業用PCがLinux/macOSの場合、device-<id>.keyの権限を600または400に設定してください

メンテナンスが完了したらenebularのデバイス詳細画面からリモートメンテナンスのトグルボタンをオフにすることが可能です。

オン/オフ切り替え履歴の確認

リモートメンテナンスのオン/オフ切り替えの実施者や実施時刻を実行履歴画面から確認できます。

enebular画面の左側メニューの実行履歴をクリックするとユーザが実施したActionのリストを表示します。

以下のAction Typeがリモートメンテナンスのオン/オフのActionです。

  • オン: Start Remote M.
  • オフ: Stop Remote M.

Triggered ByRequestedを参照することにより、実施者や実施時刻を確認できます。

利用制限時間

リモートメンテナンスでは、プロジェクトごとに、月単位の利用制限時間が設定されています(エージェント実行環境の利用上限についてはエージェント実行環境の管理を参照ください)。
利用制限時間は、プロジェクトに割り当てられる利用時間*1と、ライセンスが登録されたデバイスの、月中の最大数*2から計算されます。

*1: 100時間
*2: 1デバイス(またはエージェント実行環境)あたり、10時間

利用制限時間までの残り時間は、デバイス詳細画面のリモートメンテナンス欄のRemaining timeに表示されます。
Remaining timeは、デバイス詳細画面を表示してから20分間はリアルタイムで表示の更新が行われますが、それ以降は更新されません。 利用制限時間を超過して利用した分については、利用料金を請求させて頂きます。

エンタープライズプラン/トライアルプランの場合は、利用制限時間を超過しないための注意喚起として、利用制限時間までの残り時間が20時間以下になったことをenebularが検知したときに、プロジェクトの所有者へ利用制限時間超過前の警告メールを送信します(フリープランの場合、警告メールを送信しません)。

利用制限時間を超過している状態でリモートメンテナンスをオンにしようとしたときは、警告ダイアログを表示します。
警告ダイアログでOKボタンをクリックした場合、リモートメンテナンスがオンとなり、プロジェクトの所有者と実行したユーザへ利用制限時間超過通知メールを送信します。
警告ダイアログでCancelボタンをクリックした場合、リモートメンテナンスはオンになりません。

使用状況の確認

リモートメンテナンスの利用時間や利用制限時間を使用状況画面から確認できます。

使用状況の詳細については、使用状況を参照してください。

注意事項

  • リモートメンテナンスの利用時間は、SSH接続中の時間ではなく、リモートメンテナンスがオンになったときから加算されます。そのため、メンテナンスの必要がないときは、リモートメンテナンスをオフにしてください。
  • リモートメンテナンスがオンになってから8時間経過したことをenebularが検知したとき、リモートメンテナンスは自動的にオフとなり、SSH接続が切断されますのでご注意ください。
  • リモートメンテナンスがオンになってからデバイスの電源が切れていることをenebularが検知したとき、リモートメンテナンスは自動的にオフとなります。
  • エンタープライズプラン/トライアルプランでは、利用制限時間超過前の警告メールを1ヵ月で1度のみ送信します。たとえば、ライセンス登録したデバイス数が増えたことにより利用制限時間が増えた後、再度、利用制限時間までの残り時間が20時間以下になった場合、メールは送信されません。
  • エージェント実行環境の場合は、フリープランでもリモートメンテナンスを利用できます。フリープランの制限時間はプロジェクトあたり1ヵ月で10時間まで利用できます。利用制限時間に近づいても警告メールは送信されません。

results matching ""

    No results matching ""