Convertit des objets Microsoft .NET Framework au format HTML pouvant être affiché dans un navigateur Web.
Syntaxe
ConvertTo-Html [[-Head] <string[]>] [[-Title] <string>] [[-Body] <string[]>] [-CssUri <Uri>] [[-Property] <Object[]>] [-As <string>] [-InputObject <psobject>] [-PostContent <string[]>] [-PreContent <string[]>] [<CommonParameters>] ConvertTo-Html [-Fragment] [[-Property] <Object[]>] [-As <string>] [-InputObject <psobject>] [-PostContent <string[]>] [-PreContent <string[]>] [<CommonParameters>]
Description
L'applet de commande ConvertTo-Html convertit des objets .NET Framework au format HTML pouvant être affiché dans un navigateur Web. Vous pouvez utiliser cette applet de commande pour afficher la sortie d'une commande dans une page Web.
Vous pouvez utiliser les paramètres de ConvertTo-Html pour sélectionner des propriétés d'objet, pour spécifier un format de table ou de liste, pour indiquer le titre de la page HTML, pour ajouter du texte avant et après l'objet et pour retourner uniquement un fragment de table ou de liste, au lieu d'une page DTD stricte.
Lorsque vous envoyez plusieurs objets à ConvertTo-Html, Windows PowerShell crée la table (ou la liste) en fonction des propriétés du premier objet que vous envoyez. Si les autres objets ne possèdent pas l'une des propriétés spécifiées, la valeur de propriété de cet objet est une cellule vide. Si les autres objets ont des propriétés supplémentaires, ces valeurs de propriété ne sont pas incluses dans le fichier.
Paramètres
-As <string>
Détermine si l'objet est mis en forme sous la forme d'une table ou d'une liste. Les valeurs valides sont TABLE et LIST. La valeur par défaut est TABLE.
La valeur TABLE génère une table HTML qui ressemble à la table Windows PowerShell. La ligne d'en-tête affiche le nom des propriétés. Chaque ligne de la table représente un objet et affiche les valeurs de l'objet pour chaque propriété.
La valeur LIST génère une table HTML à deux colonnes pour chaque objet, qui ressemble au format de liste de Windows PowerShell. La première colonne contient le nom de la propriété, tandis que la deuxième affiche sa valeur.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
Table |
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-Body <string[]>
Spécifie le texte à ajouter après la balise <BODY> d'ouverture. Par défaut, aucun texte ne figure à cette position.
|
Obligatoire ? |
false |
|
Position ? |
4 |
|
Valeur par défaut |
No text. |
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-CssUri <Uri>
Spécifie l'URI (Uniform Resource Identifier) de la feuille de style en cascade (CSS) appliquée au fichier HTML. L'URI est inclus dans un lien de feuille de style de la sortie.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-Fragment
Génère uniquement une table HTML. Les balises HTML, HEAD, TITLE et BODY sont omises.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-Head <string[]>
Spécifie le contenu de la balise <HEAD>. La valeur par défaut est <title>HTML TABLE</title>. Si vous utilisez le paramètre Head, le paramètre Title est ignoré.
|
Obligatoire ? |
false |
|
Position ? |
2 |
|
Valeur par défaut |
<title>HTML TABLE</title> |
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-InputObject <psobject>
Spécifie les objets à représenter au format HTML. Entrez une variable contenant les objets ou tapez une commande ou une expression qui obtient les objets.
Si vous utilisez ce paramètre pour envoyer plusieurs objets, tels que tous les services d'un ordinateur, ConvertTo-Html crée une table qui affiche les propriétés d'une collection ou d'une table d'objets (System.Object []). Pour créer une table d'objets individuels, utilisez l'opérateur de pipeline pour diriger les objets vers ConvertTo-Html.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
true (ByValue) |
|
Accepter les caractères génériques ? |
false |
-PostContent <string[]>
Spécifie le texte à ajouter après la balise </TABLE> de fermeture. Par défaut, aucun texte ne figure à cette position.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
No text |
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-PreContent <string[]>
Spécifie le texte à ajouter avant la balise <TABLE> d'ouverture. Par défaut, aucun texte ne figure à cette position.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
No text |
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-Property <Object[]>
Inclut les propriétés spécifiées des objets dans le document HTML.
|
Obligatoire ? |
false |
|
Position ? |
1 |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-Title <string>
Spécifie un titre pour le fichier HTML, à savoir le texte qui apparaît entre les balises <TITLE>.
|
Obligatoire ? |
false |
|
Position ? |
3 |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
<CommonParameters>
Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer et -OutVariable. Pour plus d'informations, consultez about_Commonparameters.
Entrées et sorties
Le type d'entrée est le type des objets que vous pouvez diriger vers l'applet de commande. Le type de retour est le type des objets que l'applet de commande retourne.
|
Entrées |
System.Management.Automation.PSObject Vous pouvez diriger n'importe quel objet .NET vers ConvertTo-Html. |
|
Sorties |
System.String ConvertTo-Html retourne une série de chaînes composées de code HTML valide. |
Remarques
Pour utiliser cette applet de commande, dirigez un ou plusieurs objets vers l'applet de commande ou utilisez le paramètre InputObject pour spécifier l'objet. Lorsque l'entrée consiste en plusieurs objets, la sortie de ces deux méthodes est assez différente.
-- Lorsque vous dirigez plusieurs objets vers une applet de commande, Windows PowerShell envoie ces objets un par un. En conséquence, ConvertTo-Html crée une table qui affiche les objets individuels. Par exemple, si vous dirigez les processus d'un ordinateur vers ConvertTo-Html, la table générée affiche tous les processus.
-- Lorsque vous utilisez le paramètre InputObject pour envoyer plusieurs objets, ConvertTo-Html reçoit ces objets sous la forme d'une collection ou d'un tableau. En conséquence, elle crée une table qui affiche le tableau et ses propriétés, et non pas les éléments du tableau. Par exemple, si vous utilisez InputObject pour envoyer les processus d'un ordinateur à ConvertTo-Html, la table obtenue affiche un tableau d'objets (System.Object[]) et ses propriétés.
Pour se conformer à la DTD stricte du format XHTML, la balise DOCTYPE est modifiée en conséquence :
(<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">)
Exemple 1
C:\PS>convertto-html -inputobject (get-date) Description ----------- Cette commande crée une page HTML qui affiche les propriétés de la date actuelle. Elle utilise le paramètre InputObject pour envoyer les résultats d'une commande Get-Date à l'applet de commande ConvertTo-Html.
Exemple 2
C:\PS>get-alias | convertto-html > aliases.htm C:\PS> invoke-item aliases.htm Description ----------- Cette commande crée une page HTML qui répertorie les alias Windows PowerShell de la console actuelle. Elle utilise l'applet de commande Get-Alias pour obtenir les alias. Elle utilise l'opérateur de pipeline (|) pour envoyer les alias à l'applet de commande ConvertTo-Html, qui crée la page HTML.
Exemple 3
C:\PS>get-eventlog -logname "Windows PowerShell | convertto-html > pslog.htm Description ----------- Cette commande crée une page HTML appelée pslog.htm qui affiche les événements du journal d'événements Windows PowerShell de l'ordinateur local. Elle utilise l'applet de commande Get-EventLog pour obtenir les événements du journal Windows PowerShell, puis se sert de l'opérateur de pipeline (|) pour envoyer les événements à l'applet de commande ConvertTo-Html. La commande utilise également l'opérateur de redirection (>) pour envoyer le code HTML au fichier pslog.htm.
Exemple 4
C:\PS>get-process | convertto-html -property Name, Path, Company -title "Process Information" > proc.htm; ii proc.htm Description ----------- Ces commandes créent et ouvrent une page HTML qui répertorie le nom, le chemin d'accès et la société des processus de l'ordinateur local. La première commande utilise l'applet de commande Get-Process pour obtenir les objets représentant les processus exécutés sur l'ordinateur. Elle utilise l'opérateur de pipeline (|) pour envoyer les objets processus à l'applet de commande ConvertTo-Html. La commande utilise le paramètre Property pour sélectionner trois propriétés des objets processus à inclure dans la table. Elle utilise le paramètre Title pour spécifier le titre de la page HTML. Elle utilise également l'opérateur de redirection (>) pour envoyer le contenu HTML obtenu vers un fichier intitulé Proc.htm. La deuxième commande utilise l'applet de commande Invoke-Item (alias = ii) pour ouvrir le fichier Proc.htm dans le navigateur par défaut. Les deux commandes sont séparées par un point-virgule (;).
Exemple 5
C:\PS>get-service | convertto-html -CssUri "test.css" <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html> <head> <title>HTML TABLE</title> <link rel="stylesheet" type="text/css" href="test.css" /> ... Description ----------- Cette commande crée une page HTML avec les objets services retournés par l'applet de commande Get-Service. Elle utilise le paramètre CssUri pour spécifier une feuille de style en cascade pour la page HTML. Le paramètre CssUri ajoute une balise « <link rel="stylesheet" type="text/css » supplémentaire au contenu HTML obtenu. L'attribut HREF de la balise contient le nom de la feuille de style.
Exemple 6
C:\PS>get-service | convertto-html -as LIST > services.htm Description ----------- Cette commande crée une page HTML avec les objets services retournés par l'applet de commande Get-Service. Elle utilise le paramètre As pour spécifier un format de liste. L'opérateur de redirection (>) envoie le contenu HTML généré au fichier Services.htm.
Exemple 7
C:\PS>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> Description ----------- Cette commande utilise ConvertTo-Html pour générer une table HTML de la date actuelle. Elle utilise l'applet de commande Get-Date pour obtenir la date actuelle. Elle utilise un opérateur de pipeline (|) pour envoyer les résultats à l'applet de commande ConvertTo-Html (alias « cth »). La commande ConvertTo-Html inclut le paramètre Fragment, qui limite la sortie à une table HTML. En conséquence, les autres éléments d'une page HTML, tels que les balises <HEAD> et <BODY>, sont omis.
Exemple 8
C:\PS>get-eventlog -log "Windows PowerShell" | convertto-html -property id, level, task Description ----------- Cette commande utilise l'applet de commande Get-EventLog pour obtenir les événements du journal d'événements Windows PowerShell. Elle utilise un opérateur de pipeline (|) pour envoyer les événements à l'applet de commande ConvertTo-Html, qui les convertit au format HTML. La commande ConvertTo-Html utilise le paramètre Property pour sélectionner uniquement les propriétés ID, Level et Task de l'événement.
Exemple 9
C:\PS>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." > services.htm; ii services.htm Description ----------- Cette commande crée et ouvre une page Web qui affiche les services de l'ordinateur commençant par la lettre A. Elle utilise les paramètres Title, Body, PreContent et PostContent de ConvertTo-Html pour personnaliser la sortie. La première partie de la commande utilise l'applet de commande Get-Service pour obtenir les services de l'ordinateur commençant par la lettre A. La commande utilise un opérateur de pipeline (|) pour envoyer les résultats à l'applet de commande ConvertTo-Html. Elle utilise un opérateur de redirection (>) pour envoyer la sortie au fichier Services.htm. Un point-virgule (;) termine la première commande et en démarre une deuxième, qui utilise l'applet de commande Invoke-Item (alias = ii) pour ouvrir le fichier Services.htm dans le navigateur par défaut.
Voir aussi