dsc-konfiguration

Synopsis

Använd ett konfigurationsdokument.

Syntax

dsc config [Options] <COMMAND>

Description

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-resurskommandot .

Kommandon

exportera

Kommandot export genererar ett konfigurationsdokument som definierar befintliga instanser av en uppsättning resurser. Mer information finns i dsc config export.

get

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

set

Kommandot set framtvingar önskat tillstånd för resursinstanserna i ett konfigurationsdokument. Mer information finns i konfigurationsuppsättningen dsc.

test

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

hjälp

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

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

dsc config help [<SUBCOMMAND>]

Till exempel dsc config help får du hjälp med det här kommandot. dsc config help set får hjälp för set underkommandot.

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

Alternativ

-f, --parameters_file

Anger sökvägen till en datafil som innehåller parametrarna 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 definieras i själva konfigurationen.

Datafilen måste innehålla ett objekt med parameters nyckeln. Värdet för parameters nyckeln 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 kan inte användas med alternativet --parameters . Välj om parametrarna ska skickas som en datasträng med --parameters alternativet eller i en datafil med alternativet --parameters_file .

Mer information om hur du definierar parametrar i ett konfigurationsdokument finns i DSC-konfigurationsdokumentparameterschema. Mer information om hur du använder parametrar i konfigurationsdokumentet finns i parameterfunktionsreferensen.

-p, --parameters

Anger vilka parametrar som ska skickas till konfigurationen som en JSON- eller YAML-sträng. 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 konfigurationen.

Datasträngen måste innehålla ett objekt med parameters nyckeln. Värdet för parameters nyckeln 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 kan inte användas med alternativet --parameters_file . Välj om parametrarna ska skickas som en datasträng med --parameters alternativet eller i en datafil med alternativet --parameters_file .

Mer information om hur du definierar parametrar i ett konfigurationsdokument finns i DSC-konfigurationsdokumentparameterschema. Mer information om hur du använder parametrar i konfigurationsdokumentet finns i parameterfunktionsreferensen.

-h, --help

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

Type:      Boolean
Mandatory: false

Miljövariabler

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

Anteckning

Om du definierar variabeln DSC_CONFIG_ROOT utanför DSC genererar DSC en varning när den åsidosätter den befintliga miljövariabelns värde för en åtgärd.

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