Paket-Compliance-Scripte (SMC) als Powershell-Scripte erstellen

mypDeploy bietet Ihnen ab Version 3.9.8.0 die Möglichkeit, Paket-Compliance-Scripte (ScriptMipCompliance, kurz SMC) zu erstellen.

Hierüber können Sie beispielsweise in migrierten oder teilweise verwalteten Umgebungen feststellen, ob ein durch mypDeploy bereitgestelltes Paket bereits anderweitig installiert wurde.

Formaler Aufbau

Damit Ihr SMC-Script als Powershell-Script erkannt wird, muss es mit dieser Kommentarzeile beginnen:

# mypDeploy PowerShell Script

Danach können Sie mit beliebigem Powershell-Code fortfahren.

Einstiegs-Funktionen

Folgende Einstiegspunkte werden über fix vorgegebene Funktionsnamen definiert:

• Function PS-MypdclnEpTestCompliance (wird ausgeführt, bevor eine Paketinstallation/-deinstallation ausgeführt wird)

Parameter

Die Funktion verfügt über keine Parameter.

Powershell-Erweiterungen

Wir haben für Sie eine Cmdlet-Erweiterung bereitgestellt, die Sie in Ihrem Powershell-Script benutzen können, um mypDeploy über das Ergebnis Ihres Powershell-Scripts zu informieren.

CSL_ReturnValue "Result","Meldung"

Das Cmdlet erwartet zwei Strings als Parameter. “Result” ist fest vorgegeben, als zweiten Parameter tragen Sie Ihre Rückmeldung ein (s. nächster Absatz).

Rückmeldung an mypDeploy

Sie steuern innerhalb Ihrer Powershell-Funktion mit der Erweiterung “CSL_ReturnValue”, wie der mypDeployClientService die Ausführung des SME bewertet.

• CSL_ReturnValue "Result","0" → das Paket ist nicht installiert

• CSL_ReturnValue "Result","1" → das Paket ist installiert

• Verlassen Sie Ihre Funktion mit einem ExitCode 0 (oder wenn die Funktion normal beendet wird setzt die PS diesen implizit) verlassen, wird der mypDeployClientService die Scriptausführung als erfolgreich und wertet CSL_ReturnValue aus.

• Setzen Sie in Ihrer Funktion über Exit(), Return() oder Throw'' explizit einen terminierenden Fehler innerhalb der Powershell-Funktion, wird der mypDeployClientService die Scriptausführung als fehlerhaft werten, einen Protokolleintrag erstellen und die Verarbeitung abbrechen. Im Protokolleintrag erhalten Sie entweder den via Throw'' gesetzten Fehlertext oder (wenn Sie die Funktion über Exit/Return verlassen) den Inhalt von $Error[0].
  Beispiel:
  # mypDeploy PowerShell script
  Function PS-MypdclnEpTestCompliance
  {
  $ErrorActionPreference = "Continue"
  Throw 'Das Compliance-Script endet immer mit einem Fehler'
  }

  erzeugt folgenden Protokolleintrag in mypDeploy:
  Aktion: Ausführungs-Fehler
  Zeit: 02.12.2022, 17:09:22
  Computer: WWVTDEMO07
  Quelle: Client
  Meldung: 14761: Das Paket-Ausführungs-Skript-Skript "MypdclnEpTestCompliance" hat einen Fehler gemeldet: PowerShell Initialisierungs-Fehler (Code 1510): System.Management.Automation.RuntimeException : Das Compliance-Script endet immer mit einem Fehler.

Verzögern der Installation

Sie können über Ihr SMC mypDeploy auch anweisen, das Paket mit einer Verzögerung zu installieren.

• CSL_ReturnValue "Result","2" → das Paket ist nicht installiert, soll aber aktuell auch nicht installiert werden.

• CSL_ReturnValue "DelayMin","X" → erneuter Installationsversuch in x Minuten.

• CSL_ReturnValue "DelayMsg","erneuter Versuch" → Eine Meldung, die in das Protokoll des Clients eingetragen wird.

• Beispiel:
  # mypDeploy PowerShell script
  Function PS-MypdclnEpTestCompliance
  {
  $ErrorActionPreference = "Continue"
  If ((Get-WmiObject -class win32_battery).EstimatedChargeRemaining -ge 50)
  {
  CSL_ReturnValue "Result", "0"
  }
  Else
  {
  CSL_ReturnValue "Result", "2"
  CSL_ReturnValue "DelayMin", "15"
  CSL_ReturnValue "DelayMsg", "Akkustand zu niedrig; erneuter Versuch in 15 Minuten"
  }
  }
  erzeugt folgenden Protokolleintrag in mypDeploy:
  Aktion: Paketstatus geändert
  Paket/Patch:
  Neuer Status: Nicht installiert
  Zeit: 3.1.2024, 10:50:50
  Computer: WWMPBN07
  Benutzer: WWMPBN07
  Quelle: Client
  Meldung: Akkustand zu niedrig; erneuter Versuch in 15 Minuten

In diesem Beispiel wird geprüft, ob der Akku zu mindestens 50% geladen ist. Falls nicht wird die entsprechende Meldung zurück an mypDeploy gegeben. Nach der eingestellten Wartezeit wird beim nächsten Durchlauf des mypDeploy-Clients das SMC erneut ausgeführt.

Reihenfolge der Ausführung

SMC werden immer vor der Aktion ausgeführt, die Sie überwachen (Installation/Deinstallation)

Installation Software A

1. Software A wird zugewiesen

2. Das SMC für Software A führt die Funktion PS-MypdclnEpTestCompliance aus

3. mypDeployClientService wertet das Ergebnis des SMC aus

4. hat das SMC als Ergebnis “1” gemeldet, wird das Paket nicht heruntergeladen, sondern in der mypDeploy-Datenbank als “installiert” aktualisiert und ggf. noch im Cache befindliche Installationsdateien gelöscht

5. hat das SMC als Ergebnis “0” gemeldet, wird das Paket wie gewohnt heruntergeladen und installiert

Deinstallation Software A

1. Software A wird zur Deinstallation zugewiesen

2. Das SMC für Software A führt die Funktion PS-MypdclnEpTestCompliance aus

3. mypDeployClientService wertet das Ergebnis des SMC aus

4. hat das SMC als Ergebnis “0” gemeldet, wird das Paket nicht heruntergeladen, sondern in der mypDeploy-Datenbank als “nicht installiert” aktualisiert und ggf. noch im Cache befindliche Installationsdateien gelöscht

5. hat das SMC als Ergebnis “1” gemeldet, wird das Paket wie gewohnt heruntergeladen und deinstalliert

SMC registrieren

Über “Aktion/Serverseitig verwaltete Scripte” registrieren Sie Ihr SMC in der mypDeploy-Datenbank.

Open

Wählen Sie Ihr Script aus

Open

Der Name wird Ihnen aus dem Scriptnamen vorgeschlagen.

Eine optionale Beschreibung kann mit Erläuterungen gefüllt werden.

SMC zuordnen

Sobald Sie Ihr SMC registriert haben, können Sie es genau einem Paket zuordnen.

Wählen Sie aus den Listen das Paket aus, das das SMC prüfen soll. Es werden Ihnen nur Pakete angeboten, keine Scripte oder Scriptgruppen.

Ihre Auswahl sehen Sie anschließend in den Eigenschaften des SMC

Sonstige Hinweise