Compartir a través de

Export-Alias

  • Referencia
Módulo:
Microsoft.PowerShell.Utility

Exporta información sobre los alias definidos actualmente en un archivo.

Sintaxis

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 cmdlet Export-Alias exporta los alias de la sesión actual a un archivo. Si el archivo de salida no existe, 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 de 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 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 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 en la parte superior del archivo.

El comando también usa el parámetro Force para sobrescribir los archivos 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 de CurrentUser-CurrentHost. La ruta de acceso al perfil se guarda en la variable $PROFILE. El comando usa el cmdlet Get-Content para obtener los alias del archivo Alias.ps1 y el cmdlet Add-Content para agregarlos al perfil. Para obtener más información, vea about_Profiles.

Los comandos tercero y cuarto agregan los alias en el archivo Alias.ps1 a una sesión remota en el equipo Server01. El tercer comando usa el cmdlet New-PSSession para crear la sesión. El cuarto comando usa el parámetro FilePath del cmdlet Invoke-Command 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.

Tipo:SwitchParameter
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-As

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

  • CSV. Formato de valor separado por comas (CSV).
  • Guión. Crea un comando Set-Alias para cada alias exportado. Si asigna un nombre al archivo de salida con una extensión de nombre de archivo .ps1, puede ejecutarlo como un script para agregar los alias a cualquier sesión.
Tipo:ExportAliasFormat
Valores aceptados:Csv, Script
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-Confirm

Le pide confirmación antes de ejecutar el cmdlet.

Tipo:SwitchParameter
Alias:cf
Posición:Named
Valor predeterminado:False
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-Description

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

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-Force

Obliga a que el comando se ejecute sin pedir confirmación del usuario.

Sobrescribe el archivo de salida, incluso si el atributo de solo lectura está establecido en el archivo.

De forma predeterminada, Export-Alias sobrescribe los archivos sin advertencia, a menos que el atributo de solo lectura o oculto esté establecido o el parámetro NoClobber se use 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 a Export-Alias a sobrescribir archivos con el atributo oculto.

Tipo:SwitchParameter
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín: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 incluye caracteres de escape, escríbala entre comillas simples. Las comillas simples indican a PowerShell que no interprete ningún carácter como secuencias de escape.

Tipo:String
Alias:PSPath, LP
Posición:Named
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:True
Aceptar caracteres comodín: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 de la sesión o ámbito.

Tipo:String[]
Posición:1
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:True

-NoClobber

Indica que este cmdlet impide que Export-Alias sobrescriba 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 que tiene el atributo de solo lectura.

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

Tipo:SwitchParameter
Alias:NoOverwrite
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-PassThru

Devuelve un objeto que representa el elemento con el que está trabajando. De forma predeterminada, este cmdlet no genera ninguna salida.

Tipo:SwitchParameter
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín: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.

Tipo:String
Posición:0
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:False
Aceptar caracteres comodín:True

-Scope

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

  • 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.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-WhatIf

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

Tipo:SwitchParameter
Alias:wi
Posición:Named
Valor predeterminado:False
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín: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.