Freigeben über

Export-Alias

  • Referenz
Modul:
Microsoft.PowerShell.Utility

Exportiert Informationen zu aktuell definierten Aliasen in eine Datei.

Syntax

Export-Alias
      [-Path] <String>
      [[-Name] <String[]>]
      [-PassThru]
      [-As <ExportAliasFormat>]
      [-Append]
      [-Force]
      [-NoClobber]
      [-Description <String>]
      [-Scope <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Export-Alias
      -LiteralPath <String>
      [[-Name] <String[]>]
      [-PassThru]
      [-As <ExportAliasFormat>]
      [-Append]
      [-Force]
      [-NoClobber]
      [-Description <String>]
      [-Scope <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Beschreibung

Das Cmdlet Export-Alias exportiert die Aliase in der aktuellen Sitzung in eine Datei. Wenn die Ausgabedatei nicht vorhanden ist, erstellt das Cmdlet sie.

Export-Alias die Aliase in einem bestimmten Bereich oder allen Bereichen exportieren können, kann sie die Daten im CSV-Format oder als Reihe von Set-Alias Befehlen generieren, die Sie einer Sitzung oder einem PowerShell-Profil hinzufügen können.

Beispiele

Beispiel 1: Exportieren eines Alias

Export-Alias -Path "alias.csv"

Mit diesem Befehl werden aktuelle Aliasinformationen in eine Datei mit dem Namen Alias.csv im aktuellen Verzeichnis exportiert.

Beispiel 2: Exportieren eines Alias, es sei denn, die Exportdatei ist bereits vorhanden

Export-Alias -Path "alias.csv" -NoClobber

Mit diesem Befehl werden die Aliase in der aktuellen Sitzung in eine Alias.csv Datei exportiert.

Da der NoClobber Parameter angegeben ist, schlägt der Befehl fehl, wenn bereits eine Alias.csv Datei im aktuellen Verzeichnis vorhanden ist.

Beispiel 3: Anfügen von Aliasen an eine Datei

Export-Alias -Path "alias.csv" -Append -Description "Appended Aliases" -Force

Mit diesem Befehl werden die Aliase in der aktuellen Sitzung an die Alias.csv Datei angefügt.

Der Befehl verwendet den parameter Description, um den Kommentaren oben in der Datei eine Beschreibung hinzuzufügen.

Der Befehl verwendet auch den Parameter Force, um vorhandene Alias.csv Dateien zu überschreiben, auch wenn sie über das schreibgeschützte Attribut verfügen.

Beispiel 4: Exportieren von Aliasen als Skript

Export-Alias -Path "alias.ps1" -As Script
Add-Content -Path $Profile -Value (Get-Content alias.ps1)
$S = New-PSSession -ComputerName Server01
Invoke-Command -Session $S -FilePath .\alias.ps1

In diesem Beispiel wird gezeigt, wie Sie das Skriptdateiformat verwenden, das Export-Alias generiert.

Der erste Befehl exportiert die Aliase in der Sitzung in die Alias.ps1 Datei. Es verwendet den parameter As mit einem Wert von Script, um eine Datei zu generieren, die einen Set-Alias Befehl für jeden Alias enthält.

Mit dem zweiten Befehl werden dem CurrentUser-CurrentHost Profil die Aliase in der Alias.ps1 Datei hinzugefügt. Der Pfad zum Profil wird in der variablen $Profile gespeichert. Der Befehl verwendet das Cmdlet Get-Content, um die Aliase aus der Alias.ps1-Datei und dem Cmdlet Add-Content abzurufen, um sie dem Profil hinzuzufügen. Weitere Informationen finden Sie unter about_Profiles.

Die dritten und vierten Befehle fügen die Aliase in der Alias.ps1-Datei zu einer Remotesitzung auf dem Server01-Computer hinzu. Der dritte Befehl verwendet das cmdlet New-PSSession zum Erstellen der Sitzung. Der vierte Befehl verwendet den FilePath-Parameter des cmdlets Invoke-Command, um die Alias.ps1 Datei in der neuen Sitzung auszuführen.

Parameter

-Append

Gibt an, dass dieses Cmdlet die Ausgabe an die angegebene Datei angibt, anstatt den vorhandenen Inhalt dieser Datei zu überschreiben.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-As

Gibt das Ausgabeformat an. CSV ist die Standardeinstellung. Die zulässigen Werte für diesen Parameter sind:

  • CSV. CSV-Format (Kommagetrennte Werte).
  • Skript. Erstellt einen Set-Alias Befehl für jeden exportierten Alias. Wenn Sie die Ausgabedatei mit einer .ps1 Dateinamenerweiterung benennen, können Sie sie als Skript ausführen, um die Aliase einer beliebigen Sitzung hinzuzufügen.
Typ:ExportAliasFormat
Zulässige Werte:Csv, Script
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Confirm

Fordert Sie vor dem Ausführen des Cmdlets zur Bestätigung auf.

Typ:SwitchParameter
Aliase:cf
Position:Named
Standardwert:False
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Description

Gibt die Beschreibung der exportierten Datei an. Die Beschreibung wird oben in der Datei als Kommentar angezeigt und folgt den Kopfzeileninformationen.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Force

Erzwingt die Ausführung des Befehls, ohne eine Benutzerbestätigung zu verlangen.

Überschreibt die Ausgabedatei, auch wenn das schreibgeschützte Attribut für die Datei festgelegt ist.

Standardmäßig überschreibt Export-Alias Dateien ohne Warnung, es sei denn, das schreibgeschützte oder ausgeblendete Attribut wird festgelegt, oder der NoClobber Parameter wird im Befehl verwendet. Der NoClobber--Parameter hat Vorrang vor dem parameter Force, wenn beide in einem Befehl verwendet werden.

Der Parameter Force kann nicht erzwingen, dass Export-Alias Dateien mit dem ausgeblendeten Attribut überschreiben kann.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-LiteralPath

Gibt den Pfad zur Ausgabedatei an. Im Gegensatz zu Pathwird der Wert des LiteralPath--Parameters genau so verwendet, wie er eingegeben wird. Es werden keine Zeichen als Wildcards interpretiert. Wenn der Pfad Escapezeichen enthält, schließen Sie ihn in einfache Anführungszeichen ein. Einfache Anführungszeichen weisen PowerShell an, keine Zeichen als Escapesequenzen zu interpretieren.

Typ:String
Aliase:PSPath
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Name

Gibt die Namen als Array der zu exportierenden Aliase an. Wildcards sind zulässig.

Standardmäßig exportiert Export-Alias alle Aliase in der Sitzung oder im Bereich.

Typ:String[]
Position:1
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:True

-NoClobber

Gibt an, dass dieses Cmdlet verhindert, dass Export-Alias Dateien überschreiben, auch wenn der parameter Force im Befehl verwendet wird.

Wenn der NoClobber Parameter ausgelassen wird, überschreibt Export-Alias eine vorhandene Datei ohne Warnung, es sei denn, das schreibgeschützte Attribut ist für die Datei festgelegt. NoClobber- hat Vorrang vor dem parameter Force, mit dem Export-Alias eine Datei mit dem schreibgeschützten Attribut überschreiben kann.

NoClobber- verhindert nicht, dass der parameter Append Inhalt zu einer vorhandenen Datei hinzufügt.

Typ:SwitchParameter
Aliase:NoOverwrite
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-PassThru

Gibt ein Objekt zurück, das das Element darstellt, mit dem Sie arbeiten. Standardmäßig generiert dieses Cmdlet keine Ausgabe.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Path

Gibt den Pfad zur Ausgabedatei an. Wildcards sind zulässig, der resultierende Pfadwert muss jedoch in einen einzelnen Dateinamen aufgelöst werden.

Typ:String
Position:0
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:True

-Scope

Gibt den Bereich an, aus dem die Aliase exportiert werden sollen. Die zulässigen Werte für diesen Parameter sind:

  • Global
  • Local
  • Script
  • Eine Zahl relativ zum aktuellen Bereich (0 bis zur Anzahl der Bereiche, wobei 0 der aktuelle Bereich ist und 1 das übergeordnete Element ist)

Der Standardwert ist Local. Weitere Informationen finden Sie unter about_Scopes.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-WhatIf

Zeigt, was passiert, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Typ:SwitchParameter
Aliase:wi
Position:Named
Standardwert:False
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

Eingaben

None

Sie können keine Objekte an dieses Cmdlet weiterleiten.

Ausgaben

None

Standardmäßig gibt dieses Cmdlet keine Ausgabe zurück.

AliasInfo

Wenn Sie den PassThru Parameter verwenden, gibt dieses Cmdlet ein AliasInfo- Objekt zurück, das den Alias darstellt.

Hinweise

Windows PowerShell enthält die folgenden Aliase für Export-Alias:

  • epal
  • Sie können nur eine Datei Export-Aliases.