(Opcional) Instale o plugin do Session Manager para a AWS CLI - AWS Systems Manager

(Opcional) Instale o plugin do Session Manager para a AWS CLI

Se você quiser usar o AWS Command Line Interface (AWS CLI) para iniciar e encerrar sessões que se conectam aos seus nós gerenciados, primeiro será necessário instalar o plugin do Session Manager em sua máquina local. O plugin pode ser instalado em versões compatíveis do Microsoft Windows, macOS, Linux e Ubuntu Server.

Usar a versão mais recente do plugin do Session Manager

O plugin do Session Manager é atualizado ocasionalmente com funcionalidade aprimorada. Recomendamos que você verifique regularmente que está usando a versão mais recente do plugin. Para mais informações, consulte Versão mais recente e histórico de lançamentos do plugin Session Manager.

Pré-requisitos de instalação

A AWS CLI versão 1.16.12 ou posterior deve ser instalada na máquina local para usar o plugin do Session Manager.

Instalar o plugin do Session Manager no Windows

Você pode instalar o plugin do Session Manager no Microsoft Windows Vista ou posterior usando o instalador independente.

Quando as atualizações são lançadas, repita o processo de instalação para instalar a versão mais recente do plugin do Session Manager.

nota

Para obter melhores resultados, recomendamos iniciar sessões em clientes Windows usando a aplicação do Windows PowerShell versão 5 ou posterior. Como alternativa, use o shell de comando no Microsoft Windows 10. O plugin do Session Manager é compatível apenas com o PowerShell e o shell de comando. Ferramentas da linha de comando de terceiros podem não ser compatíveis com o plugin.

Para instalar o plugin do Session Manager usando o instalador EXE

  1. Baixe o instalador usando a seguinte URL:

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

    Como alternativa, você pode baixar uma versão compactada do instalador usando o seguinte URL:

    https://s3.amazonaws.com/session-manager-downloads/plugin/latest/windows/SessionManagerPlugin.zip
  2. Execute o instalador baixado e siga as instruções na tela. Se você baixou a versão compactada do instalador, você deve descompactar o instalador primeiro.

    Deixe a caixa do local de instalação em branco para instalar o plugin no diretório padrão.

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

  3. Verifique se a instalação foi bem-sucedida. Para obter mais informações, consulte Verifique a instalação do plugin do Session Manager.

    nota

    Se o Windows não consegue encontrar o executável, pode ser necessário abrir o prompt de comando ou adicione o diretório de instalação à sua variável de ambiente PATH manualmente. Para obter informações, consulte o tópico sobre solução de problemas O plugin Session Manager não é adicionado automaticamente ao caminho de linha de comando (Windows).

Instalar e desinstalar o plugin do Session Manager no macOS.

Você pode instalar o plugin Session Manager no macOS usando o instalador integrado.

Importante

O pacote de instalador fornecido não é compatível com a instalação em caminhos com espaços.

Para instalar o plugin Session Manager usando o pacote de instalador (macOS)

  1. Baixe o instalador em pacote.

    curl "https://s3.amazonaws.com/session-manager-downloads/plugin/latest/mac/sessionmanager-bundle.zip" -o "sessionmanager-bundle.zip"
  2. Descompacte o pacote.

    unzip sessionmanager-bundle.zip
  3. Execute o comando de instalação.

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

    O plugin exige Python 2.6.5 ou posterior ou Python 3.3 ou posterior. Por padrão, o script de instalação é executado sob a versão padrão do sistema do Python. Se uma versão diferente do Python estiver instalada, mas deseja usá-la para instalar o plugin do Session Manager, execute o script de instalação com essa versão por caminho absoluto para o Python executável. Veja um exemplo a seguir.

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

    O instalador instala o plugin do Session Manager em /usr/local/sessionmanagerplugin e cria o symlink session-manager-plugin no diretório /usr/local/bin. Isso elimina a necessidade de especificar o diretório de instalação na variável $PATH do usuário.

    Para ver uma explicação das opções -i e -b, use a opção -h.

    ./sessionmanager-bundle/install -h
  4. Verifique se a instalação foi bem-sucedida. Para obter mais informações, consulte Verifique a instalação do plugin do Session Manager.

nota

Se você não deseja desinstalar o plugin, execute os comandos a seguir, um de cada vez.

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

Instale o plugin Session Manager no macOS usando o instalador assinado.

Você pode instalar o plugin Session Manager no macOS usando o instalador assinado.

Para instalar o plugin do Session Manager usando o instalador assinado (macOS)

  1. Baixe o instalador assinado.

    curl "https://s3.amazonaws.com/session-manager-downloads/plugin/latest/mac/session-manager-plugin.pkg" -o "session-manager-plugin.pkg"
  2. Execute o comando de instalação.

    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. Verifique se a instalação foi bem-sucedida. Para obter mais informações, consulte Verifique a instalação do plugin do Session Manager.

Instalar o plugin do Session Manager no Linux

  1. Baixe o pacote RPM do plugin do Session Manager:

    • 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. Execute o comando de instalação.

    sudo yum install -y session-manager-plugin.rpm
  3. Verifique se a instalação foi bem-sucedida. Para obter mais informações, consulte Verifique a instalação do plugin do Session Manager.

nota

Se você não deseja desinstalar o plugin, execute sudo yum erase session-manager-plugin -y

Instalar o plugin do Session Manager no Ubuntu Server

  1. Baixe o pacote deb do plugin do Session Manager:

    • 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. Execute o comando de instalação.

    sudo dpkg -i session-manager-plugin.deb
  3. Verifique se a instalação foi bem-sucedida. Para obter mais informações, consulte Verifique a instalação do plugin do Session Manager.

nota

Se você não deseja desinstalar o plugin, execute sudo dpkg -r session-manager-plugin

Verifique a instalação do plugin do Session Manager

Execute os comandos a seguir para verificar se a instalação do plugin do Session Manager foi bem-sucedida.

session-manager-plugin

Se a instalação foi bem-sucedida, a mensagem a seguir é retornada.

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

Você também pode testar a instalação executando o seguinte comando no AWS CLI.

nota

Esse comando funcionará somente se o administrador do Session Manager tiver concedido as permissões do IAM necessárias para acessar o nó gerenciado de destino usando Session Manager.

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

Plugin Session Manager no GitHub

O código-fonte do plugin do Session Manager está disponível no GitHub e você poderá adaptá-lo de acordo com suas necessidades. Incentivamos você a enviar solicitações pull sobre alterações que gostaria que fosse incluídas. Porém, a Amazon Web Services não oferece suporte à execução de cópias modificadas desse software.

(Opcional) Ative o plugin de registro em log do Session Manager

O plugin do Session Manager inclui uma opção para permitir o registro em log para sessões que você executar. Por padrão, o registro em log está desativado.

Se você permitir o registro em log, o plugin Session Manager criará arquivos de log para ambas as atividades (session-manager-plugin.log) e erros (errors.log) da aplicação em sua máquina local.

Ative o registro em log do plugin do Session Manager (Windows)

  1. Localize o arquivo seelog.xml.template para o plugin.

    O local padrão é C:\Program Files\Amazon\SessionManagerPlugin\seelog.xml.template.

  2. Altere o nome do arquivo para seelog.xml.

  3. Abra o arquivo e altere minlevel="off" para minlevel="info" ou minlevel="debug".

    nota

    Por padrão, as entradas de log sobre como abrir um canal de dados e reconectar sessões são registrados no nível INFO. As entradas de fluxo de dados (pacotes e confirmação) são registradas no nível DEBUG.

  4. Altere outras opções de configuração as quais deseja modificar. As opções que você pode alterar incluem:

    • Depurar nível: você pode alterar o nível de depuração de formatid="fmtinfo" para outputs formatid="fmtdebug".

    • Opções de arquivo de log: você pode fazer alterações nas opções de arquivo de log, incluindo onde os logs são armazenados, com exceção dos nomes dos arquivos.

      Importante

      Não altere os nomes de arquivos ou o registro não funcionará corretamente.

      <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. Salve o arquivo.

Ative o registro em log para o plugin do Session Manager (Linux e macOS)

  1. Localize o arquivo seelog.xml.template para o plugin.

    O local padrão é /usr/local/sessionmanagerplugin/seelog.xml.template.

  2. Altere o nome do arquivo para seelog.xml.

  3. Abra o arquivo e altere minlevel="off" para minlevel="info" ou minlevel="debug".

    nota

    Por padrão, as entradas de log sobre como abrir canais de dados e reconectar sessões são registrados no nível INFO. As entradas de fluxo de dados (pacotes e confirmação) são registradas no nível DEBUG.

  4. Altere outras opções de configuração as quais deseja modificar. As opções que você pode alterar incluem:

    • Depurar nível: você pode alterar o nível de depuração de formatid="fmtinfo" para outputs formatid="fmtdebug"

    • Opções de arquivo de log: você pode fazer alterações nas opções de arquivo de log, incluindo onde os logs são armazenados, com exceção dos nomes dos arquivos.

      Importante

      Não altere os nomes de arquivos ou o registro não funcionará corretamente.

      <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"/>
      Importante

      Se você usar o diretório padrão para armazenar logs, você deve executar comandos de sessão usando sudo ou atribuir o diretório onde o plugin está instalado permissões totais de leitura e gravação. Para ignorar essas restrições, altere o local onde os logs são armazenados.

  5. Salve o arquivo.

Versão mais recente e histórico de lançamentos do plugin Session Manager

Suas máquinas locais devem estar executando uma versão com suporte para o plugin Session Manager. A versão mínima compatível atual é 1.1.17.0. Se você estiver executando uma versão anterior, as operações do Session Manager podem não ser bem-sucedidas.

Para ver se você tem a versão mais recente, execute o seguinte comando no AWS CLI.

nota

O comando retornará resultados somente se o plugin estiver localizado no diretório de instalação padrão do tipo de sistema operacional. Você também pode verificar a versão no conteúdo do arquivo do VERSION no diretório onde você instalou o plugin.

session-manager-plugin --version

A tabela a seguir lista todas as versões do plugin do Session Manager, bem como os recursos e aprimoramentos incluídos em cada versão.

Versão Data de lançamento Detalhes
1.2.295,0

12 de janeiro de 2022

Correção de bugs: sessões suspensas causadas pelo reenvio de dados de fluxo do cliente quando o agente se torna inativo e registros incorretos de mensagens start_publication e pause_publication.
1.2.279,0

27 de outubro de 2021

Aprimoramento: empacotamento em zip para a plataforma Windows.
1.2.245,0

19 de agosto de 2021

Melhoria: atualize o aws-sdk-go para a versão mais recente (v1.40.17) para suporte ao logon único (SSO).
1.2.234,0

26 de julho de 2021

Correção de bugs: administre o encerramento abrupto da sessão no tipo de sessão interativa.
1.2.205,0

10 de junho de 2021

Melhoria: adição de suporte para o instalador do macOS
1.2.54,0

29 de janeiro de 2021

Melhoria: inclusão do suporte a sessões em execução no modo de execução NonInteractiveCommands.
1.2.30.0

24 de novembro de 2020

Melhoria: (somente sessões de encaminhamento de porta) melhoria geral da performance.

1.2.7.0

15 de outubro de 2020

Melhoria: (somente sessões de encaminhamento de porta) latência reduzida e melhoria geral da performance.

1.1.61.0

17 de abril de 2020

Melhoria: adição de suporte do ARM para Linux e Ubuntu Server.

1.1.54.0

6 de janeiro de 2020

Correção de erros: administre a condição de disputa dos pacotes que estão sendo descartados quando o plugin Session Manager ainda não estiver pronto.

1.1.50.0

19 de novembro de 2019

Melhoria: adição de suporte para encaminhar uma porta para um soquete unix local.

1.1.35.0

7 de novembro de 2019

Melhoria: (sessões de encaminhamento de porta somente) envie um comando TerminateSession para o SSM Agent quando o usuário local pressionar Ctrl+C.

1.1.33.0 26 de setembro de 2019 Melhoria: (somente sessões de encaminhamento de porta) envio de um sinal de desconexão para o servidor quando o cliente interromper a conexão TCP.
1.1.31.0 6 de setembro de 2019 Melhoria: atualização para manter a sessão de encaminhamento de porta aberta até que o servidor remoto encerre a conexão.

1.1.26.0

30 de julho de 2019

Melhoria: atualização para limitar a taxa de transferência de dados durante uma sessão.

1.1.23.0

9 de julho de 2019

Melhoria: adição de suporte à execução de sessões SSH usando o Session Manager.

1.1.17.0 4 de abril de 2019

Melhoria: adição de suporte para a criptografia adicional de dados da sessão usando o AWS Key Management Service (AWS KMS).

1.0.37.0 20 de setembro de 2018

Melhoria: correção de erros para a versão do Windows.

1.0.0.0 11 de setembro de 2018

Versão inicial do plugin do Session Manager.