Compartir a través de

ConvertTo-Html

  • Referencia
Módulo:
Microsoft.PowerShell.Utility

Convierte los objetos de Microsoft .NET Framework en HTML que se puede mostrar en un explorador web.

Syntax

ConvertTo-Html
              [-InputObject <PSObject>]
              [[-Property] <Object[]>]
              [[-Body] <String[]>]
              [[-Head] <String[]>]
              [[-Title] <String>]
              [-As <String>]
              [-CssUri <Uri>]
              [-PostContent <String[]>]
              [-PreContent <String[]>]
              [<CommonParameters>]
ConvertTo-Html
              [-InputObject <PSObject>]
              [[-Property] <Object[]>]
              [-As <String>]
              [-Fragment]
              [-PostContent <String[]>]
              [-PreContent <String[]>]
              [<CommonParameters>]

Description

El cmdlet ConvertTo-Html convierte objetos de .NET Framework en HTML que se pueden mostrar en un explorador web. Este cmdlet se puede usar para mostrar el resultado de un comando en una página web.

Puede usar los parámetros de ConvertTo-Html para seleccionar propiedades de objeto, para especificar un formato de tabla o lista, para especificar el título de página HTML, para agregar texto antes y después del objeto, y para devolver solo la tabla o el fragmento de lista, en lugar de una página DTD estricta.

Al enviar varios objetos a ConvertTo-Html, Windows PowerShell crea la tabla o una lista, en función de las propiedades del primer objeto que envíe. Si los demás objetos no tienen una de las propiedades especificadas, el valor de propiedad de ese objeto es una celda vacía. Si los demás objetos tienen propiedades adicionales, esos valores de propiedad no se incluyen en el archivo.

Ejemplos

Ejemplo 1: Create una página web para mostrar la fecha

PS C:\> ConvertTo-Html -InputObject (Get-Date)

Este comando crea una página HTML que muestra las propiedades de la fecha actual. Usa el parámetro InputObject para enviar los resultados de un comando Get-Date al cmdlet ConvertTo-Html .

Ejemplo 2: Create una página web para mostrar alias de PowerShell

PS C:\> Get-Alias | ConvertTo-Html | Out-File aliases.htm
PS C:\> Invoke-Item aliases.htm

Este comando crea una página HTML que enumera los alias de Windows PowerShell en la consola actual.

El comando utiliza el cmdlet Get-Alias para obtener los alias. Usa el operador de canalización (|) para enviar los alias al cmdlet ConvertTo-Html , que crea la página HTML. El comando también usa el cmdlet Out-File para enviar el código HTML al archivo aliases.htm.

Ejemplo 3: Create una página web para mostrar eventos de PowerShell

PS C:\> Get-EventLog -LogName "Windows PowerShell" | ConvertTo-Html | Out-File pslog.htm

Este comando crea una página HTML llamada pslog.htm que muestra los eventos del registro de eventos de Windows PowerShell en el equipo local.

Usa el cmdlet Get-EventLog para obtener los eventos en el registro de Windows PowerShell y, a continuación, usa el operador de canalización (|) para enviar los eventos al cmdlet ConvertTo-Html.

El comando también usa el cmdlet Out-File para enviar el código HTML al archivo pslog.htm.

Ejemplo 4: Create una página web para mostrar procesos

PS C:\> Get-Process | ConvertTo-Html -Property Name, Path, Company -Title "Process Information" | Out-File proc.htm; ii proc.htm

Estos comandos crean y abren una página HTML que muestra el nombre, la ruta de acceso y la compañía de los procesos en el equipo local.

El primer comando usa el cmdlet Get-Process para obtener los objetos que representan los procesos que se ejecutan en el equipo. El comando usa el operador de canalización (|) para enviar los objetos de proceso al cmdlet ConvertTo-Html .

El comando usa el parámetro Property para seleccionar tres propiedades de los objetos de proceso que se incluirán en la tabla. El comando usa el parámetro Title para especificar un título para la página HTML. El comando también usa el cmdlet Out-File para enviar el CÓDIGO HTML resultante a un archivo denominado Proc.htm.

El segundo comando usa el cmdlet Invoke-Item (alias = ii) para abrir el archivo Proc.htm en el explorador predeterminado. Los dos comandos están separados por punto y coma (;).

Ejemplo 5: Create una página web para mostrar objetos de servicio

PS> get-service | convertto-html -CssUri "test.css"
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"  "https://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<title>HTML TABLE</title>
<link rel="stylesheet" type="text/css" href="test.css" />
...

Este comando crea una página HTML de los objetos de servicio que devuelve el cmdlet Get-Service. El comando usa el parámetro CssUri para especificar una hoja de estilos en cascada para la página HTML.

El parámetro CssUri agrega una etiqueta link adicional <rel="stylesheet" type="text/css"/ href="test.css"> al HTML resultante. El atributo HREF de la etiqueta contiene el nombre de la hoja de estilos.

Ejemplo 6: Create una página web para mostrar objetos de servicio

PS C:\> Get-Service | ConvertTo-Html -As LIST | Out-File services.htm

Este comando crea una página HTML de los objetos de servicio que devuelve el cmdlet Get-Service. El comando usa el parámetro As para especificar un formato de lista. El cmdlet Out-File envía el código HTML resultante al archivo Services.htm.

Ejemplo 7: Create una tabla web para la fecha actual

PS C:\> Get-Date | cth -Fragment
<table>
<colgroup>...</colgroup>
<tr><th>DisplayHint</th><th>DateTime</th><th>Date</th><th>Day</th><th>DayOfWeek</th><th>DayOfYear</th><th>Hour</th>
<th>Kind</th><th>Millisecond</th><th>Minute</th><th>Month</th><th>Second</th><th>Ticks</th><th>TimeOfDay</th><th>Year</th></tr>
<tr><td>DateTime</td><td>Monday, May 05, 2008 10:40:04 AM</td><td>5/5/2008 12:00:00 AM</td><td>5</td><td>Monday</td>
<td>126</td><td>10</td><td>Local</td><td>123</td><td>40</td><td>5</td><td>4</td><td>633455808041237213</td><td>10:40:04.12
37213</td><td>2008</td></tr>
</table>

Este comando usa ConvertTo-Html para generar una tabla HTML de la fecha actual. El comando utiliza el cmdlet Get-Date para obtener la fecha actual. Usa un operador de canalización (|) para enviar los resultados al cmdlet ConvertTo-Html (con alias como cth).

El comando ConvertTo-Html incluye el parámetro Fragment , que limita la salida a una tabla HTML. Como resultado, se omiten los demás elementos de una página HTML, como las <etiquetas HEAD> y <BODY> .

Ejemplo 8: Create una página web para mostrar eventos de PowerShell

PS C:\> Get-EventLog -Log "Windows PowerShell" | ConvertTo-Html -Property id, level, task

Este comando usa el cmdlet Get-EventLog para obtener eventos del registro de eventos de Windows PowerShell.

Usa un operador de canalización (|) para enviar los eventos al cmdlet ConvertTo-Html , que convierte los eventos en formato HTML.

El comando ConvertTo-Html usa el parámetro Property para seleccionar solo las propiedades ID, Level y Task del evento.

Ejemplo 9: Create una página web para mostrar los servicios especificados

PS C:\> Get-Service A* | ConvertTo-Html -Title "Windows Services: Server01" -Body (get-date) -Pre
"<P>Generated by Corporate IT</P>" -Post "For details, contact Corporate IT." | Out-File services.htm; ii services.htm

Este comando crea y abre una página web que muestra los servicios en el equipo que comienzan por A. Usa los parámetros Title, Body, PreContent y PostContent de ConvertTo-Html para personalizar la salida.

La primera parte del comando usa el cmdlet Get-Service para obtener los servicios en el equipo que comienzan por A. El comando usa un operador de canalización (|) para enviar los resultados al cmdlet ConvertTo-Html . El comando también usa el cmdlet Out-File para enviar la salida al archivo Services.htm.

Un punto y coma (;) finaliza el primer comando e inicia un segundo comando, que usa el cmdlet Invoke-Item (alias = "ii") para abrir el archivo Services.htm en el explorador predeterminado.

Parámetros

-As

Especifica si el objeto tiene formato de tabla o lista. Los valores aceptables para este parámetro son: Table y List. El valor predeterminado es Table.

El valor table genera una tabla HTML similar al formato de tabla Windows PowerShell. La fila de encabezado muestra los nombres de propiedad. Cada fila de la tabla representa un objeto y muestra los valores de cada propiedad del objeto.

El valor List genera una tabla HTML de dos columnas para cada objeto similar al formato de lista de Windows PowerShell. La primera columna muestra el nombre de propiedad; la segunda columna muestra el valor de propiedad.

Type:String
Accepted values:Table, List
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Body

Especifica el texto, como matriz, que se va a agregar después de la etiqueta BODY> de apertura<. De forma predeterminada, no hay ningún texto en esa posición.

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

-CssUri

Especifica el identificador uniforme de recursos (URI) de la hoja de estilos en cascada (CSS) que se aplica al archivo HTML. El URI se incluye en un vínculo de hoja de estilos en el resultado.

Type:Uri
Aliases:cu, uri
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Fragment

Indica que este cmdlet solo genera una tabla HTML. Se omiten las etiquetas HTML, HEAD, TITLE y BODY.

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

-Head

Especifica el contenido de la <etiqueta HEAD> como una matriz. El valor predeterminado es <title HTML TABLE</title>>. Si usa el parámetro Head , se omite el parámetro Title .

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

-InputObject

Especifica los objetos que se representarán en HTML. Especifique una variable que contenga los objetos, o escriba un comando o una expresión que obtenga los objetos.

Si usa este parámetro para enviar varios objetos, como todos los servicios de un equipo, ConvertTo-Html crea una tabla que muestra las propiedades de una colección o de una matriz de objetos (System.Object[]). Para crear una tabla de los objetos individuales, use el operador de canalización para canalizar los objetos a ConvertTo-Html.

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

-PostContent

Especifica el texto que se va a agregar después de la etiqueta /TABLE> de cierre<. De forma predeterminada, no hay ningún texto en esa posición.

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

-PreContent

Especifica una matriz de texto que se va a agregar antes de la etiqueta TABLE> de apertura<. De forma predeterminada, no hay ningún texto en esa posición.

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

-Property

Especifica las propiedades de los objetos en el código HTML. El valor del parámetro Property puede ser una nueva propiedad calculada. Para crear una propiedad calculada, utilice una tabla hash. Las claves válidas son:

  • > Cadena de etiqueta <(a diferencia de Select-Object o Format-Table, no se admite la clave Name)
  • Cadena> de expresión <o <bloque de script>
Type:Object[]
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Title

Especifica un título para el archivo HTML, es decir, el texto que aparece entre las <etiquetas TITLE> .

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

Entradas

PSObject

Puede canalizar cualquier objeto .NET a ConvertTo-Html.

Salidas

System.String or System.Xml.XmlDocument

Este cmdlet devuelve una serie de cadenas que componen html válidos.

Notas

  • Para usar este cmdlet, canalice uno o varios objetos al cmdlet o use el parámetro InputObject para especificar el objeto. Cuando la entrada consta de varios objetos, el resultado de estos dos métodos es bastante diferente.

    • Al canalizar varios objetos a un cmdlet, Windows PowerShell envía los objetos al cmdlet de uno en uno. Como resultado, ConvertTo-Html crea una tabla que muestra los objetos individuales. Por ejemplo, si canaliza los procesos de un equipo a ConvertTo-Html, la tabla resultante muestra todos los procesos.

    • Cuando se usa el parámetro InputObject para enviar varios objetos, ConvertTo-Html recibe estos objetos como una colección o como una matriz. Como resultado, crea una tabla que muestra la matriz y sus propiedades, no los elementos de la matriz. Por ejemplo, si usa InputObject para enviar los procesos en un equipo a ConvertTo-Html, la tabla resultante muestra una matriz de objetos (System.Object[]) y sus propiedades.

    Para cumplir con la DTD estricta XHTML, la etiqueta DOCTYPE se modifica en consecuencia:

    (<! DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">)