configurazione dsc

Riepilogo

Applicare un documento di configurazione.

Sintassi

dsc config [Options] <COMMAND>

Descrizione

Il dsc config comando include sottocomandi per la gestione delle istanze delle risorse definite in un documento di configurazione DSC. Per gestire direttamente le risorse, vedere il comando dsc resource .

Comandi

esportazione

Il export comando genera un documento di configurazione che definisce le istanze esistenti di un set di risorse. Per ulteriori informazioni, vedere esportazione della configurazione dsc.

ottenere

Il get comando recupera lo stato corrente delle istanze delle risorse in un documento di configurazione. Per altre informazioni, vedere dsc config get.

mettere

Il set comando applica lo stato desiderato delle istanze della risorsa in un documento di configurazione. Per altre informazioni, vedere set di configurazione dsc.

prova

Il test comando verifica se le istanze delle risorse in un documento di configurazione si trovano nello stato desiderato. Per altre informazioni, vedere test di configurazione dsc.

Aiuto

Il help comando restituisce informazioni della Guida per questo comando o per un sottocomando.

Per ottenere la guida per un comando o un sottocomando, utilizzare la sintassi:

dsc config help [<SUBCOMMAND>]

Ad esempio, dsc config help ottiene la guida per questo comando. dsc config help set Ottiene l'aiuto per il set sottocomando.

È inoltre possibile utilizzare l'opzione --help sul comando o sul sottocomando per visualizzare le informazioni della guida. Ad esempio, dsc config --help o dsc config set --help.

Opzioni

-f, --file-parametri

Specifica il percorso di un file di dati contenente i parametri da passare alla configurazione come JSON o YAML. Quando si specifica questa opzione, DSC interpreta le chiavi nel file di dati come parametri e utilizza i valori specificati. I valori nel file di dati sostituiscono tutte le impostazioni predefinite definite nella configurazione stessa.

Il file di dati deve contenere un oggetto con la parameters chiave. Il valore della parameters chiave deve essere un oggetto in cui ogni chiave è il nome di un parametro definito e ogni valore è un valore valido per tale parametro.

Questa opzione si esclude a vicenda con l'opzione --parameters .

A partire dalla versione 3.1.0 di DSC, è possibile passare i dati dei parametri a un sottocomando su stdin. Quando si esegue questa operazione, è necessario passare il documento di configurazione come stringa di input o come percorso di un file nel sistema. Non è possibile passare sia il file dei parametri che il documento di configurazione a un comando da stdin.

Per altre informazioni sulla definizione dei parametri in un documento di configurazione, vedere Schema dei parametri del documento di configurazione DSC. Per ulteriori informazioni sull'utilizzo dei parametri nel documento di configurazione, vedere le informazioni di riferimento sulla funzione dei parametri.

Type        : string
Mandatory   : false
LongSyntax  : --parameters-file <PARAMETERS_FILE>
ShortSyntax : -f <PARAMETERS_FILE>

-p, --parametri

Specifica i parametri da passare al documento di configurazione come stringa di dati formattata come JSON o YAML. Quando si specifica questa opzione, DSC interpreta le chiavi nella stringa di dati come parametri e usa i valori specificati. I valori nella stringa di dati sostituiscono tutte le impostazioni predefinite definite nel documento di configurazione stesso.

La stringa di dati deve contenere un oggetto con la parameters chiave. Il valore della parameters chiave deve essere un oggetto in cui ogni chiave è il nome di un parametro definito e ogni valore è un valore valido per tale parametro.

Questa opzione si esclude a vicenda con l'opzione --parameters_file .

Per altre informazioni sulla definizione dei parametri in un documento di configurazione, vedere Schema dei parametri del documento di configurazione DSC. Per ulteriori informazioni sull'utilizzo dei parametri nel documento di configurazione, vedere le informazioni di riferimento sulla funzione dei parametri.

Type        : string
Mandatory   : false
LongSyntax  : --parameters <PARAMETERS>
ShortSyntax : -p <PARAMETERS>

-r, --sistema-radice

Usare questa opzione per specificare il percorso della radice del sistema operativo quando non si è destinati al sistema operativo attualmente in esecuzione.

Type        : string
Mandatory   : false
LongSyntax  : --system-root <SYSTEM_ROOT>
ShortSyntax : -r <SYSTEM_ROOT>

-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

I dsc config * sottocomandi creano la variabile d'ambiente DSC_CONFIG_ROOT quando si chiama un comando con l'opzione --path per specificare il documento di configurazione da utilizzare per il comando. DSC imposta il valore della variabile di DSC_CONFIG_ROOT ambiente sul percorso completo della cartella contenente il documento di configurazione specificato.

Annotazioni

Se si definisce la DSC_CONFIG_ROOT variabile all'esterno di DSC, DSC genera un avviso quando esegue l'override del valore della variabile di ambiente esistente per un'operazione.

È possibile utilizzare la funzione di configurazione envvar per fare riferimento al percorso della cartella per le istanze di risorse nella configurazione.