jeu de configuration dsc

Synopsis

Applique l’état souhaité des instances de ressources dans un document de configuration.

Syntaxe

Document de configuration à partir d’un fichier

dsc config set [Options] --file <FILE>

Document de configuration à partir de la chaîne d’option

dsc config set [Options] --input <INPUT>

Document de configuration à partir de stdin

cat <FILE> | dsc config set [Options] --file -

Document de configuration à partir d’un fichier avec les paramètres de stdin

cat <PARAMETERS_FILE> | dsc config --parameters-file - set [Options] --file <FILE>

Document de configuration à partir de la chaîne d’options avec les paramètres de stdin

cat <PARAMETERS_FILE> | dsc config --parameters-file - set [Options] --input <INPUT>

Descriptif

La set sous-commande applique l’état souhaité des instances de ressource dans un document de configuration. Lorsque cette commande s’exécute, DSC valide le document de configuration avant d’appeler l’opération de test pour chaque instance de ressource définie dans le document. DSC appelle ensuite l’opération set pour chaque instance de ressource qui n’est pas dans l’état souhaité.

Le document de configuration doit être transmis à cette commande au format JSON ou YAML avec l’option --input or --file .

Exemples

Exemple 1 : Définir les instances de ressources d’une configuration à l’état souhaité

La commande inspecte les instances de ressource définies dans le document de configuration enregistré sous example.dsc.config.yaml et les met à l’état souhaité si nécessaire.

# example.dsc.config.yaml
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
resources:
- name: Windows only
  type: Microsoft.DSC/Assertion
  properties:
    $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
    resources:
    - name: os
      type: Microsoft/OSInfo
      properties:
        family: Windows
- name: Current user registry example
  type: Microsoft.Windows/Registry
  properties:
    keyPath: HKCU\example
    _exist: true
  dependsOn:
    - "[resourceId('Microsoft.DSC/Assertion', 'Windows only')"

cat ./example.dsc.config.yaml | dsc config set --file -

Exemple 2 : passage d’un fichier à lire en tant que document de configuration

La commande utilise l’option file pour appliquer la configuration définie dans le example.dsc.config.yaml fichier.

dsc config set --file ./example.dsc.config.yaml

Exemple 3 : passage d’un document de configuration en tant que variable

La commande utilise l’option input pour appliquer la configuration stockée dans la $desired variable.

dsc config set --input $desired

Options

-i, --input

Spécifie le document de configuration pour lequel appliquer l’état.

Le document doit être une chaîne contenant un objet JSON ou YAML. DSC valide le document par rapport au schéma du document de configuration. Si la validation échoue, DSC génère une erreur.

Cette option s’exclut mutuellement avec l’option --file .

Type        : string
Mandatory   : false
LongSyntax  : --input <INPUT>
ShortSyntax : -i <INPUT>

-f, --fichier

Définit le chemin d’accès à un document de configuration pour lequel appliquer l’état.

Le fichier spécifié doit contenir un document de configuration en tant qu’objet JSON ou YAML. DSC valide le document par rapport au schéma du document de configuration. Si la validation échoue ou si le fichier spécifié n’existe pas, DSC génère une erreur.

Vous pouvez également utiliser cette option pour passer un document de configuration à partir de stdin, comme illustré dans l’exemple 1.

Cette option s’exclut mutuellement avec l’option --input .

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

-w, --what-if

Lorsque vous spécifiez cette option d’indicateur, DSC ne modifie pas réellement l’état du système avec l’opération set . Au lieu de cela, il renvoie une sortie indiquant comment l’opération changera l’état du système lorsqu’elle est appelée sans cette option. Utilisez cette option pour afficher un aperçu des modifications apportées par DSC à un système.

Le résultat de la commande lorsque vous utilisez cette option est le même que sans, sauf que le champ de ExecutionType métadonnées est défini sur WhatIf au lieu de Actual.

Type        : boolean
Mandatory   : false
LongSyntax  : --what-if
ShortSyntax : -w

-o, --format-de-sortie

L’option --output-format contrôle le format utilisé par DSC pour les données renvoyées par la commande. Les formats disponibles sont les suivants :

• json pour émettre les données sous la forme d’une ligne JSON.
• pretty-json pour émettre les données au format JSON avec des sauts de ligne, des retraits et des espaces pour plus de lisibilité.
• yaml pour émettre les données au format YAML.

Le format de sortie par défaut varie selon que DSC détecte que la sortie est redirigée ou capturée en tant que variable :

• Si la commande n’est pas redirigée ou capturée, DSC affiche la sortie au yaml format dans la console.
• Si la sortie de la commande est redirigée ou capturée, DSC émet les données au json format stdout.

Lorsque vous utilisez cette option, DSC utilise le format spécifié, que la commande soit redirigée ou capturée.

Lorsque la commande n’est pas redirigée ou capturée, la sortie de la console est formatée pour une meilleure lisibilité. Lorsque la commande n’est pas redirigée ou capturée, la sortie inclut des séquences terminales pour la mise en forme.

Type        : string
Mandatory   : false
ValidValues : [json, pretty-json, yaml]
LongSyntax  : --output-format <OUTPUT_FORMAT>
ShortSyntax : -o <OUTPUT_FORMAT>

-h, --help

Affiche l’aide de la commande ou de la sous-commande actuelle. Lorsque vous spécifiez cette option, l’application ignore toutes les autres options et arguments.

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

Sortie

Cette commande renvoie des données formatées qui incluent si l’opération ou les ressources ont généré des erreurs, la collecte des messages émis pendant l’opération et les résultats de l’opération définie pour chaque instance. Pour plus d’informations, consultez schéma d’obtention de résultat de configuration dsc.

Pour plus d’informations sur le formatage des données de sortie, consultez l’option --output-format.