(Opcional) Instalação do Session Manager Plugin para AWS CLI

Se quiser usar a AWS CLI para iniciar e encerrar sessões que se conectam às suas instâncias gerenciadas, primeiro será necessário instalar o Session Manager plugin em sua máquina local. O plug-in pode ser instalado em versões compatíveis do Microsoft Windows, macOS, Linux e Ubuntu Server.

Usar a versão mais recente do Session Manager Plugin

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

Pré-requisitos de instalação

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

Instalar a Session Manager Plugin no Windows

Você pode instalar o Session Manager plugin 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 Session Manager plugin.

nota

Para obter melhores resultados, recomendamos iniciar sessões em clientes Windows usando o aplicativo do Windows PowerShell versão 5 ou posterior. No Microsoft Windows 10, o prompt de comando também fornece suporte confiável para as operações do Session Manager.

Instalar o Session Manager plugin usando o instalador EXE

1. Baixe o instalador usando a seguinte URL:

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

2. Execute o instalador obtido por download e siga as instruções na tela.

   Deixe a caixa local de instalação em branco para instalar o plug-in para o diretório padrão:

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

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

   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 Session Manager Plugin não é adicionado automaticamente ao caminho de linha de comando (Windows).

Instalar e desinstalar o Session Manager Plugin no macOS

Você pode instalar o Session Manager plugin no macOS usando o Bundled Installer.

Importante

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

Instalar o Session Manager plugin usando o pacote de instalador (macOS)

1. Faça download do Bundled Installer:

   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

   A plug-in requer o Python 2.6.5 ou posterior ou o 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 Session Manager plugin, 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 a Session Manager plugin 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 informações, consulte Verificar a instalação do Session Manager Plugin.

nota

Se você não deseja desinstalar o plug-in, execute os seguintes comandos, um de cada vez:

sudo rm -rf /usr/local/sessionmanagerplugin

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

Instale Session Manager Plugin no Linux

1. Faça download do pacote RPM do Session Manager plugin:

   • 64 bits:

     curl "https://s3.amazonaws.com/session-manager-downloads/plugin/latest/linux_64bit/session-manager-plugin.rpm" -o "session-manager-plugin.rpm"

   • 32 bits:

     curl "https://s3.amazonaws.com/session-manager-downloads/plugin/latest/linux_32bit/session-manager-plugin.rpm" -o "session-manager-plugin.rpm"

   • ARM de 64 bits:

     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 informações, consulte Verificar a instalação do Session Manager Plugin.

nota

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

Instale a Session Manager Plugin no Ubuntu Server

1. Faça download do pacote deb do Session Manager plugin:

   • 64 bits:

     curl "https://s3.amazonaws.com/session-manager-downloads/plugin/latest/ubuntu_64bit/session-manager-plugin.deb" -o "session-manager-plugin.deb"

   • 32 bits:

     curl "https://s3.amazonaws.com/session-manager-downloads/plugin/latest/ubuntu_32bit/session-manager-plugin.deb" -o "session-manager-plugin.deb"

   • ARM de 64 bits:

     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 informações, consulte Verificar a instalação do Session Manager Plugin.

nota

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

Verificar a instalação do Session Manager Plugin

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

session-manager-plugin

Se a instalação foi bem-sucedida, a seguinte mensagem é 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 a instância de destino usando Session Manager.

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

(Opcional) Habilitar o registro em log do Session Manager Plugin

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

Se você habilitar o registro, o Session Manager plugin cria arquivos de log para ambas as atividades (session-manager-plugin.log) e erros (errors.log) do aplicativo em sua máquina local.

Tópicos

• Ativar o registro em log para o Session Manager Plugin (Windows)
• Ativar o registro em log para o Session Manager Plugin (Linux e macOS)

Ativar o registro em log para o Session Manager Plugin (Windows)

1. Localize o arquivo seelog.xml.template para o plug-in.

   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 arquivo ou o registro não funcionará corretamente.

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

Ativar o registro em log para o Session Manager Plugin (Linux e macOS)

1. Localize o arquivo seelog.xml.template para o plug-in.

   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 arquivo 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 plug-in 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 versões do Session Manager Plugin

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

A versão mínima compatível atual é 1.1.17.0.

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 plug-in 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 plug-in.

session-manager-plugin --version

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

Versão	Data de lançamento	Detalhes
1.1.61.0	17 de abril de 2020	Melhoria: adicionado suporte do ARM para Linux e Ubuntu Server.
1.1.54.0	6 de janeiro de 2020	Correção de erros: lidar com cenário de condição de corrida de pacotes que estão sendo descartados quando o Session Manager plugin não está 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 Agente do SSM 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 Gerenciador de sessões.
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 Session Manager plugin.