New-PSSessionOption

Syntaxe

Default (Par défaut)

New-PSSessionOption
    [-MaximumRedirection <Int32>]
    [-NoCompression]
    [-NoMachineProfile]
    [-Culture <CultureInfo>]
    [-UICulture <CultureInfo>]
    [-MaximumReceivedDataSizePerCommand <Int32>]
    [-MaximumReceivedObjectSize <Int32>]
    [-OutputBufferingMode <OutputBufferingMode>]
    [-MaxConnectionRetryCount <Int32>]
    [-ApplicationArguments <PSPrimitiveDictionary>]
    [-OpenTimeout <Int32>]
    [-CancelTimeout <Int32>]
    [-IdleTimeout <Int32>]
    [-ProxyAccessType <ProxyAccessType>]
    [-ProxyAuthentication <AuthenticationMechanism>]
    [-ProxyCredential <PSCredential>]
    [-SkipCACheck]
    [-SkipCNCheck]
    [-SkipRevocationCheck]
    [-OperationTimeout <Int32>]
    [-NoEncryption]
    [-UseUTF16]
    [-IncludePortInSPN]
    [<CommonParameters>]

Description

Exemples

Exemple 1 : Créer une option de session par défaut

New-PSSessionOption

MaximumConnectionRedirectionCount : 5
NoCompression                     : False
NoMachineProfile                  : False
ProxyAccessType                   : IEConfig
ProxyAuthentication               : Negotiate
ProxyCredential                   :
SkipCACheck                       : False
SkipCNCheck                       : False
SkipRevocationCheck               : False
OperationTimeout                  : 00:03:00
NoEncryption                      : False
UseUTF16                          : False
Culture                           :
UICulture                         :
MaximumReceivedDataSizePerCommand :
MaximumReceivedObjectSize         :
ApplicationArguments              :
OpenTimeout                       : 00:03:00
CancelTimeout                     : 00:01:00
IdleTimeout                       : 00:04:00

Exemple 2 : Configurer une session à l’aide d’un objet d’option de session

$pso = New-PSSessionOption -Culture "fr-fr" -MaximumReceivedObjectSize 10MB
New-PSSession -ComputerName Server01 -SessionOption $pso

Exemple 3 : Démarrer une session interactive

Enter-PSSession -ComputerName Server01 -SessionOption (New-PSSessionOption -NoEncryption -NoCompression)

Exemple 4 : Modifier un objet d’option de session

$a = New-PSSessionOption
$a.OpenTimeout

Days              : 0
Hours             : 0
Minutes           : 3
Seconds           : 0
Milliseconds      : 0
Ticks             : 1800000000
TotalDays         : 0.00208333333333333
TotalHours        : 0.05
TotalMinutes      : 3
TotalSeconds      : 180
TotalMilliseconds : 180000

$a.UICulture = (Get-UICulture)
$a.OpenTimeout = (New-Timespan -Minutes 4)
$a.MaximumConnectionRedirectionCount = 1
$a

MaximumConnectionRedirectionCount : 1
NoCompression                     : False
NoMachineProfile                  : False
ProxyAccessType                   : IEConfig
ProxyAuthentication               : Negotiate
ProxyCredential                   :
SkipCACheck                       : False
SkipCNCheck                       : False
SkipRevocationCheck               : False
OperationTimeout                  : 00:03:00
NoEncryption                      : False
UseUTF16                          : False
Culture                           :
UICulture                         : en-US
MaximumReceivedDataSizePerCommand :
MaximumReceivedObjectSize         :
ApplicationArguments              :
OpenTimeout                       : 00:04:00
CancelTimeout                     : 00:01:00
IdleTimeout                       : 00:04:00

Exemple 5 : Créer une variable de préférence

$PSSessionOption = New-PSSessionOption -OpenTimeOut 120000

Exemple 6 : Répondre aux exigences d’une configuration de session à distance

$skipCN = New-PSSessionOption -SkipCNCheck
New-PSSession -ComputerName 171.09.21.207 -UseSSL -Credential Domain01\User01 -SessionOption $SkipCN

Exemple 7 : Rendre les arguments disponibles pour une session à distance

$team = @{Team="IT"; Use="Testing"}
$TeamOption = New-PSSessionOption -ApplicationArguments $team
$s = New-PSSession -ComputerName Server01 -SessionOption $TeamOption
Invoke-Command -Session $s {$PSSenderInfo.ApplicationArguments}

Name                 Value
----                 -----
Team                 IT
Use                  Testing
PSVersionTable       {CLRVersion, BuildVersion, PSVersion, WSManStackVersion...}

Invoke-Command -Session $s {
  if ($PSSenderInfo.ApplicationArguments.Use -ne "Testing") {
    .\logFiles.ps1
  }
  else {
    "Just testing."
  }
}

Just testing.

Paramètres

-ApplicationArguments

Spécifie un dictionnaire primitif envoyé à la session distante. Les commandes et les scripts de la session distante, y compris les scripts de démarrage dans la configuration de session, peuvent trouver ce dictionnaire dans la ApplicationArguments propriété de la variable automatique $PSSenderInfo. Vous pouvez utiliser ce paramètre pour envoyer des données à la session à distance.

Pour plus d’informations, consultez about_Hash_Tables, about_Session_Configurationset about_Automatic_Variables.

Propriétés du paramètre

Jeux de paramètres

-CancelTimeout

Détermine la durée pendant laquelle PowerShell attend une opération d’annulation (CTRL+C) avant de la terminer. Entrez une valeur en millisecondes.

La valeur par défaut est 6 0000 (une minute). La valeur 0 (zéro) signifie qu’il n’y a pas de délai d’attente ; la commande se poursuit indéfiniment.

Propriétés du paramètre

Jeux de paramètres

-Culture

Spécifie la culture à utiliser pour la session. Entrez un nom de culture au format <languagecode2>-<country/regioncode2> (comme ja-JP), une variable qui contient un objet CultureInfo ou une commande qui obtient un objet CultureInfo.

La valeur par défaut est $Nullet la culture définie dans le système d’exploitation est utilisée dans la session.

Propriétés du paramètre

Jeux de paramètres

-IdleTimeout

Détermine la durée pendant laquelle la session reste ouverte si l’ordinateur distant ne reçoit aucune communication de l’ordinateur local. Cela inclut le signal de pulsation. Lorsque l’intervalle expire, la session se ferme.

La valeur de délai d’inactivité est importante si vous envisagez de vous déconnecter et de vous reconnecter à une session. Vous ne pouvez vous reconnecter que si la session n’a pas expiré.

Entrez une valeur en millisecondes. La valeur minimale est 6 0000 (1 minute). La valeur maximale est la valeur de la propriété MaxIdleTimeoutms de la configuration de session. La valeur par défaut, -1, ne définit pas de délai d’inactivité.

La session utilise le délai d’inactivité défini dans les options de session, le cas échéant. Si aucun n’est défini (-1), la session utilise la valeur de l'IdleTimeoutMs propriété de la configuration de session ou de la valeur de délai d’attente de l’interpréteur de commandes WSMan (WSMan:\<ComputerName>\Shell\IdleTimeout), selon la valeur la plus courte.

Si le délai d’inactivité défini dans les options de session dépasse la valeur de la MaxIdleTimeoutMs propriété de la configuration de session, la commande permettant de créer une session échoue.

La valeur IdleTimeoutMs de la configuration de session Microsoft.PowerShell par défaut est de 72 0000 millisecondes (2 heures). Sa valeur MaxIdleTimeoutMs est 2147483647 millisecondes (>24 jours). La valeur par défaut du délai d’inactivité de l’interpréteur de commandes WSMan (WSMan:\<ComputerName>\Shell\IdleTimeout) est de 72 0000 millisecondes (2 heures).

La valeur de délai d’inactivité d’une session peut également être modifiée lors de la déconnexion d’une session ou de la reconnexion à une session. Pour plus d’informations, consultez Disconnect-PSSession et Connect-PSSession.

Dans Windows PowerShell 2.0, la valeur par défaut du paramètre IdleTimeout est 24 000 (4 minutes).

Propriétés du paramètre

Jeux de paramètres

-IncludePortInSPN

Inclut le numéro de port dans le nom du principal de service (SPN) utilisé pour l’authentification Kerberos, par exemple, HTTP://<ComputerName>:5985. Cette option permet à un client qui utilise un SPN non défini par défaut de s’authentifier auprès d’un ordinateur distant qui utilise l’authentification Kerberos.

L’option est conçue pour les entreprises où plusieurs services qui prennent en charge l’authentification Kerberos s’exécutent sous différents comptes d’utilisateur. Par exemple, une application IIS qui autorise l’authentification Kerberos peut exiger que le SPN par défaut soit inscrit auprès d’un compte d’utilisateur différent du compte d’ordinateur. Dans ce cas, la communication à distance de PowerShell ne peut pas utiliser Kerberos pour s'authentifier, car elle nécessite un SPN enregistré sur le compte de l'ordinateur. Pour résoudre ce problème, les administrateurs peuvent créer différents SPN, tels que l’utilisation de Setspn.exe, qui sont inscrits dans différents comptes d’utilisateur et peuvent les distinguer en incluant le numéro de port dans le SPN.

Pour plus d'informations, reportez-vous à la section Vue d'ensemble de Setspn.

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

Propriétés du paramètre

Jeux de paramètres

-MaxConnectionRetryCount

Spécifie le nombre de fois où PowerShell tente d’établir une connexion à un ordinateur cible si la tentative actuelle échoue en raison de problèmes réseau. La valeur par défaut est 5.

Ce paramètre a été ajouté pour PowerShell version 5.0.

Propriétés du paramètre

Jeux de paramètres

-MaximumReceivedDataSizePerCommand

Spécifie le nombre maximal d’octets que l’ordinateur local peut recevoir à partir de l’ordinateur distant dans une seule commande. Entrez une valeur en octets. Par défaut, il n’existe aucune limite de taille de données.

Cette option est conçue pour protéger les ressources sur l’ordinateur client.

Propriétés du paramètre

Jeux de paramètres

-MaximumReceivedObjectSize

Spécifie la taille maximale d’un objet que l’ordinateur local peut recevoir de l’ordinateur distant. Cette option est conçue pour protéger les ressources sur l’ordinateur client. Entrez une valeur en octets.

Dans Windows PowerShell 2.0, si vous omettez ce paramètre, il n’existe aucune limite de taille d’objet. À compter de Windows PowerShell 3.0, si vous omettez ce paramètre, la valeur par défaut est de 200 Mo.

Propriétés du paramètre

Jeux de paramètres

-MaximumRedirection

Détermine le nombre de fois où PowerShell redirige une connexion vers un AUTRE URI (Uniform Resource Identifier) avant l’échec de la connexion. La valeur par défaut est 5. La valeur 0 (zéro) empêche toute redirection.

Cette option est utilisée dans la session uniquement lorsque le paramètre AllowRedirection est utilisé dans la commande qui crée la session.

Propriétés du paramètre

Jeux de paramètres

-NoCompression

Désactive la compression de paquets dans la session. La compression utilise plus de cycles de processeur, mais elle accélère la transmission.

Propriétés du paramètre

Jeux de paramètres

-NoEncryption

Désactive le chiffrement des données.

Propriétés du paramètre

Jeux de paramètres

-NoMachineProfile

Empêche le chargement du profil utilisateur Windows de l’utilisateur. Par conséquent, la session peut être créée plus rapidement, mais les paramètres de Registre spécifiques à l’utilisateur, les éléments tels que les variables d’environnement et les certificats ne sont pas disponibles dans la session.

Propriétés du paramètre

Jeux de paramètres

-OpenTimeout

Détermine la durée pendant laquelle l’ordinateur client attend que la connexion de session soit établie. Lorsque l’intervalle expire, la commande permettant d’établir la connexion échoue. Entrez une valeur en millisecondes.

La valeur par défaut est 1800000 (3 minutes). La valeur 0 (zéro) signifie qu’il n’y a pas de délai d’attente ; la commande se poursuit indéfiniment.

Propriétés du paramètre

Jeux de paramètres

-OperationTimeout

Détermine la durée maximale pendant laquelle une opération de la session peut s’exécuter. Lorsque l’intervalle expire, l’opération échoue. Entrez une valeur en millisecondes.

La valeur par défaut est 1800000 (3 minutes). La valeur 0 (zéro) signifie qu’il n’y a pas de délai d’attente ; l’opération se poursuit indéfiniment.

Propriétés du paramètre

Jeux de paramètres

-OutputBufferingMode

Détermine la façon dont la sortie de commande est gérée dans les sessions déconnectées lorsque la mémoire tampon de sortie devient pleine.

Si le mode de mise en mémoire tampon de sortie n’est pas défini dans la session ou dans la configuration de session, la valeur par défaut est Bloquer. Les utilisateurs peuvent également modifier le mode de mise en mémoire tampon de sortie lors de la déconnexion de la session.

Si vous omettez ce paramètre, la valeur de l’objet OutputBufferingMode de l’objet d’option de session est None. La valeur Bloquer ou Supprimer remplace l’option de transport du mode de mise en mémoire tampon de sortie définie dans la configuration de session. Les valeurs acceptables pour ce paramètre sont les suivantes :

• Bloquer. Lorsque la mémoire tampon de sortie est pleine, l’exécution est suspendue jusqu’à ce que la mémoire tampon soit effacée.
• Goutte. 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 supprimée.
• Aucun. Aucun mode de mise en mémoire tampon de sortie n’est spécifié.

Pour plus d’informations sur l’option de transport en mode de mise en mémoire tampon de sortie, consultez New-PSTransportOption.

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

Propriétés du paramètre

Jeux de paramètres

-ProxyAccessType

Détermine le mécanisme utilisé pour résoudre le nom d’hôte. Les valeurs acceptables pour ce paramètre sont les suivantes :

• IEConfig
• WinHttpConfig
• AutoDetect
• NoProxyServer
• Aucun

La valeur par défaut est Aucun.

Pour plus d'informations sur les valeurs de ce paramètre, voir l'énumération ProxyAccessType.

Propriétés du paramètre

Jeux de paramètres

-ProxyAuthentication

Spécifie la méthode d’authentification utilisée pour la résolution de proxy. Les valeurs acceptables pour ce paramètre sont les suivantes : de base, Digestet Negotiate. La valeur par défaut est Negotiate.

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

Propriétés du paramètre

Jeux de paramètres

-ProxyCredential

Spécifie les informations d’identification à utiliser pour l’authentification proxy. Entrez une variable qui contient un objet PSCredential ou une commande permettant d’obtenir un objet PSCredential, tel qu'une commande Get-Credential. Si cette option n’est pas définie, aucune information d’identification n’est spécifiée.

Propriétés du paramètre

Jeux de paramètres

-SkipCACheck

Spécifie que lorsqu’il se connecte via HTTPS, le client ne valide pas que le certificat de serveur est signé par une autorité de certification approuvée.

Utilisez cette option uniquement lorsque l’ordinateur distant est approuvé à l’aide d’un autre mécanisme, par exemple lorsque l’ordinateur distant fait partie d’un réseau physiquement sécurisé et isolé ou lorsque l’ordinateur distant est répertorié comme hôte approuvé dans une configuration WinRM.

Propriétés du paramètre

Jeux de paramètres

-SkipCNCheck

Spécifie que le nom commun du certificat du serveur n’a pas besoin de correspondre au nom d’hôte du serveur. Cette option est utilisée uniquement dans les opérations distantes qui utilisent le protocole HTTPS.

Utilisez cette option uniquement pour les ordinateurs approuvés.

Propriétés du paramètre

Jeux de paramètres

-SkipRevocationCheck

Ne valide pas l’état de révocation du certificat de serveur.

Propriétés du paramètre

Jeux de paramètres

-UICulture

Spécifie la culture de l’interface utilisateur à utiliser pour la session.

Les valeurs valides sont les suivantes :

• Un nom de culture au format <languagecode2>-<country/regioncode2>, tel que ja-JP
• Variable qui contient un objet CultureInfo
• Commande qui obtient un objet CultureInfo, tel que Get-Culture

La valeur par défaut est $nullet la culture de l’interface utilisateur définie dans le système d’exploitation lorsque la session est créée est utilisée dans la session.

Propriétés du paramètre

Jeux de paramètres

-UseUTF16

Indique que cette applet de commande encode la requête au format UTF16 au lieu du format UTF8.

Propriétés du paramètre

Jeux de paramètres

CommonParameters

Entrées

None

Sorties

PSSessionOption

Notes

Liens associés

• Enter-PSSession
• Invoke-Command
• New-PSSession