dsc

Přehled

Aplikujte konfiguraci nebo vyvolávejte specifické zdroje pro správu softwarových komponent.

Syntax

dsc [Options] <COMMAND>

Commands

Dokončovač

Příkaz completer vrátí skript shellu, který po spuštění zaregistruje dokončení pro daný shell. Pro více informací viz dsc completer.

config

Příkaz config spravuje dokument DSC Configuration (DSC Configuration dokument). Můžete ho použít k:

• Získejte aktuální stav konfigurace.
• Otestujte, zda je konfigurace v požadovaném stavu.
• Nastavte konfiguraci na požadovaný stav.

Pro více informací viz konfigurace dsc.

prostředek

Velitelství resource spravuje DSC zdroj. Můžete ho použít k:

• Uveďte dostupné zdroje.
• Získejte JSON schéma pro instance zdroje.
• Získejte aktuální stav instance zdroje.
• Otestujte, zda je instance zdroje v požadovaném stavu.
• Nastavte instanci zdroje na požadovaný stav.

Pro více informací viz zdroj dsc

schéma

Příkaz schema vrací JSON schéma pro konkrétní typ DSC. Pro více informací viz schéma dsc.

Nápověda

Příkaz help vrací nápovědu pro dsc, příkaz nebo podpříkaz.

Pro pomoc s příkazem nebo podpříkazem použijte syntaxi:

dsc help <COMMAND> [<SUBCOMMAND>]

Například dostane dsc help config pomoc s podpříkazem config . dsc help config set Dostane pomoc s podpříkazem config set .

Můžete také použít možnost --help na příkazu pro zobrazení nápovědy. Například dsc config --help nebo dsc config set --help.

Možnosti

-l, --stopová úroveň

Definuje minimální úroveň zpráv, kterou by měl DSC během operace vysílat. Zprávy v DSC jsou kategorizovány podle jejich úrovně.

Následující seznam ukazuje platné úrovně zpráv od nejvyšší po nejnižší úroveň. Když je tato možnost nastavena na jakoukoli hodnotu v seznamu, DSC vysílá zprávy na této úrovni a výše.

• error
• warn (výchozí)
• info
• debug
• trace

Warning

Výstup trace úrovně vysílá veškerý JSON vstup/výstup, který DSC zpracovává během vykonávání. DSC JSON před jeho vydáním nedezinfikuje. Tato úroveň stopy je určena pouze pro použití vývojáři. Nikdy nepřesměrujte trace výstup úrovně do úložiště, protože by mohl obsahovat citlivé informace.

Například když je úroveň logaritmu , debugDSC vysílá zprávy pro každou úroveň logu kromě trace. Když je úroveň logu , errorDSC vysílá pouze chybové zprávy. DSC ignoruje každou zprávu s nižší úrovní logu.

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

-f, --trace-format

Definuje výstupní formát pro vysílání zpráv o stopě na stderr. DSC podporuje následující formáty:

• default - Vysílá zprávu s barevným označením ANSI konzole pro časové razítko, úroveň zprávy a číslo řádku.
• plaintext - Jako default , ale bez barev konzole.
• json - Každou zprávu vysílá jako komprimovaný JSON objekt s vlastními vlastnostmi časového razítka, úrovně, zprávy a čísla řádku.

Type         : string
Mandatory    : false
DefaultValue : default
ValidValues  : [default, plaintext, json]
LongSyntax   : --trace-format <TRACE_FORMAT>
ShortSyntax  : -f <TRACE_FORMAT>

-p, --progress-format

Definuje formát pokroku, který se používá při vysílání zpráv o průběhu na stderr. DSC podporuje následující formáty:

• default - Zobrazuje ukazatel průběhu, pokud DSC detekuje, že je volán interaktivně. Jinak DSC neukazuje žádný pokrok.
• none - Neukazuje to žádný pokrok.
• json - Vysílá postup jako komprimované JSON objekty s vlastnostmi časovým razítkem, úrovní, zprávou a číslem řádku.

Type         : string
Mandatory    : false
DefaultValue : default
ValidValues  : [default, none, json]
LongSyntax   : --progress-format <PROGRESS_FORMAT>
ShortSyntax  : -p <PROGRESS_FORMAT>

-V, --verze

Zobrazuje verzi aplikace. Když tuto možnost zadáš, aplikace ignoruje všechny možnosti a argumenty kromě --help, který tuto možnost přepíše.

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

-h, --help (--nápověda)

Zobrazí nápovědu k aktuálnímu příkazu nebo podpříkazu. Když tuto volbu určíte, aplikace ignoruje všechny ostatní volby a argumenty.

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

Proměnné prostředí

Ve výchozím nastavení příkaz dsc vyhledává DSC manifesty zdrojů ve složkách definovaných proměnnou PATH prostředí. Pokud je proměnná DSC_RESOURCE_PATH prostředí definována, dsc místo v se vyhledávají složky v .DSC_RESOURCE_PATHPATH

Prostředí DSC_RESOURCE_PATH musí být proměnná prostředí, která dodržuje stejné konvence jako proměnná PATH prostředí operačního systému. Na jiných platformách jsou samostatné cesty k složkám s středníkem (;) Windows a na jiných platformách dvojtečkou (:).

Ukončovací kódy

Příkaz dsc používá sémantické výstupní kódy. Každý výstupní kód představuje jiný výsledek pro provedení příkazu.

Ukončovací kód	Význam
0	Příkaz byl úspěšně vykonán bez chyb.
1	Příkaz selhal, protože obdržel neplatné argumenty.
2	Příkaz selhal, protože zdroj vyvolal chybu.
3	Příkaz selhal, protože hodnota nemohla být serializována do JSON nebo deserializována.
4	Příkaz selhal, protože vstup pro příkaz nebyl platný v YAML ani JSON.
5	Příkaz selhal, protože definice zdroje nebo hodnota instance byla neplatná vůči JSON schématu.
6	Příkaz byl zrušen přerušením Ctrl+C .

Poznámky

DSC očekává, že vstupní řetězce budou používat kódování UTF-8. Když předáváte vstup ze stdin nebo cestu do souboru, ujistěte se, že vstup je zakódován jako UTF-8.