Variablen und Funktionen
Security Controls bietet für jedes Skript eine Reihe von PowerShell-Variablen und -Funktionen. Die Namen der Variablen beginnen alle mit "ST_". Die Namen der Funktionen beginnen mit "ST-". Sie können diese Variablen und Funktionen in Ihren Skripten verwenden.
Für PowerShell-Variablen gibt es unterschiedliche Bereiche:
- Global: Verfügbar für die aktuelle PowerShell-Sitzung.
- Skript: Im Skript deklariert (außerhalb der Funktionen) und lokal für dieses Skript gültig.
- Privat: In einer Funktion deklariert und lokal für diese Funktion gültig.
- Lokal: Der aktuelle Bereich, also Global, Skript oder Privat.
Die in Security Controls enthaltenen Variablen sind auf globaler Ebene deklariert. Da jeder Zielcomputer als eigene PowerShell-Sitzung ausgeführt wird, entspricht dies einer Deklaration im Bereich des Skripts.
Durchlaufvariablen
Die folgende Tabelle enthält die auf den Durchlauf bezogenen Variablen. Auf allen Computern wird derselbe Wert für diese Variablen angezeigt. Ändern Sie nicht den Wert von Variablen, die als [schreibgeschützt] gekennzeichnet sind.
| Name der Variable | Beschreibung |
|---|---|
| ST_OutputDirectory | Der vollständige Pfad zum Basisausgabeverzeichnis. Für den Durchlauf wird ein Unterverzeichnis erstellt. [schreibgeschützt] |
| ST_RunDirectory | Der vollständige Pfad zum Ausgabeverzeichnis für den Durchlauf. [schreibgeschützt] |
| ST_RunErrorFile | Der vollständige Pfad zur Fehlerdatei für den Durchlauf. Fehler, die sich nicht auf einen bestimmten Computer beziehen, sollten in diese Datei geschrieben werden. Diese Datei enthält auch Meldungen zu Computern, die nicht als IP-Adresse aufgelöst werden konnten. Für nicht auflösbare Computer wird ein Unterverzeichnis ohne Computerzuordnung angelegt. [schreibgeschützt] |
| ST_RunName | Der Name des Durchlaufs, der auf der Benutzeroberfläche bei der Initiierung oder Planung angegeben wurde, sowie Dauer des Durchlaufs. Standardmäßig wird der Name des Skripts oder der Vorlage verwendet. [schreibgeschützt] |
| ST_RunOnConsole | Setzen Sie den Wert auf "$false", wenn das Skript PowerShell Remoting verwendet, anderenfalls auf "$true". [schreibgeschützt] |
| ST_RunOutputFile | Der vollständige Pfad zur standardmäßigen Ausgabedatei des Durchlaufs. Die gesamte Ausgabe, die in der Konsole bei Ausführung über eine Befehlseingabeaufforderung angezeigt wird, wird in dieser Datei abgelegt. [schreibgeschützt] |
| ST_RunResult | Dies ist ein Kurzergebnis für den Durchlauf und wird in der Vorgangsüberwachung angezeigt. Die Länge ist auf 100 Zeichen begrenzt. Wenn Sie diese Variable in Ihrem Skript nicht explizit festlegen, wird sie so eingestellt, dass die Anzahl der Computer mit Fehlern und die Anzahl der Computer mit erfolgter Fehlerbehebung angezeigt werden. |
Computervariablen
Die folgende Tabelle enthält die auf den Computer bezogenen Variablen. Der Wert der Variablen kann auf jedem Zielcomputer anders lauten. Ändern Sie nicht den Wert von Variablen, die als [schreibgeschützt] gekennzeichnet sind.
| Name der Variable | Beschreibung |
|---|---|
| ST_ComputerName | Der Name des Zielcomputers. [schreibgeschützt] |
| ST_Credential | Ein PSCredential-Objekt, das den Benutzernamen und das SecureString-Kennwort für die Verbindung mit dem Zielcomputer enthält. Diese Variable kann an jeden Befehl übergeben werden, der den Credential-Parameter unterstützt. [schreibgeschützt] |
| ST_DomainName | Der Name der Domäne oder der Arbeitsgruppe des Zielcomputers. [schreibgeschützt] |
| ST_MachineDirectory | Der vollständige Pfad zum Computerverzeichnis. Dies ist in der Regel der Computername. Enthält dieser Zeichen, die in Ordnernamen nicht zulässig sind, werden diese durch Unterstriche ersetzt. [schreibgeschützt] |
| ST_MachineError | Ein boolescher Wert, der darauf hinweist, dass während der Skriptausführung für diesen spezifischen Computer ein oder mehrere Fehler aufgetreten sind. |
| ST_MachineErrorFile | Der vollständige Pfad zur Fehlerdatei für den Computer. Sollten bei der Skriptausführung Fehler festgestellt werden, werden sie in dieser Datei erfasst. [schreibgeschützt] |
| ST_MachineOutputFile | Der vollständige Pfad zur Ausgabedatei für den Computer. Die durch das Skript in der Standardausgabe generierte Ausgabe wird in dieser Datei erfasst. |
| ST_MachineResult | Dies ist ein Kurzergebnis für den Computer und wird in der Vorgangsüberwachung angezeigt. Die Länge ist auf 100 Zeichen begrenzt. Wenn Sie diese Variable in Ihrem Skript nicht explizit festlegen, wird sie so eingestellt, dass eine Erfolgsmeldung ausgegeben wird, wenn keine Fehler erkannt wurden. Bei Fehlern wird die Fehlermeldung des ersten Fehlers für diesen Computer ausgegeben. Mit der Funktion "ST-SetMachineResult" wird der Wert dieser Variable explizit eingestellt. |
| ST_MachineResultSet | Ein boolescher Wert, der darauf hinweist, dass das Skript die Variable "ST_MachineResult" festgelegt hat. Verwenden Sie die Funktion "ST-SetMachineResult" um die Variable "ST_MachineResult" und diese Variable festzulegen. |
End Function
Security Controls bietet einen Satz mit Funktionen, die für die von Ihnen erstellten Skripte verfügbar sind. Die Funktionen sind in der nachfolgenden Tabelle aufgeführt.
| Name der Variable | Beschreibung |
|---|---|
| ST-GetTargetOS | Diese Funktion versucht, eine Verbindung zum Zielsystem herzustellen, WMI abzufragen und das Win32_OperatingSystem-Objekt abzurufen. |
| ST-SetMachineResult | Diese Funktion verwendet einen Zeichenfolgeparameter. Sie setzt die Variable "ST_MachineResult" auf die übergebene Zeichenfolge und die Variable "ST_MachineResultSet" auf "$true". |
| ST-SetMachineError | Diese Funktion verwendet ein Zeichenfolgenargument. Sie setzt die Variable "ST_MachineResult" auf die übergebene Zeichenfolge. Die Variablen "ST_MachineResultSet" und "ST_MachineError" werden außerdem auf "$true" gesetzt. |
| ST-SendMessage | Diese Funktion verwendet einen Zeichenfolgeparameter. Die Zeichenfolge wird in der Vorgangsüberwachung angezeigt. Mit dieser Funktion lässt sich der Fortschritt lang andauernder Skripte überwachen. Nach Abschluss des Skripts wird die Zeichenfolge aus "ST_MachineResult" in der Vorgangsüberwachung angezeigt. Abgesehen von der Fehlerbehebung sollten Sie diese Methode nicht in Skripten mit kurzer Ausführungszeit aufrufen. Falls eine längere Zeichenfolge übergeben wird, wird diese auf 100 Zeichen gekürzt. |
| ST-CreateMachineDirectory | Normalerweise wird das Computerverzeichnis erst erstellt, nachdem eine Ausgabe generiert wurde. Falls durch Ihr Skript Dateien im Computerverzeichnis erstellt werden, legen Sie anhand dieser Funktion zuerst das Verzeichnis an, bevor Ausgaben generiert werden. Die Funktion kann mehrmals aufgerufen werden. |
| ST-CreateRunDirectory | Normalerweise wird das Ausführungsverzeichnis erst erstellt, nachdem eine Ausgabe generiert wurde. Falls durch Ihr Skript Dateien im Ausführungsverzeichnis erstellt werden, legen Sie anhand dieser Funktion zuerst das Verzeichnis an, bevor Ausgaben generiert werden. Die Funktion kann mehrmals aufgerufen werden. |
| ST-ComputerAndCredential | Diese Funktion gibt geeignete Werte für die Parameter "ComputerName" und "Credential" für den Zielcomputer zurück. Details finden Sie unter Festlegen der Parameter "ComputerName" und "Credential". |
| ST-SubCC | Diese Funktion verwendet einen Zeichenfolgeparameter, der einen gültigen PowerShell-Befehl darstellt. Die Funktion ersetzt "$ST_CC" in der Befehlszeichenfolge durch Werte, die für die Parameter "ComputerName" und "Credential" des Befehls geeignet sind. Anschließend werden der daraus resultierende Befehl ausgeführt und die Ergebnisse zurückgegeben. Details finden Sie unter Festlegen der Parameter "ComputerName" und "Credential". |