dsc

Synopsis

Applicare la configurazione o invocare risorse specifiche per gestire i componenti software.

Sintassi

dsc [Options] <COMMAND>

Comandi

completatore

Il completer comando restituisce uno script di shell che, una volta eseguito, registra completamenti per lo shell fornito. Per maggiori informazioni, vedi dsc completer.

config

Il config comando gestisce un documento di configurazione DSC. È possibile usarlo per:

  • Ottieni lo stato attuale della configurazione.
  • Verifica se una configurazione è nello stato desiderato.
  • Imposta una configurazione nello stato desiderato.

Per maggiori informazioni, vedi dsc config.

resource

Il resource comando gestisce una risorsa DSC. È possibile usarlo per:

  • Elenca le risorse disponibili.
  • Ottieni lo schema JSON delle istanze di una risorsa.
  • Ottieni lo stato attuale di un'istanza di risorsa.
  • Verifica se un'istanza di risorsa è nello stato desiderato.
  • Imposta un'istanza di risorsa nello stato desiderato.

Per maggiori informazioni, consulta la risorsa dsc

schema

Il schema comando restituisce lo schema JSON per un tipo specifico di DSC. Per maggiori informazioni, vedi schema dsc.

Guida

Il help comando restituisce informazioni di aiuto per dsc, un comando o un sottocomando.

Per ottenere aiuto per un comando o un sottocomando, usa la sintassi:

dsc help <COMMAND> [<SUBCOMMAND>]

Per esempio, dsc help config riceve l'aiuto per il config sottocomando. dsc help config set Riceve aiuto per il config set subcomando.

Puoi anche usare l'opzione --help su un comando per visualizzare le informazioni di aiuto. Ad esempio, dsc config --help o dsc config set --help.

Opzioni

-l, --livello di traccia

Definisce il livello minimo di messaggio che il DSC dovrebbe emettere durante un'operazione. I messaggi in DSC sono classificati in base al loro livello.

L'elenco seguente mostra i livelli validi dei messaggi dal livello più alto al più basso. Quando questa opzione è impostata su un valore qualsiasi nella lista, DSC emette messaggi a quel livello e superiore.

  • error
  • warn (impostazione predefinita)
  • info
  • debug
  • trace

Avvertimento

L'output trace del livello emette tutto l'input/output JSON che il DSC elabora durante l'esecuzione. DSC non sanifica il JSON prima di emetterlo. Questo livello di traccia è destinato solo all'uso da parte degli sviluppatori. Non reindirizzare trace mai l'output a livello di memoria perché potrebbe contenere informazioni sensibili.

Ad esempio, quando il livello logaritmico è debug, DSC emette messaggi per ogni livello logaritmitico tranne trace. Quando il livello di log è error, DSC emette solo messaggi di errore. DSC ignora ogni messaggio con un livello logaritario inferiore.

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

-f, --formato traccia

Definisce il formato di uscita da usare quando si emettono messaggi di traccia su stderr. DSC supporta i seguenti formati:

  • default - Emette il messaggio con colorazione ANSI della console per il timestamp, il livello del messaggio e il numero della riga.
  • plaintext - Senza colori default della console.
  • json - Emette ogni messaggio come oggetto JSON compresso con timestamp, livello, messaggio e numero di riga come proprietà.
Type         : string
Mandatory    : false
DefaultValue : default
ValidValues  : [default, plaintext, json]
LongSyntax   : --trace-format <TRACE_FORMAT>
ShortSyntax  : -f <TRACE_FORMAT>

-p, --formato-progresso

Definisce il formato di progresso da utilizzare quando si emettono messaggi di progresso su stderr. DSC supporta i seguenti formati:

  • default - Mostra una barra di avanzamento se DSC rileva che viene chiamata in modo interattivo. Altrimenti, DSC non mostra alcun progresso.
  • none - Non mostra alcun progresso.
  • json - Emette il progresso come oggetti JSON compressi con timestamp, livello, messaggio e numero di riga come proprietà.
Type         : string
Mandatory    : false
DefaultValue : default
ValidValues  : [default, none, json]
LongSyntax   : --progress-format <PROGRESS_FORMAT>
ShortSyntax  : -p <PROGRESS_FORMAT>

-V, --versione

Visualizza la versione dell'applicazione. Quando specifichi questa opzione, l'applicazione ignora tutte le opzioni e gli argomenti tranne --help, che sovrascrive questa opzione.

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

-h, --help (aiuto)

Visualizza la Guida per il comando o il sottocomando corrente. Quando si specifica questa opzione, l'applicazione ignora tutte le altre opzioni e argomenti.

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

Variabili di ambiente

Di default, il dsc comando cerca manifesti di risorse DSC nelle cartelle definite dalla PATH variabile di ambiente. Se la DSC_RESOURCE_PATH variabile ambiente è definita, dsc cerca nelle cartelle in DSC_RESOURCE_PATH invece di PATH.

L'ambiente DSC_RESOURCE_PATH deve essere una variabile di ambiente che segue le stesse convenzioni della PATH variabile di ambiente del sistema operativo. Separare i percorsi delle cartelle con un punto e virgola (;) su Windows e due punti (:) su altre piattaforme.

Codici di uscita

Il dsc comando utilizza codici di uscita semantici. Ogni codice di uscita rappresenta un risultato diverso per l'esecuzione del comando.

Codice di uscita Significato
0 Il comando fu eseguito con successo senza alcun errore.
1 Il comando fallì perché ricevette argomentazioni invalide.
2 Il comando è fallito perché una risorsa ha generato un errore.
3 Il comando falliva perché un valore non poteva essere serializzato o deerializzato da JSON.
4 Il comando è fallito perché l'input per il comando non era valido né in YAML né in JSON.
5 Il comando falliva perché una definizione di risorsa o un valore di istanza era invalido rispetto al suo schema JSON.
6 Il comando fu cancellato da un'interruzione Ctrl+C .

Notes

DSC si aspetta che le stringhe di ingresso utilizzino la codifica UTF-8. Quando passi input da stdin o dal percorso a un file, assicurati che l'input sia codificato come UTF-8.