`AWSSupport-EnableWindowsEC2SerialConsole`

Description

Le runbook vous AWSSupport-EnableWindowsEC2SerialConsole permet d'activer la console série Amazon EC2, la console d'administration spéciale (SAC) et le menu de démarrage sur votre instance Windows Amazon EC2. Grâce à la fonctionnalité de console série Amazon Elastic Compute Cloud (Amazon EC2), vous avez accès au port série de votre instance Amazon EC2 pour résoudre les problèmes de démarrage, de configuration réseau et autres. Le runbook automatise les étapes nécessaires pour activer la fonctionnalité sur les instances en cours d'exécution et gérées par AWS Systems Manager, ainsi que sur celles en état arrêté ou non gérées par. AWS Systems Manager

Fonctionnement

Le manuel AWSSupport-EnableWindowsEC2SerialConsole d'automatisation permet d'activer le SAC et le menu de démarrage sur les instances Amazon EC2 exécutant Microsoft Windows Server. Pour les instances en cours d'exécution et gérées par AWS Systems Manager, le runbook exécute un PowerShell script AWS Systems Manager Run Command pour activer le SAC et le menu de démarrage. Pour les instances à l'état arrêté ou non gérées par AWS Systems Manager, le runbook utilise le AWSSupport-StartEC2 RescueWorkflow pour créer une instance Amazon EC2 temporaire afin d'effectuer les modifications requises hors ligne.

Pour plus d'informations, consultez la console série Amazon EC2 pour les instances Windows.

Important

Si vous activez le SAC sur une instance, les services Amazon EC2 qui reposent sur la récupération du mot de passe ne fonctionneront pas depuis la console Amazon EC2. Pour plus d’informations, consultez Utilisation de SAC pour dépanner votre instance Windows.
Pour configurer l'accès à la console série, vous devez accorder l'accès à la console série au niveau du compte, puis configurer des politiques Gestion des identités et des accès AWS (IAM) pour accorder l'accès à vos utilisateurs. Vous devez également configurer un utilisateur avec mot de passe sur chaque instance afin que vos utilisateurs puissent utiliser la console série pour le dépannage. Pour plus d'informations, consultez Configurer l'accès à la console série Amazon EC2.
Pour savoir si la console série est activée sur votre compte, voir Afficher le statut d'accès du compte à la console série.
L'accès à la console série n'est pris en charge que sur les instances virtualisées basées sur le système Nitro.

Pour plus d'informations, consultez les prérequis relatifs à la console série Amazon EC2.

Type de document

Automatisation

Propriétaire

Amazon

Plateformes

Windows

Paramètres

Autorisations IAM requises

Le AutomationAssumeRole paramètre nécessite les actions suivantes pour utiliser correctement le runbook.

JSON


{
    "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:aws:ec2:us-east-1:111122223333:instance/i-02573cafcfEXAMPLE",
                "arn:aws:ec2:us-east-1:111122223333:volume/vol-049df61146EXAMPLE",
                "arn:aws:iam::111122223333:instance-profile/instance-profile-name",
                "arn:aws:ssm:us-east-1:111122223333:parameter/aws/service/*",
                "arn:aws:ssm:us-east-1:*:document/AWSSupport-StartEC2RescueWorkflow",
                "arn:aws:ssm:us-east-1:*:document/AWS-ConfigureAWSPackage",
                "arn:aws:ssm:us-east-1:*:document/AWS-RunPowerShellScript",
                "arn:aws:ssm:us-east-1:111122223333:automation-execution/*"
            ]
        },
        {
            "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": {
                "StringEquals": {
                    "iam:PassedToService": [
                        "ssm.amazonaws.com",
                        "ec2.amazonaws.com"
                    ]
                }
            }
        }
    ]
}

Instructions

Pour configurer l'automatisation, procédez comme suit :

Accédez au AWSSupport-EnableWindowsEC2SerialConsole dans la AWS Systems Manager console.
Sélectionnez Execute automation (Exécuter l'automatisation).
Pour les paramètres d'entrée, entrez ce qui suit :
- InstanceId: (Obligatoire)
  
  L'ID de l'instance Amazon EC2 sur laquelle vous souhaitez activer la console série Amazon EC2 (SAC) et le menu de démarrage.
- AutomationAssumeRole: (Facultatif)
  
  L'Amazon Resource Name (ARN) du rôle IAM qui permet à Systems Manager Automation d'effectuer les actions en votre nom. Si aucun rôle n'est spécifié, Systems Manager Automation utilise les autorisations de l'utilisateur qui lance ce runbook.
- HelperInstanceType: (Conditionnel)
  
  Type d'instance Amazon EC2 que le runbook fournit pour configurer la console série Amazon EC2 pour une instance hors ligne.
- HelperInstanceProfileName: (Conditionnel)
  
  Nom d'un profil d'instance IAM existant pour l'instance d'assistance. Si vous activez le SAC et le menu de démarrage sur une instance arrêtée ou non gérée par AWS Systems Manager, cela est obligatoire. Si aucun profil d'instance IAM n'est spécifié, l'automatisation en crée un en votre nom.
- SubnetId: (Conditionnel)
  
  ID de sous-réseau pour une instance d'assistance. Par défaut, il utilise le même sous-réseau que celui où réside l'instance fournie.
  
  Important
  Si vous fournissez un sous-réseau personnalisé, il doit se trouver dans la même zone de disponibilité que InstanceId les points de terminaison de Systems Manager et autoriser l'accès à ceux-ci. Cela n'est nécessaire que si l'instance cible est à l'état arrêté ou n'est pas gérée par AWS Systems Manager.
- CreateInstanceBackupBeforeScriptExecution: (Facultatif)
  
  Spécifiez True pour créer une sauvegarde Amazon Machine Images (AMI) de l'instance Amazon EC2 avant d'activer le SAC et le menu de démarrage. L'AMI sera conservée une fois l'automatisation terminée. Il est de votre responsabilité de sécuriser l'accès à l'AMI ou de la supprimer.
- BackupAmazonMachineImagePrefix: (Conditionnel)
  
  Préfixe pour l'Amazon Machine Image (AMI) créé si le CreateInstanceBackupBeforeScriptExecution paramètre est défini sur. True
Sélectionnez Exécuter.
L'automatisation démarre.
Le document exécute les étapes suivantes :
- CheckIfEc2 SerialConsoleAccessEnabled :
  
  Vérifie si l'accès à la console série Amazon EC2 est activé au niveau du compte. Remarque : L'accès à la console série n'est pas disponible par défaut. Pour plus d'informations, consultez Configurer l'accès à la console série Amazon EC2.
- CheckIfEc2 InstanceIsWindows :
  
  Indique si la plate-forme d'instance cible est Windows.
- GetInstanceType:
  
  Récupère le type d'instance de l'instance cible.
- CheckIfInstanceTypeIsNitro:
  
  Vérifie si l'hyperviseur de type d'instance est basé sur Nitro. L'accès à la console série n'est pris en charge que sur les instances virtualisées basées sur le système Nitro.
- CheckIfInstanceIsInAutoScalingGroup:
  
  Vérifie si l'instance Amazon EC2 fait partie d'un groupe Amazon EC2 Auto Scaling en appelant l'API. DescribeAutoScalingInstances Si l'instance fait partie d'un groupe Amazon EC2 Auto Scaling, cela garantit que l'assistant de portage pour l'instance .NET est en état de veille.
- WaitForEc2 InstanceStateStablized :
  
  Attend que l'instance soit en cours d'exécution ou arrêtée.
- GetEc2 InstanceState :
  
  Obtient l'état actuel de l'instance.
- BranchOnEc2 InstanceState :
  
  Branches basées sur l'état de l'instance récupéré à l'étape précédente. Si cet état d'instance est en cours d'exécution, il passe à l'CheckIfEc2InstanceIsManagedBySSMétape et sinon, il passe à l'CheckIfHelperInstanceProfileIsProvidedétape.
- CheckIfEc2 InstanceIsManagedBy SMS :
  
  Vérifie si l'instance est gérée par AWS Systems Manager. S'il est géré, le runbook active le SAC et le menu de démarrage à l'aide d'une commande d' PowerShell exécution.
- BranchOnPreEC2RescueBackup:
  
  Branches basées sur le paramètre CreateInstanceBackupBeforeScriptExecution d'entrée.
- CreateAmazonMachineImageBackup:
  
  Crée une sauvegarde AMI de l'instance.
- Activez SACAnd BootMenu :
  
  Active le SAC et le menu de démarrage en exécutant un script PowerShell Run Command.
- RebootInstance:
  
  Redémarre l'instance Amazon EC2 pour appliquer la configuration. Il s'agit de la dernière étape si l'instance est en ligne et est gérée par AWS Systems Manager.
- CheckIfHelperInstanceProfileIsProvided:
  
  Vérifie si le paramètre HelperInstanceProfileName spécifié existe avant d'activer le SAC et le menu de démarrage hors ligne à l'aide d'une instance Amazon EC2 temporaire.
- RunAutomationToInjectOfflineScriptForEnablingSACAndBootMenu:
  
  Exécute le menu AWSSupport-StartEC2RescueWorkflow pour activer le SAC et le menu de démarrage lorsque l'instance est arrêtée ou n'est pas gérée par AWS Systems Manager.
- GetExecutionDetails:
  
  Récupère l'ID d'image de la sauvegarde et de la sortie du script hors ligne.
Une fois terminé, consultez la section Sorties pour obtenir les résultats détaillés de l'exécution :
- Activez SACAnd BootMenu .Output :
  
  Résultat de l'exécution de la commande dans l'EnableSACAndBootMenuétape.
- GetExecutionDetails.OfflineScriptOutput:
  
  Sortie du script hors ligne exécuté à l'RunAutomationToInjectOfflineScriptForEnablingSACAndBootMenuétape.
- GetExecutionDetails.BackupBeforeScriptExecution:
  
  ID d'image de la sauvegarde AMI prise si le paramètre CreateInstanceBackupBeforeScriptExecution d'entrée est True.

Références

Systems Manager Automation

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

AWSPremiumSupport-DiagnoseDiskUsageOnLinux

AWSPremiumSupport-ExtendVolumesOnWindows