AWS Systems Manager
ユーザーガイド

(オプション) AWS CLI 用の Session Manager Plugin をインストールする

AWS CLI を使用してマネージドインスタンスに接続するセッションを開始および終了する場合は、まずローカルマシンに Session Manager plugin をインストールする必要があります。このプラグインは、Microsoft Windows、macOS、Linux、および Ubuntu Server のサポートされているバージョンにインストールできます。

最新バージョンの Session Manager Plugin を使用する

プラグインは、機能強化のために時々更新されます。プラグインの最新バージョンを使用していることを定期的に確認することをお勧めします。詳細については、「 Session Manager Plugin 最新バージョンとリリース履歴」を参照してください。

インストールの前提条件

Session Manager plugin を使用するには、ローカルマシンに AWS CLI バージョン 1.16.12 以降がインストールされている必要があります。

Windows に Session Manager Plugin をインストールする

スタンドアロンインストーラを使用して、Microsoft Windows Vista 以降に Session Manager plugin をインストールできます。

更新がリリースされたときは、最新バージョンの Session Manager plugin を取得するため、インストールプロセスを繰り返す必要があります。

注記

最良の結果を得るには、Windows PowerShell アプリケーションのバージョン 5 以降を使用して、Windows クライアントでセッションを開始することをお勧めします。Microsoft Windows 10 では、コマンドプロンプトでも信頼性の高い Session Manager の操作のサポートを提供しています。

EXE インストーラを使用して Session Manager plugin をインストールするには

  1. 次の URL を使用してインストーラをダウンロードします。

    https://s3.amazonaws.com/session-manager-downloads/plugin/latest/windows/SessionManagerPluginSetup.exe
  2. ダウンロードしたインストーラを実行し、画面の指示に従います。

    インストール先のボックスを空白のままにして、プラグインをデフォルトディレクトリにインストールします。

    • C:\%PROGRAMFILES%\Amazon\SessionManagerPlugin\bin\

  3. インストールが成功したことを確認します。詳細については、Session Manager Plugin のインストールを検証する を参照してください。

    注記

    Windows が実行ファイルを見つけることができない場合、コマンドプロンプトを再度開くか、または手動でインストールディレクトリを PATH 環境変数に追加します。詳細については、トラブルシューティングトピック「Session Manager Plugin がコマンドラインパスに自動的に追加されない (Windows)」を参照してください。

macOS で Session Manager Plugin をインストールおよびアンインストールする

バンドルされたインストーラを使用して、macOS に Session Manager plugin をインストールできます。

重要

バンドルされたインストーラでは、スペースを含むパスへのインストールはサポートされていません。

バンドルされたインストーラを使用して Session Manager plugin をインストールするには (macOS)

  1. バンドルされたインストーラをダウンロードします。

    curl "https://s3.amazonaws.com/session-manager-downloads/plugin/latest/mac/sessionmanager-bundle.zip" -o "sessionmanager-bundle.zip"
  2. パッケージを解凍します。

    unzip sessionmanager-bundle.zip
  3. インストールコマンドを実行します。

    sudo ./sessionmanager-bundle/install -i /usr/local/sessionmanagerplugin -b /usr/local/bin/session-manager-plugin

    注記

    プラグインには Python 2.6.5 以降または Python 3.3 が必要です。デフォルトでは、インストールスクリプトはシステムのデフォルトバージョンの Python で実行されます。別のバージョンの Python がインストールされており、それを使用して Session Manager plugin をインストールする場合は、Python の実行可能ファイルへの絶対パスを指定してそのバージョンでインストールスクリプトを実行します。以下に例を示します。

    sudo /usr/local/bin/python3.6 sessionmanager-bundle/install -i /usr/local/sessionmanagerplugin -b /usr/local/bin/session-manager-plugin

    インストーラは Session Manager plugin を /usr/local/sessionmanagerplugin にインストールし、シンボリックリンク session-manager-plugin/usr/local/bin ディレクトリに作成します。これにより、ユーザーの $PATH 変数にインストールディレクトリを指定する必要がなくなります。

    -i オプションおよび -b オプションの説明を表示するには、-h オプションを使用します。

    ./sessionmanager-bundle/install -h
  4. インストールが成功したことを確認します。詳細については、Session Manager Plugin のインストールを検証する を参照してください。

注記

プラグインをアンインストールする必要がある場合は、次の 2 つのコマンドを一度に 1 つずつ実行します。

sudo rm -rf /usr/local/sessionmanagerplugin
sudo rm /usr/local/bin/session-manager-plugin

Linux に Session Manager Plugin をインストールする

  1. Session Manager plugin RPM パッケージをダウンロードします。

    • 64 ビット:

      curl "https://s3.amazonaws.com/session-manager-downloads/plugin/latest/linux_64bit/session-manager-plugin.rpm" -o "session-manager-plugin.rpm"
    • 32 ビット:

      curl "https://s3.amazonaws.com/session-manager-downloads/plugin/latest/linux_32bit/session-manager-plugin.rpm" -o "session-manager-plugin.rpm"
  2. インストールコマンドを実行します。

    sudo yum install -y session-manager-plugin.rpm
  3. インストールが成功したことを確認します。詳細については、Session Manager Plugin のインストールを検証する を参照してください。

注記

プラグインをアンインストールする必要がある場合は、sudo yum erase session-manager-plugin -y を実行します。

Ubuntu Server に Session Manager Plugin をインストールする

  1. Session Manager plugin deb パッケージをダウンロードします。

    • 64 ビット:

      curl "https://s3.amazonaws.com/session-manager-downloads/plugin/latest/ubuntu_64bit/session-manager-plugin.deb" -o "session-manager-plugin.deb"
    • 32 ビット:

      curl "https://s3.amazonaws.com/session-manager-downloads/plugin/latest/ubuntu_32bit/session-manager-plugin.deb" -o "session-manager-plugin.deb"
  2. インストールコマンドを実行します。

    sudo dpkg -i session-manager-plugin.deb
  3. インストールが成功したことを確認します。詳細については、Session Manager Plugin のインストールを検証する を参照してください。

注記

プラグインをアンインストールする必要がある場合は、sudo dpkg -r session-manager-plugin を実行します。

Session Manager Plugin のインストールを検証する

Session Manager plugin が正常にインストールされたことを確認するには、次のコマンドを実行します。

session-manager-plugin

インストールが成功すると、次のメッセージが返されます。

The Session Manager plugin is installed successfully. Use the AWS CLI to start a session.

AWS CLI で次のコマンドを実行してインストールをテストすることもできます。

注記

このコマンドは、Session Manager を使用してターゲットインスタンスにアクセスするために必要な、IAM アクセス権限を Session Manager の管理者が付与した場合にのみ機能します。

aws ssm start-session --target id-of-an-instance-you-have-permissions-to-access

(オプション) Session Manager Plugin ログ記録を有効にする

Session Manager plugin には、実行するセッションのログ記録を有効にするオプションが含まれています。ログ記録はデフォルトでは無効になっています。

ログ記録を有効にすると、Session Manager plugin は、ローカルマシン上のアプリケーションアクティビティ (session-manager-plugin.log) とエラー (errors.log) のログファイルを作成します。

Session Manager Plugin のログ記録を有効にする (Windows)

  1. プラグインの seelog.xml.template ファイルを探します。

    デフォルトの場所は C:\%PROGRAMDATA%\Amazon\SessionManagerPlugin\seelog.xml.template です。

  2. ファイルの名前を seelog.xml に変更します。

  3. ファイルを開き、minlevel="off"minlevel="info" または minlevel="debug" に変更します。

    注記

    デフォルトでは、データチャネルのオープンとセッションの再接続に関するログエントリは、INFO レベルで記録されます。データフロー (パケットおよび送達確認) エントリは、DEBUG レベルで記録されます。

  4. 変更が必要なその他の設定オプションを変更します。変更できるオプションには、次のようなものがあります。

    • デバッグレベル: デバッグレベルを formatid="fmtinfo" から outputs formatid="fmtdebug" に変更することができます。

    • ログファイルのオプション: ログファイルの保存場所を含むログファイルオプションを変更できます (ログファイル名を除く)。

      重要

      ファイル名を変更しないでください。ログが正しく機能しなくなります。

      <rollingfile type="size" filename="C:\%PROGRAMDATA%\Amazon\SessionManagerPlugin\Logs\session-manager-plugin.log" maxsize="30000000" maxrolls="5"/> <filter levels="error,critical" formatid="fmterror"> <rollingfile type="size" filename="C:\%PROGRAMDATA%\Amazon\SessionManagerPlugin\Logs\errors.log" maxsize="10000000" maxrolls="5"/>
  5. ファイルを保存します。

Session Manager Plugin のログ記録を有効にする (Linux and macOS)

  1. プラグインの seelog.xml.template ファイルを探します。

    デフォルトの場所は /usr/local/sessionmanagerplugin/seelog.xml.template です。

  2. ファイルの名前を seelog.xml に変更します。

  3. ファイルを開き、minlevel="off"minlevel="info" または minlevel="debug" に変更します。

    注記

    デフォルトでは、データチャネルのオープンとセッションの再接続に関するログエントリは、INFO レベルで記録されます。データフロー (パケットおよび送達確認) エントリは、DEBUG レベルで記録されます。

  4. 変更が必要なその他の設定オプションを変更します。変更できるオプションには、次のようなものがあります。

    • デバッグレベル: デバッグレベルを formatid="fmtinfo" から outputs formatid="fmtdebug" に変更することができます。

    • ログファイルのオプション: ログファイルの保存場所を含むログファイルオプションを変更できます (ログファイル名を除く)。

      重要

      ファイル名を変更しないでください。ログが正しく機能しなくなります。

      <rollingfile type="size" filename="/usr/local/sessionmanagerplugin/logs/session-manager-plugin.log" maxsize="30000000" maxrolls="5"/> <filter levels="error,critical" formatid="fmterror"> <rollingfile type="size" filename="/usr/local/sessionmanagerplugin/logs/errors.log" maxsize="10000000" maxrolls="5"/>

      重要

      ログを保存するために指定されたデフォルトのディレクトリを使用する場合は、sudo を使用してセッションコマンドを実行するか、プラグインがインストールされているディレクトリに完全な読み取りおよび書き込みのアクセス権限を与える必要があります。これらの制限を回避するには、ログを保存する場所を変更します。

  5. ファイルを保存します。

Session Manager Plugin 最新バージョンとリリース履歴

ローカルマシンで、Session Manager plugin のサポートされているバージョンを実行している必要があります。それ以前のバージョンを実行している場合、Session Manager 操作は失敗する可能性があります。

現在サポートされている最小バージョンは 1.1.17.0 です。

最新リリースはバージョン 1.1.33.0 です。

最新バージョンを使用しているかどうかを確認するには、AWS CLI で次のコマンドを実行します。

注記

このコマンドは、プラグインがご使用のオペレーティングシステムタイプのデフォルトのインストールディレクトリにある場合にのみ結果を返します。プラグインをインストールしたディレクトリの、VERSION ファイルのコンテンツでバージョンを確認することもできます。

session-manager-plugin --version

次の表は、Session Manager plugin のすべてのリリースと、各バージョンに含まれている機能や機能強化を示しています。

バージョン リリース日 詳細
1.1.33.0 2019 年 9 月 26 日 機能強化:(ポート転送セッションのみ)クライアントが TCP 接続を中断したときに、サーバーに切断信号を送信します。
1.1.31.0 2019 年 9 月 6 日 機能強化: リモートサーバーが接続を閉じるまでポート転送セッションを開いたままにするための更新です。

1.1.26.0

2019 年 7 月 30 日

機能拡張: セッション中のデータ転送速度を制限します。

1.1.23.0

2019 年 7 月 9 日

機能拡張: Session Manager を使用して SSH セッションを実行するためのサポートを追加します。

1.1.17.0 2019 年 4 月 4 日

機能強化: AWS Key Management Service (AWS KMS) を使用してセッションデータをさらに暗号化するためのサポートを追加します。

1.0.37.0 2018 年 9 月 20 日

機能強化: Windows バージョンのバグ修正。

1.0.0.0 2018 年 9 月 11 日

Session Manager plugin の初回リリース。