Remove-DscConfigurationDocument

  • Référence
Module:
PSDesiredStateConfiguration

Supprime un document de configuration du magasin de configuration DSC.

Syntax

Remove-DscConfigurationDocument
      -Stage <Stage>
      [-Force]
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

L’applet Remove-DscConfigurationDocument de commande supprime un document de configuration (.moffichier) du magasin de configuration Windows PowerShell Desired State Configuration (DSC). Pendant la configuration, l’applet de Start-DscConfiguration commande copie un .mof fichier dans un dossier sur l’ordinateur cible. Cette applet de commande supprime ce document de configuration et effectue un nettoyage supplémentaire.

Cette applet de commande est disponible uniquement dans le cadre du correctif cumulatif de novembre 2014 pour Windows RT 8.1, Windows 8.1 et Windows Server 2012 R2.

Exemples

Exemple 1 : Supprimer le document de configuration actuel

$Session = New-CimSession -ComputerName "Server01" -Credential ACCOUNTS\PattiFuller
Remove-DscConfigurationDocument -Stage Current -CimSession $Session

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 variable $Session. La commande vous invite à entrer un mot de passe. Pour plus d'informations, voir Get-Help New-CimSession.

La deuxième commande supprime le document de configuration actuel pour l’ordinateur spécifié dans la session CimSession stockée dans $Session.

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’à ce que le travail soit terminé. 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, et 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 New-CimSession applet de commande ou Get-CimSession .

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

-Confirm

Vous demande une confirmation avant d’exécuter l’applet de commande.

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

-Force

Indique que cette applet de commande arrête le travail de configuration en cours d’exécution avant de supprimer le document de configuration. Force l’exécution de la commande sans demander la confirmation de l’utilisateur.

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

-Stage

Spécifie le document de configuration à supprimer. Vous pouvez spécifier plusieurs documents. Les valeurs valides pour ce paramètre sont :

  • Current - Supprimez le document de configuration qui décrit l’état actuel du système.
  • Pending - Supprimez le document de configuration qui décrit l’état en attente du système.
  • Previous - Supprimez le document de configuration qui décrit l’état précédent du système.
Type:Microsoft.PowerShell.Cmdletization.GeneratedTypes.RemoveDscConfigurationDocument.Stage
Accepted values:Current, Pending, Previous
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 qu’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 exécutées 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

-WhatIf

Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

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

Entrées

None

Sorties

None