dsc-Konfiguration

Artikel
05/11/2024

Zusammenfassung

Wenden Sie ein Konfigurationsdokument an.

Syntax

dsc config [Options] <COMMAND>

BESCHREIBUNG

Der dsc config Befehl enthält Unterbefehle zum Verwalten der in einem DSC-Konfigurationsdokument definierten Ressourceninstanzen. Informationen zum direkten Verwalten von Ressourcen finden Sie im Befehl dsc resource .

Befehle

Export

Der export Befehl generiert ein Konfigurationsdokument, das die vorhandenen Instanzen einer Gruppe von Ressourcen definiert. Weitere Informationen finden Sie unter dsc-Konfigurationsexport.

get

Der get Befehl ruft den aktuellen Zustand der Ressourceninstanzen in einem Konfigurationsdokument ab. Weitere Informationen finden Sie unter dsc config get.

set

Der set Befehl erzwingt den gewünschten Zustand der Ressourceninstanzen in einem Konfigurationsdokument. Weitere Informationen finden Sie unter dsc-Konfigurationssatz.

test

Der test Befehl überprüft, ob sich die Ressourceninstanzen in einem Konfigurationsdokument im gewünschten Zustand befinden. Weitere Informationen finden Sie unter dsc-Konfigurationstest.

help

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

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

dsc config help [<SUBCOMMAND>]

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

Sie können auch die Option --help für den Befehl oder Unterbefehl verwenden, um die Hilfeinformationen anzuzeigen. Zum Beispiel: dsc config --help oder dsc config set --help.

Optionen

-f, --parameters_file

Gibt den Pfad zu einer Datendatei an, die die Parameter enthält, die als JSON oder YAML an die Konfiguration übergeben werden sollen. Wenn Sie diese Option angeben, interpretiert DSC die Schlüssel in der Datendatei als Parameter und verwendet die angegebenen Werte. Die Werte in der Datendatei setzen alle in der Konfiguration selbst definierten Standardwerte außer Kraft.

Die Datendatei muss ein -Objekt mit dem parameters Schlüssel enthalten. Der Wert des parameters Schlüssels muss ein Objekt sein, wobei jeder Schlüssel der Name eines definierten Parameters ist und jeder Wert ein gültiger Wert für diesen Parameter ist.

Diese Option kann nicht mit der --parameters Option verwendet werden. Wählen Sie aus, ob die Parameter als Datenzeichenfolge mit der --parameters Option oder in einer Datendatei mit der --parameters_file Option übergeben werden sollen.

Weitere Informationen zum Definieren von Parametern in einem Konfigurationsdokument finden Sie unter DSC-Konfigurationsdokumentparameterschema. Weitere Informationen zur Verwendung von Parametern im Konfigurationsdokument finden Sie in der Referenz zur Parameterfunktion.

-p, --parameters

Gibt die Parameter an, die als JSON- oder YAML-Zeichenfolge an die Konfiguration übergeben werden sollen. Wenn Sie diese Option angeben, interpretiert DSC die Schlüssel in der Datenzeichenfolge als Parameter und verwendet die angegebenen Werte. Die Werte in der Datenzeichenfolge setzen alle in der Konfiguration selbst definierten Standardwerte außer Kraft.

Die Datenzeichenfolge muss ein -Objekt mit dem parameters Schlüssel enthalten. Der Wert des parameters Schlüssels muss ein Objekt sein, wobei jeder Schlüssel der Name eines definierten Parameters ist und jeder Wert ein gültiger Wert für diesen Parameter ist.

Diese Option kann nicht mit der --parameters_file Option verwendet werden. Wählen Sie aus, ob die Parameter als Datenzeichenfolge mit der --parameters Option oder in einer Datendatei mit der --parameters_file Option übergeben werden sollen.

-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

Umgebungsvariablen

Die dsc config * Unterbefehle erstellen die DSC_CONFIG_ROOT Umgebungsvariable, wenn Sie einen Befehl mit der --path Option zum Angeben des konfigurationsdokuments für den Befehl aufrufen. DSC legt den Wert der DSC_CONFIG_ROOT Umgebungsvariablen auf den vollständigen Pfad des Ordners fest, der das angegebene Konfigurationsdokument enthält.

Hinweis

Wenn Sie die DSC_CONFIG_ROOT Variable außerhalb von DSC definieren, löst DSC eine Warnung aus, wenn der Wert der vorhandenen Umgebungsvariable für einen Vorgang überschrieben wird.

Sie können die envvar-Konfigurationsfunktion verwenden, um auf diesen Ordnerpfad für Ressourceninstanzen in der Konfiguration zu verweisen.

Freigeben über