Partager via

Export-Console

  • Référence
Module:
Microsoft.PowerShell.Core

Exporte les noms des composants logiciels enfichables dans la session active vers un fichier console.

Syntaxe

Export-Console
      [[-Path] <String>]
      [-Force]
      [-NoClobber]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

L’applet de commande export-console exporte les noms des composants logiciels enfichables Windows PowerShell dans la session active vers un fichier de console Windows PowerShell (.psc1). Vous pouvez utiliser cette applet de commande pour enregistrer les composants logiciels enfichables à utiliser dans les sessions ultérieures.

Pour ajouter les composants logiciels enfichables dans le fichier console .psc1 à une session, démarrez Windows PowerShell (Powershell.exe) à 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.

Exemples

Exemple 1 : Exporter les noms des composants logiciels enfichables dans la session active

PS C:\> Export-Console -Path $pshome\Consoles\ConsoleS1.psc1

Cette commande exporte les noms des composants logiciels enfichables Windows PowerShell dans la session active vers le fichier ConsoleS1.psc1 dans le dossier Consoles du dossier d’installation De Windows PowerShell, $pshome.

Exemple 2 : Exporter les noms des composants logiciels enfichables dans le fichier console le plus récent

PS C:\> Export-Console

Cette commande exporte les noms des composants logiciels enfichables Windows PowerShell de la session active vers le fichier de console Windows PowerShell récemment utilisé dans la session active. Il remplace le contenu du fichier précédent.

Si vous n’avez pas exporté de fichier console pendant la session active, vous êtes invité à continuer, puis invité à entrer un nom de fichier.

Exemple 3 : Ajouter un composant logiciel enfichable et exporter les noms des composants logiciels enfichables

PS C:\> Add-PSSnapin NewPSSnapin
PS C:\> Export-Console -path NewPSSnapinConsole.psc1
PS C:\> powershell.exe -PsConsoleFile NewPsSnapinConsole.psc1

Ces commandes ajoutent le composant logiciel enfichable NewPSSnapin Windows PowerShell à la session active, exportez les noms des composants logiciels enfichables Windows PowerShell dans la session active vers un fichier console, puis démarrez 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 pouvez uniquement ajouter des composants logiciels enfichables Windows PowerShell inscrits sur votre système.

La deuxième commande exporte les noms du composant logiciel enfichable 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 les fournisseurs du composant logiciel enfichable sont disponibles dans la session active.

Exemple 4 : Exporter des noms de composants logiciels enfichables vers un emplacement spécifié

PS C:\> export-console -path Console01
PS C:\> notepad console01.psc1
<?xml version="1.0" encoding="utf-8"?>
<PSConsoleFile ConsoleSchemaVersion="1.0">
  <PSVersion>2.0</PSVersion>
  <PSSnapIns>
     <PSSnapIn Name="NewPSSnapin" />
  </PSSnapIns>
</PSConsoleFile>

Cette commande exporte les noms des composants logiciels enfichables Windows PowerShell dans la session active vers le fichier Console01.psc1 dans le répertoire actif.

La deuxième commande affiche le contenu du fichier Console01.psc1 dans le Bloc-notes.

Exemple 5 : Déterminer le fichier console à mettre à jour

PS C:\> powershell.exe -PSConsoleFile Console01.psc1
PS C:\> Add-PSSnapin MySnapin
PS C:\> Export-Console NewConsole.psc1
PS C:\> $ConsoleFileName
PS C:\> Add-PSSnapin SnapIn03
PS C:\> Export-Console

Cet exemple montre comment utiliser la variable automatique $ConsoleFileName pour déterminer le fichier de console qui sera mis à jour si vous utilisez Export-Console sans 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 dans la session dans le fichier NewConsole.psc1.

La quatrième commande affiche la variable $ConsoleFileName. Il contient le fichier console le plus récemment utilisé. L’exemple de sortie indique 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 Export-Console sans paramètre path Path. Cette commande exporte les noms de tous les composants logiciels enfichables Windows PowerShell dans la session active vers le fichier le plus récemment utilisé, NewConsole.psc1.

Paramètres

-Confirm

Vous invite à confirmer avant d’exécuter l’applet de commande.

Type:SwitchParameter
Alias:cf
Position:Named
Valeur par défaut:False
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Force

Indique que cette applet de commande remplace les données d’un fichier console sans avertissement, même si le fichier a l’attribut en lecture seule. L’attribut en lecture seule est modifié et n’est pas réinitialisé lorsque la commande se termine.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-NoClobber

Indique que cette applet de commande ne remplace pas un fichier de console existant. Par défaut, si un fichier se produit dans le chemin spécifié, Export-Console remplace le fichier sans avertissement.

Type:SwitchParameter
Alias:NoOverwrite
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Path

Spécifie un chemin d’accès et un nom de fichier pour le fichier console (*.psc1). Entrez un chemin et un nom facultatifs. Les caractères génériques ne sont pas autorisés.

Si vous spécifiez uniquement un nom de fichier, Export-Console crée un fichier portant ce nom et l’extension de nom de fichier .psc1 dans le répertoire actif.

Ce paramètre est obligatoire, sauf si vous avez ouvert Windows PowerShell avec le paramètre PSConsoleFile ou exporté un fichier console pendant la session active. Il est également nécessaire 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 fichier de console utilisé le plus récemment dans cette session. Le chemin d’accès du fichier console le plus récemment utilisé est stocké dans la valeur de la variable automatique $ConsoleFileName. Pour plus d’informations, consultez about_Automatic_Variables.

Type:String
Alias:PSPath
Position:0
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-WhatIf

Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande n’est pas exécutée.

Type:SwitchParameter
Alias:wi
Position:Named
Valeur par défaut:False
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

String

Vous pouvez diriger une chaîne de chemin vers cette applet de commande.

Sorties

FileInfo

Cette applet de commande crée un fichier qui contient les alias exportés.

Notes

  • Lorsqu’un fichier console (.psc1) est utilisé pour démarrer la session, le nom du fichier console est automatiquement stocké dans la variable automatique $ConsoleFileName. La valeur de $ConsoleFileName est mise à jour lorsque vous utilisez le paramètre Path de Export-Console pour spécifier un nouveau fichier de console. Lorsqu’aucun fichier console n’est utilisé, $ConsoleFileName n’a aucune valeur ($Null).

    Pour utiliser un fichier de console Windows PowerShell dans une nouvelle session, utilisez la syntaxe suivante pour démarrer Windows PowerShell :

    powershell.exe -PsConsoleFile \<ConsoleFile\>.psc1

    Vous pouvez également enregistrer les composants logiciels enfichables Windows PowerShell pour les sessions futures en ajoutant une commande Add-PSSnapin à votre profil Windows PowerShell. Pour plus d’informations, consultez about_Profiles.