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 Export-Alias Cmdlet exportiert die Aliase in der aktuellen Sitzung in eine Datei. Wenn die Ausgabedatei nicht vorhanden ist, wird sie vom Cmdlet erstellt.

Export-Alias kann die Aliase in einem bestimmten Bereich oder allen Bereichen exportieren, sie können die Daten im CSV-Format oder als Eine 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"

Dieser Befehl exportiert die aktuellen Aliasinformationen in eine Datei namens „Alias.csv“ im aktuellen Verzeichnis.

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

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

Dieser Befehl exportiert die Aliase der aktuellen Sitzung in eine Datei namens „Alias.csv“.

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

Beispiel 3: Anfügen von Aliasen an eine Datei

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

Dieser Befehl fügt die Aliase der aktuellen Sitzung an eine Datei namens „Alias.csv“ an.

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 generierte Export-Alias Skriptdateiformat verwenden.

Der erste Befehl exportiert die Aliase der Sitzung in die Datei „Alias.ps1“. Er verwendet den Parameter "As " mit dem Wert "Script", um eine Datei zu generieren, die einen Set-Alias-Befehl für jeden Alias enthält.

Der zweite Befehl fügt dem CurrentUser-CurrentHost-Profil die Aliase aus der Datei „Alias.ps1“ hinzu. Der Pfad zum Profil wird in der $Profile Variablen gespeichert. Der Befehl verwendet das Get-Content Cmdlet, um die Aliase aus der Datei Alias.ps1 und dem Add-Content Cmdlet abzurufen, um sie dem Profil hinzuzufügen. Weitere Informationen finden Sie unter about_Profiles.

Durch den dritten und vierten Befehl werden die Aliase in der Datei „Alias.ps1“ einer Remotesitzung auf dem Computer Server01 hinzugefügt. Der dritte Befehl verwendet das New-PSSession Cmdlet zum Erstellen der Sitzung. Der vierte Befehl verwendet den FilePath-Parameter des Invoke-Command Cmdlets, um die Datei Alias.ps1 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.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-As

Gibt das Ausgabeformat an. CSV ist das Standardformat. Zulässige Werte für diesen Parameter:

  • CSV. Durch Trennzeichen getrenntes Format (.csv).
  • Skript. Erstellt einen Set-Alias Befehl für jeden exportierten Alias. Wenn Sie die Ausgabedatei mit der Dateierweiterung „.ps1“ benennen, können Sie sie als Skript ausführen, um die Aliase beliebigen Sitzungen hinzuzufügen.
Type:ExportAliasFormat
Accepted values:Csv, Script
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Gibt die Beschreibung der exportierten Datei an. Die Beschreibung wird am Anfang der Datei nach den Headerinformationen als Kommentar angezeigt.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Erzwingt die Ausführung des Befehls ohne Aufforderung zur Bestätigung durch den Benutzer.

Überschreibt die Ausgabedatei, auch wenn das ReadOnly-Attribut für die Datei festgelegt wurde.

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

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LiteralPath

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

Type:String
Aliases:PSPath, LP
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

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

Exportiert standardmäßig Export-Alias alle Aliase in der Sitzung oder im Bereich.

Type:String[]
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:True

-NoClobber

Gibt an, dass dieses Cmdlet das Überschreiben von Dateien verhindert Export-Alias , auch wenn der Parameter Force im Befehl verwendet wird.

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

NoClobber verhindert nicht, dass der Append-Parameter Einer vorhandenen Datei Inhalt hinzufügt.

Type:SwitchParameter
Aliases:NoOverwrite
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

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

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:True

-Scope

Gibt den Bereich an, aus dem die Aliase exportiert werden sollen. Zulässige Werte für diesen Parameter:

  • Global
  • Lokal
  • Skript
  • 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 "Lokal". Weitere Informationen finden Sie unter about_Scopes.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters: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

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

  • Alle Plattformen:
    • epal
  • Sie können Export-Alias nur für eine Datei ausführen.