Disconnect-PSSession
Se déconnecte d’une session.
Syntaxe
Disconnect-PSSession
[-Session] <PSSession[]>
[-IdleTimeoutSec <Int32>]
[-OutputBufferingMode <OutputBufferingMode>]
[-ThrottleLimit <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Disconnect-PSSession
[-IdleTimeoutSec <Int32>]
[-OutputBufferingMode <OutputBufferingMode>]
[-ThrottleLimit <Int32>]
-Name <String[]>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Disconnect-PSSession
[-IdleTimeoutSec <Int32>]
[-OutputBufferingMode <OutputBufferingMode>]
[-ThrottleLimit <Int32>]
-InstanceId <Guid[]>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Disconnect-PSSession
[-IdleTimeoutSec <Int32>]
[-OutputBufferingMode <OutputBufferingMode>]
[-ThrottleLimit <Int32>]
[-Id] <Int32[]>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
L’applet de commande Disconnect-PSSession
déconnecte une session PowerShell (PSSession), telle qu’une applet de commande démarrée à l’aide de l’applet de commande New-PSSession
, à partir de la session active. Par conséquent, le PSSession est dans un état déconnecté. Vous pouvez vous connecter au PSSession déconnecté de la session active ou d’une autre session sur l’ordinateur local ou sur un autre ordinateur.
L’applet de commande Disconnect-PSSession
déconnecte uniquement session PSSessions connectées à la session active.
Disconnect-PSSession
ne peut pas déconnecter les sessions PSSessions interrompues ou fermées , ou les interactives démarrées à l’aide de l’applet de commande Enter-PSSession
et ne peuvent pas déconnecter sessions PSSessions connectées à d’autres sessions.
Pour vous reconnecter à une PSSession déconnectée, utilisez les applets de commande Connect-PSSession
ou Receive-PSSession
.
Lorsqu’une PSSession est déconnectée, les commandes du PSSession continuent à s’exécuter jusqu’à ce qu’elles se terminent, sauf si les PSSession expirent ou les commandes dans le PSSession sont bloquées par une mémoire tampon de sortie complète. Pour modifier le délai d’inactivité, utilisez le paramètre IdleTimeoutSec. Pour modifier le mode de mise en mémoire tampon de sortie, utilisez le paramètre OutputBufferingMode Vous pouvez également utiliser le paramètre InDisconnectedSession de l’applet de commande Invoke-Command
pour exécuter une commande dans une session déconnectée.
Pour plus d’informations sur la fonctionnalité Sessions déconnectées, consultez about_Remote_Disconnected_Sessions.
Cette applet de commande est introduite dans Windows PowerShell 3.0.
Exemples
Exemple 1 : déconnecter une session par nom
Cette commande déconnecte lePSSession UpdateSession
sur l’ordinateur Server01 de la session active. La commande utilise le paramètre Name pour identifier le PSSession.
PS> Disconnect-PSSession -Name UpdateSession
Id Name ComputerName State ConfigurationName Availability
-- ---- ------------ ----- ----------------- ------------
1 UpdateSession Server01 Disconnected Microsoft.PowerShell None
La sortie indique que la tentative de déconnexion a réussi. L’état de session est Disconnected
et le de disponibilité est None
, ce qui indique que la session n’est pas occupée et peut être reconnectée.
Exemple 2 : déconnecter une session d’un ordinateur spécifique
Cette commande déconnecte lePSSession ITTask
sur l’ordinateur Server12 de la session active. La session ITTask
a été créée dans la session active et se connecte à l’ordinateur Server12. La commande utilise l’applet de commande Get-PSSession
pour obtenir la session et l’applet de commande Disconnect-PSSession
pour la déconnecter.
PS> Get-PSSession -ComputerName Server12 -Name ITTask |
Disconnect-PSSession -OutputBufferingMode Drop -IdleTimeoutSec 86400
Id Name ComputerName State ConfigurationName Availability
-- ---- ------------ ----- ----------------- ------------
1 ITTask Server12 Disconnected ITTasks None
La commande Disconnect-PSSession
utilise le paramètre OutputBufferingMode pour définir le mode de sortie sur Drop
. Ce paramètre garantit que le script en cours d’exécution dans la session peut continuer à s’exécuter même si la mémoire tampon de sortie de session est pleine. Étant donné que le script écrit sa sortie dans un rapport sur un partage de fichiers, d’autres sorties peuvent être perdues sans conséquence.
La commande utilise également le paramètre IdleTimeoutSec pour étendre le délai d’inactivité de la session à 24 heures. Ce paramètre permet à cet administrateur ou à d’autres administrateurs de se reconnecter à la session pour vérifier que le script s’est exécuté et dépanner si nécessaire.
Exemple 3 : utilisation de plusieurs sessions PSSession sur plusieurs ordinateurs
Cette série de commandes montre comment l’applet de commande Disconnect-PSSession
peut être utilisée dans un scénario d’entreprise. Dans ce cas, un nouveau technicien démarre un script dans une session sur un ordinateur distant et rencontre un problème. Le technicien se déconnecte de la session afin qu’un responsable plus expérimenté puisse se connecter à la session et résoudre le problème.
PS> $s = New-PSSession -ComputerName Srv1, Srv2, Srv30 -Name ITTask
PS> Invoke-Command $s -FilePath \\Server01\Scripts\Get-PatchStatus.ps1
PS> Get-PSSession -Name ITTask -ComputerName Srv1 | Disconnect-PSSession
Id Name ComputerName State ConfigurationName Availability
-- ---- ------------ ----- ----------------- ------------
1 ITTask Srv1 Disconnected Microsoft.PowerShell None
PS> Get-PSSession -ComputerName Srv1, Srv2, Srv30 -Name ITTask
Id Name ComputerName State ConfigurationName Availability
-- ---- ------------ ----- ----------------- ------------
1 ITTask Srv1 Disconnected Microsoft.PowerShell None
2 ITTask Srv2 Opened Microsoft.PowerShell Available
3 ITTask Srv30 Opened Microsoft.PowerShell Available
PS> Get-PSSession -ComputerName Srv1 -Name ITTask -Credential Domain01\User01
Id Name ComputerName State ConfigurationName Availability
-- ---- ------------ ----- ----------------- ------------
1 ITTask Srv1 Disconnected Microsoft.PowerShell None
PS> $s = Connect-PSSession -ComputerName Srv1 -Name ITTask -Credential Domain01\User01
PS> Invoke-Command -Session $s {dir $HOME\Scripts\PatchStatusOutput.ps1}
PS> Invoke-Command -Session $s {mkdir $HOME\Scripts\PatchStatusOutput}
PS> Invoke-Command -Session $s -FilePath \\Server01\Scripts\Get-PatchStatus.ps1
PS> Disconnect-PSSession -Session $s
Le technicien commence par créer des sessions sur plusieurs ordinateurs distants et exécuter un script dans chaque session. La première commande utilise l’applet de commande New-PSSession
pour créer la session ITTask
sur trois ordinateurs distants. La commande enregistre les sessions dans la variable $s
. La deuxième commande utilise le paramètre FilePath de l’applet de commande Invoke-Command
pour exécuter un script dans les sessions de la variable $s
.
Le script exécuté sur l’ordinateur Srv1 génère des erreurs inattendues. Le technicien contacte son responsable et demande de l’aide. Le responsable dirige le technicien à se déconnecter de la session afin qu’il puisse enquêter. La deuxième commande utilise l’applet de commande Get-PSSession
pour obtenir la session ITTask
sur l’ordinateur Srv1 et l’applet de commande Disconnect-PSSession
pour la déconnecter. Cette commande n’affecte pas les sessions ITTask
sur les autres ordinateurs.
La troisième commande utilise l’applet de commande Get-PSSession
pour obtenir les sessions ITTask
. La sortie indique que les sessions ITTask
sur les ordinateurs Srv2 et Srv30 n’ont pas été affectées par la commande à déconnecter.
Le responsable se connecte à son ordinateur personnel, se connecte à son réseau d’entreprise, démarre PowerShell et utilise l’applet de commande Get-PSSession
pour obtenir la session ITTask
sur l’ordinateur Srv1. Il utilise les informations d’identification du technicien pour accéder à la session.
Ensuite, le gestionnaire utilise l’applet de commande Connect-PSSession
pour se connecter à la session ITTask
sur l’ordinateur Srv1. La commande enregistre la session dans la variable $s
.
Le gestionnaire utilise l’applet de commande Invoke-Command
pour exécuter certaines commandes de diagnostic dans la session dans la variable $s
. Il reconnaît que le script a échoué parce qu’il n’a pas trouvé de répertoire requis.
Le gestionnaire utilise la fonction MkDir
pour créer le répertoire, puis redémarre le script Get-PatchStatus.ps1
et se déconnecte de la session. Le responsable signale ses résultats au technicien, suggère qu’il se reconnecte à la session pour effectuer les tâches et lui demande d’ajouter une commande au script Get-PatchStatus.ps1
qui crée le répertoire requis s’il n’existe pas.
Exemple 4 : Modifier la valeur de délai d’expiration d’une session PSSession
Cet exemple montre comment corriger la valeur de l'propriété IdleTimeout d’une session afin qu’elle puisse être déconnectée.
La propriété de délai d’inactivité d’une session est essentielle pour les sessions déconnectées, car elle détermine la durée pendant laquelle une session déconnectée est conservée avant sa suppression. Vous pouvez définir l’option de délai d’inactivité lorsque vous créez une session et lorsque vous la déconnectez. Les valeurs par défaut du délai d’inactivité d’une session sont définies dans la variable de préférence $PSSessionOption
sur l’ordinateur local et dans la configuration de session sur l’ordinateur distant. Les valeurs définies pour la session sont prioritaires sur les valeurs définies dans la configuration de session, mais les valeurs de session ne peuvent pas dépasser les quotas définis dans la configuration de session, telles que les MaxIdleTimeoutMs valeur.
PS> $Timeout = New-PSSessionOption -IdleTimeout 172800000
PS> $s = New-PSSession -Computer Server01 -Name ITTask -SessionOption $Timeout
PS> Disconnect-PSSession -Session $s
Disconnect-PSSession : The session ITTask cannot be disconnected because the specified
idle timeout value 172800(seconds) is either greater than the server maximum allowed
43200 (seconds) or less that the minimum allowed60(seconds). Choose an idle time out
value that is within the allowed range and try again.
PS> Invoke-Command -ComputerName Server01 {Get-PSSessionConfiguration Microsoft.PowerShell} |
Format-List -Property *
Architecture : 64
Filename : %windir%\system32\pwrshplugin.dll
ResourceUri : http://schemas.microsoft.com/powershell/microsoft.powershell
MaxConcurrentCommandsPerShell : 1000
UseSharedProcess : false
ProcessIdleTimeoutSec : 0
xmlns : http://schemas.microsoft.com/wbem/wsman/1/config/PluginConfiguration
MaxConcurrentUsers : 5
lang : en-US
SupportsOptions : true
ExactMatch : true
RunAsUser :
IdleTimeoutms : 7200000
PSVersion : 3.0
OutputBufferingMode : Block
AutoRestart : false
SecurityDescriptorSddl : O:NSG:BAD:P(A;;GA;;;BA)S:P(AU;FA;GA;;;WD)(AU;SA;GXGW;;;WD)
MaxMemoryPerShellMB : 1024
MaxIdleTimeoutms : 2147483647
Uri : http://schemas.microsoft.com/powershell/microsoft.powershell
SDKVersion : 2
Name : microsoft.powershell
XmlRenderingType : text
Capability : {Shell}
RunAsPassword :
MaxProcessesPerShell : 15
ParentResourceUri : http://schemas.microsoft.com/powershell/microsoft.powershell
Enabled : true
MaxShells : 25
MaxShellsPerUser : 25
Permission : BUILTIN\Administrators AccessAllowed
PSComputerName : localhost
RunspaceId : aea84310-6dbf-4c21-90ac-13980039925a
PSShowComputerName : True
PS> $s.Runspace.ConnectionInfo
ConnectionUri : http://Server01/wsman
ComputerName : Server01
Scheme : http
Port : 80
AppName : /wsman
Credential :
ShellUri : http://schemas.microsoft.com/powershell/Microsoft.PowerShell
AuthenticationMechanism : Default
CertificateThumbprint :
MaximumConnectionRedirectionCount : 5
MaximumReceivedDataSizePerCommand :
MaximumReceivedObjectSize : 209715200
UseCompression : True
NoMachineProfile : False
ProxyAccessType : None
ProxyAuthentication : Negotiate
ProxyCredential :
SkipCACheck : False
SkipCNCheck : False
SkipRevocationCheck : False
NoEncryption : False
UseUTF16 : False
OutputBufferingMode : Drop
IncludePortInSPN : False
Culture : en-US
UICulture : en-US
OpenTimeout : 180000
CancelTimeout : 60000
OperationTimeout : 180000
IdleTimeout : 172800000
PS> Disconnect-PSSession $s -IdleTimeoutSec 43200
Id Name ComputerName State ConfigurationName Availability
-- ---- ------------ ----- ----------------- ------------
4 ITTask Server01 Disconnected Microsoft.PowerShell None
PS> $s.Runspace.ConnectionInfo.IdleTimeout
43200000
La première commande utilise l’applet de commande New-PSSessionOption
pour créer un objet d’option de session. Il utilise le paramètre IdleTimeout pour définir un délai d’inactivité de 48 heures (172800000
millisecondes). La commande enregistre l’objet d’option de session dans la variable $Timeout
.
La deuxième commande utilise l’applet de commande New-PSSession
pour créer la session ITTask
sur l’ordinateur Server01. La commande enregistre la session dans la variable $s
. La valeur du paramètre SessionOption est le délai d’inactivité de 48 heures dans la variable $Timeout
.
La troisième commande déconnecte la session ITTask
dans la variable $s
. La commande échoue, car la valeur du délai d’inactivité de la session dépasse le quota MaxIdleTimeoutMs dans la configuration de la session. Étant donné que le délai d’inactivité n’est pas utilisé tant que la session n’est pas déconnectée, cette violation peut ne pas être détectée pendant l’utilisation de la session.
La quatrième commande utilise l’applet de commande Invoke-Command
pour exécuter une commande Get-PSSessionConfiguration
pour la configuration de session Microsoft.PowerShell
sur l’ordinateur Server01. La commande utilise l’applet de commande Format-List
pour afficher toutes les propriétés de la configuration de session dans une liste. La sortie indique que la propriété MaxIdleTimeoutMS, qui établit la valeur maximale autorisée IdleTimeout pour les sessions qui utilisent la configuration de session, est 43200000
millisecondes (12 heures).
La cinquième commande obtient les valeurs d’option de session de la session dans la variable $s
. Les valeurs de nombreuses options de session sont des propriétés de la propriété ConnectionInfo de la propriété Runspace de la session. La sortie indique que la valeur de la propriété IdleTimeout de la session est 172800000
millisecondes (48 heures), ce qui enfreint le quota MaxIdleTimeoutMs de 12 heures dans la configuration de la session. Pour résoudre ce conflit, vous pouvez utiliser le paramètre ConfigurationName pour sélectionner une autre configuration de session ou utiliser le paramètre IdleTimeout pour réduire le délai d’inactivité de la session.
La sixième commande déconnecte la session. Il utilise le paramètre IdleTimeoutSec pour définir le délai d’inactivité sur le maximum de 12 heures.
La septième commande obtient la valeur de la propriété IdleTimeout de la session déconnectée, qui est mesurée en millisecondes. La sortie confirme que la commande a réussi.
Paramètres
-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 |
-Id
Se déconnecte des sessions avec l’ID de session spécifié. Tapez un ou plusieurs ID (séparés par des virgules) ou utilisez l’opérateur de plage (..
) pour spécifier une plage d’ID.
Pour obtenir l’ID d’une session, utilisez l’applet de commande Get-PSSession
. L’ID d’instance est stocké dans la propriété ID de la session.
Type: | Int32[] |
Position: | 1 |
Valeur par défaut: | None |
Obligatoire: | True |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-IdleTimeoutSec
Modifie la valeur du délai d’inactivité du PSSession déconnecté. Entrez une valeur en secondes. La valeur minimale est 60
(1 minute).
Le délai d’inactivité détermine la durée pendant laquelle l' PSSession déconnectée est conservée sur l’ordinateur distant. Lorsque le délai d’expiration expire, le PSSession est supprimé.
Les PSSessions déconnectées sont considérées comme inactives à partir du moment où elles sont déconnectées, même si les commandes s’exécutent dans la session déconnectée.
La valeur par défaut du délai d’inactivité d’une session est définie par la valeur de la IdleTimeoutMs propriété de la configuration de session. La valeur par défaut est 7200000
millisecondes (2 heures).
La valeur de ce paramètre est prioritaire sur la valeur de la propriété IdleTimeout de la variable de préférence $PSSessionOption
et de la valeur de délai d’inactivité par défaut dans la configuration de la session. Toutefois, cette valeur ne peut pas dépasser la valeur de la MaxIdleTimeoutMs propriété de la configuration de session. La valeur par défaut de MaxIdleTimeoutMs est de 12 heures (43200000
millisecondes).
Type: | Int32 |
Position: | Named |
Valeur par défaut: | 60 |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-InstanceId
Se déconnecte des sessions avec les ID d’instance spécifiés.
L’ID d’instance est un GUID qui identifie de façon unique une session sur un ordinateur local ou distant. L’ID d’instance est unique, même entre plusieurs sessions sur plusieurs ordinateurs.
Pour obtenir l’ID d’instance d’une session, utilisez l’applet de commande Get-PSSession
. L’ID d’instance est stocké dans la propriété InstanceID de la session.
Type: | Guid[] |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | True |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-Name
Se déconnecte des sessions avec les noms conviviaux spécifiés. Les caractères génériques sont autorisés.
Pour obtenir le nom convivial d’une session, utilisez l’applet de commande Get-PSSession
. Le nom convivial est stocké dans la propriété Name de la session.
Type: | String[] |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | True |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | True |
-OutputBufferingMode
Détermine la façon dont la sortie de commande est gérée dans la session déconnectée lorsque la mémoire tampon de sortie est pleine. La valeur par défaut est Block
.
Si la commande de la session déconnectée retourne la sortie et que la mémoire tampon de sortie se remplit, la valeur de ce paramètre détermine efficacement si la commande continue à s’exécuter pendant la déconnexion de la session. Une valeur de Block
interrompt la commande jusqu’à ce que la session soit reconnectée. Une valeur de Drop
permet à la commande de se terminer, bien que les données puissent être perdues. Lorsque vous utilisez la valeur Drop
, redirigez la sortie de commande vers un fichier sur le disque.
Les valeurs valides sont les suivantes :
-
Block
: lorsque la mémoire tampon de sortie est pleine, l’exécution est suspendue jusqu’à ce que la mémoire tampon soit effacée. -
Drop
: lorsque la mémoire tampon de sortie est pleine, l’exécution se poursuit. Lorsque la nouvelle sortie est enregistrée, la sortie la plus ancienne est ignorée. -
None
: aucun mode de mise en mémoire tampon de sortie n’est spécifié. La valeur de la propriété OutputBufferingMode de la configuration de session est utilisée pour la session déconnectée.
Type: | OutputBufferingMode |
Position: | Named |
Valeur par défaut: | Block |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-Session
Se déconnecte du PSSessions spécifié. Entrez objets PSSession, tels que ceux retournés par l’applet de commande New-PSSession
. Vous pouvez également diriger un objet PSSession vers Disconnect-PSSession
.
L’applet de commande Get-PSSession
peut obtenir tous les PSSessions qui se terminent sur un ordinateur distant, y compris les psSessions déconnectées et psSessions connectées à d’autres sessions sur d’autres ordinateurs.
Disconnect-PSSession
déconnecte uniquement session PSSession connectées à la session active. Si vous dirigez d’autres sessions PSSessions vers Disconnect-PSSession
, la commande Disconnect-PSSession
échoue.
Type: | PSSession[] |
Position: | 1 |
Valeur par défaut: | None |
Obligatoire: | True |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-ThrottleLimit
Définit la limite de limitation pour la commande Disconnect-PSSession
.
La limite de limitation est le nombre maximal de connexions simultanées qui peuvent être établies pour exécuter cette commande. Si vous omettez ce paramètre ou entrez une valeur de 0
, la valeur par défaut, 32
, est utilisée.
La limite de limitation s’applique uniquement à la commande actuelle, et non à la session ou à l’ordinateur.
Type: | Int32 |
Position: | Named |
Valeur par défaut: | 32 |
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
Vous pouvez diriger une session vers cette applet de commande.
Sorties
Cette applet de commande retourne un objet représentant la session qu’elle a déconnectée.
Notes
Windows PowerShell inclut les alias suivants pour Disconnect-PSSession
:
dnsn
L’applet de commande
Disconnect-PSSession
fonctionne uniquement lorsque les ordinateurs locaux et distants exécutent PowerShell 3.0 ou version ultérieure.Si vous utilisez l’applet de commande
Disconnect-PSSession
sur une session déconnectée, la commande n’a aucun effet sur la session et ne génère pas d’erreurs.Les sessions de bouclage déconnectées avec des jetons de sécurité interactifs (celles créées avec le paramètre EnableNetworkAccess) peuvent être reconnectées uniquement à partir de l’ordinateur sur lequel la session a été créée. Cette restriction protège l’ordinateur contre l’accès malveillant.
Lorsque vous déconnectez un PSSession, l’état de session est
Disconnected
et la disponibilité est Aucun.La valeur de la propriété State est relative à la session active. Par conséquent, une valeur de
Disconnected
signifie que le PSSession n’est pas connecté à la session active. Toutefois, cela ne signifie pas que le PSSession est déconnecté de toutes les sessions. Il peut être connecté à une autre session. Pour déterminer si vous pouvez vous connecter ou vous reconnecter à la session, utilisez la propriété Availability.Une valeur Availability de
None
indique que vous pouvez vous connecter à la session. Une valeur deBusy
indique que vous ne pouvez pas vous connecter au PSSession, car il est connecté à une autre session.Pour plus d’informations sur les valeurs de la propriété State des sessions, consultez 'énumération RunspaceState.
Pour plus d’informations sur les valeurs de la propriété Availability des sessions, consultez 'énumération RunspaceAvailability.