Export-Alias

  • Referencia
Módulo:
Microsoft.PowerShell.Utility

Exporta a un archivo la información acerca de los alias definidos actualmente.

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>]

Description

El Export-Alias cmdlet exporta los alias de la sesión actual a un archivo. Si no existe el archivo de salida, el cmdlet lo creará.

Export-Alias puede exportar los alias en un ámbito determinado o en todos los ámbitos, puede generar los datos en formato CSV o como una serie de comandos Set-Alias que puede agregar a una sesión o a un perfil de PowerShell.

Ejemplos

Ejemplo 1: Exportación de un alias

Export-Alias -Path "alias.csv"

Este comando exporta la información de alias actual a un archivo denominado Alias.csv situado en el directorio actual.

Ejemplo 2: Exportar un alias a menos que el archivo de exportación ya exista

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

Este comando exporta los alias de la sesión actual a un archivo denominado Alias.csv.

Dado que se especifica el parámetro NoClobber , se producirá un error en el comando si ya existe un archivo Alias.csv en el directorio actual.

Ejemplo 3: Anexar alias a un archivo

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

Este comando anexa los alias de la sesión actual al archivo Alias.csv.

El comando usa el parámetro Description para agregar una descripción a los comentarios de la parte superior del archivo.

El comando también usa el parámetro Force para sobrescribir los archivos de Alias.csv existentes, incluso si tienen el atributo de solo lectura.

Ejemplo 4: Exportación de alias como script

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

En este ejemplo se muestra cómo usar el formato de archivo de script que Export-Alias genera.

El primer comando exporta los alias de la sesión al archivo Alias.ps1. Usa el parámetro As con un valor de Script para generar un archivo que contenga un comando Set-Alias para cada alias.

El segundo comando agrega los alias del archivo Alias.ps1 al perfil CurrentUser-CurrentHost. La ruta de acceso al perfil se guarda en la $Profile variable . El comando usa el Get-Content cmdlet para obtener los alias del archivo Alias.ps1 y el Add-Content cmdlet para agregarlos al perfil. Para obtener más información, consulte about_Profiles.

El tercer y cuarto comando agregan los alias del archivo Alias.ps1 a una sesión remota en el equipo Server01. El tercer comando usa el New-PSSession cmdlet para crear la sesión. El cuarto comando usa el parámetro FilePath del Invoke-Command cmdlet para ejecutar el archivo Alias.ps1 en la nueva sesión.

Parámetros

-Append

Indica que este cmdlet anexa la salida al archivo especificado, en lugar de sobrescribir el contenido existente de ese archivo.

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

-As

Especifica el formato de salida. CSV es el valor predeterminado. Los valores permitidos para este parámetro son los siguientes:

  • CSV. Formato de valores separados por comas (CSV).
  • Script. Crea un Set-Alias comando para cada alias exportado. Si asigna al archivo de salida la extensión de nombre de archivo .ps1, puede ejecutarlo como un script para agregar los alias a cualquier sesión.
Type:ExportAliasFormat
Accepted values:Csv, Script
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Le solicita su confirmación antes de ejecutar el cmdlet.

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

-Description

Especifica la descripción del archivo exportado. La descripción aparece como un comentario en la parte superior del archivo, después de la información de encabezado.

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

-Force

Obliga al comando a ejecutarse sin solicitar la confirmación del usuario.

Sobrescribe el archivo de salida, incluso aunque este tenga el atributo de sólo lectura.

De forma predeterminada, Export-Alias sobrescribe los archivos sin advertencia, a menos que se establezca el atributo de solo lectura o oculto o se use el parámetro NoClobber en el comando . El parámetro NoClobber tiene prioridad sobre el parámetro Force cuando ambos se usan en un comando.

El parámetro Force no puede forzar Export-Alias la sobrescritura de archivos con el atributo oculto.

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

-LiteralPath

Especifica la ruta de acceso al archivo de salida. A diferencia de Path, el valor del parámetro LiteralPath se usa exactamente como se escribe. Ninguno de los caracteres se interpreta como caracteres comodín. Si la ruta de acceso contiene caracteres de escape, escríbalos entre comillas simples. Las comillas simples indican a PowerShell que no interprete ningún carácter como secuencias de escape.

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

-Name

Especifica los nombres como una matriz de los alias que se van a exportar. Se permiten los caracteres comodín.

De forma predeterminada, Export-Alias exporta todos los alias en la sesión o el ámbito.

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

-NoClobber

Indica que este cmdlet impide Export-Alias sobrescribir los archivos, incluso si el parámetro Force se usa en el comando .

Si se omite el parámetro NoClobber , Export-Alias sobrescribirá un archivo existente sin advertencia, a menos que el atributo de solo lectura esté establecido en el archivo. NoClobber tiene prioridad sobre el parámetro Force , que permite Export-Alias sobrescribir un archivo con el atributo de solo lectura.

NoClobber no impide que el parámetro Append agregue contenido a un archivo existente.

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

-PassThru

Devuelve un objeto que representa el elemento con el que está trabajando. De forma predeterminada, este cmdlet no genera ningún resultado.

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

-Path

Especifica la ruta de acceso al archivo de salida. Se permite caracteres comodín, pero el valor de la ruta de acceso resultante debe resolverse en un nombre de archivo único.

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

-Scope

Especifica el ámbito desde el que se deben exportar los alias. Los valores permitidos para este parámetro son los siguientes:

  • Global
  • Local
  • Script
  • Número relativo al ámbito actual (de 0 al número de ámbitos donde 0 es el ámbito actual y 1 es su elemento primario).

El valor predeterminado es Local. Para obtener más información, consulte about_Scopes.

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

-WhatIf

Muestra lo que sucedería si se ejecutara el cmdlet. El cmdlet no se ejecuta.

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

Entradas

None

No se pueden canalizar objetos a este cmdlet.

Salidas

None

De forma predeterminada, este cmdlet no devuelve ninguna salida.

AliasInfo

Cuando se usa el parámetro PassThru , este cmdlet devuelve un objeto AliasInfo que representa el alias.

Notas

PowerShell incluye los siguientes alias para Export-Alias:

  • Todas las plataformas:
    • epal
  • Sólo puede utilizar el cmdlet Export-Aliases para exportar alias a un archivo.