AWSSupport-EnableWindowsEC2SerialConsole - AWS Systems Manager Referência do runbook de automação

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

AWSSupport-EnableWindowsEC2SerialConsole

Descrição

O runbook AWSSupport-EnableWindowsEC2SerialConsole ajuda você a habilitar o Amazon EC2 Serial Console, o Special Admin Console (SAC) e o menu de inicialização em sua instância Windows do Amazon EC2. Com o recurso Amazon Elastic Compute Cloud (Amazon EC2) Serial Console, você tem acesso à porta serial da sua instância do Amazon EC2 para solucionar problemas de inicialização, configuração de rede e outros problemas. O runbook automatiza as etapas necessárias para habilitar o recurso em instâncias em estado de execução e gerenciadas por AWS Systems Manager, bem como naquelas em estado parado ou não gerenciadas por. AWS Systems Manager

Como funciona?

O runbook de AWSSupport-EnableWindowsEC2SerialConsole automação ajuda a habilitar o SAC e o menu de inicialização nas instâncias do Amazon EC2 que executam o Microsoft Windows Server. Para instâncias em estado de execução e gerenciadas por AWS Systems Manager, o runbook executa um PowerShell script AWS Systems Manager Executar comando para ativar o SAC e o menu de inicialização. Para instâncias em estado parado ou não gerenciadas por AWS Systems Manager, o runbook usa o AWSSupport-startEC2 RescueWorkflow para criar uma instância temporária do Amazon EC2 para realizar as alterações necessárias off-line.

Para obter mais informações, consulte Amazon EC2 Serial Console para instâncias do Windows.

Importante

  • Se você habilitar o SAC em uma instância, os serviços do Amazon EC2 que dependem da recuperação de senha não funcionarão no console do Amazon EC2. Para mais informações, consulte Use SAC to troubleshoot your Windows instance (Usar o SAC para solucionar problemas de instâncias do Windows).

  • Para configurar o acesso ao console serial, você deve conceder acesso ao console serial no nível da conta e, em seguida, configurar políticas AWS Identity and Access Management (IAM) para conceder acesso aos seus usuários. Você também deve configurar um usuário com senha em cada instância para que seus usuários possam usar o console serial para solução de problemas. Para obter mais informações, consulte Configurar o acesso ao console serial do Amazon EC2.

  • Para ver se o console serial está ativado em sua conta, consulte Exibir o status de acesso da conta ao console serial.

  • O acesso ao console serial só é suportado em instâncias virtualizadas criadas no Sistema Nitro.

Para obter mais informações, consulte os pré-requisitos do console serial do Amazon EC2.

Tipo de documento

Automação

Proprietário

Amazon

Plataformas

Windows

Parâmetros

Permissões obrigatórias do IAM

O parâmetro AutomationAssumeRole requer as seguintes ações para usar o runbook com êxito.


        {
            "Version": "2012-10-17",
            "Statement": [
                {
                    "Effect": "Allow",
                    "Action": [
                        "autoscaling:DescribeAutoScalingInstances",
                        "ec2:GetSerialConsoleAccessStatus",
                        "ec2:Describe*",
                        "ec2:createTags",
                        "ec2:createImage",
                        "ssm:DescribeAutomationExecutions",
                        "ssm:DescribeInstanceInformation",
                        "ssm:GetAutomationExecution",
                        "ssm:ListCommandInvocations",
                        "ssm:ListCommands"
                    ],
                    "Resource": "*"
                },
                {
                    "Effect": "Allow",
                    "Action": [
                        "ec2:AttachVolume",
                        "ec2:DetachVolume",
                        "ec2:ModifyInstanceAttribute",
                        "ec2:RebootInstances",
                        "ec2:StartInstances",
                        "ec2:StopInstances",
                        "iam:GetInstanceProfile",
                        "ssm:GetParameters",
                        "ssm:SendCommand",
                        "ssm:StartAutomationExecution"
                    ],
                    "Resource": [
                        "arn:${Partition}:ec2:${Region}:${AccountId}:instance/${InstanceId}",
                        "arn:${Partition}:ec2:${Region}:${AccountId}:volume/${VolumeId}",
                        "arn:${Partition}:iam::${AccountId}:instance-profile/${InstanceProfileName}",
                        "arn:${Partition}:ssm:${Region}::parameter/aws/service/*",
                        "arn:${Partition}:ssm:${Region}::automation-definition/AWSSupport-StartEC2RescueWorkflow:*",
                        "arn:${Partition}:ssm:${Region}::document/AWS-ConfigureAWSPackage",
                        "arn:${Partition}:ssm:${Region}::document/AWS-RunPowerShellScript"
                    ]
                },
                {
                    "Effect": "Allow",
                    "Action": [
                        "cloudformation:CreateStack"
                    ],
                    "Resource": "*",
                    "Condition": {
                        "StringLike": {
                            "aws:RequestTag/Name": "AWSSupport-EC2Rescue: *"
                        },
                        "ForAllValues:StringEquals": {
                            "aws:TagKeys": [
                                "AWSSupport-EC2Rescue-AutomationExecution",
                                "Name"
                            ]
                        }
                    }
                },
                {
                    "Effect": "Allow",
                    "Action": [
                        "cloudformation:DeleteStack",
                        "cloudformation:DescribeStackEvents",
                        "cloudformation:DescribeStackResource",
                        "cloudformation:DescribeStacks",
                        "ec2:AttachVolume",
                        "ec2:DetachVolume",
                        "ec2:RebootInstances",
                        "ec2:StopInstances",
                        "ec2:TerminateInstances",
                        "ssm:SendCommand"
                    ],
                    "Resource": "*",
                    "Condition": {
                        "StringLike": {
                            "aws:ResourceTag/Name": "AWSSupport-EC2Rescue: *"
                        }
                    }
                },
                {
                    "Effect": "Allow",
                    "Action": [
                        "ec2:CreateLaunchTemplate",
                        "ec2:DeleteLaunchTemplate",
                        "ec2:RunInstances"                
                    ],
                    "Resource": "*",
                    "Condition": {
                        "ForAnyValue:StringEquals": {
                            "aws:CalledVia": [
                                "cloudformation.amazonaws.com"
                            ]
                        }
                    }
                },
                {
                    "Effect": "Allow",
                    "Action": [
                        "iam:PassRole"
                    ],
                    "Resource": "*",
                    "Condition": {
                        "StringLikeIfExists": {
                            "iam:PassedToService": [
                                "ssm.amazonaws.com",
                                "ec2.amazonaws.com"
                            ]
                        }
                    }
                }
            ]
        }

Instruções

Siga estas etapas para configurar a automação:

  1. Navegue até o AWSSupport-EnableWindowsEC2SerialConsole no AWS Systems Manager console.

  2. Selecione Execute automation (Executar automação).

  3. Para os parâmetros de entrada, insira o seguinte:

    • InstanceId: (Obrigatório)

      O ID da instância do Amazon EC2 que você deseja habilitar para o console serial do Amazon EC2 (SAC) e o menu de inicialização.

    • AutomationAssumeRole: (Opcional)

      O Amazon Resource Name (ARN) da função do IAM que permite que o Systems Manager Automation execute as ações em seu nome. Se nenhuma função for especificada, o Systems Manager Automation usa as permissões do usuário que inicia esse runbook.

    • HelperInstanceType: (Condicional)

      O tipo de instância do Amazon EC2 que o runbook provisiona para configurar o console serial do Amazon EC2 para uma instância offline.

    • HelperInstanceProfileName: (Condicional)

      O nome de um perfil de instância do IAM existente para a instância auxiliar. Se você estiver habilitando o SAC e o menu de inicialização em uma instância que está parada ou não é gerenciada por AWS Systems Manager, isso é necessário. Se um perfil de instância do IAM não for especificado, a automação cria um em seu nome.

    • SubnetId: (Condicional)

      O ID da sub-rede de uma instância auxiliar. Por padrão, ele usa a mesma sub-rede em que a instância fornecida reside.

      Importante

      Se você fornecer uma sub-rede personalizada, ela deverá estar na mesma InstanceId zona de disponibilidade e permitir o acesso aos endpoints do Systems Manager. Isso só é necessário se a instância de destino estiver parada ou não for gerenciada pelo AWS Systems Manager.

    • CreateInstanceBackupBeforeScriptExecution: (Opcional)

      Especifique True para criar um backup da Amazon Machine Images (AMI) da instância do Amazon EC2 antes de ativar o SAC e o menu de inicialização. A AMI persistirá depois da conclusão da automação. É sua responsabilidade proteger o acesso à AMI ou excluí-la.

    • BackupAmazonMachineImagePrefix: (Condicional)

      Um prefixo para a Amazon Machine Image (AMI) que é criado se o CreateInstanceBackupBeforeScriptExecution parâmetro estiver definido como. True

    Input parameters for configuring EC2 serial console, including instance ID and IAM role settings.

  4. Selecione Executar.

  5. A automação é iniciada.

  6. O bucket realiza as seguintes etapas:

    • CheckIfEc2SerialConsoleAccessEnabled:

      Verifica se o acesso ao console serial do Amazon EC2 está habilitado no nível da conta. Nota: O acesso ao console serial não está disponível por padrão. Para obter mais informações, consulte Configurar o acesso ao console serial do Amazon EC2.

    • CheckIfEc2InstanceIsWindows:

      Afirma se a plataforma da instância de destino é o Windows.

    • GetInstanceType:

      Recupera o tipo de instância da instância de destino.

    • CheckIfInstanceTypeIsNitro:

      Verifica se o hipervisor do tipo de instância é baseado em Nitro. O acesso ao console serial só é suportado em instâncias virtualizadas criadas no sistema Nitro.

    • CheckIfInstanceIsInAutoScalingGrupo:

      Verifica se a instância do Amazon EC2 faz parte de um grupo do Amazon EC2 Auto Scaling chamando a API. DescribeAutoScalingInstances Se a instância fizer parte de um grupo do Amazon EC2 Auto Scaling, ela garante que a instância do Porting Assistant para o.NET esteja no estado de ciclo de vida em espera.

    • WaitForEc2InstanceStateStablized:

      Espera que a instância esteja em execução ou parada.

    • GetEc2InstanceState:

      Obtém o estado atual da instância.

    • BranchOnEc2InstanceState:

      Ramificações com base no estado da instância recuperado na etapa anterior. Se esse estado de instância estiver em execução, ele vai para a CheckIfEc2InstanceIsManagedBySSM etapa e, se não, vai para a CheckIfHelperInstanceProfileIsProvided etapa.

    • CheckIfEc2 InstanceIsManagedBy SMS:

      Verifica se a instância é gerenciada pelo AWS Systems Manager. Se gerenciado, o runbook ativa o SAC e o menu de inicialização usando um PowerShell comando Executar.

    • BranchOnPreEC2: RescueBackup

      Ramificações com base no parâmetro CreateInstanceBackupBeforeScriptExecution de entrada.

    • CreateAmazonMachineImageBackup:

      Cria um backup da AMI da instância.

    • Habilite o SAC: AndBootMenu

      Ativa o SAC e o menu de inicialização executando um script PowerShell Executar comando.

    • RebootInstance:

      Reinicializa a instância do Amazon EC2 para aplicar a configuração. Essa é a etapa final se a instância estiver on-line e for gerenciada pelo AWS Systems Manager.

    • CheckIfHelperInstanceProfileIsProvided:

      Verifica se o HelperInstanceProfileName especificado existe antes de ativar o SAC e o menu de inicialização off-line usando uma instância temporária do Amazon EC2.

    • RunAutomationToInjectOfflineScriptForHabilitando o SAC: AndBootMenu

      Executa o AWSSupport-StartEC2RescueWorkflow para ativar o SAC e o menu de inicialização quando a instância está parada ou não é gerenciada pelo AWS Systems Manager.

    • GetExecutionDetails:

      Recupera o ID da imagem do backup e da saída do script offline.

  7. Depois de concluído, revise a seção Saídas para obter os resultados detalhados da execução:

    • Habilite o SAC. Saída: AndBootMenu

      Saída da execução do comando na EnableSACAndBootMenu etapa.

    • GetExecutionDetails.OfflineScriptOutput:

      Saída do script off-line executado na RunAutomationToInjectOfflineScriptForEnablingSACAndBootMenu etapa.

    • GetExecutionDetails.BackupBeforeScriptExecution:

      ID da imagem do backup da AMI obtido se o parâmetro CreateInstanceBackupBeforeScriptExecution de entrada for True.

Saída de execução em uma instância que está sendo executada e gerenciada pelo AWS Systems Manager

Console output showing successful operations and pending execution details.

Saída da execução em uma instância interrompida ou não gerenciada pelo AWS Systems Manager

Console output showing offline script execution details and successful operations.

Referências

Automação do Systems Manager