Crée un objet qui contient les options avancées d'une session PSSession.
Syntaxe
New-PSSessionOption [-ApplicationArguments <PSPrimitiveDictionary>] [-CancelTimeOut <int>] [-Culture <CultureInfo>] [-IdleTimeOut <int>] [-MaximumReceivedDataSizePerCommand <int>] [-MaximumReceivedObjectSize <int>] [-MaximumRedirection <int>] [-NoCompression] [-NoEncryption] [-NoMachineProfile] [-OpenTimeOut <int>] [-OperationTimeOut <int>] [-ProxyAccessType {<None> | <IEConfig> | <WinHttpConfig> | <AutoDetect> | <NoProxyServer>}] [-ProxyAuthentication {<Default> | <Basic> | <Negotiate> | <NegotiateWithImplicitCredential> | <Credssp> | <Digest> | <Kerberos>}] [-ProxyCredential <PSCredential>] [-SkipCACheck] [-SkipCNCheck] [-SkipRevocationCheck] [-UICulture <CultureInfo>] [-UseUTF16] [<CommonParameters>]
Description
L'applet de commande New-PSSessionOption crée un objet qui contient les options avancées d'une session PSSession. Vous pouvez utiliser l'objet comme valeur du paramètre SessionOption des applets de commande qui créent une session PSSession, telles que New-PSSession, Enter-PSSession et Invoke-Command.
Sans paramètres, New-PSSessionOption génère un objet qui contient les valeurs par défaut de toutes les options. Étant donné que toutes les propriétés peuvent être modifiées, vous pouvez utiliser l'objet résultant comme modèle et créer des objets d'option standard pour votre entreprise.
Paramètres
-ApplicationArguments <PSPrimitiveDictionary>
Spécifie une table de hachage envoyée directement à la configuration de session sans interprétation. Cette table de hachage est disponible pour la configuration de session en tant que propriété de la classe PSSenderInfo.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-CancelTimeOut <int>
Détermine le délai pendant lequel Windows PowerShell attend qu'une opération d'annulation (CTRL + C) s'exécute avant d'y mettre fin. Entrez une valeur en millisecondes.
La valeur par défaut est 60000 (1 minute). La valeur 0 (zéro) indique qu'aucun délai d'attente n'est défini ; la commande se poursuit indéfiniment.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
60000 |
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-Culture <CultureInfo>
Spécifie la culture à utiliser pour la session PSSession. Entrez un nom de culture au format <code_langue2>-<code_pays/région2>, tel que « ja-jP », une variable contenant un objet CultureInfo ou une commande permettant d'obtenir un objet CultureInfo, telle que « get-culture ».
La valeur par défaut est $null et la culture qui est définie dans le système d'exploitation lors de la création de la session PSSession est utilisée dans cette dernière.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
Current culture |
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-IdleTimeOut <int>
Détermine le délai pendant lequel la session PSSession reste ouverte si l'ordinateur distant ne reçoit pas de communication en provenance de l'ordinateur local, telle que le signal de pulsation. Lorsque ce délai expire, la session PSSession se ferme.
Entrez une valeur en millisecondes. La valeur par défaut est 240000 secondes (4 minutes). La valeur minimale est 60000 (1 minute).
Si à la fois les ordinateurs locaux et distants spécifient une valeur de délai d'inactivité, la session PSSession utilise la valeur de délai la plus courte. L'ordinateur local peut configurer une valeur de délai d'inactivité en utilisant ce paramètre ou en définissant un délai d'inactivité dans la variable de préférence $PSSessionOption. L'ordinateur distant peut spécifier une valeur de délai d'inactivité dans la configuration du service Gestion des services Web (WSMAN:\localhost\shell\idletimeout).
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
240000 |
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-MaximumReceivedDataSizePerCommand <int>
Spécifie le nombre maximal d'octets que l'ordinateur local peut recevoir en provenance de l'ordinateur distant dans une seule commande. Entrez une valeur en octets. Par défaut, il n'existe aucune limite pour la taille des données.
Cette option est conçue pour protéger les ressources présentes sur l'ordinateur client.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
No limit |
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-MaximumReceivedObjectSize <int>
Spécifie la taille maximale des objets que l'ordinateur local peut recevoir en provenance de l'ordinateur distant. Entrez une valeur en octets. Par défaut, il n'existe aucune limite pour la taille des données.
Cette option est conçue pour protéger les ressources présentes sur l'ordinateur client.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
No limit |
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-MaximumRedirection <int>
Détermine le nombre de fois où Windows PowerShell redirige une connexion vers un autre URI (Uniform Resource Identifier) avant que la connexion échoue. La valeur par défaut est 5. La valeur 0 (zéro) empêche toute redirection.
Cette option est utilisée dans la session PSSession uniquement lorsque le paramètre AllowRedirection est employé dans la commande qui crée cette session.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
5 |
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-NoCompression
Désactive la compression de paquets dans la session PSSession. La compression utilise un plus grand nombre de cycles processeur, mais accélère la transmission.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
False |
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-NoEncryption
Désactive le chiffrement de données.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
False |
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-NoMachineProfile
Empêche le chargement du profil utilisateur Windows. Par conséquent, la session PSSession 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 cette session.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
False |
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-OpenTimeOut <int>
Détermine le délai pendant lequel l'ordinateur client attend l'établissement de la connexion de session. Lorsque le délai expire, la commande permettant d'établir la connexion échoue. Entrez une valeur en millisecondes.
La valeur par défaut est 180000 secondes (3 minutes). La valeur 0 (zéro) indique qu'aucun délai d'attente n'est défini ; la commande se poursuit indéfiniment.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
180000 |
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-OperationTimeOut <int>
Détermine le délai maximum pendant lequel toute opération de la session PSSession peut s'exécuter. Lorsque le délai expire, l'opération échoue. Entrez une valeur en millisecondes.
La valeur par défaut est 180000 secondes (3 minutes). La valeur 0 (zéro) indique qu'aucun délai d'attente n'est défini ; l'opération se poursuit indéfiniment.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
180000 |
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-ProxyAccessType <ProxyAccessType>
Détermine le mécanisme utilisé pour la résolution du nom d'hôte. Les valeurs valides sont IEConfig, WinHttpConfig, AutoDetect, NoProxyServer et None. La valeur par défaut est None.
Pour plus d'informations sur les valeurs de ce paramètre, consultez la description de l'énumération System.Management.Automation.Remoting.ProxyAccessType dans la bibliothèque MSDN (Microsoft Developer Network) à l'adresse https://go.microsoft.com/fwlink/?LinkId=144756.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
aucun |
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-ProxyAuthentication <AuthenticationMechanism>
Spécifie la méthode d'authentification utilisée pour la résolution de proxy. Les valeurs valides sont Basic, Digest et Negociate. La valeur par défaut est Negotiate.
Pour plus d'informations sur les valeurs de ce paramètre, consultez la description de l'énumération System.Management.Automation.Runspaces.AuthenticationMechanism dans la bibliothèque MSDN (Microsoft Developer Network) à l'adresse https://go.microsoft.com/fwlink/?LinkID=144382.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
Negotiate |
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-ProxyCredential <PSCredential>
Spécifie les informations d'identification à utiliser pour l'authentification de proxy. Entrez une variable qui contient un objet PSCredential ou une commande permettant d'obtenir un objet PSCredential, telle que Get-Credential. Si cette option n'est pas définie, aucune information d'identification n'est spécifiée.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
aucun |
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-SkipCACheck
Spécifie que, lors de la connexion 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é par un autre mécanisme, par exemple si l'ordinateur distant fait partie d'un réseau qui est physiquement sécurisé et isolé, ou s'il est répertorié comme hôte approuvé dans une configuration du service Gestion à distance de Windows (WinRM).
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
False |
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-SkipCNCheck
Indique que le nom commun de certificat du serveur ne doit pas nécessairement correspondre au nom d'hôte du serveur. Cette option est utilisée uniquement dans les opérations distantes qui font appel au protocole HTTPS.
Employez-la seulement pour les ordinateurs approuvés.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
False |
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-SkipRevocationCheck
Ne valide pas l'état de révocation du certificat de serveur.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
False |
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-UICulture <CultureInfo>
Spécifie la culture d'interface utilisateur à employer pour la session PSSession.
Entrez un nom de culture au format <code_langue2>-<code_pays/région2>, tel que « ja-jP », une variable contenant un objet CultureInfo ou une commande permettant d'obtenir un objet CultureInfo, telle que Get-Culture.
La valeur par défaut est $null et la culture d'interface utilisateur qui est définie dans le système d'exploitation lors de la création de la session PSSession est utilisée dans cette dernière.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
Current UI culture |
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-UseUTF16
Encode la demande au format UTF16, et non pas UTF8.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
False (UTF8 encoding) |
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
<CommonParameters>
Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer et -OutVariable. Pour plus d'informations, consultez about_Commonparameters.
Entrées et sorties
Le type d'entrée est le type des objets que vous pouvez diriger vers l'applet de commande. Le type de retour est le type des objets que l'applet de commande retourne.
|
Entrées |
Aucun Vous ne pouvez pas diriger d'entrée vers cette applet de commande. |
|
Sorties |
System.Management.Automation.Remoting.PSSessionOption |
Remarques
Si le paramètre SessionOption n'est pas utilisé dans une commande pour créer une session PSSession, les options de session sont déterminées par les valeurs de propriété de la variable de préférence $PSSessionOption, si elle est définie. Pour plus d'informations sur la variable $PSSessionOption, consultez about_Preference_Variables.
Exemple 1
C:\PS>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 Description ----------- Cette commande crée un objet d'option de session avec toutes les valeurs par défaut.
Exemple 2
C:\PS>$pso = new-pssessionoption -Culture "fr-fr" -MaximumReceivedObjectSize 10MB C:\PS> new-pssession -computerName Server01 -SessionOption $pso Description ----------- Cet exemple indique comment utiliser un objet d'option de session pour configurer une session. La première commande crée un nouvel objet d'option de session et l'enregistre dans la valeur de la variable $pso. La deuxième commande fait appel à l'applet de commande New-PSSession pour créer une session PSSession sur l'ordinateur distant Server01. Elle utilise l'objet d'option de session dans la valeur de la variable $pso comme valeur du paramètre SessionOption.
Exemple 3
C:\PS>enter-pssession -computername Server01 -sessionOption (new-pssessionoption -noEncryption -noCompression) Description ----------- Cette commande utilise l'applet de commande Enter-PSSession pour démarrer une session interactive avec l'ordinateur Server01. La valeur du paramètre SessionOption correspond à une commande New-PSSessionOption associée aux paramètres booléens NoEncryption et NoCompression. La commande New-PSSessionOption est placée entre parenthèses de façon à être exécutée avant la commande Enter-PSSession.
Exemple 4
C:\PS>$a = 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 C:\PS> $a.UICulture = (get-UICulture) C:\PS> $a.OpenTimeout = (new-timespan -minutes 4) C:\PS> $a.MaximumConnectionRedirectionCount = 1 C:\PS> $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 Description ----------- Cet exemple montre que vous pouvez modifier l'objet d'option de session. Toutes les propriétés ont des valeurs en lecture/écriture. Utilisez cette méthode afin de créer un objet session standard pour votre entreprise, puis des versions personnalisées de cet objet pour des usages particuliers.
Exemple 5
C:\PS>$PSSessionOption = New-PSSessionOption -OpenTimeOut 120000 Description ----------- Cette commande crée un variable de préférence $PSSessionOption. Lorsque la variable de préférence $PSSessionOption existe dans la session, elle établit des valeurs par défaut pour les options des sessions PSSession créées à l'aide des applets de commande New-PSSession, Enter-PSSession et Invoke-Command. Pour que la variable $PSSessionOption soit disponible dans toutes les sessions, ajoutez-la à votre session et votre profil Windows PowerShell. Pour plus d'informations sur la variable $PSSessionOption, consultez about_Preference_Variables. Pour plus d'informations sur les profils, consultez about_Profiles.
Exemple 6
C:\PS>$skipCN = new-pssessionoption -SkipCNCheck C:\PS> new-pssession -computername 171.09.21.207 -UseSSL -credential domain01\user01 -sessionOption $skipCN Description ----------- Cet exemple indique comment utiliser un objet SessionOption afin de remplir les conditions requises pour une configuration de session à distance. La première commande utilise l'applet de commande New-PSSessionOption pour créer un objet d'option de session avec la propriété SkipCNCheck. Elle enregistre l'objet de session résultant dans la variable $skipCN. La deuxième commande fait appel à l'applet de commande New-PSSession pour créer une nouvelle session PSSession sur un ordinateur distant. La variable de contrôle $skipCN est employée dans la valeur du paramètre SessionOption. Étant donné que l'ordinateur est identifié par son adresse IP, la valeur du paramètre ComputerName ne correspond à aucun nom commun figurant dans le certificat utilisé pour SSL (Secure Sockets Layer). Par conséquent, l'option SkipCNCheck est obligatoire.
Voir aussi