Exporta a un archivo la información sobre los alias actualmente definidos.
Sintaxis
Export-Alias [-Path] <string> [[-Name] <string[]>] [-Append] [-As {<Csv> | <Script>}] [-Description <string>] [-Force] [-NoClobber] [-PassThru] [-Scope <string>] [-Confirm] [-WhatIf] [<CommonParameters>]
Descripción
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 de un ámbito determinado o todos los ámbitos y puede generar los datos en formato CSV o como una serie de comandos Set-Alias que se pueden agregar a una sesión o un perfil de Windows PowerShell.
Parámetros
-Append
Anexa el resultado al archivo especificado, en lugar de sobrescribir el contenido existente del archivo.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
-As <ExportAliasFormat>
Determina el formato de los resultados. El valor predeterminado es CSV.
Los valores válidos son:
-- CSV: formato de valores separados por comas (CSV).
-- Script: crea un comando Set-Alias para cada alias exportado. Si asigna al nombre del archivo de salida la extensión .ps1, podrá ejecutarlo como un script para agregar los alias a cualquier sesión.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
-Description <string>
Agrega una descripción al archivo exportado. La descripción aparece como un comentario en la parte superior del archivo tras la información del encabezado.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
-Force
Sobrescribe el archivo de salida, incluso si está establecido el atributo de solo lectura en el archivo.
De forma predeterminada, Export-Alias sobrescribe los archivos sin avisar, a menos que esté establecido el atributo de solo lectura u oculto o se utilice el parámetro NoClobber en el comando. El parámetro NoClobber tiene precedencia sobre el parámetro Force cuando se utilizan ambos en un comando.
El parámetro Force no puede obligar a Export-Alias a sobrescribir los archivos que tengan establecido el atributo oculto.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
Does not overwrite read-only files. |
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
-Name <string[]>
Especifica los nombres de los alias que se van a exportar. Se permite el uso de caracteres comodín.
De forma predeterminada, Export-Alias exporta todos los alias de la sesión o del ámbito.
|
¿Requerido? |
false |
|
¿Posición? |
2 |
|
Valor predeterminado |
Export all aliases |
|
¿Aceptar canalización? |
true (ByPropertyName) |
|
¿Aceptar caracteres comodín? |
false |
-NoClobber
Evita que Export-Alias sobrescriba los archivos, incluso si se usa el parámetro Force en el comando.
Si se omite el parámetro NoClobber, Export-Alias sobrescribirá un archivo existente sin avisar, a menos que tenga establecido el atributo de solo lectura. NoClobber tiene precedencia sobre el parámetro Force, lo que permite a Export-Alias sobrescribir un archivo con el atributo de solo lectura.
NoClobber no evita que el parámetro Append agregue contenido a un archivo existente.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
Overwrites read-write files. |
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
-PassThru
Devuelve objetos que representan los alias exportados. De forma predeterminada, este cmdlet no genera resultados.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
No output |
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
-Path <string>
Especifica la ruta de acceso al archivo de salida. Se permite el uso de caracteres comodín, pero el valor resultante debe indicar un único nombre de archivo. Este parámetro es obligatorio.
|
¿Requerido? |
true |
|
¿Posición? |
1 |
|
Valor predeterminado |
ninguno |
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
-Scope <string>
Especifica el ámbito desde el que deben exportarse los alias.
Los valores válidos son "Global", "Local", "Script" o el número correspondiente al ámbito actual (entre 0 y el número de ámbitos, donde 0 es el ámbito actual y 1 su ámbito principal). "Local" es el valor predeterminado. Para obtener más información, vea about_Scopes.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
Local |
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
-Confirm
Solicita confirmación antes de ejecutar el comando.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
-WhatIf
Describe lo que ocurriría si ejecutara el comando sin ejecutarlo realmente.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
<CommonParameters>
Este cmdlet admite los parámetros comunes: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer y -OutVariable. Para obtener más información, vea about_Commonparameters.
Entradas y salidas
El tipo de entrada es el tipo de los objetos que se pueden canalizar al cmdlet. El tipo devuelto es el tipo de los objetos que el cmdlet devuelve.
|
Entradas |
Ninguno. No puede canalizar objetos a este cmdlet. |
|
Salidas |
Ninguno o System.Management.Automation.AliasInfo Cuando se usa el parámetro Passthru, Export-Alias devuelve un objeto System.Management.Automation.AliasInfo que representa el alias. En caso contrario, este cmdlet no genera resultados. |
Notas
Los alias se pueden exportar únicamente a un archivo.
Ejemplo 1
C:\PS>export-alias -path alias.csv Descripción ----------- Este comando exporta la información actual de los alias a un archivo denominado Alias.csv del directorio actual.
Ejemplo 2
C:\PS>export-alias -path alias.csv -noclobber Descripción ----------- Este comando exporta los alias de la sesión actual a un archivo denominado Alias.csv. Como se ha especificado el parámetro NoClobber, el comando generará un error si ya existe un archivo denominado Alias.csv en el directorio actual.
Ejemplo 3
C:\PS>export-alias -path alias.csv -append -description "Appended Aliases" -force Descripción ----------- Este comando anexa los alias de la sesión actual al archivo Alias.csv. El comando utiliza el parámetro Description para agregar una descripción a los comentarios en la parte superior del archivo. El comando también utiliza el parámetro Force para sobrescribir cualquier archivo Alias.csv existente, incluso si tiene establecido el atributo de solo lectura.
Ejemplo 4
C:\PS>export-alias -path alias.ps1 -as script C:\PS> add-content -path $profile -value (get-content alias.ps1) C:\PS> $s = new-pssession -computername Server01 C:\PS> invoke-command -session $s -filepath .\alias.ps1 Descripción ----------- En este ejemplo se muestra cómo utilizar el formato de archivo de script que Export-Alias genera. El primer comando exporta los alias de la sesión al archivo Alias.ps1. Utiliza el parámetro As con el valor Script para generar un archivo que contiene 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 está guardada en la variable $profile.) El comando utiliza 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. 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 cmdlet New-PSSession para crear la sesión. El cuarto comando utiliza el parámetro FilePath del cmdlet Invoke-Command para ejecutar el archivo Alias.ps1 en la nueva sesión.
Vea también