Exporte les noms des composants logiciels enfichables de la session active vers un fichier console.
Syntaxe
Export-Console [[-Path] <string>] [-Force] [-NoClobber] [-Confirmer] [-WhatIf] [<CommonParameters>]
Description
L'applet de commande Export-Console exporte les noms des composants logiciels enfichables Windows PowerShell de la session active vers un fichier console (.psc1) de Windows PowerShell. Vous pouvez utiliser cette applet de commande pour économiser les composants logiciels enfichables pour de futures sessions.
Pour ajouter les composants logiciels enfichables du fichier console .psc1 à une session, démarrez Windows PowerShell (Powershell.exe) sur la ligne de commande, à l'aide de Cmd.exe ou d'une autre session Windows PowerShell, puis utilisez le paramètre PSConsoleFile de Powershell.exe pour spécifier le fichier console.
Pour plus d'informations sur les composants logiciels enfichables Windows PowerShell, consultez about_Pssnapins.
Paramètres
-Force
Remplace les données d'un fichier console sans avertissement, même si ce fichier possède l'attribut de lecture seule. L'attribut de lecture seule est modifié et n'est pas réinitialisé une fois la commande exécutée.
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
|
Accepter l'entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
false |
-NoClobber
Ne remplace pas un fichier console existant (n'écrase pas son contenu). Par défaut, si un fichier existe dans le chemin d'accès spécifié, Export-Console le remplace sans avertissement.
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
|
Accepter l'entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
false |
-Path <string>
Spécifie un chemin d'accès et un nom de fichier pour le fichier console (*.psc1). Entrez un chemin d'accès (facultatif) et un nom. Les caractères génériques ne sont pas autorisés.
Si vous tapez uniquement un nom de fichier, Export-Console crée, dans le répertoire actif, un fichier portant ce nom, suivi de l'extension « .psc1 ».
Ce paramètre est obligatoire à moins que vous ayez ouvert Windows PowerShell avec le paramètre PSConsoleFile ou exporté un fichier console pendant la session active. Il est également obligatoire lorsque vous utilisez le paramètre NoClobber pour empêcher le remplacement du fichier console actuel.
Si vous omettez ce paramètre, Export-Console remplace le dernier fichier console utilisé pendant cette session (c'est-à-dire qu'elle écrase son contenu). Le chemin d'accès au dernier fichier console utilisé est stocké dans la valeur de la variable automatique $ConsoleFileName. Pour plus d'informations, consultez about_Automatic_Variables.
Obligatoire ? |
false |
Position ? |
1 |
Valeur par défaut |
|
Accepter l'entrée de pipeline ? |
true (ByValue, ByPropertyName) |
Accepter les caractères génériques ? |
false |
-Confirmer
Vous invite à confirmer l'exécution de la commande.
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
|
Accepter l'entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
false |
-WhatIf
Décrit le résultat que vous obtiendriez en exécutant la commande, sans réellement l'exécuter.
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
|
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 |
System.String Vous pouvez diriger une chaîne de chemin d'accès vers Export-Console. |
Sorties |
System.IO.FileInfo Export-Console crée un fichier qui contient les alias exportés. |
Remarques
Lorsqu'un fichier console (.psc1) est utilisé pour démarrer la session, son nom est stocké automatiquement dans la variable automatique $ConsoleFileName. La valeur de $ConsoleFileName est mise à jour lorsque vous utilisez le paramètre Path d'Export-Console pour spécifier un nouveau fichier console. Si aucun fichier console n'est utilisé, $ConsoleFileName n'a aucune valeur ($null).
Pour employer un fichier console de Windows PowerShell dans une nouvelle session, utilisez la syntaxe suivante pour démarrer Windows PowerShell :
« powershell.exe -PsConsoleFile <Fichier_console>.psc1 ».
Vous pouvez également enregistrer des composants logiciels enfichables Windows PowerShell pour des sessions ultérieures en ajoutant une commande Add-PSSnapin à votre profil Windows PowerShell. Pour plus d'informations, consultez about_Profiles.
Exemple 1
C:\PS>export-console -path $pshome\Consoles\ConsoleS1.psc1 Description ----------- Cette commande exporte les noms des composants logiciels enfichables Windows PowerShell de la session active vers le fichier ConsoleS1.psc1 du sous-répertoire Consoles du répertoire d'installation Windows PowerShell, $pshome.
Exemple 2
C:\PS>export-console Description ----------- Cette commande exporte les noms des composants logiciels enfichables Windows PowerShell de la session active vers le dernier fichier console Windows PowerShell utilisé pendant la session active. Elle remplace le contenu du fichier précédent. Si vous n'avez pas exporté de fichier console pendant la session active, vous êtes invité à indiquer si vous souhaitez poursuivre, puis à entrer un nom de fichier.
Exemple 3
C:\PS>add-pssnapin NewPSSnapin C:\PS> export-console -path NewPSSnapinConsole.psc1 C:\PS> powershell.exe -PsConsoleFile NewPsSnapinConsole.psc1 Description ----------- Ces commandes ajoutent le composant logiciel enfichable Windows PowerShell NewPSSnapin à la session active, exportent les noms des composants logiciels enfichables Windows PowerShell de la session active vers un fichier console, puis démarrent une session Windows PowerShell avec le fichier console. La première commande utilise l'applet de commande Add-PSSnapin pour ajouter le composant logiciel enfichable NewPSSnapin à la session active. Vous ne pouvez ajouter que des composants logiciels enfichables Windows PowerShell qui sont inscrits sur votre système. La deuxième commande exporte les noms des composants logiciels enfichables Windows PowerShell vers le fichier NewPSSnapinConsole.psc1. La troisième commande démarre Windows PowerShell avec le fichier NewPSSnapinConsole.psc1. Étant donné que le fichier console inclut le nom du composant logiciel enfichable Windows PowerShell, les applets de commande et fournisseurs de ce dernier sont disponibles dans la session active.
Exemple 4
C:\PS>export-console -path Console01 C:\PS> notepad console01.psc1 <?xml version="1.0" encoding="utf-8"?> <PSConsoleFile ConsoleSchemaVersion="1.0"> <PSVersion>2.0</PSVersion> <PSSnapIns> <PSSnapIn Name="NewPSSnapin" /> </PSSnapIns> </PSConsoleFile> Description ----------- Cette commande exporte les noms des composants logiciels enfichables Windows PowerShell de la session active vers le fichier Console01.psc1 du répertoire actif. La deuxième commande affiche le contenu du fichier Console01.psc1 dans le Bloc-notes.
Exemple 5
C:\PS>powershell.exe -PSConsoleFile Console01.psc1 C:\PS> add-pssnapin MySnapin C:\PS> export-console NewConsole.psc1 C:\PS> $consolefilename C:\PS> add-pssnapin SnapIn03 C:\PS> export-console Description ----------- Cet exemple montre comment utiliser la variable automatique $ConsoleFileName pour déterminer quel fichier console sera mis à jour si vous utilisez Export-Console sans une valeur de paramètre Path. La première commande utilise le paramètre PSConsoleFile de PowerShell.exe pour ouvrir Windows PowerShell avec le fichier Console01.psc1. La deuxième commande utilise l'applet de commande Add-PSSnapin pour ajouter le composant logiciel enfichable Windows PowerShell MySnapin à la session active. La troisième commande utilise l'applet de commande Export-Console pour exporter les noms de tous les composants logiciels enfichables Windows PowerShell de la session vers le fichier NewConsole.psc1. La quatrième commande utilise le paramètre $ConsoleFileName pour afficher le fichier console le plus récemment utilisé. L'exemple de sortie montre que NewConsole.ps1 est le fichier le plus récemment utilisé. La cinquième commande ajoute SnapIn03 à la console actuelle. La sixième commande utilise l'applet de commande ExportConsole sans paramètre Path. Cette commande exporte les noms de tous les composants logiciels enfichables Windows PowerShell de la session active vers le fichier le plus récemment utilisé, NewConsole01.psc1.
Voir aussi