Aktivierung eines Plan4Continuity-Notfallplans durch ConnectWise Automate

In diesem Artikel zeigen wir Ihnen, wie Sie einen Notfallplan von Plan4Continuity mithilfe der API-Funktionalität aus ConnectWise Automate heraus aktivieren können. Ein typischer Anwendungsfall ist beispielsweise der Ausfall eines Servers, der durch das entsprechende Monitoring in ConnectWise Automate auffällt. Daraufhin kann der Plan automatisch via Skript aktiviert werden.

Um einen Plan aus ConnectWise Automate heraus aktivieren zu können, ist es eingangs notwendig, die korrekte URL für die Aktivierung per API aus dem Plan4Continuitiy-Dashboard zu entnehmen (Lesen Sie dazu auch: Nutzung der Plan4Continuity-API für die Planaktivierung).  Sie können  die Aktivierung via PowerShell mit dem folgenden Befehl testen: 

Invoke-WebRequest -URI "https://api.plan4continuity.com/Example"
Nun können Sie mit den Vorbereitungen in ConnectWise Automate beginnen. Damit Sie die URL nicht immer wieder in das entsprechende Skript kopieren müssen, speichern Sie diese vorher in einem EDF (Extra Data Field) ab. Dabei handelt es sich um Datenfelder, die in einem Skript verwendet werden können. Beispielsweise können Sie eine bestimmte URL in einem EDF speichern und dieses Feld dem dazu passenden Server zuweisen. Weitere Informationen zu der Erstellung von EDFs finden Sie hier. 

Um eine URL einem passenden Server zuzuweisen, wählen Sie diesen im Control Center mit einem Doppelklick aus, sodass sich der Computer Management Screen öffnet. Dort gehen Sie nun zu "Automation → Extra Data Fields". 


Navigieren Sie zum erstellten EDF und wählen den passenden Wert aus. Füllen Sie das Textfeld nun mit dem gewünschten Wert aus.



Sie können jetzt mit der Erstellung des Skripts beginnen. Dafür navigieren Sie im Control Center zu "Automation → View Scripts". Erstellen Sie im gewünschten Ordner ein neues Skript.

Um den Plan erfolgreich zu aktivieren, sind die nachfolgenden Schritte notwendig:

  1. Den Wert aus dem EDF auslesen und in einer Variable abspeichern
  2. Das Skript mithilfe der Variablen ausführen
  3. Überprüfen, ob die Ausführung erfolgreich war, ansonsten wird eine Fehlermeldung verschickt. 
  4. Erstellung einer Gruppe und Zuweisung von Servern
  5. Erstellung eines Alert-Template

  1. Den Wert aus dem EDF auslesen und in einer Variable abspeichern
    Der erste Schritt im Skript ist "ExtraData Get Value". Hier geben Sie das EDF an, welches ausgelesen werden soll. Sie können dies im Dropdown-Menü auswählen. Wichtig ist, dass Sie unter "ID" die Variable %computerid% angeben, da ansonsten nicht der korrekte EDF-Wert in die Variable geschrieben wird. Im Feld "Variable" geben Sie die Variable an, die mit dem Wert aus dem EDF gefüllt werden soll.
  2. Den API-Call mithilfe der Variable ausführen
    Hierfür wird erneut ein Skript-Schritt hinzugefügt. Diesmal wählen Sie "Execute Script". Als Typ wird "PowerShell" ausgewählt, das eigentliche Skript setzt sich nun aus der Variablen und dem eigentlichen Aufruf zusammen. Wenn Sie die Variable "stringresult" im ersten Schritt ausgewählt haben, sieht das auszuführende Skript folgendermaßen aus:
    Invoke-WebRequest -URI "@stringresult@"
    Beachten Sie bitte, dass Sie an dieser Stelle die "@" Zeichen für einen erfolgreichen Abruf benötigen. Ausgeführt wird das Skript vom Local Agent, das Ergebnis kann in der Variable "shellresult" gesichert werden.
     

  3. Überprüfen, ob die Ausführung erfolgreich war, ansonsten wird eine Fehlermeldung verschickt
    Optional kann noch eine Fehlerbehandlung im Script eingebaut werden. Dies ist empfohlen, da etwaige Fehler in der Skriptausführung so schneller bemerkt werden. Dafür fügen Sie dem Skript zwei weitere Schritte hinzu. Der erste Schritt ist "Variable Check" und prüft die "shellresult"-Variable auf einen bestimmten Wert. Es wird geprüft, ob die Variable den Wert "200" enthält, der als Statuscode für eine erfolgreiche Abfrage zurückgegeben wird. Falls ja, wird das Skript beendet; falls nein, wird in einem weiteren Schritt eine E-Mail verschickt. 

    Prüfung auf den genannten Wert: 


    Als letzter Schritt wird nun die Funktion "Email" verwendet. Hierbei kann dann eine Benachrichtigung an einen gewünschten Empfänger verschickt werden, welche im Fehlerfall ausgelöst wird. 



    Das Skript ist damit vollständig, die Funktionalität lässt sich nun mit der "Debug Script"-Schaltfläche überprüfen. Bei erfolgreicher Durchführung erhalten wir je nach genutzter API-URL eine Bestätigung via E-Mail. Sie können die Skript-Datei hier herunterladen und in Ihre Umgebung importieren (System → General → Import → XML Expasion).


    Abschließend ist es notwendig, das entsprechende Monitoring einzurichten, welches für das eigentliche Auslösen des Skriptes zuständig ist. Hierfür eignet sich der bereits existierende Monitor "LT - Offline Servers". Dieser kann an eine bestimmte Gruppe von Servern gebunden werden. Danach ist es erforderlich, den Monitor für diese Gruppe entsprechend anzupassen, sodass der korrekte Alert ausgelöst wird. Hierfür wird ein Alert Template verwendet. 

  4. Erstellen einer Gruppe und Zuweisung von Servern
    Damit sich in der Gruppe die Server befinden, die auch im Notfallplan enthalten sind, muss zuvor eine Suche erstellt werden. Damit können Sie die gewünschten Server einer Gruppe zuweisen. Wie Sie eine Suche erstellen können, erfahren Sie hier. 
    Nun können Sie die Gruppe im Control Center unter  "Browse → Groups → New → Group" erstellen. Es öffnet sich die Gruppenübersicht. Hier vergeben Sie zuerst einen Namen und wählen dann unter "Computers" Ihre eingerichtete Suche aus. Mit der Schaltfläche "Preview/Run" lässt sich das Ergebnis der Suche nochmals überprüfen. Bestätigen Sie nun Ihre Eingaben mit "Save" und die Gruppe wird erstellt. 

  5. Erstellung eines Alert-Template
    Im nächsten Schritt wird ein entsprechendes Alert Template erstellt, das im Fehlerfall das Skript ausführt. 
    Für die Erstellung eines neuen Alert Template rufen Sie "Automation → Templates → Alert Templates" auf. Im oberen Bereich gehen Sie auf "New Template", es öffnet sich die nachfolgende Übersicht: 


    Vergeben Sie einen Namen für das Template, ein Kommentar ist optional. Im nächsten Schritt muss noch der passende Alert hinzugefügt werden, dafür wählen Sie "Add Alerts" aus. Hier wird nun der Typ des Alerts, die Script Action, ein User Contact, sowie der Zeitrahmen gewählt, zu dem das Template einen Alarm auslösen soll.


    Mit einem Klick auf "Save" werden die Eingaben bestätigt.

    Abschließend wechseln Sie erneut in die Gruppenübersicht und wählen die zuvor erstellte Gruppe mit einem Doppelklick aus. Die Internal Monitors finden Sie unter "Computers → Internal Monitors". Suchen Sie dort nach "LT - Offline Servers", wählen Sie diesen Monitor mit einem Rechtsklick an und klicken auf "Edit Settings". Nun wird der Monitor aktiviert und das eben erstellte Alert Template ausgewählt.


    Damit ist auch die Konfiguration des Monitorings abgeschlossen, sodass im Fehlerfall der korrekte Notfallplan für die passende Gruppe an Servern automatisch aktiviert wird.