Dsc

Zusammenfassung

Wenden Sie die Konfiguration an, oder rufen Sie bestimmte Ressourcen auf, um Softwarekomponenten zu verwalten.

Syntax

dsc [Options] <COMMAND>

Befehle

completer

Der Befehl completer gibt ein Shellskript zurück, das bei Ausführung fertigstellungen für die angegebene Shell registriert. Weitere Informationen finden Sie unter completer.

config

Der Befehl config verwaltet ein DSC-Konfigurationsdokument. Sie können es verwenden, um:

• Rufen Sie den aktuellen Status der Konfiguration ab.
• Testen Sie, ob sich eine Konfiguration im gewünschten Zustand befindet.
• Legen Sie eine Konfiguration auf den gewünschten Zustand fest.

Weitere Informationen finden Sie unter Config.

Ressource

Der Befehl resource verwaltet eine DSC-Ressource. Sie können es verwenden, um:

• Auflisten der verfügbaren Ressourcen.
• Rufen Sie das JSON-Schema für die Instanzen einer Ressource ab.
• Rufen Sie den aktuellen Status einer Ressourceninstanz ab.
• Testen Sie, ob sich eine Ressourceninstanz im gewünschten Zustand befindet.
• Legen Sie eine Ressourceninstanz auf den gewünschten Zustand fest.

Weitere Informationen finden Sie unter Ressourcen-

Schema

Der Befehl schema gibt das JSON-Schema für einen bestimmten DSC-Typ zurück. Weitere Informationen finden Sie unter Schema-.

Hilfe

Der Befehl help gibt Hilfeinformationen für dsc, einen Befehl oder einen Unterbefehl zurück.

Verwenden Sie die Syntax, um die Hilfe für einen Befehl oder Unterbefehl abzurufen:

dsc help <COMMAND> [<SUBCOMMAND>]

Beispielsweise ruft dsc help config die Hilfe für den unterbefehl config ab. dsc help config set ruft die Hilfe für den unterbefehl config set ab.

Sie können auch die Option --help auf einem Befehl verwenden, um die Hilfeinformationen anzuzeigen. Beispiel: dsc config --help oder dsc config set --help.

Optionen

-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

-l, --trace-level

Definiert die Minimale Nachrichtenebene, die während eines Vorgangs ausgegeben werden soll. Nachrichten in DSC werden nach ihrer Ebene kategorisiert.

Die folgende Liste zeigt die gültigen Nachrichtenebenen von der höchsten bis zur niedrigsten Ebene. Wenn diese Option auf einen beliebigen Wert in der Liste festgelegt ist, gibt DSC Nachrichten auf dieser Ebene und höher aus.

• error
• warning (Standard)
• info
• debug
• trace

Warnung

Die Ausgabe der trace Ebene gibt alle JSON-Eingabe-/Ausgabe aus, die DSC während der Ausführung verarbeitet. DSC sanitiert den JSON-Code nicht, bevor er ausgibt. Diese Ablaufverfolgungsebene ist nur für die Entwicklerverwendung vorgesehen. Leiten Sie niemals trace Ausgabe der Ebene an den Speicher weiter, da sie vertrauliche Informationen enthalten kann.

Wenn die Protokollebene z. B. debugist, gibt DSC Nachrichten für jede Protokollebene mit Ausnahme von traceaus. Wenn die Protokollebene errorist, gibt DSC nur Fehlermeldungen aus. DSC ignoriert jede Nachricht mit einer niedrigeren Protokollebene.

Type:         String
Mandatory:    false
DefaultValue: warning
ValidValues:  [error, warning, info, debug, trace]

-f, --trace-format

Definiert das Ausgabeformat, das beim Senden von Ablaufverfolgungsmeldungen auf stderr verwendet werden soll. DSC unterstützt die folgenden Formate:

• default – Gibt die Nachricht mit ANSI-Konsolenfarbe für den Zeitstempel, die Nachrichtenebene und die Zeilennummer aus.
• plaintext – Wie default, aber ohne Konsolenfarben.
• json – Gibt jede Nachricht als komprimiertes JSON-Objekt mit dem Zeitstempel, der Ebene, der Nachricht und der Zeilennummer als Eigenschaften aus.

Type:         String
Mandatory:    false
DefaultValue: default
ValidValues:  [default, plaintext, json]

-V, --version

Zeigt die Version der Anwendung an. Wenn Sie diese Option angeben, ignoriert die Anwendung alle Optionen und Argumente nach dieser Option.

Type:      Boolean
Mandatory: false

Umgebungsvariablen

Standardmäßig sucht der befehl dsc nach befehlsbasierten DSC-Ressourcenmanifesten in den Ordnern, die durch die PATH Umgebungsvariable definiert sind. Wenn die DSC_RESOURCE_PATH Umgebungsvariable definiert ist, durchsucht dsc die Ordner in DSC_RESOURCE_PATH anstelle von PATH.

Die DSC_RESOURCE_PATH Umgebung muss eine Umgebungsvariable sein, die den gleichen Konventionen entspricht wie die PATH Umgebungsvariable für das Betriebssystem. Trennen Sie Ordnerpfade mit einem Semikolon (;) unter Windows und einem Doppelpunkt (:) auf anderen Plattformen.

Ausgangscodes

Der Befehl dsc verwendet semantische Exitcodes. Jeder Beendigungscode stellt ein anderes Ergebnis für die Ausführung des Befehls dar.

Exit Code	Bedeutung
0	Der Befehl wurde ohne Fehler erfolgreich ausgeführt.
1	Fehler des Befehls, weil er ungültige Argumente empfangen hat.
2	Fehler beim Befehl, da eine Ressource einen Fehler ausgelöst hat.
3	Fehler beim Befehl, da ein Wert nicht in JSON serialisiert oder deserialisiert werden konnte.
4	Der Befehl ist fehlgeschlagen, da die Eingabe für den Befehl ungültige YAML- oder JSON-Code war.
5	Fehler beim Befehl, da eine Ressourcendefinition oder ein Instanzwert für das JSON-Schema ungültig war.
6	Der Befehl wurde von einer STRG-+C-unterbrechung abgebrochen.

Notizen

DSC erwartet Eingabezeichenfolgen für die Verwendung der UTF-8-Codierung. Wenn Sie Eingaben von Stdin oder dem Pfad zu einer Datei übergeben, stellen Sie sicher, dass die Eingabe als UTF-8 codiert ist.