Export-PSSession

Export-PSSession
    [-Session] <PSSession>
    [-OutputModule] <string>
    [[-CommandName] <string[]>]
    [[-FormatTypeName] <string[]>]
    [-Force]
    [-Encoding <string>]
    [-AllowClobber]
    [-ArgumentList <Object[]>]
    [-CommandType <CommandTypes>]
    [-Module <string[]>]
    [-FullyQualifiedModule <ModuleSpecification[]>]
    [-Certificate <X509Certificate2>]
    [<CommonParameters>]

L’applet de commande Export-PSSession obtient des applets de commande, des fonctions, des alias et d’autres types de commandes d’une autre session PowerShell (PSSession) sur un ordinateur local ou distant et les enregistre dans un module PowerShell. Pour ajouter les commandes du module à la session active, utilisez l’applet de commande Import-Module.

Contrairement à Import-PSSession, qui importe les commandes d’une autre session PSSession dans la session active, Export-PSSession enregistre les commandes dans un module. Les commandes ne sont pas importées dans la session active.

Pour exporter des commandes, utilisez l’applet de commande New-PSSession pour créer une session PSSession avec les commandes que vous souhaitez exporter. Utilisez ensuite l’applet de commande Export-PSSession pour exporter les commandes.

Pour éviter les conflits de noms de commandes, la valeur par défaut de Export-PSSession consiste à exporter toutes les commandes, à l’exception des commandes qui existent dans la session active. Vous pouvez utiliser le paramètre CommandName pour spécifier les commandes à exporter.

L’applet de commande Export-PSSession utilise la fonctionnalité de communication à distance implicite de PowerShell. Lorsque vous importez des commandes dans la session active, elles s’exécutent implicitement dans la session d’origine ou dans une session similaire sur l’ordinateur d’origine.

Cet exemple crée une session PSSession à partir de l’ordinateur local vers l’ordinateur Server01. Toutes les commandes, sauf celles qui existent dans la session active, sont exportées vers le module nommé Server01 sur l’ordinateur local. L’exportation inclut les données de mise en forme des commandes.

$S = New-PSSession -ComputerName Server01
Export-PSSession -Session $S -OutputModule Server01

La commande New-PSSession crée une session PSSession sur l’ordinateur Server01. La session PSSession est stockée dans la variable $S. La commande Export-PSSession exporte les commandes de la variable $S et met en forme les données dans le module Server01.

Cet exemple exporte toutes les commandes Get et Set à partir d’un serveur.

$S = New-PSSession -ConnectionUri https://exchange.microsoft.com/mailbox -Credential [email protected] -Authentication Negotiate
Export-PSSession -Session $S -Module exch* -CommandName Get-*, Set-* -FormatTypeName * -OutputModule $PSHOME\Modules\Exchange -Encoding ASCII

Ces commandes exportent les commandes Get et Set d’un composant logiciel enfichable Microsoft Exchange Server sur un ordinateur distant vers un module Exchange dans le répertoire $PSHOME\Modules de l’ordinateur local. Le fait de placer le module dans le répertoire $PSHOME\Modules le rend accessible à tous les utilisateurs de l’ordinateur.

Cet exemple exporte des applets de commande à partir d’une session PSSession sur un ordinateur distant et les enregistre dans un module sur l’ordinateur local. Les applets de commande du module sont ajoutées à la session active afin qu’elles puissent être utilisées.

$S = New-PSSession -ComputerName Server01 -Credential Server01\User01
Export-PSSession -Session $S -OutputModule TestCmdlets -Type Cmdlet -CommandName *test* -FormatTypeName *
Remove-PSSession $S
Import-Module TestCmdlets
Get-Help Test*
Test-Files

La commande New-PSSession crée une session PSSession sur l’ordinateur Server01 et l’enregistre dans la variable $S. La commande Export-PSSession exporte les applets de commande dont les noms commencent par Test à partir de psSession dans $S vers le module TestCmdlets sur l’ordinateur local.

L’applet de commande Remove-PSSession supprime la session PSSession dans $S de la session active. Cette commande indique que la session PSSession n’a pas besoin d’être active pour utiliser les commandes importées à partir de la session. L’applet de commande Import-Module ajoute les applets de commande dans le module TestCmdlets à la session active. La commande peut être exécutée dans n’importe quelle session à tout moment.

L’applet de commande Get-Help obtient de l’aide pour les applets de commande dont les noms commencent par Test. Une fois les commandes d’un module ajoutées à la session active, vous pouvez utiliser les applets de commande Get-Help et Get-Command pour en savoir plus sur les commandes importées. L’applet de commande Test-Files a été exportée à partir de l’ordinateur Server01 et ajoutée à la session. L’applet de commande Test-Files s’exécute dans une session distante sur l’ordinateur à partir duquel la commande a été importée. PowerShell crée une session à partir d’informations stockées dans le module TestCmdlets.

Cet exemple exporte des commandes stockées dans une variable dans la session active.

Export-PSSession -Session $S -AllowClobber -OutputModule AllCommands

Cette commande Export-PSSession exporte toutes les commandes et toutes les données de mise en forme à partir de la session PSSession dans la variable $S dans la session active. Le paramètre AllowClobber inclut des commandes portant les mêmes noms que les commandes de la session active.

Cet exemple montre comment exécuter les commandes exportées avec des options spéciales lorsque la session PSSession qui a créé les commandes exportées est fermée.

Si la session distante d’origine est fermée lorsqu’un module est importé, le module utilise toute session distante ouverte qui se connecte à l’ordinateur d’origine. S’il n’existe aucune session active sur l’ordinateur d’origine, le module rétablit une session.

Pour exécuter des commandes exportées avec des options spéciales dans une session à distance, vous devez créer une session distante avec ces options avant d’importer le module. Utiliser l’applet de commande New-PSSession avec le paramètre SessionOption

$Options = New-PSSessionOption -NoMachineProfile
$S = New-PSSession -ComputerName Server01 -SessionOption $Options
Export-PSSession -Session $S -OutputModule Server01
Remove-PSSession $S
New-PSSession -ComputerName Server01 -SessionOption $Options
Import-Module Server01

L’applet de commande New-PSSessionOption crée un objet PSSessionOption et enregistre l’objet dans la variable $Options. La commande New-PSSession crée une session PSSession sur l’ordinateur Server01. Le paramètre SessionOption utilise l’objet stocké dans $Options. La session est stockée dans la variable $S.

L’applet de commande Export-PSSession exporte les commandes de psSession dans $S vers le module Server01. L’applet de commande Remove-PSSession supprime la session PSSession dans la variable $S.

L’applet de commande New-PSSession crée une session PSSession qui se connecte à l’ordinateur Server01. Le paramètre SessionOption utilise l’objet stocké dans $Options. L’applet de commande Import-Module importe les commandes à partir du module Server01. Les commandes du module sont exécutées dans la session PSSession sur l’ordinateur Server01.

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

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

Cette applet de commande retourne une liste de fichiers qui composent le module qu’il a créé.

Windows PowerShell inclut les alias suivants pour Export-PSSession:

• epsn

Export-PSSession s’appuie sur l’infrastructure de communication à distance PowerShell. Pour utiliser cette applet de commande, l’ordinateur doit être configuré pour la communication à distance. Pour plus d'informations, voir about_Remote_Requirements.

Vous ne pouvez pas utiliser Export-PSSession pour exporter un fournisseur PowerShell.

Les commandes exportées s’exécutent implicitement dans la session PSSession à partir de laquelle elles ont été exportées. Les détails de l’exécution des commandes à distance sont entièrement gérés par PowerShell. Vous pouvez exécuter les commandes exportées comme vous le feriez pour exécuter des commandes locales.

Export-ModuleMember capture et enregistre des informations sur la session PSSession dans le module qu’il exporte. Si la session PSSession à partir de laquelle les commandes ont été exportées est fermée lorsque vous importez le module et qu’il n’y a pas de session PSSession active sur le même ordinateur, les commandes du module tentent de recréer la session PSSession. Si les tentatives de recréation de psSession échouent, les commandes exportées ne s’exécutent pas.

Les informations de session qui Export-ModuleMember capturent et enregistrent dans le module n’incluent pas les options de session, telles que celles que vous spécifiez dans la variable de préférence $PSSessionOption ou à l’aide du paramètre SessionOption des applets de commande New-PSSession, Enter-PSSessionou Invoke-Command. Si la session PSSession d’origine est fermée lorsque vous importez le module, le module utilise une autre session PSSession sur le même ordinateur, si celui-ci est disponible. Pour permettre aux commandes importées de s’exécuter dans une session correctement configurée, créez une session PSSession avec les options souhaitées avant d’importer le module.

Pour rechercher les commandes à exporter, Export-PSSession utilise l’applet de commande Invoke-Command pour exécuter une commande Get-Command dans la session PSSession. Pour obtenir et enregistrer des données de mise en forme pour les commandes, elle utilise les applets de commande Get-FormatData et Export-FormatData. Vous pouvez voir des messages d’erreur à partir de Invoke-Command, Get-Command, Get-FormatDataet Export-FormatData lorsque vous exécutez une commande Export-PSSession. En outre, Export-PSSession ne peut pas exporter de commandes à partir d’une session qui n’inclut pas les applets de commande Get-Command, Get-FormatData, Select-Objectet Get-Help.

Export-PSSession utilise l’applet de commande Write-Progress pour afficher la progression de la commande. La barre de progression peut s’afficher pendant l’exécution de la commande.

Les commandes exportées présentent les mêmes limitations que d’autres commandes distantes, notamment l’incapacité de démarrer un programme avec une interface utilisateur, comme le Bloc-notes.

Étant donné que les profils PowerShell ne sont pas exécutés dans les sessions PSSession, les commandes qu’un profil ajoute à une session ne sont pas disponibles pour Export-PSSession. Pour exporter manuellement des commandes à partir d’un profil, utilisez une commande Invoke-Command pour exécuter le profil dans PSSession manuellement avant d’exporter des commandes.

Le module que Export-PSSession crée peut inclure un fichier de mise en forme, même si la commande n’importe pas de données de mise en forme. Si la commande n’importe pas de données de mise en forme, les fichiers de mise en forme créés ne contiennent pas de données de mise en forme.