Konfigurace dsc

Přehled

Použijte konfigurační dokument.

Syntaxe

dsc config [Options] <COMMAND>

Popis

Příkaz dsc config obsahuje dílčí příkazy pro správu instancí prostředků definovaných v konfiguračním dokumentu DSC. Chcete-li spravovat prostředky přímo, přečtěte si příkaz dsc resource .

Příkazy

exportovat

Příkaz export vygeneruje konfigurační dokument, který definuje existující instance sady prostředků. Další informace naleznete v tématu Export konfigurace nástroje DSC.

get

Příkaz get načte aktuální stav instancí prostředků v konfiguračním dokumentu. Další informace naleznete v tématu dsc config get.

nastavit

Příkaz set vynutí požadovaný stav instancí prostředků v konfiguračním dokumentu. Další informace naleznete v tématu konfigurační sada nástroje dsc.

test

Příkaz test ověří, zda jsou instance prostředků v konfiguračním dokumentu v požadovaném stavu. Další informace naleznete v tématu Konfigurační test nástroje DSC.

pomoc

Příkaz help vrátí informace nápovědy pro tento příkaz nebo dílčí příkaz.

Chcete-li získat nápovědu k příkazu nebo dílčímu příkazu, použijte syntaxi:

dsc config help [<SUBCOMMAND>]

dsc config help Například získá nápovědu k tomuto příkazu. dsc config help set Získá nápovědu k dílčímu příkazu set .

K zobrazení informací nápovědy můžete také použít možnost --help v příkazu nebo dílčím příkazu. Například dsc config --help nebo dsc config set --help.

Možnosti

-f, --parameters-soubor

Určuje cestu k datovému souboru obsahujícímu parametry, které mají být předány konfiguraci jako JSON nebo YAML. Když určíte tuto volbu, DSC interpretuje klíče v datovém souboru jako parametry a použije určené hodnoty. Hodnoty v datovém souboru přepíší všechny výchozí hodnoty definované v samotné konfiguraci.

Datový soubor musí obsahovat objekt s klíčem parameters . Hodnota parameters klíče musí být objekt, kde každý klíč je název definovaného parametru a každá hodnota je platnou hodnotou pro tento parametr.

Tato možnost se vzájemně vylučuje s touto --parameters možností.

Počínaje DSC verze 3.1.0 můžete data parametrů předat dílčímu příkazu přes stdin. Pokud tak učiníte, musíte konfigurační dokument předat jako vstupní řetězec nebo cestu k souboru v systému. Soubor parametrů ani konfigurační dokument nelze předat příkazu ze standardního nastavení.

Další informace o definování parametrů v konfiguračním dokumentu naleznete v tématu Schéma parametrů konfiguračního dokumentu DSC. Další informace o použití parametrů v konfiguračním dokumentu naleznete v referenčních informacích k funkcím parameters.

Type        : string
Mandatory   : false
LongSyntax  : --parameters-file <PARAMETERS_FILE>
ShortSyntax : -f <PARAMETERS_FILE>

-p, --parametry

Určuje parametry, které mají být předány konfiguračnímu dokumentu jako řetězec dat formátovaný jako JSON nebo YAML. Když tuto možnost určíte, DSC interpretuje klíče v datovém řetězci jako parametry a použije zadané hodnoty. Hodnoty v datovém řetězci mají přednost před všemi výchozími hodnotami definovanými v samotném konfiguračním dokumentu.

Datový řetězec musí obsahovat objekt s klíčem parameters . Hodnota parameters klíče musí být objekt, kde každý klíč je název definovaného parametru a každá hodnota je platnou hodnotou pro tento parametr.

Tato možnost se vzájemně vylučuje s touto --parameters_file možností.

Další informace o definování parametrů v konfiguračním dokumentu naleznete v tématu Schéma parametrů konfiguračního dokumentu DSC. Další informace o použití parametrů v konfiguračním dokumentu naleznete v referenčních informacích k funkcím parameters.

Type        : string
Mandatory   : false
LongSyntax  : --parameters <PARAMETERS>
ShortSyntax : -p <PARAMETERS>

-r, --kořen systému

Tuto možnost použijte, chcete-li zadat cestu ke kořenovému adresáři operačního systému, pokud necílíte na aktuálně spuštěný operační systém.

Type        : string
Mandatory   : false
LongSyntax  : --system-root <SYSTEM_ROOT>
ShortSyntax : -r <SYSTEM_ROOT>

-h, --help (--nápověda)

Zobrazí nápovědu k aktuálnímu příkazu nebo dílčímu příkazu. Když tuto volbu určíte, aplikace ignoruje všechny ostatní volby a argumenty.

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

Proměnné prostředí

Dílčí dsc config * příkazy vytvoří proměnnou DSC_CONFIG_ROOT prostředí při volání příkazu s --path možností určit konfigurační dokument, který se má pro příkaz použít. DSC nastaví hodnotu proměnné DSC_CONFIG_ROOT prostředí na úplnou cestu ke složce obsahující zadaný konfigurační dokument.

Poznámka:

Pokud definujete proměnnou DSC_CONFIG_ROOT mimo DSC, DSC vyvolá upozornění, když přepíše hodnotu existující proměnné prostředí pro operaci.

Konfigurační funkci envvar můžete použít k odkazování na tuto cestu ke složce pro instance prostředků v konfiguraci.