Get-PSSession

Syntaxe

Get-PSSession
   [-Name <String[]>]
   [<CommonParameters>]

Get-PSSession
   [-ComputerName] <String[]>
   [-ApplicationName <String>]
   [-ConfigurationName <String>]
   [-Name <String[]>]
   [-Credential <PSCredential>]
   [-Authentication <AuthenticationMechanism>]
   [-CertificateThumbprint <String>]
   [-Port <Int32>]
   [-UseSSL]
   [-ThrottleLimit <Int32>]
   [-State <SessionFilterState>]
   [-SessionOption <PSSessionOption>]
   [<CommonParameters>]

Get-PSSession
   [-ComputerName] <String[]>
   [-ApplicationName <String>]
   [-ConfigurationName <String>]
   -InstanceId <Guid[]>
   [-Credential <PSCredential>]
   [-Authentication <AuthenticationMechanism>]
   [-CertificateThumbprint <String>]
   [-Port <Int32>]
   [-UseSSL]
   [-ThrottleLimit <Int32>]
   [-State <SessionFilterState>]
   [-SessionOption <PSSessionOption>]
   [<CommonParameters>]

Get-PSSession
   [-ConnectionUri] <Uri[]>
   [-ConfigurationName <String>]
   [-AllowRedirection]
   [-Name <String[]>]
   [-Credential <PSCredential>]
   [-Authentication <AuthenticationMechanism>]
   [-CertificateThumbprint <String>]
   [-ThrottleLimit <Int32>]
   [-State <SessionFilterState>]
   [-SessionOption <PSSessionOption>]
   [<CommonParameters>]

Get-PSSession
   [-ConnectionUri] <Uri[]>
   [-ConfigurationName <String>]
   [-AllowRedirection]
   -InstanceId <Guid[]>
   [-Credential <PSCredential>]
   [-Authentication <AuthenticationMechanism>]
   [-CertificateThumbprint <String>]
   [-ThrottleLimit <Int32>]
   [-State <SessionFilterState>]
   [-SessionOption <PSSessionOption>]
   [<CommonParameters>]

Get-PSSession
   [-ConfigurationName <String>]
   -InstanceId <Guid[]>
   [-State <SessionFilterState>]
   -VMName <String[]>
   [<CommonParameters>]

Get-PSSession
   [-ConfigurationName <String>]
   [-Name <String[]>]
   [-State <SessionFilterState>]
   -ContainerId <String[]>
   [<CommonParameters>]

Get-PSSession
   [-ConfigurationName <String>]
   -InstanceId <Guid[]>
   [-State <SessionFilterState>]
   -ContainerId <String[]>
   [<CommonParameters>]

Get-PSSession
   [-ConfigurationName <String>]
   [-Name <String[]>]
   [-State <SessionFilterState>]
   -VMId <Guid[]>
   [<CommonParameters>]

Get-PSSession
   [-ConfigurationName <String>]
   -InstanceId <Guid[]>
   [-State <SessionFilterState>]
   -VMId <Guid[]>
   [<CommonParameters>]

Get-PSSession
   [-ConfigurationName <String>]
   [-Name <String[]>]
   [-State <SessionFilterState>]
   -VMName <String[]>
   [<CommonParameters>]

Get-PSSession
   [-InstanceId <Guid[]>]
   [<CommonParameters>]

Get-PSSession
   [-Id] <Int32[]>
   [<CommonParameters>]

Description

L’applet Get-PSSession de commande obtient les sessions PowerShell gérées par l’utilisateur (PSSessions) sur les ordinateurs locaux et distants.

À compter de Windows PowerShell 3.0, les sessions sont stockées sur les ordinateurs à la fin distante de chaque connexion. Vous pouvez utiliser les paramètres ComputerName ou ConnectionUri pour Get-PSSession obtenir les sessions qui se connectent à l’ordinateur local ou aux ordinateurs distants, même si elles n’ont pas été créées dans la session active.

Sans paramètres, Get-PSSession obtient toutes les sessions créées dans la session active.

Utilisez les paramètres de filtrage, notamment Name, ID, InstanceID, State, ApplicationName et ConfigurationName pour sélectionner parmi les sessions qui Get-PSSession retournent.

Utilisez les paramètres restants pour configurer la connexion temporaire dans laquelle la Get-PSSession commande s’exécute lorsque vous utilisez les paramètres ComputerName ou ConnectionUri .

Pour plus d’informations sur les sessions PowerShell, consultez about_PSSessions.

Exemples

Exemple 1 : Obtenir des sessions créées dans la session active

Get-PSSession

Cette commande obtient toutes les sessions PSSession créées dans la session active. Il n’obtient pas les sessions PSSession qui ont été créées dans d’autres sessions ou sur d’autres ordinateurs , même s’ils se connectent à cet ordinateur.

Exemple 2 : Obtenir des sessions connectées à l’ordinateur local

Get-PSSession -ComputerName "localhost"

Cette commande obtient les sessions PSSession connectées à l’ordinateur local. Pour indiquer l’ordinateur local, tapez le nom de l’ordinateur, localhost ou un point (.)

La commande retourne toutes les sessions sur l'ordinateur local, même si elles ont été créées dans différentes sessions ou sur des ordinateurs différents.

Exemple 3 : Obtenir des sessions connectées à un ordinateur

Get-PSSession -ComputerName "Server02"

Id Name            ComputerName    State         ConfigurationName     Availability
 -- ----            ------------    -----         -----------------     ------------
  2 Session3        Server02       Disconnected  ITTasks                       Busy
  1 ScheduledJobs   Server02       Opened        Microsoft.PowerShell     Available
  3 Test            Server02       Disconnected  Microsoft.PowerShell          Busy

Cette commande obtient les sessions PSSession connectées à l’ordinateur Server02.

La commande retourne toutes les sessions sur Server02, même si elles ont été créées dans différentes sessions ou sur des ordinateurs différents.

La sortie indique que deux des sessions ont un Disconnected état et une Busy disponibilité. Elles ont été créées dans différentes sessions et sont en cours d'utilisation. La ScheduledJobs session, qui est Opened et Available, a été créée dans la session active.

Exemple 4 : Enregistrer les résultats de cette commande

New-PSSession -ComputerName Server01, Server02, Server03
$s1, $s2, $s3 = Get-PSSession

Cet exemple montre comment enregistrer les résultats d’une Get-PSSession commande dans plusieurs variables.

La première commande utilise l’applet New-PSSession de commande pour créer des sessions PSSession sur trois ordinateurs distants.

La deuxième commande utilise une Get-PSSession applet de commande pour obtenir les trois sessions PSSession. Il enregistre ensuite chacune des sessions PSSession dans une variable distincte.

Lorsque PowerShell affecte un tableau d’objets à un tableau de variables, il affecte le premier objet à la première variable, le deuxième objet à la deuxième variable, et ainsi de suite. S'il y a plus d'objets que de variables, il affecte tous les autres objets à la dernière variable dans le tableau. S'il y a plus de variables que d'objets, les variables supplémentaires ne sont pas utilisées.

Exemple 5 : Supprimer une session à l’aide d’un ID d’instance

Get-PSSession | Format-Table -Property ComputerName, InstanceID
$s = Get-PSSession -InstanceID a786be29-a6bb-40da-80fb-782c67f7db0f
Remove-PSSession -Session $s

Cet exemple montre comment obtenir une session PSSession à l’aide de son ID d’instance, puis supprimer la session PSSession.

La première commande obtient toutes les sessions PSSession qui ont été créées dans la session active. Il envoie les sessions PSSession à l’applet Format-Table de commande, qui affiche les propriétés ComputerName et InstanceID de chaque session PSSession.

La deuxième commande utilise l’applet Get-PSSession de commande pour obtenir une session PSSession particulière et l’enregistrer dans la $s variable. La commande utilise le paramètre InstanceID pour identifier la session PSSession.

La troisième commande utilise l’applet de commande Remove-PSSession pour supprimer la session PSSession dans la $s variable.

Exemple 6 : Obtenir une session portant un nom particulier

Les commandes de cet exemple montrent comment rechercher une session qui a un format de nom particulier et qui utilise une configuration de session particulière, puis comment se connecter à la session. Vous pouvez utiliser une commande similaire à celle-ci pour rechercher une session dans laquelle un collègue a démarré une tâche et vous connecter pour terminer la tâche.

Get-PSSession -ComputerName Server02, Server12 -Name BackupJob* -ConfigurationName ITTasks -SessionOption @{OperationTimeout=240000}

Id Name            ComputerName    State         ConfigurationName     Availability
 -- ----            ------------    -----         -----------------     ------------
  3 BackupJob04     Server02        Disconnected        ITTasks                  None

$s = Get-PSSession -ComputerName Server02 -Name BackupJob04 -ConfigurationName ITTasks | Connect-PSSession
$s

Id Name            ComputerName    State         ConfigurationName     Availability
-- ----            ------------    -----         -----------------     ------------
 5 BackupJob04     Server02        Opened        ITTasks                  Available

La première commande obtient des sessions sur les ordinateurs distants Server02 et Server12 qui ont des noms qui commencent BackupJob par et utilisent la configuration de sessionITTasks. La commande utilise le paramètre Name pour spécifier le modèle de nom et le paramètre ConfigurationName pour spécifier la configuration de session. La valeur du paramètre SessionOption est une table de hachage qui définit la valeur de OperationTimeout sur 240000 millisecondes (4 minutes). Ce paramètre donne plus de temps à la commande. Les paramètres ConfigurationName et SessionOption sont utilisés pour configurer les sessions temporaires dans lesquelles l’applet Get-PSSession de commande s’exécute sur chaque ordinateur. La sortie indique que la commande retourne la BackupJob04 session. La session est déconnectée et la disponibilité indique Nonequ’elle n’est pas utilisée.

La deuxième commande utilise l’applet Get-PSSession de commande pour accéder à la BackupJob04 session et l’applet Connect-PSSession de commande pour se connecter à la session. La commande enregistre la session dans la variable $s.

La troisième commande obtient la session dans la $s variable. La sortie indique que la Connect-PSSession commande a réussi. La session est dans l’état Ouvert et est disponible pour une utilisation.

Exemple 7 : Obtenir une session à l’aide de son ID

Get-PSSession -Id 2

Cette commande obtient la session PSSession avec l’ID 2. Étant donné que la valeur de la propriété ID est unique uniquement dans la session active, le paramètre ID est valide uniquement pour les commandes locales.

Paramètres

-AllowRedirection

-ApplicationName

-Authentication

-CertificateThumbprint

-ComputerName

-ConfigurationName

-ConnectionUri

-ContainerId

-Credential

-Id

-InstanceId

-Name

-Port

-SessionOption

-State

-ThrottleLimit

-UseSSL

-VMId

-VMName

Entrées

None

Vous ne pouvez pas diriger les objets vers cette applet de commande.

Sorties

PSSession

Notes

PowerShell inclut les alias suivants pour Get-PSSession:

• Toutes les plateformes :

  • gsn

• Cette applet de commande obtient des objets PSSession gérés par l’utilisateur, tels que ceux créés à l’aide des applets de commande et Enter-PSSessionInvoke-Command des New-PSSessionapplets de commande. Il n’obtient pas la session gérée par le système qui est créée lorsque vous démarrez PowerShell.

• À compter de Windows PowerShell 3.0, les objets PSSession sont stockés sur l’ordinateur qui se trouve côté serveur ou recevant la fin d’une connexion. Pour obtenir les sessions stockées sur l’ordinateur local ou un ordinateur distant, PowerShell établit une session temporaire sur l’ordinateur spécifié et exécute des commandes de requête dans la session.

• Pour obtenir des sessions qui se connectent à un ordinateur distant, utilisez les paramètres ComputerName ou ConnectionUri pour spécifier l’ordinateur distant. Pour filtrer les sessions qui Get-PSSession obtiennent, utilisez les paramètres Name, ID, InstanceID et State . Utilisez les paramètres restants pour configurer la session temporaire qui Get-PSSession utilise.

• Lorsque vous utilisez les paramètres ComputerName ou ConnectionUri , Get-PSSession obtient uniquement des sessions des ordinateurs exécutant Windows PowerShell 3.0 et versions ultérieures de PowerShell.

• La valeur de la propriété State d’une session PSSession est relative à la session active. Par conséquent, une valeur de Disconnected signifie que la session PSSession n’est pas connectée à la session active. Toutefois, cela ne signifie pas que la session PSSession est déconnectée de toutes les sessions. Elle peut être connectée à une autre session. Pour déterminer si vous pouvez vous connecter ou vous reconnecter à psSession à partir de la session active, utilisez la propriété Availability.

Une valeur de disponibilité de None indique que vous pouvez vous connecter à la session. La valeur Busy indique que vous ne pouvez pas vous connecter à la session PSSession , car elle est connectée à une autre session.

Pour plus d’informations sur les valeurs de la propriété State des sessions, consultez l’énumération RunspaceState.

Pour plus d’informations sur les valeurs de la propriété Availability des sessions, consultez RunspaceAvailability, énumération.

Liens associés

• Connect-PSSession
• Disconnect-PSSession
• Receive-PSSession
• Enter-PSSession
• Exit-PSSession
• Invoke-Command
• New-PSSession
• Remove-PSSession
• about_PSSessions
• about_Remote