Test-DscConfiguration

  • Référence
Module:
PSDesiredStateConfiguration

Teste si la configuration réelle sur les nœuds correspond à la configuration souhaitée.

Syntax

Test-DscConfiguration
    [[-ComputerName] <String[]>]
    [-Credential <PSCredential>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [-Detailed]
    [<CommonParameters>]
Test-DscConfiguration
    [[-ComputerName] <String[]>]
    [-Credential <PSCredential>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [-Path] <String>
    [<CommonParameters>]
Test-DscConfiguration
    [[-ComputerName] <String[]>]
    [-Credential <PSCredential>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    -ReferenceConfiguration <String>
    [<CommonParameters>]
Test-DscConfiguration
    [-ThrottleLimit <Int32>]
    -CimSession <CimSession[]>
    [-AsJob]
    [-Path] <String>
    [<CommonParameters>]
Test-DscConfiguration
    [-ThrottleLimit <Int32>]
    -CimSession <CimSession[]>
    [-AsJob]
    -ReferenceConfiguration <String>
    [<CommonParameters>]
Test-DscConfiguration
    [-ThrottleLimit <Int32>]
    -CimSession <CimSession[]>
    [-AsJob]
    [-Detailed]
    [<CommonParameters>]

Description

L’applet Test-DscConfiguration de commande vérifie si la configuration réelle sur les nœuds correspond à la configuration souhaitée. Spécifiez les ordinateurs pour lesquels vous souhaitez tester des configurations à l’aide de noms d’ordinateurs ou de sessions CIM (Common Information Model). Si vous ne spécifiez pas d'ordinateur cible, l'applet de commande teste la configuration de l'ordinateur local.

Si les configurations souhaitées et réelles correspondent, l’applet de commande retourne une valeur de chaîne « True ». Sinon, il retourne une valeur de chaîne « False ».

Exemples

Exemple 1 : Configuration de test pour l’ordinateur local

Test-DscConfiguration

Cette commande teste la configuration de l'ordinateur local.

Exemple 2 : Configuration de test pour un ordinateur spécifié

$Session = New-CimSession -ComputerName "Server01" -Credential ACCOUNTS\PattiFuller
Test-DscConfiguration -CimSession $Session

Cet exemple teste la configuration d'un ordinateur spécifié par une session CIM. L'exemple crée une session CIM pour un ordinateur nommé Server01 à utiliser avec l'applet de commande. Vous pouvez aussi créer un tableau de sessions CIM pour appliquer l'applet de commande à plusieurs ordinateurs spécifiés.

La première commande crée une session CIM à l’aide de l’applet New-CimSession de commande, puis stocke l’objet CimSession dans la $Session variable. La commande vous invite à entrer un mot de passe. Pour plus d'informations, voir Get-Help New-CimSession.

La deuxième commande teste la configuration des ordinateurs identifiés par les objets CimSession stockés dans la $Session variable, dans ce cas, l’ordinateur nommé Server01.

Exemple 3 : Tester des configurations avec des résultats détaillés

Test-DscConfiguration -ComputerName "Server01", "Server02", "Server03" -Detailed

Cette commande teste les configurations d’un ensemble d’ordinateurs spécifié par le paramètre ComputerName et retourne des informations détaillées qui incluent l’état global, les ressources qui se trouvent dans l’état souhaité, les ressources qui ne sont pas dans l’état souhaité et le nom de l’ordinateur.

Exemple 4 : Configurations de test spécifiées dans un dossier

Test-DscConfiguration -Path "C:\Dsc\Configurations"

Cette commande teste les configurations définies dans un dossier spécifié par le paramètre Path . Les configurations sont testées sur un ensemble d’ordinateurs, chacun identifié par le nom de fichier du fichier de configuration.

Exemple 5 : Configurations de test spécifiées dans un fichier

Test-DscConfiguration -ReferenceConfiguration "C:\Dsc\Configurations\WebServer.mof" -ComputerName "Server01", "Server02", "Server03"

Cette commande teste une configuration définie dans un fichier sur un ensemble d’ordinateurs spécifié par le paramètre ComputerName .

Paramètres

-AsJob

Indique que cette applet de commande exécute la commande en tant que travail en arrière-plan.

Si vous spécifiez le paramètre AsJob , la commande retourne un objet qui représente le travail, puis affiche l’invite de commandes. Vous pouvez continuer à travailler dans la session jusqu’à la fin du travail. La tâche est créée sur l'ordinateur local et les résultats provenant d'ordinateurs distants sont automatiquement retournés à l'ordinateur local. Pour gérer la tâche, utilisez les applets de commande Job. Pour obtenir les résultats de la tâche, utilisez l'applet de commande Receive-Job.

Pour utiliser ce paramètre, les ordinateurs locaux et distants doivent être configurés pour la communication à distance. Sur Windows Vista et les versions ultérieures du système d’exploitation Windows, vous devez ouvrir Windows PowerShell avec l’option Exécuter en tant qu’administrateur. Pour plus d'informations, consultez about_Remote_Requirements.

Pour plus d’informations sur Windows PowerShell travaux en arrière-plan, consultez about_Jobs et about_Remote_Jobs.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CimSession

Exécute l’applet de commande dans une session à distance ou sur un ordinateur distant. Entrez un nom d’ordinateur ou un objet de session, tel que la sortie d’une applet de commande New-CimSession ou Get-CimSession . La valeur par défaut est la session active sur l’ordinateur local.

Type:CimSession[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ComputerName

Spécifie un tableau de noms d’ordinateurs sur lequel cette applet de commande teste la configuration. L’applet de commande teste le document de configuration à l’emplacement spécifié par le paramètre Path sur ces ordinateurs.

Type:String[]
Aliases:CN, ServerName
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Credential

Spécifie un nom d'utilisateur et un mot de passe, sous la forme d'un objet PSCredential, pour l'ordinateur cible. Pour obtenir un objet PSCredential , utilisez l’applet de Get-Credential commande . Pour plus d'informations, voir Get-Help Get-Credential.

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Detailed

Indique que cette applet de commande retourne un résultat détaillé de la comparaison du document de configuration avec l’état souhaité des nœuds. Le résultat inclut des informations telles que l’état global, les ressources qui sont à l’état souhaité, les ressources qui ne sont pas dans l’état souhaité et le nom de l’ordinateur.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

Spécifie le chemin d’accès d’un dossier qui contient des fichiers de document de configuration. L’applet de commande teste la configuration par rapport à l’état souhaité des ordinateurs spécifié par le paramètre ComputerName ou CimSession .

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ReferenceConfiguration

Spécifie le chemin d’accès du fichier de document de configuration. Cette applet de commande teste la configuration par rapport à l’état réel des ordinateurs spécifié par le paramètre ComputerName ou CimSession .

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ThrottleLimit

Spécifie le nombre maximal d’opérations simultanées pouvant être établi pour exécuter l’applet de commande. Si ce paramètre est omis ou si une valeur de 0 est entrée, Windows PowerShell calcule une limite de limitation optimale pour l’applet de commande en fonction du nombre d’applets de commande CIM qui s’exécutent sur l’ordinateur. Le seuil de limitation s’applique uniquement à l’applet de commande active et non à la session ou à l’ordinateur.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False