configuration dsc

Synopsis

Appliquez un document de configuration.

Syntaxe

dsc config [Options] <COMMAND>

Descriptif

La dsc config commande inclut des sous-commandes pour la gestion des instances de ressources définies dans un document de configuration DSC. Pour gérer directement les ressources, consultez la commande de ressource dsc .

Commandes

exportation

La export commande génère un document de configuration qui définit les instances existantes d’un ensemble de ressources. Pour plus d’informations, consultez exportation de configuration dsc.

obtenir

La get commande récupère l’état actuel des instances de ressource dans un document de configuration. Pour plus d’informations, consultez dsc config get.

définir

La set commande applique l’état souhaité des instances de ressource dans un document de configuration. Pour plus d’informations, consultez jeu de configuration dsc.

essai

La test commande vérifie si les instances de ressource d’un document de configuration sont dans l’état souhaité. Pour plus d’informations, consultez test de configuration dsc.

aide

La help commande renvoie des informations d’aide pour cette commande ou une sous-commande.

Pour obtenir l’aide d’une commande ou d’une sous-commande, utilisez la syntaxe suivante :

dsc config help [<SUBCOMMAND>]

Par exemple, dsc config help obtient l’aide pour cette commande. dsc config help set obtient l’aide pour la set sous-commande.

Vous pouvez également utiliser l’option --help sur la commande ou la sous-commande pour afficher les informations d’aide. Par exemple, dsc config --help ou dsc config set --help.

Paramètres

-f, --fichier-de-paramètres

Spécifie le chemin d’accès à un fichier de données contenant les paramètres à transmettre à la configuration au format JSON ou YAML. Lorsque vous spécifiez cette option, DSC interprète les clés du fichier de données comme des paramètres et utilise les valeurs spécifiées. Les valeurs du fichier de données remplacent les valeurs par défaut définies dans la configuration elle-même.

Le fichier de données doit contenir un objet avec la parameters clé. La valeur de la parameters clé doit être un objet où chaque clé est le nom d’un paramètre défini et chaque valeur est une valeur valide pour ce paramètre.

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

À partir de la version 3.1.0 de DSC, vous pouvez transmettre les données de paramètres à une sous-commande via stdin. Lorsque vous le faites, vous devez passer le document de configuration sous la forme d’une chaîne d’entrée ou du chemin d’accès à un fichier sur le système. Vous ne pouvez pas passer à la fois le fichier de paramètres et le document de configuration à une commande à partir de stdin.

Pour plus d’informations sur la définition de paramètres dans un document de configuration, consultez Schéma de paramètres du document de configuration DSC. Pour plus d’informations sur l’utilisation des paramètres dans le document de configuration, consultez la référence de la fonction parameters.

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

-p, --parameters

Spécifie les paramètres à transmettre au document de configuration sous la forme d’une chaîne de données au format JSON ou YAML. Lorsque vous spécifiez cette option, DSC interprète les clés de la chaîne de données comme des paramètres et utilise les valeurs spécifiées. Les valeurs de la chaîne de données remplacent les valeurs par défaut définies dans le document de configuration lui-même.

La chaîne de données doit contenir un objet avec la parameters clé. La valeur de la parameters clé doit être un objet où chaque clé est le nom d’un paramètre défini et chaque valeur est une valeur valide pour ce paramètre.

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

Pour plus d’informations sur la définition de paramètres dans un document de configuration, consultez Schéma de paramètres du document de configuration DSC. Pour plus d’informations sur l’utilisation des paramètres dans le document de configuration, consultez la référence de la fonction parameters.

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

-r, --racine-système

Utilisez cette option pour spécifier le chemin d’accès à la racine du système d’exploitation lorsque vous ne ciblez pas le système d’exploitation en cours d’exécution.

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

-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

Variables d'environnement

Les dsc config * sous-commandes créent la variable d’environnement DSC_CONFIG_ROOT lorsque vous appelez une commande avec la --path possibilité de spécifier le document de configuration à utiliser pour la commande. DSC définit la valeur de la DSC_CONFIG_ROOT variable d’environnement sur le chemin d’accès complet du dossier contenant le document de configuration spécifié.

Vous pouvez utiliser la fonction de configuration envvar pour référencer le chemin d’accès à ce dossier pour les instances de ressource dans la configuration.