Freigeben über

DSC

  • Artikel

Zusammenfassung

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

Syntax

dsc [Options] <COMMAND>

Befehle

completer

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

config

Der config Befehl verwaltet ein DSC-Konfigurationsdokument. Sie können damit:

  • 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.

resource

Der resource Befehl verwaltet eine DSC-Ressource. Sie können damit:

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

Weitere Informationen finden Sie unter Ressource.

schema

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

help

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

Um die Hilfe für einen Befehl oder Unterbefehl zu erhalten, verwenden Sie die Syntax:

dsc help <COMMAND> [<SUBCOMMAND>]

Ruft beispielsweise dsc help config die Hilfe für den config Unterbefehl ab. dsc help config set ruft die Hilfe für den config set Unterbefehl ab.

Sie können auch die Option --help für einen Befehl verwenden, um die Hilfeinformationen anzuzeigen. Zum 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 DSC während eines Vorgangs ausgeben 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 trace Levelausgabe gibt alle JSON-Eingaben/Ausgaben aus, die DSC während der Ausführung verarbeitet. DSC bereinigung des JSON-Codes nicht vor der Ausgabe. Diese Ablaufverfolgungsebene ist nur für die Verwendung durch Entwickler vorgesehen. Leiten trace Sie die Ausgabe der Ebene niemals an den Speicher um, da dieser möglicherweise vertrauliche Informationen enthält.

Wenn die Protokollebene z. B. ist debug, gibt DSC Meldungen für jede Protokollebene mit Ausnahme tracevon aus. Wenn die Protokollebene ist error, 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 Ausgeben von Ablaufverfolgungsmeldungen auf stderr verwendet werden soll. DSC unterstützt die folgenden Formate:

  • default – Gibt die Nachricht mit der 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 in den dsc von der PATH Umgebungsvariablen definierten Ordnern nach befehlsbasierten DSC-Ressourcenmanifesten. Wenn die DSC_RESOURCE_PATH Umgebungsvariable definiert ist, dsc durchsucht die Ordner in DSC_RESOURCE_PATH anstelle von PATH.

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

Exitcodes

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

Exitcode Bedeutung
0 Der Befehl wurde ohne Fehler erfolgreich ausgeführt.
1 Der Befehl ist fehlgeschlagen, weil er ungültige Argumente empfangen hat.
2 Der Befehl ist fehlgeschlagen, weil eine Ressource einen Fehler ausgelöst hat.
3 Der Befehl ist fehlgeschlagen, weil ein Wert nicht in JSON serialisiert oder aus JSON deserialisiert werden konnte.
4 Der Befehl ist fehlgeschlagen, weil die Eingabe für den Befehl nicht gültig war YAML oder JSON.
5 Der Befehl ist fehlgeschlagen, weil eine Ressourcendefinition oder instance Wert für das JSON-Schema ungültig war.
6 Der Befehl wurde durch eine Strg C-Unterbrechung+ abgebrochen.