View a markdown version of this page

AWSSupport-EnableWindowsEC2SerialConsole - AWS Systems Manager Runbook-Referenz für Automation

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

AWSSupport-EnableWindowsEC2SerialConsole

Beschreibung

Das Runbook AWSSupport-EnableWindowsEC2SerialConsole hilft Ihnen bei der Aktivierung der Amazon EC2 Serial Console, der Special Admin Console (SAC) und des Startmenüs auf Ihrer Amazon EC2 Windows-Instance. Mit der Funktion der seriellen Konsole von Amazon Elastic Compute Cloud (Amazon EC2) haben Sie Zugriff auf die serielle Schnittstelle Ihrer Amazon EC2-Instance, um Fehler beim Starten, bei der Netzwerkkonfiguration und bei anderen Problemen zu beheben. Das Runbook automatisiert die Schritte, die erforderlich sind, um die Funktion für Instances zu aktivieren, die sich im Status „Running“ befinden und von verwaltet werden AWS Systems Manager, sowie für Instances, die sich im Status „Stoppen“ oder „Nicht verwaltet von“ befinden. AWS Systems Manager

Wie funktioniert es?

Das AWSSupport-EnableWindowsEC2SerialConsole Automatisierungs-Runbook hilft dabei, SAC und das Startmenü auf Amazon EC2-Instances zu aktivieren, auf denen Microsoft Windows Server ausgeführt wird. Für Instances, die sich im Status „Running“ befinden und von verwaltet werden AWS Systems Manager, führt das Runbook ein AWS Systems Manager Run PowerShell Command-Skript aus, um SAC und das Startmenü zu aktivieren. Für Instances, die sich im Status „Beendet“ befinden oder nicht von verwaltet werden AWS Systems Manager, verwendet das Runbook das, AWSSupport-StartEC2RescueWorkflow um eine temporäre Amazon EC2-Instance zu erstellen, um die erforderlichen Änderungen offline durchzuführen.

Weitere Informationen finden Sie unter Amazon EC2 Serial Console für Windows-Instances.

Wichtig

  • Wenn Sie SAC auf einer Instance aktivieren, funktionieren die Amazon EC2-Dienste, die auf das Abrufen von Kennwörtern angewiesen sind, nicht von der Amazon EC2-Konsole aus. Weitere Informationen finden Sie unter SAC zur Fehlerbehhebung von Windows-Instances verwenden.

  • Um den Zugriff auf die serielle Konsole zu konfigurieren, müssen Sie den Zugriff auf die serielle Konsole auf Kontoebene gewähren und dann AWS Identity and Access Management (IAM) -Richtlinien konfigurieren, um Ihren Benutzern Zugriff zu gewähren. Sie müssen auch einen passwortbasierten Benutzer für jede Instance konfigurieren, damit Ihre Benutzer die serielle Konsole zur Fehlerbehebung verwenden können. Weitere Informationen finden Sie unter Konfigurieren des Zugriffs auf die serielle Amazon EC2-Konsole.

  • Informationen dazu, ob die serielle Konsole in Ihrem Konto aktiviert ist, finden Sie unter Kontozugriffsstatus für die serielle Konsole anzeigen.

  • Der serielle Konsolenzugriff wird nur auf virtualisierten Instanzen unterstützt, die auf dem Nitro-System basieren.

Weitere Informationen finden Sie in den Voraussetzungen für die serielle Amazon EC2-Konsole.

Art des Dokuments

Automatisierung

Eigentümer

Amazon

Plattformen

Windows

Parameter

Erforderliche IAM-Berechtigungen

Der AutomationAssumeRole Parameter erfordert die folgenden Aktionen, um das Runbook erfolgreich zu verwenden.

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"
                    ]
                }
            }
        }
    ]
}

Anweisungen

Folgen Sie diesen Schritten, um die Automatisierung zu konfigurieren:

  1. Navigieren Sie AWSSupport-EnableWindowsEC2SerialConsole in der AWS Systems Manager Konsole zu.

  2. Wählen Sie Execute automation (Automatisierung ausführen).

  3. Geben Sie für die Eingabeparameter Folgendes ein:

    • InstanceId: (Erforderlich)

      Die ID der Amazon EC2-Instance, für die Sie die serielle Amazon EC2-Konsole (SAC) und das Startmenü aktivieren möchten.

    • AutomationAssumeRole: (Fakultativ)

      Der Amazon-Ressourcenname (ARN) der IAM-Rolle, die es Systems Manager Automation ermöglicht, die Aktionen in Ihrem Namen auszuführen. Wenn keine Rolle angegeben ist, verwendet Systems Manager Automation die Berechtigungen des Benutzers, der dieses Runbook startet.

    • HelperInstanceType: (Befristet)

      Der Typ der Amazon EC2-Instance, den das Runbook zur Konfiguration der seriellen Amazon EC2-Konsole für eine Offline-Instance bereitstellt.

    • HelperInstanceProfileName: (Befristet)

      Der Name eines vorhandenen IAM-Instanzprofils für die Hilfsinstanz. Wenn Sie SAC und das Startmenü auf einer Instance aktivieren, die sich im Status „Beendet“ befindet oder nicht von ihr verwaltet wird AWS Systems Manager, ist dies erforderlich. Wenn kein IAM-Instanzprofil angegeben ist, erstellt die Automatisierung eines in Ihrem Namen.

    • SubnetId: (Befristet)

      Die Subnetz-ID für eine Hilfsinstanz. Standardmäßig wird dasselbe Subnetz verwendet, in dem sich die bereitgestellte Instanz befindet.

      Wichtig

      Wenn Sie ein benutzerdefiniertes Subnetz angeben, muss es sich in derselben Availability Zone wie die Systems InstanceId Manager-Endpunkte befinden und den Zugriff auf diese ermöglichen. Dies ist nur erforderlich, wenn sich die Zielinstanz im Status „Beendet“ befindet oder nicht von verwaltet wird. AWS Systems Manager

    • CreateInstanceBackupBeforeScriptExecution: (Fakultativ)

      Geben Sie True an, um ein Amazon Machine Images (AMI) -Backup der Amazon EC2-Instance zu erstellen, bevor Sie SAC und das Startmenü aktivieren. Das AMI bleibt nach Abschluss der Automatisierung erhalten. Es liegt in Ihrer Verantwortung, den Zugriff auf das AMI zu sichern oder es zu löschen.

    • BackupAmazonMachineImagePrefix: (Befristet)

      Ein Präfix für das Amazon Machine Image (AMI), das erstellt wird, wenn der CreateInstanceBackupBeforeScriptExecution Parameter auf gesetzt istTrue.

  4. Wählen Sie Ausführen aus.

  5. Die Automatisierung wird initiiert.

  6. Das Dokument führt die folgenden Schritte aus:

    • CheckIfEc2SerialConsoleAccessEnabled:

      Prüft, ob der Zugriff auf die Amazon EC2 Serial Console auf Kontoebene aktiviert ist. Hinweis: Der Zugriff auf die serielle Konsole ist standardmäßig nicht verfügbar. Weitere Informationen finden Sie unter Konfigurieren des Zugriffs auf die serielle Amazon EC2-Konsole.

    • CheckIfEc2InstanceIsWindows:

      Bestätigt, ob die Zielinstanzplattform Windows ist.

    • GetInstanceType:

      Ruft den Instanztyp der Zielinstanz ab.

    • CheckIfInstanceTypeIsNitro:

      Prüft, ob der Instanztyp Hypervisor ist. Nitro-based Der serielle Konsolenzugriff wird nur auf virtualisierten Instanzen unterstützt, die auf dem Nitro-System basieren.

    • CheckIfInstanceIsInAutoScalingGroup:

      Prüft, ob die Amazon EC2-Instance Teil einer Amazon EC2 Auto Scaling-Gruppe ist, indem die API aufgerufen wird. DescribeAutoScalingInstances Wenn die Instance Teil einer Amazon EC2 Auto Scaling-Gruppe ist, stellt sie sicher, dass sich der Porting Assistant für.NET-Instance im Standby-Lebenszyklusstatus befindet.

    • WaitForEc2InstanceStateStablized:

      Wartet darauf, dass sich die Instance im laufenden oder gestoppten Zustand befindet.

    • GetEc2InstanceState:

      Ruft den aktuellen Status der Instanz ab.

    • BranchOnEc2InstanceState:

      Verzweigungen basieren auf dem Instanzstatus, der im vorherigen Schritt abgerufen wurde. Wenn dieser Instanzstatus ausgeführt wird, wechselt er zum CheckIfEc2InstanceIsManagedBySSM Schritt, und wenn nicht, wechselt er zum CheckIfHelperInstanceProfileIsProvided Schritt.

    • CheckIfEc2InstanceIsManagedBySSM:

      Prüft, ob die Instanz von verwaltet wird AWS Systems Manager. Wenn das Runbook verwaltet wird, aktiviert es SAC und das Startmenü mithilfe eines PowerShell Run-Befehls.

    • BranchOnPreEC2RescueBackup:

      Verzweigungen basieren auf dem CreateInstanceBackupBeforeScriptExecution Eingabeparameter.

    • CreateAmazonMachineImageBackup:

      Erstellt ein AMI-Backup der Instance.

    • EnableSACAndBootMenu:

      Aktiviert SAC und das Startmenü, indem ein PowerShell Run Command-Skript ausgeführt wird.

    • RebootInstance:

      Startet die Amazon EC2-Instance neu, um die Konfiguration anzuwenden. Dies ist der letzte Schritt, wenn die Instance online ist und von verwaltet wird. AWS Systems Manager

    • CheckIfHelperInstanceProfileIsProvided:

      Überprüft, ob das HelperInstanceProfileName angegebene Objekt existiert, bevor SAC und das Startmenü mithilfe einer temporären Amazon EC2-Instance offline aktiviert werden.

    • RunAutomationToInjectOfflineScriptForEnablingSACAndBootMenu:

      Führt den ausAWSSupport-StartEC2RescueWorkflow, um SAC und das Startmenü zu aktivieren, wenn sich die Instance im Status „Beendet“ befindet oder nicht von verwaltet wird AWS Systems Manager.

    • GetExecutionDetails:

      Ruft die Image-ID der Backup- und Offline-Skriptausgabe ab.

  7. Wenn Sie fertig sind, finden Sie im Abschnitt Ausgaben die detaillierten Ergebnisse der Ausführung:

    • EnableSACAndBootMenu.Output:

      Ausgabe der Befehlsausführung in dem EnableSACAndBootMenu Schritt.

    • GetExecutionDetails.OfflineScriptOutput:

      Ausgabe des im RunAutomationToInjectOfflineScriptForEnablingSACAndBootMenu Schritt ausgeführten Offline-Skripts.

    • GetExecutionDetails.BackupBeforeScriptExecution:

      Die Image-ID des AMI-Backups, das erstellt wurde, wenn der CreateInstanceBackupBeforeScriptExecution Eingabeparameter True ist.

Referenzen

Systems Manager Automation