Unregister-PSSessionConfiguration

  • Référence
Module:
Microsoft.PowerShell.Core

Supprime les configurations de sessions inscrites de l'ordinateur.

Syntax

Unregister-PSSessionConfiguration
          [-Name] <String>
          [-Force]
          [-NoServiceRestart]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]

Description

Cette applet de commande est disponible uniquement sur la plateforme Windows.

L’applet Unregister-PSSessionConfiguration de commande supprime les configurations de session inscrites de l’ordinateur. Cette applet de commande est conçue pour permettre aux administrateurs système de gérer les configurations de session personnalisées pour les utilisateurs.

Pour que la modification soit effective, Unregister-PSSessionConfiguration redémarre le service WinRM. Pour empêcher le redémarrage, spécifiez le paramètre NoServiceRestart .

Si vous supprimez accidentellement les configurations par défaut Microsoft.PowerShell ou Microsoft.PowerShell32 de session, utilisez l’applet Enable-PSRemoting de commande pour les restaurer. Pour plus d’informations, consultez about_Session_Configurations.

Exemples

Exemple 1 : Supprimer une configuration de session

Cet exemple supprime la configuration de session MaintenanceShell de l’ordinateur.

Unregister-PSSessionConfiguration -Name "MaintenanceShell"

Exemple 2 : Supprimer une configuration de session et redémarrer le service WinRM

Dans cet exemple, nous supprimons la MaintenanceShell configuration et redémarrons le service WinRM. Le paramètre Force supprime tous les messages utilisateur pour redémarrer le service WinRM sans inviter.

Unregister-PSSessionConfiguration -Name MaintenanceShell -Force

Exemple 3 : Supprimer toutes les configurations de session

Ces exemples montrent deux façons de supprimer toutes les configurations de session sur l’ordinateur. Les deux commandes ont le même effet et peuvent être utilisées de manière interchangeable.

Unregister-PSSessionConfiguration -Name *
Get-PSSessionConfiguration -Name * | Unregister-PSSessionConfiguration

Exemple 4 : Désinscrire sans redémarrage

Cet exemple montre l’effet de l’utilisation du paramètre NoServiceRestart pour empêcher un redémarrage du service qui perturberait les sessions sur l’ordinateur.

PS> Unregister-PSSessionConfiguration -Name "MaintenanceShell" -NoServiceRestart
PS> Get-PSSessionConfiguration -Name "MaintenanceShell"

Get-PSSessionConfiguration -Name MaintenanceShell : No Session Configuration matches criteria "MaintenanceShell".
+ CategoryInfo          : NotSpecified: (:) [Write-Error], WriteErrorException
+ FullyQualifiedErrorId : Microsoft.PowerShell.Commands.WriteErrorException

PS> New-PSSession -ConfigurationName "MaintenanceShell"

Id Name      ComputerName    State    Configuration         Availability
-- ----      ------------    -----    -------------         ------------
1 Session1  localhost       Opened   MaintenanceShell      Available

PS> Restart-Service winrm
PS> New-PSSession -ConfigurationName MaintenanceShell

[localhost] Connecting to remote server failed with the following error message :
 The WS-Management service cannot process the request.
 The resource URI (http://schemas.microsoft.com/powershell/MaintenanceShell) was not found in the WS-Management catalog.
 The catalog contains the metadata that describes resources, or logical endpoints.
 For more information, see the about_Remote_Troubleshooting Help topic.
 + CategoryInfo          : OpenError: (System.Manageme....RemoteRunspace:RemoteRunspace) [], PSRemotingTransportException
 + FullyQualifiedErrorId : PSSessionOpenFailed

Supprime Unregister-PSSessionConfiguration la configuration de session MaintenanceShell . Toutefois, étant donné que la commande utilise le paramètre NoServiceRestart , le service WinRM n’est pas redémarré et la modification n’est pas encore complètement effective.

Ensuite, les Get-PSSessionConfiguration tentatives d’obtention de la MaintenanceShell session. Étant donné que la session a été supprimée de la table de ressources WS-Management, Get-PSSessionConfiguration ne peut pas la retourner.

L’applet New-PSSession de commande crée une session à l’aide de la MaintenanceShell configuration. La commande a réussi. Ensuite, nous redémarrons le service WinRM.

Enfin, l’applet New-PSSession de commande tente de créer une session qui utilise la MaintenanceShell configuration. Cette fois, la session échoue, car la MaintenanceShell configuration a été supprimée lorsque le service WinRM a redémarré.

Paramètres

-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 l’applet de commande ne vous invite pas à confirmer et redémarre le service WinRM sans vous inviter. Le redémarrage du service permet d'appliquer la modification de configuration.

Pour empêcher un redémarrage et supprimer l’invite de redémarrage, utilisez le paramètre NoServiceRestart .

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

-Name

Spécifie les noms des configurations de sessions à supprimer. Entrez un nom de configuration de session ou un modèle de nom de configuration. Les caractères génériques sont autorisés. Ce paramètre est obligatoire.

Vous pouvez également diriger une configuration de session vers Unregister-PSSessionConfiguration.

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

-NoServiceRestart

Indique que cette applet de commande ne redémarre pas le service WinRM et supprime l’invite de redémarrage du service.

Par défaut, lorsque vous exécutez une Unregister-PSSessionConfiguration commande, vous êtes invité à redémarrer le service WinRM pour effectuer la modification. Tant que le service WinRM n’est pas redémarré, les utilisateurs peuvent toujours utiliser la configuration de session non inscrite, même s’ils Get-PSSessionConfiguration ne le trouvent pas.

Pour redémarrer le service WinRM sans demander d’invite, spécifiez le paramètre Force . Pour redémarrer manuellement le service WinRM, utilisez l’applet de Restart-Service commande.

Type:SwitchParameter
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

Microsoft.PowerShell.Commands.PSSessionConfigurationCommands

Vous pouvez diriger un objet de configuration de session vers cette applet de commande.

Sorties

None

Cette applet de commande ne retourne pas de sortie.

Notes

Cette applet de commande est disponible uniquement sur les plateformes Windows.

Pour exécuter cette applet de commande, vous devez démarrer PowerShell à l’aide de l’option Exécuter en tant qu’administrateur .