Partager via

Remove-DscConfigurationDocument

  • Référence
Module:
PSDesiredStateConfiguration

Supprime un document de configuration du magasin de configuration DSC.

Syntaxe

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

Description

L’applet de commande Remove-DscConfigurationDocument supprime un document de configuration (fichier.mof) du magasin de configuration DSC (Desired State Configuration) Windows PowerShell. Pendant la configuration, l’applet de commande Start-DscConfiguration copie un fichier .mof 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 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 de commande New-CimSession, puis stocke l’objet CimSession dans la variable $Session. La commande vous invite à entrer un mot de passe. Pour plus d’informations, tapez Get-Help New-CimSession.

La deuxième commande supprime le document de configuration actuel de l’ordinateur spécifié dans la 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 se termine. Le travail est créé sur l’ordinateur local et les résultats des ordinateurs distants sont automatiquement retournés à l’ordinateur local. Pour gérer le travail, utilisez les applets de commande Job. Pour obtenir les résultats du travail, 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 les travaux en arrière-plan Windows PowerShell, consultez about_Jobs et about_Remote_Jobs.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-CimSession

Exécute l’applet de commande dans une session distante ou sur un ordinateur distant. Entrez un nom d’ordinateur ou un objet de session, tel que la sortie d’une New-CimSession ou d’une applet de commande Get-CimSession.

Type:CimSession[]
Alias:Session
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Confirm

Vous invite à confirmer avant d’exécuter l’applet de commande.

Type:SwitchParameter
Alias:cf
Position:Named
Valeur par défaut:False
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques: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
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Stage

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

  • 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
Valeurs acceptées:Current, Pending, Previous
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ThrottleLimit

Spécifie le nombre maximal d’opérations simultanées qui peuvent être établies 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. La limite de limitation s’applique uniquement à l’applet de commande actuelle, et non à la session ou à l’ordinateur.

Type:Int32
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-WhatIf

Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande n’est pas exécutée.

Type:SwitchParameter
Alias:wi
Position:Named
Valeur par défaut:False
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

None

Sorties

None