DSC

Zusammenfassung

Konfiguration anwenden oder spezifische Ressourcen aufrufen, um Softwarekomponenten zu verwalten.

Syntax

dsc [Options] <COMMAND>

Commands

Completer

Der Befehl completer gibt ein Shell-Skript zurück, das bei Ausführung die Komplettierungen für die gegebene Shell registriert. Weitere Informationen finden Sie unter dsc completer.

config

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

  • Erhalte den aktuellen Zustand der Konfiguration.
  • Testen Sie, ob sich eine Konfiguration im gewünschten Zustand befindet.
  • Setze eine Konfiguration auf den gewünschten Zustand.

Für weitere Informationen siehe DSC-Konfiguration.

resource

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

  • Listen Sie die verfügbaren Ressourcen auf.
  • Hol dir das JSON-Schema für die Instanzen einer Ressource.
  • Erfassen Sie den aktuellen Zustand einer Ressourceninstanz.
  • Testen Sie, ob eine Ressourceninstanz sich im gewünschten Zustand befindet.
  • Setze eine Ressourceninstanz auf den gewünschten Zustand.

Weitere Informationen finden Sie unter der DSC-Ressource

schema

Der schema Befehl gibt das JSON-Schema für einen bestimmten DSC-Typ zurück. Für weitere Informationen siehe dsc-Schema.

Hilfe

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

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

dsc help <COMMAND> [<SUBCOMMAND>]

Zum Beispiel dsc help config bekommt er Hilfe für das config Unterkommando. dsc help config set Bekommt Hilfe für das config set Unterkommando.

Du kannst auch die --help-Option auf einem Befehl verwenden, um die Hilfeinformationen anzuzeigen. Zum Beispiel: dsc config --help oder dsc config set --help.

Options

-l, --Spur-Level

Definiert die minimale Nachrichtenebene, die DSC während einer Operation emittieren soll. Nachrichten in DSC werden nach ihrem Level kategorisiert.

Die folgende Liste zeigt die gültigen Nachrichtenstufen vom höchsten bis zum untersten Niveau. Wenn diese Option auf einen beliebigen Wert in der Liste gesetzt ist, sendet DSC Nachrichten auf dieser Ebene und höher.

  • error
  • warn (Standardwert)
  • info
  • debug
  • trace

Warnung

Die trace Pegelausgabe sendet alle JSON-Ein- und Ausgaben, die DSC während der Ausführung verarbeitet. DSC desinfiziert das JSON nicht, bevor es ausgesendet wird. Dieses Trace-Level ist ausschließlich für die Nutzung durch Entwickler gedacht. Leiten Sie niemals die Ausgabe des Levels in den Speicher um, trace da sie sensible Informationen enthalten könnten.

Zum Beispiel, wenn die Log-Ebene ist debug, sendet DSC Nachrichten für jede Log-Ebene außer trace. Wenn das Log-Level ist error, sendet DSC nur Fehlermeldungen. DSC ignoriert jede Nachricht mit einem niedrigeren Log-Level.

Type         : string
Mandatory    : false
DefaultValue : warn
ValidValues  : [error, warn, info, debug, trace]
LongSyntax   : --trace-level <TRACE_LEVEL>
ShortSyntax  : -l <TRACE_LEVEL>

-f, --Trace-Format

Definiert das Ausgabeformat, das beim Aussenden von Trace-Nachrichten auf stderr verwendet wird. DSC unterstützt folgende Formate:

  • default - Sendet die Nachricht mit ANSI-Konsolenfarbung für Zeitstempel, Nachrichtenniveau und Zeilennummer aus.
  • plaintext - Als default , aber ohne Konsolenfarben.
  • json - Gibt jede Nachricht als komprimiertes JSON-Objekt mit Zeitstempel, Level, Nachricht und Zeilennummer als Eigenschaften aus.
Type         : string
Mandatory    : false
DefaultValue : default
ValidValues  : [default, plaintext, json]
LongSyntax   : --trace-format <TRACE_FORMAT>
ShortSyntax  : -f <TRACE_FORMAT>

-p, --progress-format

Definiert das Fortschrittsformat, das beim Aussenden von Fortschrittsmeldungen auf stderr verwendet wird. DSC unterstützt folgende Formate:

  • default - Zeigt eine Fortschrittsleiste an, wenn DSC erkennt, dass sie interaktiv aufgerufen wird. Ansonsten zeigt DSC keinen Fortschritt.
  • none - Zeigt keinen Fortschritt.
  • json - Erzeugt den Fortschritt als komprimierte JSON-Objekte mit Zeitstempel, Level, Nachricht und Zeilennummer als Eigenschaften.
Type         : string
Mandatory    : false
DefaultValue : default
ValidValues  : [default, none, json]
LongSyntax   : --progress-format <PROGRESS_FORMAT>
ShortSyntax  : -p <PROGRESS_FORMAT>

-V, --Version

Zeigt die Version der Anwendung an. Wenn Sie diese Option angeben, ignoriert die Anwendung alle Optionen und Argumente außer --help, das diese Option überschreibt.

Type        : boolean
Mandatory   : false
LongSyntax  : --version
ShortSyntax : -V

-h, --help (Hilfe)

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

Type        : boolean
Mandatory   : false
LongSyntax  : --help
ShortSyntax : -h

Umgebungsvariablen

Standardmäßig sucht der dsc Befehl nach DSC-Ressourcenmanifesten in den durch die Umgebungsvariable PATH definierten Ordnern. Wenn die DSC_RESOURCE_PATH Umgebungsvariable definiert ist, dsc sucht sie die Ordner in DSC_RESOURCE_PATH statt PATH.

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

Ausgangscodes

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

Beendigungscode Bedeutung
0 Der Befehl wurde erfolgreich und fehlerfrei ausgeführt.
1 Der Befehl scheiterte, weil er ungültige Argumente erhielt.
2 Der Befehl schlug fehl, weil eine Ressource einen Fehler auslöste.
3 Der Befehl scheiterte, weil ein Wert nicht an JSON serialisiert oder deserialisiert werden konnte.
4 Der Befehl schlug fehl, weil die Eingabe für den Befehl nicht gültig war, YAML oder JSON.
5 Der Befehl scheiterte, weil eine Ressourcendefinition oder ein Instanzwert gegen sein JSON-Schema ungültig war.
6 Der Befehl wurde durch eine Unterbrechung von Strg-C+ aufgehoben.

Hinweise

DSC erwartet, dass Eingabestrings UTF-8-Codierung verwenden. Wenn du Eingaben von stdin oder den Pfad an eine Datei weitergibst, stelle sicher, dass die Eingabe als UTF-8 codiert ist.

  • Last updated on