Backup

Sie sollten ScriptRunner regelmäßig sichern, um eine schnelle Wiederherstellung des Systems gewährleisten zu können. Wichtig sind vor allem die Konfigurationseinstellungen sowie die PowerShell Reports. Diese Informationen befinden sich auf $env:ProgramData\ScriptRunner\ auf Ihrem ScriptRunner Server. Sie können für das regelmäßige Backup zwischen folgenden Möglichkeiten wählen:

  • Snapshot der ScriptRunner Server VM
  • Windows Backup
  • Backup-Software eines Drittanbieters

Führen Sie folgende Schritte für die Erstellung eines manuellen Backups aus:

  1. Prüfen Sie, ob PowerShell-Prozesse laufender Aktionen auf dem ScriptRunner Server aktiv sind. Kontrollieren Sie im Task Manager Prozesse mit dem Namen
    – SRXPSHost.exe
    – Windows PowerShell
    Hinweis: Achten Sie ebenfalls auf PowerShell Prozesse anderer Programme und Anwender.
  2. Öffnen Sie PowerShell als Administrator und beenden den ScriptRunner Service mit Stop-AsrService.
    Hinweis: Achten Sie darauf, PowerShell wieder zu schließen.
  3. Sichern Sie das Verzeichnis $env:ProgramData\ScriptRunner\.
  4. Falls Sie die Standardeinstellungen geändert haben, sichern Sie ebenfalls den Ordner Script Library.
    Hinweis: Sie können Ihre Einstellungen in der Admin Web App unter dem Hauptmenü Settings oder Script Library einsehen.
  5. Wurden Änderungen an den ScriptRunner Web Apps Konfigurationsdateien vorgenommen, sichern Sie die uri.js Datein und die /Custom/ Ordner in folgenden Verzeichnissen:
    – $env:ProgramFiles\ScriptRunner\WebApps\AdminApp\
    – $env:ProgramFiles\ScriptRunner\WebApps\DelegateApp\
    – $env:ProgramFiles\ScriptRunner\WebApps\SelfServiceApp\

Restore

Um Ihre Installation manuell wiederherzustellen, benötigen Sie folgenden Komponenten:

  • Setup der zuletzt installierten Version
  • Sicherung der Konfiguration
  • Sicherung der Script Library


Führen Sie folgende Schritte für die manuelle Wiederherstellung durch:

  1. Installieren Sie den ScriptRunner Service.
  2. Installieren Sie die ScriptRunner Web Apps.
  3. (Optional) Richten Sie https für den Web Server und für den ScriptRunner Service ein.
  4. Öffnen Sie PowerShell als Administrator und beenden den ScriptRunner Service mit Stop-AsrService.
    Hinweis: Achten Sie darauf, PowerShell wieder zu schließen.
  5. Kopieren Sie das vollständige Verzeichnis $env:ProgramData\ScriptRunner\ der Neuinstallation an einen sicheren Ort.
  6. Kopieren Sie das gesicherte Verzeichnis $env:ProgramData\ScriptRunner\ nach $env:ProgramData\ScriptRunner\ auf dem neuen ScriptRunner Server.
    Hinweis: Stellen Sie im Falle einer Migration sicher, dass die Lizenz nicht mitkopiert wird.
  7. Wenn Änderungen an der ScriptRunner Web App Konfigurationsdatei uri.js vorgenommen wurden, kopieren Sie diese aus der Sicherung auf das System, sowie die Unterordner \Custom\.
  8. Öffnen Sie PowerShell als Administrator und starten Sie den ScriptRunner Service mit Start-AsrService.
  9. Konfigurieren Sie den ScriptRunner Server und die Connector Einstellungen mit dem PowerShell-Modul ScriptRunnerSettings.
  10. Überprüfen Sie in der Admin App, ob alle Elemente und Reports verfügbar sind.
    Hinweis: Die hinterlegten Credentials müssen erneut mit korrekten Passwörtern bestätigt werden.

Migration

Um Ihre ScriptRunner Instanz auf eine andere Maschine umzuziehen benötigen Sie folgende Komponenten:

Führen Sie folgende Schritte für die manuelle Migration durch:

Alte Maschine

  1. Gehen Sie auf den Server mit der bestehenden ScriptRunner Installation
  2. Prüfen Sie, ob PowerShell-Prozesse laufender Actions auf dem ScriptRunner Server aktiv sind. Kontrollieren Sie im Task Manager Prozesse mit dem Namen
    – SRXPSHost.exe
    – Windows PowerShell
    Hinweis: Achten Sie ebenfalls auf PowerShell Prozesse anderer Programme und Anwender.
  3. Öffnen Sie PowerShell als Administrator und beenden den ScriptRunner Service mit Stop-AsrService.
    Hinweis: Achten Sie darauf, PowerShell wieder zu schließen.
  4. Gehen Sie in das Verzeichnis $env:ProgramData\ScriptRunner\ und sichern Sie es.
    Hinweis: Legen Sie diese in einem temporären Verzeichnis auf der neuen Maschine ab
  5. Sichern Sie Ihre Script Library, standardmäßig liegt diese unter §env:ProgramData\ScriptRunner\ScriptMgr
    Hinweise:
    – Mit dem Cmdlet Get-AsrSettings können Sie den Pfad der Script Library einsehen
    – Legen Sie diese in einem temporären Verzeichnis auf der neuen Maschine ab

Hinweis: Achten Sie auf die korrekte Struktur der Verzeichnisse auf dem neuen Server!

Neue Maschine

/Einrichtung

  1. Gehen Sie auf den neuen Server
  2. Installieren Sie mit dem Installationspacket den ScriptRunner Service
  3. Installieren Sie mit dem Installationspacket die ScriptRunner Web Apps
  4. Melden Sie sich in der ScriptRunner Admin App an und überprüfen die Funktionalität
    Hinweis: Prüfen Sie ebenfalls das Windows Event Log auf mögliche ScriptRunner-Fehler.
  5. (Optional) Richten Sie https für den Web Server und für den ScriptRunner Service ein.
  6. Aktivieren Sie über die PowerShell Ihre neuen Lizenzschlüssel
  7. Konfigurieren Sie die ScriptRunner Server-Einstellungen, insbesondere
    – Script-Library-Pfad (mit Set-ASRSettings)
    – E-Mail Notification Connector
  8. Konfigurieren Sie weitere Connectoren mit dem PowerShell-Modul ScriptRunnerSettings.
  9. Achten Sie darauf, dass alle notwendigen Zertifikate für Zertifikats-basierte Authentifizierung ebenfalls auf dem neuen Server abgelegt werden.
  10. (Optional) Falls Sie SSH verwenden, übertragen Sie ebenfalls die SSH-Keyfiles.

/Übertragung der Konfiguration

  1. Öffnen Sie PowerShell als Administrator und beenden den ScriptRunner Service mit Stop-AsrService.
    Hinweis: Achten Sie darauf, PowerShell wieder zu schließen.
  2. Öffnen Sie das temporäre Verzeichnis Ihrer Script Library und kopieren Sie die Struktur vollständig in das konfigurierte Script Library Verzeichnis.
  3. Öffnen Sie das temporäre Verzeichnis Ihrer gesicherten Konfiguration.
  4. Kopieren Sie die gesamten Inhalte folgender Verzeichnisse auf die gleichnamigen Unterordner
    • $env:ProgramData\ScriptRunner\Service\Local\ResultFiles
    • $env:ProgramData\ScriptRunner\Service\Settings\Params
    • $env:ProgramData\ScriptRunner\Service\Settings\Repos
    • (Optional für ISE Add-On) $env:ProgramData\ScriptRunner\Service\Settings\Staging
    • (Optional für SSH) $env:ProgramData\ScriptRunner\Service\Settings\Store
  5. Öffnen Sie PowerShell als Administrator und starten Sie den ScriptRunner Service mit Start-AsrService.
  6. Überprüfen Sie in der Admin App, ob alle Elemente und Reports verfügbar sind.
    Hinweis: Prüfen Sie ebenfalls das Windows Event Log auf mögliche ScriptRunner-Fehler.
  7. Öffnen Sie die Admin App:
    1. Navigieren Sie in den Bereich Credentials. Anhand der roten Markierung können Sie erkennen, welche Credentials Ihrer Passwordeingabe erfordern.
    2. Navigieren Sie in den Bereich Scripts | Cmdlets und überprüfen Sie, ob alle Scripte korrekt aus der Script Library ausgelesen werden.
    3. Navigieren Sie in den Bereich Targets. Überprüfen Sie die Vollständigkeit Ihrer Targets.
    4. Navigieren Sie in den Bereich Queries. Überprüfen Sie die Vollständigkeit Ihrer Queries.
      Hinweis: Achten Sie besonders auf rote Ausrufezeichen bei gescripteten Queries.
    5. Navigieren Sie in den Bereich Actions. Überprüfen Sie den Bereich auf rote Ausrufezeichen.
  8. Testen Sie anhand einer Action, ob der ScriptRunner Dienst funktionsfähig ist.
    Hinweis: Mögliche Fehler werden im Windows Event Log hinterlegt.
Änderung vorschlagen