(選用) 為 AWS CLI 安裝 Session Manager 外掛程式 - AWS Systems Manager

(選用) 為 AWS CLI 安裝 Session Manager 外掛程式

如果您想要使用 AWS Command Line Interface (AWS CLI) 開始和結束連接到您受管節點的工作階段,您必須先在本機電腦上安裝 Session Manager 外掛程式。您可以安裝外掛程式在受支援版本的 Microsoft Windows、macOS、Linux、和 Ubuntu Server。

使用 Session Manager 外掛程式的最新版本

Session Manager 外掛程式偶爾會更新以增強功能。我們建議您定期確保使用最新版本的外掛程式。如需詳細資訊,請參閱 Session Manager 外掛程式最新版本和版本歷史記錄

安裝先決條件

AWS CLI 版本 1.16.12 或更新版本必須安裝在本機機器,以便使用 Session Manager 外掛程式。

在 Windows 上安裝 Session Manager 外掛程式

您可以在 Microsoft Windows Vista 或更新版本使用獨立安裝程式安裝 Session Manager 外掛程式。

當發佈更新時,您必須重複安裝過程以獲取最新版本的 Session Manager 外掛程式。

注意

為了獲得最佳結果,我們建議您在開始工作階段時在 Windows 用戶端使用 Windows PowerShell 版本 5 或更新版本。或者,您可以在 Microsoft Windows 10 中使用命令 shell。Session Manager 外掛程式只支援 PowerShell 和命令 shell。第三方命令列工具可能與外掛程式不相容。

使用 EXE 安裝程式安裝 Session Manager 外掛程式

  1. 使用以下 URL 下載安裝程式。

    https://s3.amazonaws.com/session-manager-downloads/plugin/latest/windows/SessionManagerPluginSetup.exe

    或者,您可以使用下列 URL 下載壓縮版的安裝程式。

    https://s3.amazonaws.com/session-manager-downloads/plugin/latest/windows/SessionManagerPlugin.zip
  2. 執行下載的安裝程式,並遵循畫面上的指示操作。如果您已下載壓縮版的安裝程式,則必須先解壓縮安裝程式。

    保留安裝位置方塊空白以便安裝外掛程式預設的目錄。

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

  3. 確認已安裝成功。如需相關資訊,請參閱 驗證 Session Manager 外掛程式安裝

    注意

    如果 Windows 無法找到可執行檔,則可能需要手動重新開啟命令提示或手動將安裝目錄新增到您的 PATH 環境變數 如需詳細資訊,請參閱疑難排解主題 Session Manager 外掛程式未自動新增到命令列路徑 (Windows)

在 macOS 上安裝和解除安裝 Session Manager 外掛程式

您可以在 macOS 上使用連線的安裝程式安裝 Session Manager 外掛程式。

重要

Bundled Installer 無法安裝到包含空格的路徑。

使用 Bundled Installer (macOS) 安裝 Session Manager 外掛程式

  1. 下載 Bundled Installer。

    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 外掛程式,請使用該版本按 Python 可執行檔的絕對路徑來執行安裝指令碼。以下是範例。

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

    安裝程式會將 Session Manager 外掛程式安裝到 /usr/local/sessionmanagerplugin,並在 /usr/local/bin 目錄中建立符號連結 session-manager-plugin。這讓您無須在使用者的 $PATH 變動指定安裝的目錄。

    若要參閱 -i-b 選項的說明,請使用 -h 選項。

    ./sessionmanager-bundle/install -h
  4. 確認已安裝成功。如需相關資訊,請參閱 驗證 Session Manager 外掛程式安裝

注意

如果您想要解除安裝外掛程式,請執行以下兩個命令,按顯示的順序執行命令。

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

在 macOS 上安裝 Session Manager 外掛程式與已簽署的安裝程式

您可以在 macOS 上使用已簽署的安裝程式安裝 Session Manager 外掛程式。

若要使用已簽署的安裝程式安裝 Session Manager 外掛程式 (macOS)

  1. 下載已簽署的安裝程式。

    curl "https://s3.amazonaws.com/session-manager-downloads/plugin/latest/mac/session-manager-plugin.pkg" -o "session-manager-plugin.pkg"
  2. 執行安裝命令。

    sudo installer -pkg session-manager-plugin.pkg -target / sudo ln -s /usr/local/sessionmanagerplugin/bin/session-manager-plugin /usr/local/bin/session-manager-plugin
  3. 確認已安裝成功。如需相關資訊,請參閱 驗證 Session Manager 外掛程式安裝

在 Linux 上安裝 Session Manager 外掛程式

  1. 下載 Session Manager 外掛程式 RPM 套件。

    • Intel 64-bit (x86_64)

      curl "https://s3.amazonaws.com/session-manager-downloads/plugin/latest/linux_64bit/session-manager-plugin.rpm" -o "session-manager-plugin.rpm"
    • Intel 32-bit (x86)

      curl "https://s3.amazonaws.com/session-manager-downloads/plugin/latest/linux_32bit/session-manager-plugin.rpm" -o "session-manager-plugin.rpm"
    • ARM 64-bit (arm64)

      curl "https://s3.amazonaws.com/session-manager-downloads/plugin/latest/linux_arm64/session-manager-plugin.rpm" -o "session-manager-plugin.rpm"
  2. 執行安裝命令。

    sudo yum install -y session-manager-plugin.rpm
  3. 確認已安裝成功。如需相關資訊,請參閱 驗證 Session Manager 外掛程式安裝

注意

如果您想要解除安裝外掛程式,請執行 sudo yum erase session-manager-plugin -y

在 Ubuntu Server 上安裝 Session Manager 外掛程式

  1. 下載 Session Manager 外掛程式 deb 套件。

    • Intel 64-bit (x86_64)

      curl "https://s3.amazonaws.com/session-manager-downloads/plugin/latest/ubuntu_64bit/session-manager-plugin.deb" -o "session-manager-plugin.deb"
    • Intel 32-bit (x86)

      curl "https://s3.amazonaws.com/session-manager-downloads/plugin/latest/ubuntu_32bit/session-manager-plugin.deb" -o "session-manager-plugin.deb"
    • ARM 64-bit (arm64)

      curl "https://s3.amazonaws.com/session-manager-downloads/plugin/latest/ubuntu_arm64/session-manager-plugin.deb" -o "session-manager-plugin.deb"
  2. 執行安裝命令。

    sudo dpkg -i session-manager-plugin.deb
  3. 確認已安裝成功。如需相關資訊,請參閱 驗證 Session Manager 外掛程式安裝

注意

如果您想要解除安裝外掛程式,請執行 sudo dpkg -r session-manager-plugin

驗證 Session Manager 外掛程式安裝

執行下列命令來驗證 Session Manager 外掛程式是否安裝成功:

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

GitHub 上的 Session Manager 外掛程式

可在 GitHub 上使用 Session Manager 外掛程式的原始碼,以便您可以調整外掛程式以符合您的需求。我們建議您為想要進行的變更提交提取請求。但是,Amazon Web Services 不支援執行修改過的軟體複本。

(選用) 開啟 Session Manager 外掛程式日誌

Session Manager 外掛程式包含一個選項讓您能夠記錄執行的工作階段。根據預設,會關閉日誌。

如果您啟用記錄,Session Manager 外掛程式在本機電腦上應用程式活動建立兩個日誌檔 (session-manager-plugin.log) 和錯誤 (errors.log)。

開啟 Session Manager 外掛程式的日誌 (Windows)

  1. 找出 seelog.xml.template 檔案的外掛程式。

    預設位置為 C:\Program Files\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:\Program Files\Amazon\SessionManagerPlugin\Logs\session-manager-plugin.log" maxsize="30000000" maxrolls="5"/> <filter levels="error,critical" formatid="fmterror"> <rollingfile type="size" filename="C:\Program Files\Amazon\SessionManagerPlugin\Logs\errors.log" maxsize="10000000" maxrolls="5"/>
  5. 儲存檔案。

啟用 Session Manager 外掛程式的日誌記錄 (Linux 和 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 外掛程式最新版本和版本歷史記錄

您的本機電腦必須在支援 Session Manager 外掛程式的版本上執行。目前最低的支援版本為 1.1.17.0。如果您執行之前的版本,您的 Session Manager 操作可能不會成功。

若要查看如果您是否有最新的版本,請在 AWS CLI 執行下列命令。

注意

只在外掛程式位於您作業系統類型適用的預設安裝目錄位置中,此命令才會傳回結果。您也可以透過在您已安裝外掛程式的目錄中 VERSION 檔案的內容檢查版本。

session-manager-plugin --version

下表列出所有 Session Manager 外掛程式的版本及每個版本包含的功能及加強功能。

版本 發行日期 詳細資訊
1.2.295.0

2022 年 1 月 12 日

錯誤修正:當代理程式處於非作用狀態時,用戶端重新傳送串流資料導致的工作階段停止回應,以及 start_publicationpause_publication 訊息的不正確日誌。
1.2.279.0

2021 年 10 月 27 日

增強功能:適用於 Windows 平台的 zip 封裝。
1.2.245.0

2021 年 8 月 19 日

改進:將 aws-sdk-go 升級至最新版本 (1.40.17 版),以支援單一登入 (SSO)。
1.2.234.0

2021 年 7 月 26 日

錯誤修正:處理交互式工作階段類型中的工作階段突然終止的情況。
1.2.205.0

2021 年 6 月 10 日

改進:已新增對簽署的 macOS 安裝程式的支援。
1.2.54.0

2021 年 1 月 29 日

改進:已新增在 NonInteractiveCommands 執行模式下執行工作階段的支援。
1.2.30.0

2020 年 11 月 24 日

改進:(僅限連接埠轉送工作階段) 提高了整體效能。

1.2.7.0

2020 年 10 月 15 日

改進:(僅限連接埠轉送工作階段) 降低了延遲並提高了整體效能。

1.1.61.0

2020 年 4 月 17 日

增強功能:新增支援適用於 Linux 和 Ubuntu Server 的 ARM。

1.1.54.0

2020 年 1 月 6 日

錯誤修正:處理封包在 Session Manager 外掛程式尚未就緒時受到捨棄的競爭條件情況。

1.1.50.0

2019 年 11 月 19 日

增強:新增將埠轉送至本機 unix 通訊端的支援。

1.1.35.0

2019 年 11 月 7 日

增強:(僅限埠轉送工作階段) 當本機使用者按下 Ctrl+C 時,傳送 TerminateSession 命令至 SSM Agent。

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 外掛程式初始版本。