Dela via


Dsc

Sammanfattning

Använd konfiguration eller anropa specifika resurser för att hantera programvarukomponenter.

Syntax

dsc [Options] <COMMAND>

Kommandon

completer

Kommandot completer returnerar ett gränssnittsskript som registrerar slutföranden för det angivna gränssnittet när det körs. Mer information finns i .

konfiguration

Kommandot config hanterar ett DSC-konfigurationsdokument. Du kan använda den för att:

  • Hämta konfigurationens aktuella tillstånd.
  • Testa om en konfiguration är i önskat tillstånd.
  • Ange önskat tillstånd för en konfiguration.

Mer information finns i konfiguration.

resurs

Kommandot resource hanterar en DSC-resurs. Du kan använda den för att:

  • Visa en lista över tillgängliga resurser.
  • Hämta JSON-schemat för en resurs instanser.
  • Hämta det aktuella tillståndet för en resursinstans.
  • Testa om en resursinstans är i önskat tillstånd.
  • Ange önskat tillstånd för en resursinstans.

Mer information finns i resurs

Schemat

Kommandot schema returnerar JSON-schemat för en specifik DSC-typ. Mer information finns i schema.

Hjälp

Kommandot help returnerar hjälpinformation för dsc, ett kommando eller en underkommando.

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

dsc help <COMMAND> [<SUBCOMMAND>]

Till exempel får dsc help config hjälp för config underkommando. dsc help config set får hjälp med config set-underkommandot.

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

Alternativ

-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

-l, --trace-level

Definierar den minsta meddelandenivå som DSC ska generera under en åtgärd. Meddelanden i DSC kategoriseras efter deras nivå.

I följande lista visas giltiga meddelandenivåer från högsta till lägsta nivå. När det här alternativet är inställt på valfritt värde i listan genererar DSC meddelanden på den nivån och senare.

  • error
  • warning (standard)
  • info
  • debug
  • trace

Varning

Utdata på trace-nivå genererar alla JSON-indata/utdata som DSC bearbetar under körningen. DSC sanerar inte JSON innan den genereras. Den här spårningsnivån är endast avsedd för utvecklare. Omdirigera aldrig trace nivåutdata till lagring eftersom den kan innehålla känslig information.

När loggnivån till exempel är debuggenererar DSC meddelanden för varje loggnivå utom trace. När loggnivån är errorgenererar DSC endast felmeddelanden. DSC ignorerar varje meddelande med en lägre loggnivå.

Type:         String
Mandatory:    false
DefaultValue: warning
ValidValues:  [error, warning, info, debug, trace]

-f, --trace-format

Definierar utdataformatet som ska användas när spårningsmeddelanden genereras på stderr. DSC har stöd för följande format:

  • default – Genererar meddelandet med ANSI-konsolfärgning för tidsstämpel, meddelandenivå och radnummer.
  • plaintext – Som default men utan konsolfärger.
  • json – Genererar varje meddelande som ett komprimerat JSON-objekt med tidsstämpeln, nivån, meddelandet och radnumret som egenskaper.
Type:         String
Mandatory:    false
DefaultValue: default
ValidValues:  [default, plaintext, json]

-V, --version

Visar versionen av programmet. 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

Som standard söker kommandot dsc efter kommandobaserade DSC-resursmanifest i mapparna som definieras av PATH miljövariabeln. Om DSC_RESOURCE_PATH miljövariabeln har definierats söker dsc mapparna i DSC_RESOURCE_PATH i stället för PATH.

Den DSC_RESOURCE_PATH miljön måste vara en miljövariabel som följer samma konventioner som PATH miljövariabeln för operativsystemet. Avgränsa mappsökvägar med semikolon (;) i Windows och ett kolon (:) på andra plattformar.

Slutkoder

Kommandot dsc använder semantiska slutkoder. Varje slutkod representerar ett annat resultat för körningen av kommandot.

Avsluta kod Betydelse
0 Kommandot har körts utan fel.
1 Kommandot misslyckades eftersom det tog emot ogiltiga argument.
2 Kommandot misslyckades eftersom en resurs har genererat ett fel.
3 Kommandot misslyckades eftersom ett värde inte kunde serialiseras till eller deserialiseras från JSON.
4 Kommandot misslyckades eftersom indata för kommandot inte var giltiga YAML eller JSON.
5 Kommandot misslyckades eftersom en resursdefinition eller ett instansvärde var ogiltigt mot dess JSON-schema.
6 Kommandot avbröts av ett Ctrl+C avbrott.

Anteckningar

DSC förväntar sig att indatasträngar använder UTF-8-kodning. När du skickar indata från stdin eller sökvägen till en fil kontrollerar du att indata kodas som UTF-8.