Verwenden Sie SSH, um eine VM mithilfe eines Workflow-Typvorgangs herunterzufahren

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 8 Minuten Lesedauer

    • Verwenden Sie SSH, um eine VM mithilfe eines Workflow-Vorgangs Remote herunterzufahren. Befolgen Sie diesen Anwendungsfall, um alle Aufgaben durchzugehen, die zum Ausführen dieser Art des Herunterfahrens erforderlich sind.

    Vorbereitungen

    Erforderliche Rolle: Workflow-Designer oder sn_CMP.Cloud_admin

    Prozedur

    1. Führen Sie die folgenden Schritte aus, um die anwenderdefinierte SSH-Aktivität zu erstellen:
      1. Navigieren zu Administratorportal > Workflows > Workflow-Editoran.
      2. Klicken Sie auf Anwenderdefiniert Und klicken Sie dann auf + (Pluszeichen) zum Erstellen einer neuen anwenderdefinierten Aktivität.
      3. Wählen Sie aus der Liste der Aktivitätstypen aus SSH .
        Wählen Sie SSH als anwenderdefinierten Aktivitätstyp aus
      4. Der Aktivitätendesigner wird geöffnet, und die Registerkarte „Allgemein“ wird angezeigt
        Geben Sie einen eindeutigen Namen für die Aktivität ein, und klicken Sie dann auf Fahren Sie Fort .
      5. Fügen Sie auf der Registerkarte Eingaben die Eingabevariablen mit den folgenden Schritten hinzu, und klicken Sie dann auf Fahren Sie Fort :
      6. Klicken Sie in der Eingabetabelle auf + in einem Kreis Zum Erstellen einer neuen Eingabevariable.
      7. Klicken Sie rechts neben ABC in Name Und geben Sie den Eingabenamen ein.

        Eingaben variieren je nach Objekt, das betroffen sein soll. Sie können eine Aktivität anhalten, um eine VM anzuhalten, damit die Eingaben die Werte widerspiegeln, die zum Ausführen dieser Aktion erforderlich sind.

        Die Typ Und Obligatorisch Spalten werden entsprechend der Eingabe automatisch ausgefüllt.

      8. Erstellen Sie ein neues Eingabeobjekt für jede Eingabe in der folgenden Tabelle, und klicken Sie dann auf Fahren Sie Fort :
        Eingabevariable Typ Obligatorisch
        Host Zeichenfolge Nein
        Befehl Zeichenfolge Nein
        CredentialTag Zeichenfolge Nein
      9. Führen Sie auf der Registerkarte Ausführungsbefehl Folgendes aus:
      10. Klicken Sie in der Tabelle Ausgabe auf + in einem Kreis Zum Erstellen einer neuen Ausgabevariable.
      11. Klicken Sie rechts neben ABC in Name Und geben Sie den Ausgabenamen ein.
        Die Ausgabevariablen spiegeln die möglichen Ergebnisse wider, wenn der Workflow versucht, SSH an die VM zu senden. Die Typ Spalte wird automatisch ausgefüllt.
        Ausgaben Typ
        Fehler Zeichenfolge
        Ausgabe Zeichenfolge
      12. Klicken und ziehen Sie Fehler Variable zum Feld Variablenname in der Tabelle „Analyseregeln“.
      13. Wählen Sie im Dialogfeld „Analyseregel für Fehler“ in der Dropdown-Liste „Analysequelle“ die entsprechende Quelle aus. In diesem Fall „executionResult.errorMessages“.
      14. Wiederholen Sie den Vorgang für die Ausgabevariable, wählen Sie „executionResult.output“ als Analysequelle aus, und klicken Sie dann auf Übermitteln .
        Ausgaben werden in Analyseregeln angezeigt
      15. Klicken Sie auf Fortsetzen.
        Bedingungen sind optional.
      16. Klicken Sie Auf Speichern , Und klicken Sie dann auf Veröffentlichen Um die Aktivität für die Verwendung im Workflow verfügbar zu machen.
    2. Führen Sie die folgenden Schritte aus, um den SSH-Workflow zu erstellen, der zum Ausschalten der VM erforderlich ist:
      Wenn Sie einen Workflow erstellen, ordnen Sie ihn einer Tabelle und einer Aktivität zu.
      • Sie können den Workflow in einer Tabelle auf globaler Ebene oder einer Tabelle auf Anwendungsebene erstellen. Verwenden Sie die globale Tabelle, um den Workflow für die Verwendung mit allen ServiceNow-Anwendungen verfügbar zu machen. Hier verwenden wir eine Tabelle für Cloud Provisioning and Governance, Daher ist dieser Workflow nur für die Verwendung mit dieser Anwendung verfügbar.
      • Sie können den Workflow im Workflow-Editor oder im Aktivitätendesigner erstellen. Hier wird der Aktivitätsdesigner verwendet.
      1. Wählen Sie im Aktivitätendesigner aus Workflows Registerkarte rechts, und klicken Sie dann auf + (Pluszeichen), um einen neuen Workflow hinzuzufügen.
      2. Geben Sie im Fenster neuer Workflow einen eindeutigen Namen für den Workflow ein.
      3. Von Tabelle Wählen Sie die zu verwendende Tabelle aus.
        Suchen und verwenden Sie cmdb_ci_vm_instance der VM-Instanz Dient zur Verwendung des Workflows zum Ausschalten einer VM.
      4. Klicken Sie auf Absenden.
      5. Wenn der Workflow im Canvas angezeigt wird, löschen Sie die Verbindungslinie zwischen dem Start- und Endpunkt des Workflows.
      6. Löschen Sie die Verbindungslinie zwischen dem Start- und Endpunkt des Workflows.
      7. Klicken Sie mit der rechten Maustaste auf den Canvas „weitere Informationen“, und wählen Sie aus Eingaben Bearbeiten .
      8. Erstellen Sie die folgenden Eingaben:
        Hinweis:
        Nehmen Sie die Eingabenamen aus dem Feld Spalte, nicht aus dem Feld Bezeichnung. Wenn der Workflow einer Tabelle auf globaler Ebene zugeordnet ist, wird dem Eingabenamen im Feld Spalte u_ vorangestellt, z. B. u_ipaddress. Hier ist die Tabelle auf Anwendungsebene und benötigt daher kein Präfix.
        Tabelle : 1. Workflow-Eingaben
        Typ Bezeichnung Spalte (automatisch hinzugefügt) Max. Länge
        Zeichenfolge IPAddress ipaddress 100
        Zeichenfolge CredentialTag CredentialTag 100
      9. Klicken Sie auf Absenden.
      10. Klicken Sie mit der rechten Maustaste auf den Canvas, und wählen Sie aus Fügen Sie Eine Anwenderdefinierte Aktivität Hinzu .
      11. Suchen Sie im Fenster „Versionen“ nach der Aktivität, die Sie ursprünglich in diesem Anwendungsfall erstellt haben, und wählen Sie sie aus.
      12. Geben Sie im Fenster „neue Aktivität“ für diese Aktivität (neuer Datensatz für Workflow-Aktivität [Diagrammansicht]) einen Namen für die Aktivität ein.
      13. In Host Feld: Geben Sie die Eingabezuordnung ein, die die Aktivität erwartet.

        Hier ist die IP-Adresse des Hosts: ${workflow.inputs.u_ipaddress}. Verwenden Sie diesen Ausdruck, um die IP-Adresse abzurufen:

        $(Skript:CMPVMUtils.getReachableIp[arg=$(Stack.items[Virtual Server].attributes[sys_ID])])

      14. Geben Sie im Feld Befehl ein shutdown -h now
      15. Geben Sie im Feld Anmeldeinformations-Tag ein ${workflow.inputs.u_credentialtag}

        Verwenden Sie diesen Ausdruck, um das Anmeldeinformations-Tag abzurufen:

        $(Script:CMPVMUtils.getCredentialAlias[arg=${Stack.items[Virtual Server].attributes[sys_id]}])

      16. Klicken Sie auf Absenden.
        Die Aktivität wird im Workflow-Canvas angezeigt.
      17. Klicken Sie mit der rechten Maustaste auf den Canvas, und wählen Sie aus Fügen Sie Eine Kernaktivität Hinzu Dient zum Hinzufügen einer Skriptaktivität.
      18. Suchen Sie im Fenster Workflow-Aktivitätsdefinitionen nach, und wählen Sie aus Skript Ausführen .
      19. Geben Sie im Fenster neue Aktivität: Skript ausführen einen Namen für die Aktivität ein.
      20. Schneiden Sie ein Skript (passend zu Ihrer Umgebung) aus, und fügen Sie es in ein Skript Feld.
        Dieses Skript aktualisiert den Status der VM, nachdem sie heruntergefahren wurde.
        Beispielskript:
        if ( gs.nil(data.get(3).error)) {
                    current.state = 'off';
                    current.setWorkflow(false);
                    current.update();
}
      21. Klicken Sie auf Absenden.
      22. Verbinden Sie im Canvas die Connectors zwischen dem Anfangspunkt, der Aktivität, dem Ausführungsskript und dem Endpunkt.
      23. Validieren Sie den Workflow mithilfe der Workflow-Validierung.
        Hinweis:
        Das System empfiehlt nicht die Verwendung von current.update(). Dies kann ignoriert werden.
    3. So fügen Sie den Vorgang einem Ressourcenblock hinzu:
      Sie können aus den vorhandenen Vorgängen in einem Ressourcenblock auswählen, um mit Ihrem Workflow zu arbeiten, oder Sie können einen anwenderdefinierten Vorgang erstellen.
      1. In Portal für Cloud-Admin., Navigieren Sie zu Design > Ressourcenblöckean.
      2. Wählen Sie z. B. einen Ressourcenblock aus Virtueller Server .
      3. Verschieben Sie den Status des Ressourcenblocks aus Veröffentlicht Bis Entwurf Um sie bearbeitbar zu machen.
      4. Wählen Sie aus Vorgänge Und wählen Sie dann im Dropdown-Feld „Schnittstelle“ eine Schnittstelle aus, die dem Anwender zur Verfügung steht.
        Die Standardschnittstelle ist Virtuelle Serverschnittstelle .
      5. Klicken Sie Auf + Geben Sie rechts neben dem Feld „Vorgang“ im Dialogfeld „Vorgang hinzufügen“ einen aussagekräftigen und eindeutigen Namen ein.
      6. Wählen Sie einen Vorgang aus der Dropdown-Liste „Vorgangstyp“ aus.
      7. Wählen Sie Aus Öffentlich Aus dem Feld Zugriffstyp.
      8. Füllen Sie das Formular aus, und klicken Sie dann auf Übermitteln .
        Vorgangstyp Wählen Sie den auszuführenden Vorgang aus.
        Zugriffstyp Wählen Sie aus, damit der Anwender den Vorgang während der Bereitstellung auf Ressourcenebene anzeigen kann Öffentlich . Vorgänge auf festgelegt Privat Sind während der Bereitstellung nicht sichtbar.
        Der Vorgang ist für die Ressource verfügbar, wenn Sie die Ressource für Ihren Workflow auswählen.
      9. Um einen Ressourcenvorgangsschritt zum Aufrufen des Workflows hinzuzufügen, klicken Sie weiterhin auf der Registerkarte „Vorgänge“ auf Schritte > Schritt hinzufügenan.
        Damit der Workflow als Teil der Update-Sätze exportiert werden kann, müssen Sie eine Erweiterungsschnittstelle erstellen und den neuen Vorgang hinzufügen. Details siehe Erweitern Cloud Provisioning and GovernanceRessourcenblöcke mit einem Überschreibungsvorgang.
      10. Wählen Sie im Popup „Vorgangsschritte hinzufügen“ die Option aus Workflow Aufrufen Für Vorgangstyp .
      11. Wählen Sie aus Workflow Aus der Liste der Workflows, die Sie erstellt haben.
        Das System kann die Liste mithilfe von Tags filtern. So fügen Sie ein Tag hinzu:
        1. Navigieren Sie zu Systemeigenschaften .
        2. Suchen und wählen Sie die Systemeigenschaft aus sn_cmp.workflow_tag_filter.
        3. Bearbeiten Sie die Eigenschaft. Fügen Sie ein Tag oder eine kommagetrennte Liste von Tags hinzu.
        4. Klicken Sie auf Speichern.
      12. So filtern Sie die Workflows:
        1. Öffnen Sie in der Workflow-Tabelle den Workflow.
        2. Klicken Sie Auf Tag Hinzufügen .
        3. Geben Sie den Wert ein, den Sie zuvor in der Eigenschaft angegeben haben sn_cmp.workflow_tag_filter
        4. Klicken Sie Auf Eingabetaste Zum Hinzufügen des Werts als Tag zum Workflow. Der neue Schritt wird angezeigt, nachdem die Software den neuen Tag 2-Vorgangskatalog generiert hat.
      13. Es können Workflows vorhanden sein, die in anderen Tabellen als global erstellt werden.
        Sie können einen Workflow hinzufügen, der für eine solche Tabelle erstellt wurde. Zum Ausführen von Vorgängen für diesen Workflow-Typ benötigen Sie die sys_ID des Datensatzes, in dem der Workflow ausgeführt wird, um den aktuellen Datensatz zu erstellen. Wenn der Designer also einen Workflow hinzufügt, der sich in einer anderen Tabelle als global befindet, erstellt das System einen wf_currentParameter im Eingabeparameter für Vorgang. Sie können dann einen Ausdruck schreiben, um die sys_ID der Ressource zuzuordnen, in der der Vorgang ausgeführt wird. Sobald dies abgeschlossen ist, kann der Designer das Stichwort „current“ in Workflow-Skripts verwenden.
        So fügen Sie den Workflow hinzu:
        1. Nachdem Sie den Schritt erstellt haben, fügt das System die Workflow-Eingaben den Vorgangseingabeparametern hinzu. Sie können dann bei Bedarf die Zuordnung für diese Parameter angeben.
        2. Klicken Sie auf Katalog Generieren Schaltfläche zum Erstellen des Katalogelements für den Vorgang.
        3. Nachdem der Katalog generiert wurde, können Sie den Katalogelementen aus den Lade- und Feldänderungsregeln hinzufügen.
      14. Legen Sie den Ressourcenblock auf fest Veröffentlicht status, um den Workflow in verfügbar zu machen Cloud-Anwenderportal.
    4. Führen Sie die folgenden Schritte aus, um den Vorgang über das Anwenderportal auszuführen:
      1. Stellen Sie eine einfache AWS-VM über das Portal bereit.
      2. Nachdem die VM-Bereitstellung abgeschlossen ist, navigieren Sie zu Stapel > VM-Ressource.
      3. Wählen Sie in der Option Ressourcenvorgang auswählen die anwenderdefinierte Stoppaktivität aus, die Sie zuvor in diesem Anwendungsfall erstellt haben, und klicken Sie dann auf OK.
        Der Vorgang wird ausgeführt, nachdem das RITM erstellt wurde und sich der VM-Status in der AWS-Konsole ändert.
      4. Navigieren zu Betreiben > Pfade Dient zum Anzeigen der Pfadprotokolle und zum Nachverfolgen der Vorgangsschritte.
    5. Führen Sie zur Problembehandlung bei Bedarf die folgenden Schritte aus:
      1. Verwenden Sie das Anforderungselement (RITM), und navigieren Sie zum RootCauseAnalysis-Dashboard.
        Das RITM hat den Link zum Workflow-Kontext des derzeit ausgeführten Vorgangs.
      2. Überprüfen Sie auf diese häufigen Fehler:
        Tabelle : 2. Fehlerbehandlung
        Symptom Fehlermeldung
        VM wird heruntergefahren, aber es ist ein Problem mit der SSH-Verbindung aufgetreten „Fehler; Auftrag mit STATUSFEHLER abgeschlossen: Problem in SSH-Sitzung, Auftrag abgebrochen: Verbindung unerwartet vom SSH-Server geschlossen: \N“,
        VM wird bereits heruntergefahren/kann die VM nicht erreichen „Verbindung kann nicht hergestellt werden, Status ist „TCP_CONNECTION_FAILURE“. Zeitüberschreitung beim Warten auf TCP-Verbindung mit 10.198.252.224:22: \N“,
        Hinweis:
        Bestätigen Sie, dass die IP-Adresse der VM in wf_context die entsprechende Adresse ist. Die VM wurde möglicherweise bereits heruntergefahren. Bestätigen Sie, dass die IP-Adresse zugänglich ist.
        Stammzugriff nicht verfügbar „Fehler beim Ausgeben des Methodenaufrufs: Zugriff verweigert\nmuss Stamm sein.\nExit-Status: 1\n\n“,
        Hinweis:
        Bestätigen Sie, dass Muss Sudo Sein Das Kontrollkästchen ist in der SSH-Aktivität zu Beginn dieses Anwendungsfalls aktiviert.