dsc-konfiguráció
Áttekintés
Konfigurációs dokumentum alkalmazása.
Syntax
dsc config [Options] <COMMAND>
Description
A dsc config
parancs alparancsokat tartalmaz a DSC-konfigurációs dokumentumban definiált erőforráspéldányok kezeléséhez. Az erőforrások közvetlen kezeléséhez tekintse meg a dsc-erőforrás parancsát.
Parancsok
exportálás
A export
parancs létrehoz egy konfigurációs dokumentumot, amely meghatározza egy erőforráskészlet meglévő példányait. További információ: dsc config export.
get
A get
parancs lekéri az erőforráspéldányok aktuális állapotát egy konfigurációs dokumentumban. További információ: dsc config get.
halmaz
A set
parancs kikényszeríti az erőforráspéldányok kívánt állapotát egy konfigurációs dokumentumban.
További információ: dsc config set.
test
A test
parancs ellenőrzi, hogy a konfigurációs dokumentumban lévő erőforráspéldányok a kívánt állapotban vannak-e. További információ: dsc konfigurációs teszt.
súgó
A help
parancs a parancs vagy egy alparancs súgóadatait adja vissza.
Egy parancs vagy alparancs súgójának lekéréséhez használja a szintaxist:
dsc config help [<SUBCOMMAND>]
Ehhez a parancshoz például dsc config help
lekéri a súgót. dsc config help set
megkapja az alparancs súgóját set
.
A - -help lehetőséget is használhatja a parancson vagy az alparancson a súgóinformációk megjelenítéséhez. Például dsc config --help
vagy dsc config set --help
.
Beállítások
-f, --parameters_file
Megadja egy adatfájl elérési útját, amely tartalmazza azokat a paramétereket, amelyek JSON-ként vagy YAML-ként továbbítjak a konfigurációnak. Ha ezt a beállítást adja meg, a DSC paraméterként értelmezi az adatfájl kulcsait, és a megadott értékeket használja. Az adatfájl értékei felülbírálják a konfigurációban definiált alapértelmezett értékeket.
Az adatfájlnak tartalmaznia kell egy kulcsot tartalmazó parameters
objektumot. A kulcs értékének parameters
olyan objektumnak kell lennie, amelyben minden kulcs egy meghatározott paraméter neve, és minden érték érvényes érték az adott paraméterhez.
Ez a beállítás nem használható a --parameters
beállítással. Adja meg, hogy adatsztringként adja-e át a paramétereket a --parameters
beállítással, vagy egy adatfájlban a --parameters_file
beállítással.
A paraméterek konfigurációs dokumentumban való definiálásáról további információt a DSC Konfigurációs dokumentum paramétersémájában talál. A paraméterek konfigurációs dokumentumban való használatával kapcsolatos további információkért lásd a paraméterfüggvények referenciáját.
-p, --parameters
Meghatározza a konfigurációnak JSON- vagy YAML-sztringként átadni kívánt paramétereket. Ha ezt a beállítást adja meg, a DSC paraméterként értelmezi az adatsztring kulcsait, és a megadott értékeket használja. Az adatsztring értékei felülbírálják a konfigurációban definiált alapértelmezett értékeket.
Az adatsztringnek tartalmaznia kell egy kulcsot tartalmazó parameters
objektumot. A kulcs értékének parameters
olyan objektumnak kell lennie, amelyben minden kulcs egy meghatározott paraméter neve, és minden érték érvényes érték az adott paraméterhez.
Ez a beállítás nem használható a --parameters_file
beállítással. Adja meg, hogy adatsztringként adja-e át a paramétereket a --parameters
beállítással, vagy egy adatfájlban a --parameters_file
beállítással.
A paraméterek konfigurációs dokumentumban való definiálásáról további információt a DSC Konfigurációs dokumentum paramétersémájában talál. A paraméterek konfigurációs dokumentumban való használatával kapcsolatos további információkért lásd a paraméterfüggvények referenciáját.
-h, --help
Megjeleníti az aktuális parancs vagy alparancs súgóját. Ha ezt a beállítást adja meg, az alkalmazás figyelmen kívül hagyja az összes beállítást és argumentumot.
Type: Boolean
Mandatory: false
Környezeti változók
Az dsc config *
alparancsok létrehozzák a DSC_CONFIG_ROOT
környezeti változót, amikor meghív egy parancsot a --path
parancshoz használni kívánt konfigurációs dokumentum megadásának lehetőségével. A DSC a DSC_CONFIG_ROOT
környezeti változó értékét a megadott konfigurációs dokumentumot tartalmazó mappa teljes elérési útjára állítja.
Megjegyzés
Ha a változót a DSC-n kívül definiálja, a DSC_CONFIG_ROOT
DSC figyelmeztetést jelenít meg, amikor felülbírálja a meglévő környezeti változó értékét egy művelethez.
Az envvar konfigurációs függvénnyel hivatkozhat a konfigurációban lévő erőforráspéldányok mappaútvonalára.