dsc-konfiguration

Sammanfattning

Använd ett konfigurationsdokument.

Syntax

dsc config [Options] <COMMAND>

Beskrivning

Kommandot dsc config innehåller underkommandon för att hantera de resursinstanser som definierats i ett DSC-konfigurationsdokument. Information om hur du hanterar resurser direkt finns i dsc resource kommandot.

Kommandon

export

Kommandot export genererar ett konfigurationsdokument som definierar de befintliga instanserna av en uppsättning resurser. Mer information finns i export av dsc-konfiguration.

få

Kommandot get hämtar det aktuella tillståndet för resursinstanserna i ett konfigurationsdokument. Mer information finns i dsc config get.

sätta

Kommandot set framtvingar det önskade tillståndet för resursinstanserna i ett konfigurationsdokument. Mer information finns i dsc config set.

test

Kommandot test verifierar om resursinstanserna i ett konfigurationsdokument är i önskat tillstånd. Mer information finns i dsc config test.

hjälp

Kommandot help returnerar hjälpinformation för det här kommandot eller ett underkommando.

Om du vill få hjälp med ett kommando eller underkommando använder du syntaxen:

dsc config help [<SUBCOMMAND>]

Får till exempel dsc config help hjälp för det här kommandot. dsc config help set Får hjälp för underkommandot set .

Du kan också använda alternativet --help på kommandot eller underkommandot för att visa hjälpinformationen. Till exempel dsc config --help eller dsc config set --help.

Alternativ

-f, --parametrar-fil

Anger sökvägen till en datafil som innehåller de parametrar som ska skickas till konfigurationen som JSON eller YAML. När du anger det här alternativet tolkar DSC nycklarna i datafilen som parametrar och använder de angivna värdena. Värdena i datafilen åsidosätter alla standardvärden som definierats i själva konfigurationen.

Datafilen måste innehålla ett objekt med nyckeln parameters . Värdet för nyckeln parameters måste vara ett objekt där varje nyckel är namnet på en definierad parameter och varje värde är ett giltigt värde för den parametern.

Det här alternativet är ömsesidigt uteslutande med alternativet --parameters .

Från och med DSC version 3.1.0 kan du skicka parameterdata till ett underkommando över stdin. När du gör det måste du skicka konfigurationsdokumentet som en indatasträng eller sökvägen till en fil i systemet. Du kan inte skicka både parameterfilen och konfigurationsdokumentet till ett kommando från stdin.

Mer information om hur du definierar parametrar i ett konfigurationsdokument finns i Parameterschema för DSC-konfigurationsdokument. Mer information om hur du använder parametrar i konfigurationsdokumentet finns i funktionsreferensen för parametrar.

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

-p, --parametrar

Anger de parametrar som ska skickas till konfigurationsdokumentet som en sträng med data formaterade som JSON eller YAML. När du anger det här alternativet tolkar DSC nycklarna i datasträngen som parametrar och använder de angivna värdena. Värdena i datasträngen åsidosätter alla standardvärden som definierats i själva konfigurationsdokumentet.

Datasträngen måste innehålla ett objekt med nyckeln parameters . Värdet för nyckeln parameters måste vara ett objekt där varje nyckel är namnet på en definierad parameter och varje värde är ett giltigt värde för den parametern.

Det här alternativet är ömsesidigt uteslutande med alternativet --parameters_file .

Mer information om hur du definierar parametrar i ett konfigurationsdokument finns i Parameterschema för DSC-konfigurationsdokument. Mer information om hur du använder parametrar i konfigurationsdokumentet finns i funktionsreferensen för parametrar.

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

-r, --system-root

Använd det här alternativet för att ange sökvägen till operativsystemets rot när du inte riktar in dig på det aktuella operativsystemet som körs.

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

-h, --hjälp

Visar hjälpen för det aktuella kommandot eller underkommandot. När du anger det här alternativet ignoreras alla andra alternativ och argument.

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

Miljövariabler

Underkommandona dsc config * skapar miljövariabeln DSC_CONFIG_ROOT när du anropar ett kommando med --path alternativet att ange konfigurationsdokumentet som ska användas för kommandot. DSC anger värdet för miljövariabeln DSC_CONFIG_ROOT till den fullständiga sökvägen till mappen som innehåller det angivna konfigurationsdokumentet.

Du kan använda konfigurationsfunktionen envvar för att referera till mappsökvägen för resursinstanser i konfigurationen.