dsc-Konfigurationstest

Artikel
06/24/2024

Zusammenfassung

Überprüft, ob sich die Ressourceninstanzen in einem Konfigurationsdokument im gewünschten Zustand befinden.

Syntax

Konfigurationsdokument aus stdin

<document-string> | dsc config test [Options]

Konfigurationsdokument aus Optionszeichenfolge

dsc config test [Options] --document <document-string>

Konfigurationsdokument aus Datei

dsc config test [Options] --path <document-filepath>

BESCHREIBUNG

Der test Unterbefehl überprüft, ob sich die Ressourceninstanzen in einem Konfigurationsdokument im gewünschten Zustand befinden. Wenn dieser Befehl ausgeführt wird, überprüft DSC das Konfigurationsdokument vor dem Aufrufen des Testvorgangs für jede im Dokument definierte Ressource instance.

Das Konfigurationsdokument muss an diesen Befehl als JSON oder YAML über stdin, als Zeichenfolge mit der Dokumentoption oder aus einer Datei mit der Pfadoption übergeben werden.

Beispiele

Beispiel 1: Testen, ob sich die Ressourceninstanzen einer Konfiguration im gewünschten Zustand befinden

Der Befehl gibt die status, den gewünschten Zustand, den tatsächlichen Zustand und unterschiedliche Eigenschaften für die Ressourceninstanzen zurück, die im Konfigurationsdokument definiert sind, das als example.dsc.config.yamlgespeichert wird.

# example.dsc.config.yaml
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
resources:
- name: Windows only
  type: Microsoft.DSC/Assertion
  properties:
    $schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
    resources:
    - name: os
      type: Microsoft/OSInfo
      properties:
        family: Windows
- name: Current user registry example
  type: Microsoft.Windows/Registry
  properties:
    keyPath: HKCU\example
    _exist: true
  dependsOn:
    - "[resourceId('Microsoft.DSC/Assertion', 'Windows only')"

cat ./example.dsc.config.yaml | dsc config test

Beispiel 2: Übergeben einer Datei zum Lesen als Konfigurationsdokument

Der Befehl verwendet die Pfadoption , um die in der example.dsc.config.yaml Datei definierte Konfiguration zu überprüfen.

dsc config test --path ./example.dsc.config.yaml

Beispiel 3: Übergeben eines Konfigurationsdokuments als Variable

Der Befehl verwendet die Dokumentoption , um die in der Variablen gespeicherte $desired Konfiguration zu überprüfen.

dsc config test --document $desired

Optionen

-d, --document

Gibt das Konfigurationsdokument an, für das der Status überprüft werden soll. Das Dokument muss eine Zeichenfolge sein, die ein JSON- oder YAML-Objekt enthält. DSC überprüft das Dokument anhand des Konfigurationsdokumentschemas. Wenn die Überprüfung fehlschlägt, löst DSC einen Fehler aus.

Diese Option kann nicht mit dem Konfigurationsdokument über stdin oder mit der --path Option verwendet werden. Wählen Sie aus, ob das Konfigurationsdokument über stdin, aus einer Datei mit der Option oder mit der --path Option an den --document Befehl übergeben werden soll.

Type:      String
Mandatory: false

-p, --path

Definiert den Pfad zu einem Konfigurationsdokument, für das der Zustand überprüft werden soll, anstatt das Dokument aus stdin zu übergeben oder es als Zeichenfolge mit der --document Option zu übergeben. Die angegebene Datei muss ein Konfigurationsdokument als JSON- oder YAML-Objekt enthalten. DSC überprüft das Dokument anhand des Konfigurationsdokumentschemas. Wenn die Überprüfung fehlschlägt oder die angegebene Datei nicht vorhanden ist, löst DSC einen Fehler aus.

Diese Option schließt sich mit der --document Option gegenseitig aus. Wenn Sie diese Option verwenden, ignoriert DSC alle Eingaben von stdin.

Type:      String
Mandatory: false

-f, --format

Die --format Option steuert das Konsolenausgabeformat für den Befehl. Wenn die Befehlsausgabe umgeleitet oder als Variable erfasst wird, ist die Ausgabe immer JSON.

Type:         String
Mandatory:    false
DefaultValue: yaml
ValidValues:  [json, pretty-json, yaml]

-h, --help

Zeigt die Hilfe für den aktuellen Befehl oder Unterbefehl an. Wenn Sie diese Option angeben, ignoriert die Anwendung alle Optionen und Argumente nach dieser Option.

Type:      Boolean
Mandatory: false

Ausgabe

Dieser Befehl gibt eine JSON-Ausgabe zurück, die enthält, ob der Vorgang oder Ressourcen Fehler ausgelöst haben, die Sammlung der während des Vorgangs ausgegebenen Nachrichten und die Testvorgangsergebnisse für jeden instance. Weitere Informationen finden Sie unter dsc-Konfigurationstestergebnisschema.

Freigeben über