dsc

Synopsis

Tillämpa konfiguration eller anropa specifika resurser för att hantera mjukvarukomponenter.

Syntax

dsc [Options] <COMMAND>

Commands

kompletterare

Kommandot completer returnerar ett skalskript som, när det körs, registrerar färdigställanden för det givna skalet. För mer information, se dsc completer.

config

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

  • Få det aktuella läget för konfigurationen.
  • Testa om en konfiguration är i önskat tillstånd.
  • Ställ in en konfiguration till önskat tillstånd.

För mer information, se dsc-konfiguration.

resource

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

  • Lista tillgängliga resurser.
  • Hämta JSON-schemat för en resurss instanser.
  • Få det aktuella tillståndet för en resursinstans.
  • Testa om en resursinstans är i önskat tillstånd.
  • Sätt en resursinstans till önskat tillstånd.

För mer information, se dsc-resursen

schema

Kommandot schema returnerar JSON-schemat för en specifik DSC-typ. För mer information, se dsc-schema.

hjälp

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

För att få hjälp med ett kommando eller underkommando, använd syntaxen:

dsc help <COMMAND> [<SUBCOMMAND>]

Till exempel dsc help config får han hjälp för underkommandot config . dsc help config set Får hjälp till underkommandot config set .

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

Options

-l, --spårnivå

Definierar den minsta meddelandenivå DSC ska sända under en operation. Meddelanden i DSC kategoriseras efter deras nivå.

Följande lista visar de giltiga meddelandenivåerna från högsta till lägsta nivå. När detta alternativ är inställt på valfritt värde i listan, skickar DSC meddelanden på den nivån och högre.

  • error
  • warn (standardinställning)
  • info
  • debug
  • trace

Varning

Nivåutgången trace avger all JSON-in- och utdata som DSC bearbetar under körningen. DSC sanerar inte JSON:en innan den sänder ut den. Denna spårnivå är endast avsedd för utvecklarbruk. Omdirigera trace aldrig nivåutgång till lagring eftersom den kan innehålla känslig information.

Till exempel, när log-nivån är debug, sänder DSC meddelanden för varje log-nivå utom trace. När lognivån är error, sänder DSC endast felmeddelanden. DSC ignorerar alla meddelanden med en lägre loggnivå.

Type         : string
Mandatory    : false
DefaultValue : warn
ValidValues  : [error, warn, info, debug, trace]
LongSyntax   : --trace-level <TRACE_LEVEL>
ShortSyntax  : -l <TRACE_LEVEL>

-f, --trace-format

Definierar utdataformatet som ska användas vid sändning av spårmeddelanden på stderr. DSC stöder följande format:

  • default - Sänder meddelandet med ANSI-konsolfärgning för tidsstämpel, meddelandenivå och radnummer.
  • plaintext - Som default men utan några konsolfärger.
  • json - Sänder varje meddelande som ett komprimerat JSON-objekt med tidsstämpel, nivå, meddelande och radnummer som egenskaper.
Type         : string
Mandatory    : false
DefaultValue : default
ValidValues  : [default, plaintext, json]
LongSyntax   : --trace-format <TRACE_FORMAT>
ShortSyntax  : -f <TRACE_FORMAT>

-p, --progress-format

Definierar progressformatet som ska användas vid sändning av progressmeddelanden på stderr. DSC stöder följande format:

  • default - Visar en framstegsindikator om DSC upptäcker att den anropas interaktivt. Annars visar DSC ingen framsteg.
  • none - Visar ingen framsteg.
  • json - Sänder progression som komprimerade JSON-objekt med tidsstämpel, nivå, meddelande och radnummer som egenskaper.
Type         : string
Mandatory    : false
DefaultValue : default
ValidValues  : [default, none, json]
LongSyntax   : --progress-format <PROGRESS_FORMAT>
ShortSyntax  : -p <PROGRESS_FORMAT>

-V, --version

Visar versionen av applikationen. När du anger detta alternativ ignorerar applikationen alla alternativ och argument utom --help, som åsidosätter detta alternativ.

Type        : boolean
Mandatory   : false
LongSyntax  : --version
ShortSyntax : -V

-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

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

Miljön DSC_RESOURCE_PATH måste vara en miljövariabel som följer samma konventioner som miljövariabeln PATH för operativsystemet. Separata mappvägar med semikolon (;) på Windows och kolon (:) på andra plattformar.

Slutkoder

Kommandot dsc använder semantiska exitkoder. Varje exitkod representerar ett annat resultat för exekveringen av kommandot.

Avslutskod Innebörd
0 Kommandot utfördes framgångsrikt utan några fel.
1 Kommandot misslyckades eftersom det mottog ogiltiga argument.
2 Kommandot misslyckades eftersom en resurs gav ett fel.
3 Kommandot misslyckades eftersom ett värde inte kunde serialiseras till eller deserialiseras från JSON.
4 Kommandot misslyckades eftersom inmatningen för kommandot inte var giltig YAML eller JSON.
5 Kommandot misslyckades eftersom en resursdefinition eller instansvärde var ogiltigt mot dess JSON-schema.
6 Kommandot avbröts av ett avbrott i Ctrl+C .

Notes

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, se till att inmatningen är kodad som UTF-8.

  • Last updated on