Get-PSSession

Syntaxe

Name (Par défaut)

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

ComputerName

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>]

ComputerInstanceId

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

ConnectionUriInstanceId

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

ConnectionUri

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

ContainerId

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

ContainerIdInstanceId

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

VMId

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

VMIdInstanceId

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

VMName

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

VMNameInstanceId

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

InstanceId

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

Id

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

Description

Exemples

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

Get-PSSession

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

Get-PSSession -ComputerName "localhost"

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

Exemple 4 : Enregistrer les résultats de cette commande

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

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

Exemple 6 : Obtenir une session portant un nom particulier

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

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

Get-PSSession -Id 2

Paramètres

-AllowRedirection

Indique que cette applet de commande autorise la redirection de cette connexion vers un AUTRE URI (Uniform Resource Identifier). Par défaut, PowerShell ne redirige pas les connexions.

Ce paramètre configure la connexion temporaire créée pour exécuter une Get-PSSession commande avec le paramètre ConnectionUri .

Ce paramètre a été introduit dans Windows PowerShell 3.0.

Propriétés du paramètre

Jeux de paramètres

-ApplicationName

Spécifie le nom d’une application. Cette applet de commande se connecte uniquement aux sessions qui utilisent l’application spécifiée.

Entrez le segment de nom d’application de l’URI de connexion. Par exemple, dans l’URI de connexion suivant, le nom de l’application est WSMan : http://localhost:5985/WSMAN. Le nom de l’application d’une session est stocké dans la propriété Runspace.ConnectionInfo.AppName de la session.

La valeur de ce paramètre est utilisée pour sélectionner et filtrer des sessions. Elle ne modifie pas l’application utilisée par la session.

Propriétés du paramètre

Jeux de paramètres

-Authentication

Spécifie le mécanisme utilisé pour authentifier les informations d’identification de la session dans laquelle la Get-PSSession commande s’exécute.

Ce paramètre configure la connexion temporaire créée pour exécuter une Get-PSSession commande avec le paramètre ComputerName ou ConnectionUri .

Les valeurs acceptables pour ce paramètre sont les suivantes :

• Default
• Basic
• CredSSP
• Digest
• Kerberos
• Negotiate
• NegotiateWithImplicitCredential.

La valeur par défaut est Default.

Pour plus d'informations sur les valeurs de ce paramètre, voir AuthenticationMechanism Enumeration.

Ce paramètre a été introduit dans Windows PowerShell 3.0.

Propriétés du paramètre

Jeux de paramètres

-CertificateThumbprint

Spécifie le certificat de clé publique numérique (X509) d’un compte d’utilisateur autorisé à créer la session dans laquelle la Get-PSSession commande s’exécute. Entrez l’empreinte numérique du certificat.

Ce paramètre configure la connexion temporaire créée pour exécuter une Get-PSSession commande avec le paramètre ComputerName ou ConnectionUri .

Les certificats sont utilisés dans l’authentification basée sur les certificats client. Ils ne peuvent être mappés qu’à des comptes d’utilisateur locaux ; ils ne fonctionnent pas avec les comptes de domaine.

Pour obtenir une empreinte numérique de certificat, utilisez une commande Get-Item ou Get-ChildItem dans le lecteur powerShell Cert:.

Ce paramètre a été introduit dans Windows PowerShell 3.0.

Propriétés du paramètre

Jeux de paramètres

-ComputerName

Spécifie un tableau de noms d’ordinateurs. Obtient les sessions qui se connectent aux ordinateurs spécifiés. Les caractères génériques ne sont pas autorisés. Il n’existe aucune valeur par défaut.

À compter de Windows PowerShell 3.0, objets PSSession sont stockés sur les ordinateurs à la fin distante de chaque connexion. Pour obtenir les sessions sur les ordinateurs spécifiés, PowerShell crée une connexion temporaire à chaque ordinateur et exécute une Get-PSSession commande.

Tapez le nom NetBIOS, une adresse IP ou un nom de domaine complet d’un ou plusieurs ordinateurs. Pour spécifier l’ordinateur local, tapez le nom de l’ordinateur, localhostou un point (.).

Propriétés du paramètre

Jeux de paramètres

-ConfigurationName

Spécifie le nom d’une configuration. Cette applet de commande obtient uniquement les sessions qui utilisent la configuration de session spécifiée.

Entrez un nom de configuration ou l'URI complet de la ressource pour une configuration de session. Si vous spécifiez uniquement le nom de configuration, l’URI de schéma suivant est ajouté : http://schemas.microsoft.com/powershell. Le nom de configuration d’une session est stocké dans la propriété ConfigurationName de la session.

La valeur de ce paramètre est utilisée pour sélectionner et filtrer des sessions. Elle ne modifie pas la configuration de session utilisée par la session.

Pour plus d’informations sur les configurations de session, consultez about_Session_Configurations.

Propriétés du paramètre

Jeux de paramètres

-ConnectionUri

Spécifie un URI qui définit le point de terminaison de connexion pour la session temporaire dans laquelle la Get-PSSession commande s’exécute. L’URI doit être complet.

Ce paramètre configure la connexion temporaire créée pour exécuter une Get-PSSession commande avec le paramètre ConnectionUri .

Le format de cette chaîne est :

<Transport>://<ComputerName>:<Port\>/<ApplicationName>

La valeur par défaut est http://localhost:5985/WSMAN.

Si vous ne spécifiez pas de ConnectionUri, vous pouvez utiliser les paramètres UseSSL, ComputerName, Portet ApplicationName pour spécifier les valeurs ConnectionURI . Les valeurs valides pour le segment Transport de l’URI sont HTTP et HTTPS. Si vous spécifiez un URI de connexion avec un segment de transport, mais que vous ne spécifiez pas de port, la session est créée avec des ports standard : 80 pour HTTP et 443 pour HTTPS. Pour utiliser les ports par défaut pour la communication à distance PowerShell, spécifiez 5985 de port pour HTTP ou 5986 pour HTTPS.

Si l’ordinateur de destination redirige la connexion vers un autre URI, PowerShell empêche la redirection, sauf si vous utilisez le paramètre AllowRedirection dans la commande.

Ce paramètre a été introduit dans Windows PowerShell 3.0.

Ce paramètre obtient des sessions uniquement à partir d’ordinateurs qui exécutent Windows PowerShell 3.0 ou versions ultérieures de Windows PowerShell. Les versions antérieures ne stockent pas les sessions.

Propriétés du paramètre

Jeux de paramètres

-ContainerId

Spécifie un tableau d’identifiants de conteneurs. Cette applet de commande démarre une session interactive avec chacun des conteneurs spécifiés. Utilisez la commande docker ps pour obtenir la liste des ID de conteneur. Pour plus d’informations, consultez l’aide de la commande docker ps.

Propriétés du paramètre

Jeux de paramètres

-Credential

Spécifie les informations d’identification d’un utilisateur. Cette applet de commande exécute la commande avec les autorisations de l’utilisateur spécifié. Spécifiez un compte d’utilisateur autorisé à se connecter à l’ordinateur distant et exécutez une Get-PSSession commande. La valeur par défaut est l’utilisateur actuel.

Tapez un nom d’utilisateur, tel que User01 ou Domain01\User01, ou entrez un objet PSCredential généré par l’applet de commande Get-Credential. Si vous tapez un nom d’utilisateur, vous êtes invité à entrer le mot de passe.

Les informations d’identification sont stockées dans un objet PSCredential et le mot de passe est stocké en tant que SecureString.

Ce paramètre est configuré sur la connexion temporaire créée pour exécuter une Get-PSSession commande avec le paramètre ComputerName ou ConnectionUri .

Ce paramètre a été introduit dans Windows PowerShell 3.0.

Propriétés du paramètre

Jeux de paramètres

-Id

Spécifie un tableau d’ID de session. Cette applet de commande obtient uniquement les sessions avec les ID spécifiés. 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. Vous ne pouvez pas utiliser le paramètre Id avec le paramètre ComputerName .

Un ID est un entier qui identifie de manière unique les sessions gérées par l’utilisateur dans la session active. Il est plus facile de mémoriser et de taper que le InstanceId, mais il est unique uniquement dans la session active. L’ID d’une session est stocké dans la propriété ID de la session.

Propriétés du paramètre

Jeux de paramètres

-InstanceId

Spécifie un tableau d’ID d’instance de sessions. Cette applet de commande obtient uniquement les 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' InstanceId est unique, même lorsque vous avez plusieurs sessions en cours d’exécution dans PowerShell.

L’ID d’instance d’une session est stocké dans la propriété InstanceId de la session.

Propriétés du paramètre

Jeux de paramètres

-Name

Spécifie un tableau de noms de session. Cette applet de commande obtient uniquement les sessions qui ont les noms conviviaux spécifiés. Les caractères génériques sont autorisés.

Le nom convivial d’une session est stocké dans la propriété Name de la session.

Propriétés du paramètre

Jeux de paramètres

-Port

Spécifie le port réseau spécifié utilisé pour la connexion temporaire dans laquelle la Get-PSSession commande s’exécute. Pour établir une connexion à un ordinateur distant, l’ordinateur distant doit être à l’écoute sur le port utilisé par la connexion. Les ports par défaut sont 5985, qui est le port WinRM pour HTTP, et 5986, qui est le port WinRM pour HTTPS.

Avant d’utiliser un autre port, vous devez configurer l’écouteur WinRM sur l’ordinateur distant pour écouter sur ce port. Pour configurer l’écouteur, tapez les deux commandes suivantes à l’invite PowerShell :

Remove-Item -Path WSMan:\Localhost\listener\listener* -Recurse

New-Item -Path WSMan:\Localhost\listener -Transport http -Address * -Port \<port-number\>

Ce paramètre est configuré sur la connexion temporaire créée pour exécuter une Get-PSSession commande avec le paramètre ComputerName ou ConnectionUri .

N’utilisez pas le paramètre de port , sauf si vous devez. Le port défini dans la commande s’applique à tous les ordinateurs ou sessions sur lesquels la commande s’exécute. Un autre paramètre de port peut empêcher l’exécution de la commande sur tous les ordinateurs.

Ce paramètre a été introduit dans Windows PowerShell 3.0.

Propriétés du paramètre

Jeux de paramètres

-SessionOption

Spécifie les options avancées de la session. Entrez un objet SessionOption, tel qu’un objet que vous créez à l’aide de l’applet de commande New-PSSessionOption, ou une table de hachage dans laquelle les clés sont des noms d’options de session et les valeurs sont des valeurs d’option de session.

Les valeurs par défaut des options sont déterminées par la valeur de la variable de préférence $PSSessionOption, si elle est définie. Sinon, les valeurs par défaut sont établies par les options définies dans la configuration de session.

Les valeurs d’option de session sont prioritaires sur les valeurs par défaut pour les sessions définies dans la variable de préférence $PSSessionOption et dans la configuration de session. Toutefois, ils ne sont pas prioritaires sur les valeurs maximales, les quotas ou les limites définis dans la configuration de session.

Pour obtenir une description des options de session, y compris les valeurs par défaut, consultez New-PSSessionOption. Pour plus d’informations sur la variable de préférence $PSSessionOption, consultez about_Preference_Variables. Pour plus d’informations sur les configurations de session, consultez about_Session_Configurations.

Propriétés du paramètre

Jeux de paramètres

-State

Spécifie un état de session. Cette applet de commande obtient uniquement les sessions à l’état spécifié. Les valeurs acceptables pour ce paramètre sont les suivantes : All, , OpenedDisconnected, Closed, et Broken. La valeur par défaut est All.

La valeur d’état de session est relative aux sessions actuelles. Les sessions qui n’ont pas été créées dans les sessions actuelles et qui ne sont pas connectées à la session active ont un état même Disconnected lorsqu’elles sont connectées à une autre session.

L’état d’une session est stocké dans la propriété State de la session.

Ce paramètre a été introduit dans Windows PowerShell 3.0.

Propriétés du paramètre

Jeux de paramètres

-ThrottleLimit

Spécifie le nombre maximal de connexions simultanées qui peuvent être établies pour exécuter la Get-PSSession commande. Si vous omettez ce paramètre ou entrez une valeur de 0 (zéro), 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.

Ce paramètre a été introduit dans Windows PowerShell 3.0.

Propriétés du paramètre

Jeux de paramètres

-UseSSL

Indique que cette applet de commande utilise le protocole SSL (Secure Sockets Layer) pour établir la connexion dans laquelle la Get-PSSession commande s’exécute. Par défaut, SSL n’est pas utilisé. Si vous utilisez ce paramètre, mais que SSL n’est pas disponible sur le port utilisé pour la commande, la commande échoue.

Ce paramètre configure la connexion temporaire créée pour exécuter une Get-PSSession commande avec le paramètre ComputerName .

Ce paramètre a été introduit dans Windows PowerShell 3.0.

Propriétés du paramètre

Jeux de paramètres

-VMId

Spécifie un tableau d’identifiants de machines virtuelles. Cette applet de commande démarre une session interactive avec chacune des machines virtuelles spécifiées. Pour afficher les machines virtuelles disponibles, utilisez la commande suivante :

Get-VM | Select-Object -Property Name, ID

Propriétés du paramètre

Jeux de paramètres

-VMName

Spécifie un tableau de noms de machines virtuelles. Cette applet de commande démarre une session interactive avec chacune des machines virtuelles spécifiées. Pour afficher les machines virtuelles disponibles, utilisez l’applet de commande Get-VM.

Propriétés du paramètre

Jeux de paramètres

CommonParameters

Entrées

None

Sorties

PSSession

Notes

Liens associés

• Connect-PSSession
• Disconnect-PSSession
• Receive-PSSession
• Enter-PSSession
• Exit-PSSession
• Invoke-Command
• New-PSSession
• Remove-PSSession
• À propos de PSSessions
• about_Remote