PSWebGui

0.17.0-Beta

en-us/PSWebGui-help.xml

                                <?xml version="1.0" encoding="utf-8"?>

<helpItems schema="maml" xmlns="http://msh">

  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

    <command:details>

      <command:name>Format-Html</command:name>

      <command:verb>Format</command:verb>

      <command:noun>Html</command:noun>

      <maml:description>

        <maml:para>Formats and stylizes PowerShell commands output using HTML and Bootstrap.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Converts the output of PowerShell commands, passed by pipeline, to HTML format and adds Bootstrap style classes.</maml:para>

      <maml:para>Depending on the set of parameters, the output can be converted to table format, card format, or raw (no style). If no parameters are set, by default it is converted to table format.

In essence, it is like "ConverTo-Html -Fragment" PowerShell cmdlet but with Bootstrap styling built-in and another features.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Format-Html</maml:name>

        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none">

          <maml:name>InputObject</maml:name>

          <maml:description>

            <maml:para>Command or object to be formated in HTML, passed by pipeline.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue>

          <dev:type>

            <maml:name>PSObject</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Tabledark, Table-dark">

          <maml:name>Darktable</maml:name>

          <maml:description>

            <maml:para>Set this parameter to display a dark table.</maml:para>

            <maml:para></maml:para>

            <maml:para>&lt;table class="table table-dark"&gt;...&lt;/table&gt;</maml:para>

          </maml:description>

          <dev:type>

            <maml:name>SwitchParameter</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Theaddark, Thead-dark">

          <maml:name>Darkheader</maml:name>

          <maml:description>

            <maml:para>Set this parameter to display a table with dark header.</maml:para>

            <maml:para></maml:para>

            <maml:para>&lt;table class="table"&gt;</maml:para>

            <maml:para>    &lt;thead class="thead-dark"&gt;...&lt;/thead&gt;</maml:para>

            <maml:para>&lt;/table&gt;</maml:para>

          </maml:description>

          <dev:type>

            <maml:name>SwitchParameter</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>Striped</maml:name>

          <maml:description>

            <maml:para>Set this parameter to display a striped table.</maml:para>

            <maml:para></maml:para>

            <maml:para>&lt;table class="table table-striped"&gt;...&lt;/table&gt;</maml:para>

          </maml:description>

          <dev:type>

            <maml:name>SwitchParameter</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>Hover</maml:name>

          <maml:description>

            <maml:para>Set this parameter to display a hoverable rows table.</maml:para>

            <maml:para></maml:para>

            <maml:para>&lt;table class="table table-hover"&gt;...&lt;/table&gt;</maml:para>

          </maml:description>

          <dev:type>

            <maml:name>SwitchParameter</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>Id</maml:name>

          <maml:description>

            <maml:para>Use this parameter to set an id attribute for the table.</maml:para>

            <maml:para></maml:para>

            <maml:para>&lt;table id="table1"&gt;...&lt;/table&gt;</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

          <dev:type>

            <maml:name>String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

      <command:syntaxItem>

        <maml:name>Format-Html</maml:name>

        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none">

          <maml:name>InputObject</maml:name>

          <maml:description>

            <maml:para>Command or object to be formated in HTML, passed by pipeline.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue>

          <dev:type>

            <maml:name>PSObject</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>Cards</maml:name>

          <maml:description>

            <maml:para>Specifies a number, between 1 and 6, to display the command output in Bootstrap card style. The number specified is the number of cards displayed per row.</maml:para>

            <maml:para>This parameter only displays the first two properties of the object passed. The first one will be dipslayed as the card title, the second will be the card text. (See the cards section of the Bootstrap v4.6 documentation for more info about card layout)</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>

          <dev:type>

            <maml:name>Int32</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>0</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

      <command:syntaxItem>

        <maml:name>Format-Html</maml:name>

        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none">

          <maml:name>InputObject</maml:name>

          <maml:description>

            <maml:para>Command or object to be formated in HTML, passed by pipeline.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue>

          <dev:type>

            <maml:name>PSObject</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>Raw</maml:name>

          <maml:description>

            <maml:para>Set this parameter to display output in HTML format but without style.</maml:para>

          </maml:description>

          <dev:type>

            <maml:name>SwitchParameter</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none">

        <maml:name>InputObject</maml:name>

        <maml:description>

          <maml:para>Command or object to be formated in HTML, passed by pipeline.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue>

        <dev:type>

          <maml:name>PSObject</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Tabledark, Table-dark">

        <maml:name>Darktable</maml:name>

        <maml:description>

          <maml:para>Set this parameter to display a dark table.</maml:para>

          <maml:para></maml:para>

          <maml:para>&lt;table class="table table-dark"&gt;...&lt;/table&gt;</maml:para>

        </maml:description>

        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

        <dev:type>

          <maml:name>SwitchParameter</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>False</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Theaddark, Thead-dark">

        <maml:name>Darkheader</maml:name>

        <maml:description>

          <maml:para>Set this parameter to display a table with dark header.</maml:para>

          <maml:para></maml:para>

          <maml:para>&lt;table class="table"&gt;</maml:para>

          <maml:para>    &lt;thead class="thead-dark"&gt;...&lt;/thead&gt;</maml:para>

          <maml:para>&lt;/table&gt;</maml:para>

        </maml:description>

        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

        <dev:type>

          <maml:name>SwitchParameter</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>False</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>Striped</maml:name>

        <maml:description>

          <maml:para>Set this parameter to display a striped table.</maml:para>

          <maml:para></maml:para>

          <maml:para>&lt;table class="table table-striped"&gt;...&lt;/table&gt;</maml:para>

        </maml:description>

        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

        <dev:type>

          <maml:name>SwitchParameter</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>False</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>Hover</maml:name>

        <maml:description>

          <maml:para>Set this parameter to display a hoverable rows table.</maml:para>

          <maml:para></maml:para>

          <maml:para>&lt;table class="table table-hover"&gt;...&lt;/table&gt;</maml:para>

        </maml:description>

        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

        <dev:type>

          <maml:name>SwitchParameter</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>False</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>Id</maml:name>

        <maml:description>

          <maml:para>Use this parameter to set an id attribute for the table.</maml:para>

          <maml:para></maml:para>

          <maml:para>&lt;table id="table1"&gt;...&lt;/table&gt;</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

        <dev:type>

          <maml:name>String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>False</dev:defaultValue>

      </command:parameter>

      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>Cards</maml:name>

        <maml:description>

          <maml:para>Specifies a number, between 1 and 6, to display the command output in Bootstrap card style. The number specified is the number of cards displayed per row.</maml:para>

          <maml:para>This parameter only displays the first two properties of the object passed. The first one will be dipslayed as the card title, the second will be the card text. (See the cards section of the Bootstrap v4.6 documentation for more info about card layout)</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>

        <dev:type>

          <maml:name>Int32</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>0</dev:defaultValue>

      </command:parameter>

      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>Raw</maml:name>

        <maml:description>

          <maml:para>Set this parameter to display output in HTML format but without style.</maml:para>

        </maml:description>

        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

        <dev:type>

          <maml:name>SwitchParameter</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>False</dev:defaultValue>

      </command:parameter>

    </command:parameters>

    <command:inputTypes>

      <command:inputType>

        <dev:type>

          <maml:name>System.String</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:inputType>

      <command:inputType>

        <dev:type>

          <maml:name>System.Object</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:inputType>

    </command:inputTypes>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>System.String</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para></maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>

        <dev:code>PS&gt; Get-Service | Format-Html

&lt;table class='table'&gt;

&lt;thead&gt;

&lt;tr&gt;

&lt;th&gt;Name&lt;/th&gt;

&lt;th&gt;RequiredServices&lt;/th&gt;

&lt;th&gt;CanPauseAndContinue&lt;/th&gt;

...

&lt;/tr&gt;

&lt;/thead&gt;

&lt;tbody&gt;

&lt;tr&gt;

&lt;td&gt;AJRouter&lt;/td&gt;

&lt;td&gt;System.ServiceProcess.ServiceController[]&lt;/td&gt;

&lt;td&gt;False&lt;/td&gt;

...

&lt;/tr&gt;

&lt;tr&gt;

&lt;td&gt;ALG&lt;/td&gt;

&lt;td&gt;System.ServiceProcess.ServiceController[]&lt;/td&gt;

&lt;td&gt;False&lt;/td&gt;

...

&lt;/tr&gt;

...

&lt;/tbody&gt;

&lt;/table&gt;</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title>

        <dev:code>PS&gt; Get-Process | Select-Object Cpu, Name | Format-Html -Darkheader -Striped -Hover

&lt;table class='table table-striped table-hover'&gt;

&lt;thead class='thead-dark'&gt;

&lt;tr&gt;

&lt;th&gt;CPU&lt;/th&gt;

&lt;th&gt;Name&lt;/th&gt;

&lt;/tr&gt;

&lt;/thead&gt;

&lt;tbody&gt;

&lt;tr&gt;

&lt;td&gt;1475,09375&lt;/td&gt;

&lt;td&gt;msedge.exe&lt;/td&gt;

&lt;/tr&gt;

&lt;tr&gt;

&lt;td&gt;0,671875&lt;/td&gt;

&lt;td&gt;explorer.exe&lt;/td&gt;

&lt;/tr&gt;

...

&lt;/tbody&gt;

&lt;/table&gt;</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title>

        <dev:code>PS&gt; Get-Service | Select-Object Status, DisplayName | Format-Html -Cards 3

&lt;div class='row row-cols-3'&gt;

&lt;div class='card col'&gt;

&lt;div class='card-body'&gt;

&lt;h5 class='card-title'&gt;Stopped&lt;/h5&gt;

&lt;p class='card-text'&gt;AJRouter&lt;/p&gt;

&lt;/div&gt;

&lt;/div&gt;

&lt;div class='card col'&gt;

&lt;div class='card-body'&gt;

&lt;h5 class='card-title'&gt;Running&lt;/h5&gt;

&lt;p class='card-text'&gt;ALG&lt;/p&gt;

&lt;/div&gt;

&lt;/div&gt;

...

&lt;/div&gt;</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title>

        <dev:code>PS&gt; Get-Date | Format-Html -Raw

Tuesday, June 25, 2019 14:53:32</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

    <command:details>

      <command:name>Get-CredentialForm</command:name>

      <command:verb>Get</command:verb>

      <command:noun>CredentialForm</command:noun>

      <maml:description>

        <maml:para>Gets credential information from form.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Gets the information sent by the form generated by "Write-CredentialForm" function.</maml:para>

      <maml:para>Returns a PSCredential object with the username and password encrypted. Same as with PowerShell "Get-Credential" cmdlet.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Get-CredentialForm</maml:name>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters />

    <command:inputTypes />

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>System.Object</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para>## RELATED LINKS</maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>

        <dev:code>PS&gt; Get-CredentialForm

UserName                             Password

--------                             --------

Administrator    System.Security.SecureString</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

    <command:details>

      <command:name>Hide-PSConsole</command:name>

      <command:verb>Hide</command:verb>

      <command:noun>PSConsole</command:noun>

      <maml:description>

        <maml:para>Hide the PowerShell console.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Hide current PowerShell console window. Sets $GLOBAL:CONSOLE_DISPLAY to 0</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Hide-PSConsole</maml:name>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters />

    <command:inputTypes />

    <command:returnValues />

    <maml:alertSet>

      <maml:alert>

        <maml:para></maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>-------------------------- Example 1 --------------------------</maml:title>

        <dev:code>PS C:\&gt; Hide-PSConsole</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

    <command:details>

      <command:name>Set-GuiLocation</command:name>

      <command:verb>Set</command:verb>

      <command:noun>GuiLocation</command:noun>

      <maml:description>

        <maml:para>Redirects to another URL passed by parameter.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Redirects, without user intervention, to another location, passing the URL by parameter.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Set-GuiLocation</maml:name>

        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="Location, Path">

          <maml:name>URL</maml:name>

          <maml:description>

            <maml:para>Specifies the URL to be redirected to.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

          <dev:type>

            <maml:name>String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="Location, Path">

        <maml:name>URL</maml:name>

        <maml:description>

          <maml:para>Specifies the URL to be redirected to.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

        <dev:type>

          <maml:name>String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

    </command:parameters>

    <command:inputTypes>

      <command:inputType>

        <dev:type>

          <maml:name>System.String</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:inputType>

    </command:inputTypes>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>System.Object</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para>## RELATED LINKS</maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>

        <dev:code>PS&gt; Set-GuiLocation -URL "/"

&lt;script&gt;window.location.href="/"&lt;/script&gt;</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

    <command:details>

      <command:name>Set-Title</command:name>

      <command:verb>Set</command:verb>

      <command:noun>Title</command:noun>

      <maml:description>

        <maml:para>Sets the web page title.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Sets the web page title. Override the current title for this page (set in Show-PSWebGui function). Only for web page title, not for window title.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Set-Title</maml:name>

        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">

          <maml:name>Title</maml:name>

          <maml:description>

            <maml:para>Specifies the title to set.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

          <dev:type>

            <maml:name>String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">

        <maml:name>Title</maml:name>

        <maml:description>

          <maml:para>Specifies the title to set.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

        <dev:type>

          <maml:name>String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

    </command:parameters>

    <command:inputTypes>

      <command:inputType>

        <dev:type>

          <maml:name>System.String</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:inputType>

    </command:inputTypes>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>System.Object</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para>## RELATED LINKS</maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>

        <dev:code>PS&gt; Set-Title -Title "Page title"

&lt;script&gt;document.title='Page title'&lt;/script&gt;</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

    <command:details>

      <command:name>Show-PSConsole</command:name>

      <command:verb>Show</command:verb>

      <command:noun>PSConsole</command:noun>

      <maml:description>

        <maml:para>Shows the PowerShell console.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Shows the current hidden PowerShell console window. Sets $GLOBAL:CONSOLE_DISPLAY to 1</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Show-PSConsole</maml:name>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters />

    <command:inputTypes />

    <command:returnValues />

    <maml:alertSet>

      <maml:alert>

        <maml:para></maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>-------------------------- Example 1 --------------------------</maml:title>

        <dev:code>PS C:\&gt; Show-PSConsole</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

    <command:details>

      <command:name>Show-PSWebGUI</command:name>

      <command:verb>Show</command:verb>

      <command:noun>PSWebGUI</command:noun>

      <maml:description>

        <maml:para>Displays a styled graphical user interface (GUI) for PowerShell from an object passed with HTML and PowerShell content.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Starts a simple web server, listening on localhost, to display the structure and content passed within an object.</maml:para>

      <maml:para>By default, it shows up a very simple web browser in a WPF window to display the content passed by parameter.</maml:para>

      <maml:para>The content can be a string, an HTML page, cmdlets, functions or complex powershell scripts. The HTML content will be stylized with Bootstrap CSS framework. The server can execute and display local HTML or PS1 files. Custom CSS and Javascript are also compatible.</maml:para>

      <maml:para>POST and GET methods are available and can be accesses by "$_POST[]" and "$_GET[]" variables, just like within PHP.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Show-PSWebGUI</maml:name>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="Routes, Input">

          <maml:name>InputObject</maml:name>

          <maml:description>

            <maml:para>Specifies the object with the structure and content to display in the GUI.</maml:para>

            <maml:para>The way to define custom routes with associated HTML and PowerShell content is through a hash table and scriptblocks whitin it. The hash table are made up of keys and their associated values. Keys are custom defined relative paths, and must always start with "/"; values are strings, HTML and PowerShell scripts enclosed within a scriptblock.</maml:para>

            <maml:para>This is an example of a GUI structure passed as an input object:</maml:para>

            <maml:para></maml:para>

            <maml:para>$routes=@{</maml:para>

            <maml:para></maml:para>

            <maml:para>    "/"={</maml:para>

            <maml:para>        "&lt;div&gt;</maml:para>

            <maml:para>            &lt;h1&gt;Menú&lt;/h1&gt;</maml:para>

            <maml:para>            &lt;a href='/showProcesses'&gt;&lt;h2&gt;Show Running Processes&lt;/h2&gt;&lt;/a&gt;</maml:para>

            <maml:para>            &lt;a href='/showServices'&gt;&lt;h2&gt;Show Running Services&lt;/h2&gt;&lt;/a&gt;</maml:para>

            <maml:para>        &lt;/div&gt;"</maml:para>

            <maml:para>    }</maml:para>

            <maml:para></maml:para>

            <maml:para>    "/showProcesses" = { Get-Process | Select-Object name, cpu | Format-Html }</maml:para>

            <maml:para></maml:para>

            <maml:para>    "/showServices" = {</maml:para>

            <maml:para>        "&lt;div&gt;</maml:para>

            <maml:para>            &lt;h1&gt;Services&lt;/h1&gt;"</maml:para>

            <maml:para>            Get-Service | Select-Object Name, Status | Where-Object Status -eq "Running" | Format-Html</maml:para>

            <maml:para>        "&lt;/div&gt;"</maml:para>

            <maml:para>    }</maml:para>

            <maml:para></maml:para>

            <maml:para>}</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>

          <dev:type>

            <maml:name>Object</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>Port</maml:name>

          <maml:description>

            <maml:para>Specifies TCP port number to listen to. Default 80.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>

          <dev:type>

            <maml:name>Int32</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>80</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>Title</maml:name>

          <maml:description>

            <maml:para>Specifies the window title and the HTML page title.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

          <dev:type>

            <maml:name>String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>PoweShell Web GUI</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>Icon</maml:name>

          <maml:description>

            <maml:para>Specifies the path for the icon used on the window and on the HTML page. This path can be absolute or relative to the document root. If the path is not within the document root, it will only be displayed on window.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

          <dev:type>

            <maml:name>String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>CssUri</maml:name>

          <maml:description>

            <maml:para>Specifies the CSS URI to use in addition to Bootstrap. It can be a local file or an Internet URL. It can not be relative path, must be absolute.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

          <dev:type>

            <maml:name>String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Root">

          <maml:name>DocumentRoot</maml:name>

          <maml:description>

            <maml:para>Specifies the root path for the files that the server will access. Do not put final slash. Default $PWD</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

          <dev:type>

            <maml:name>String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>$PWD.path</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="NoConsole, Silent, Hidden">

          <maml:name>Display</maml:name>

          <maml:description>

            <maml:para>This parameter accepts two values: - NoGUI: Set this value to not display the GUI WPF window. The content can only be viewed within a third-party web browser.</maml:para>

            <maml:para>- NoConsole: Hide the powershell console.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

          <dev:type>

            <maml:name>String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>NoHeadTags</maml:name>

          <maml:description>

            <maml:para>Set this parameter to not display "&lt;html&gt;", "&lt;head&gt;", "&lt;meta&gt;", "&lt;link&gt;", "&lt;style&gt;" and "&lt;body&gt;" tags. With this option, the content will not be formated.</maml:para>

          </maml:description>

          <dev:type>

            <maml:name>SwitchParameter</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>Page404</maml:name>

          <maml:description>

            <maml:para>Use this parameter to set an HTML file as the 404 error page.</maml:para>

            <maml:para>This parameter must be an absolute or relative path to an HTML file. The content of the file will be displayed when the server cannot find the path (response code 404).</maml:para>

            <maml:para>Valid file extensions:</maml:para>

            <maml:para>- .html</maml:para>

            <maml:para>- .xhtml</maml:para>

            <maml:para>- .htm</maml:para>

            <maml:para>- .txt</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

          <dev:type>

            <maml:name>String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="Routes, Input">

        <maml:name>InputObject</maml:name>

        <maml:description>

          <maml:para>Specifies the object with the structure and content to display in the GUI.</maml:para>

          <maml:para>The way to define custom routes with associated HTML and PowerShell content is through a hash table and scriptblocks whitin it. The hash table are made up of keys and their associated values. Keys are custom defined relative paths, and must always start with "/"; values are strings, HTML and PowerShell scripts enclosed within a scriptblock.</maml:para>

          <maml:para>This is an example of a GUI structure passed as an input object:</maml:para>

          <maml:para></maml:para>

          <maml:para>$routes=@{</maml:para>

          <maml:para></maml:para>

          <maml:para>    "/"={</maml:para>

          <maml:para>        "&lt;div&gt;</maml:para>

          <maml:para>            &lt;h1&gt;Menú&lt;/h1&gt;</maml:para>

          <maml:para>            &lt;a href='/showProcesses'&gt;&lt;h2&gt;Show Running Processes&lt;/h2&gt;&lt;/a&gt;</maml:para>

          <maml:para>            &lt;a href='/showServices'&gt;&lt;h2&gt;Show Running Services&lt;/h2&gt;&lt;/a&gt;</maml:para>

          <maml:para>        &lt;/div&gt;"</maml:para>

          <maml:para>    }</maml:para>

          <maml:para></maml:para>

          <maml:para>    "/showProcesses" = { Get-Process | Select-Object name, cpu | Format-Html }</maml:para>

          <maml:para></maml:para>

          <maml:para>    "/showServices" = {</maml:para>

          <maml:para>        "&lt;div&gt;</maml:para>

          <maml:para>            &lt;h1&gt;Services&lt;/h1&gt;"</maml:para>

          <maml:para>            Get-Service | Select-Object Name, Status | Where-Object Status -eq "Running" | Format-Html</maml:para>

          <maml:para>        "&lt;/div&gt;"</maml:para>

          <maml:para>    }</maml:para>

          <maml:para></maml:para>

          <maml:para>}</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>

        <dev:type>

          <maml:name>Object</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>Port</maml:name>

        <maml:description>

          <maml:para>Specifies TCP port number to listen to. Default 80.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>

        <dev:type>

          <maml:name>Int32</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>80</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>Title</maml:name>

        <maml:description>

          <maml:para>Specifies the window title and the HTML page title.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

        <dev:type>

          <maml:name>String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>PoweShell Web GUI</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>Icon</maml:name>

        <maml:description>

          <maml:para>Specifies the path for the icon used on the window and on the HTML page. This path can be absolute or relative to the document root. If the path is not within the document root, it will only be displayed on window.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

        <dev:type>

          <maml:name>String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>CssUri</maml:name>

        <maml:description>

          <maml:para>Specifies the CSS URI to use in addition to Bootstrap. It can be a local file or an Internet URL. It can not be relative path, must be absolute.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

        <dev:type>

          <maml:name>String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Root">

        <maml:name>DocumentRoot</maml:name>

        <maml:description>

          <maml:para>Specifies the root path for the files that the server will access. Do not put final slash. Default $PWD</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

        <dev:type>

          <maml:name>String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>$PWD.path</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="NoConsole, Silent, Hidden">

        <maml:name>Display</maml:name>

        <maml:description>

          <maml:para>This parameter accepts two values:</maml:para>

          <maml:para>- NoGUI: Set this value to not display the GUI WPF window. The content can only be viewed within a third-party web browser.</maml:para>

          <maml:para>- NoConsole: Hide the powershell console.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

        <dev:type>

          <maml:name>String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>False</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>NoHeadTags</maml:name>

        <maml:description>

          <maml:para>Set this parameter to not display "&lt;html&gt;", "&lt;head&gt;", "&lt;meta&gt;", "&lt;link&gt;", "&lt;style&gt;" and "&lt;body&gt;" tags. With this option, the content will not be formated.</maml:para>

        </maml:description>

        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

        <dev:type>

          <maml:name>SwitchParameter</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>False</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>Page404</maml:name>

        <maml:description>

          <maml:para>Use this parameter to set an HTML file as the 404 error page.</maml:para>

          <maml:para>This parameter must be an absolute or relative path to an HTML file. The content of the file will be displayed when the server cannot find the path (response code 404).</maml:para>

          <maml:para>Valid file extensions:</maml:para>

          <maml:para>- .html</maml:para>

          <maml:para>- .xhtml</maml:para>

          <maml:para>- .htm</maml:para>

          <maml:para>- .txt</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

        <dev:type>

          <maml:name>String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>False</dev:defaultValue>

      </command:parameter>

    </command:parameters>

    <command:inputTypes>

      <command:inputType>

        <dev:type>

          <maml:name>System.String</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:inputType>

      <command:inputType>

        <dev:type>

          <maml:name>System.Object</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:inputType>

    </command:inputTypes>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>System.String</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:returnValue>

      <command:returnValue>

        <dev:type>

          <maml:name>Debug and Verbose modes write request and response information to the console.</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para></maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>

        <dev:code>Show-PSWebGUI -InputObject "Hello Wordl!"</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title>

        <dev:code>Show-PSWebGUI -InputObject $routes -Title "My custom GUI"</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title>

        <dev:code>Show-PSWebGUI -InputObject $routes -Title "My custom GUI" -Port 8080 -CssUri "C:\myresources\style.css" -Icon "C:\myresources\icon.png"</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title>

        <dev:code>Show-PSWebGUI -InputObject $routes -CssUri "C:\myresources\style.css" -DocumentRoot "C:\myresources" -Icon "/icon.png"</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

    <command:details>

      <command:name>Show-PSWebGUIExample</command:name>

      <command:verb>Show</command:verb>

      <command:noun>PSWebGUIExample</command:noun>

      <maml:description>

        <maml:para>Displays an example GUI.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Displays a basic GUI example to show how this module runs. This funtion returns the object with the structure and content used to display the graphical interface.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Show-PSWebGUIExample</maml:name>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters />

    <command:inputTypes>

      <command:inputType>

        <dev:type>

          <maml:name>None</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:inputType>

    </command:inputTypes>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>System.String</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para></maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>

        <dev:code>Show-PSWebGUIExample</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

    <command:details>

      <command:name>Stop-PSWebGui</command:name>

      <command:verb>Stop</command:verb>

      <command:noun>PSWebGui</command:noun>

      <maml:description>

        <maml:para>Stops a PSWebGui instance.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Stops a Powershell server instance of the PSWebGui module.</maml:para>

      <maml:para>By default, it tries to stop only the web server of an instance of the PSWebGui module, listening on port 80, by sending "/stop()" request.</maml:para>

      <maml:para>Setting "-Force" parameter, it also tries to close the Powershell process of the instance and, whit that, the opened GUI window.</maml:para>

      <maml:para>You can specify any other port where the instance is listening.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Stop-PSWebGui</maml:name>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>Port</maml:name>

          <maml:description>

            <maml:para>Specifie the port number where the instance is listening.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>

          <dev:type>

            <maml:name>Int32</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>80</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>Force</maml:name>

          <maml:description>

            <maml:para>Set this parameter to kill the powershell process where the instance is listening.</maml:para>

            <maml:para>Use this parameter when the instance is not responding to "/stop()" requests, when you want to close the GUI window by command line or when you need to completely close powershell process.</maml:para>

          </maml:description>

          <dev:type>

            <maml:name>SwitchParameter</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>Port</maml:name>

        <maml:description>

          <maml:para>Specifie the port number where the instance is listening.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>

        <dev:type>

          <maml:name>Int32</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>80</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>Force</maml:name>

        <maml:description>

          <maml:para>Set this parameter to kill the powershell process where the instance is listening.</maml:para>

          <maml:para>Use this parameter when the instance is not responding to "/stop()" requests, when you want to close the GUI window by command line or when you need to completely close powershell process.</maml:para>

        </maml:description>

        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

        <dev:type>

          <maml:name>SwitchParameter</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>False</dev:defaultValue>

      </command:parameter>

    </command:parameters>

    <command:inputTypes />

    <command:returnValues />

    <maml:alertSet>

      <maml:alert>

        <maml:para>## RELATED LINKS</maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>

        <dev:code>PS&gt; Stop-PSWebGui</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title>

        <dev:code>PS&gt; Stop-PSWebGui -Port 8080</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title>

        <dev:code>PS&gt; Stop-PSWebGui -Force -Port 8080</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

    <command:details>

      <command:name>Write-CredentialForm</command:name>

      <command:verb>Write</command:verb>

      <command:noun>CredentialForm</command:noun>

      <maml:description>

        <maml:para>Writes and displays a web page with basic form to enter credentials.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Writes and displays a web page with a basic form to enter credentials. The form has user and password inputs and a submit button.</maml:para>

      <maml:para>By default, the function writes the labels for the inputs and the button, form title and description, but this is all customizable using parameters.</maml:para>

      <maml:para>Because credentials will be sent with this form, the method is always POST, it can not be modified. The POST variables for the inputs are "$_POST["userName"]" and "$_POST["Password"]".</maml:para>

      <maml:para>This form is the HTML+Bootstrap version of PowerShell "Get-Credential" cmdlet.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Write-CredentialForm</maml:name>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">

          <maml:name>Title</maml:name>

          <maml:description>

            <maml:para>Specifies a title for the form. This title will appear as "&lt;h2&gt;" tag at the top of the form. The web page title will be modified too.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

          <dev:type>

            <maml:name>String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>Credential input</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">

          <maml:name>Description</maml:name>

          <maml:description>

            <maml:para>Specifies a description for the form. This description will appear as "&lt;p&gt;" tag at the top of the form.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

          <dev:type>

            <maml:name>String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>Enter your credential</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none">

          <maml:name>Action</maml:name>

          <maml:description>

            <maml:para>Specifies the action attribute. This is the URL where the form will send the data.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

          <dev:type>

            <maml:name>String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none">

          <maml:name>UsernameLabel</maml:name>

          <maml:description>

            <maml:para>Specifies a label for the username input.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

          <dev:type>

            <maml:name>String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>Enter your username</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none">

          <maml:name>PasswordLabel</maml:name>

          <maml:description>

            <maml:para>Specifies a label for the password input.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

          <dev:type>

            <maml:name>String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>Enter your password</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none">

          <maml:name>SubmitLabel</maml:name>

          <maml:description>

            <maml:para>Specifies a label for the submit button.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

          <dev:type>

            <maml:name>String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>Submit</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none">

        <maml:name>Action</maml:name>

        <maml:description>

          <maml:para>Specifies the action attribute. This is the URL where the form will send the data.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

        <dev:type>

          <maml:name>String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">

        <maml:name>Description</maml:name>

        <maml:description>

          <maml:para>Specifies a description for the form. This description will appear as "&lt;p&gt;" tag at the top of the form.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

        <dev:type>

          <maml:name>String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>Enter your credential</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none">

        <maml:name>PasswordLabel</maml:name>

        <maml:description>

          <maml:para>Specifies a label for the password input.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

        <dev:type>

          <maml:name>String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>Enter your password</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none">

        <maml:name>SubmitLabel</maml:name>

        <maml:description>

          <maml:para>Specifies a label for the submit button.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

        <dev:type>

          <maml:name>String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>Submit</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">

        <maml:name>Title</maml:name>

        <maml:description>

          <maml:para>Specifies a title for the form. This title will appear as "&lt;h2&gt;" tag at the top of the form. The web page title will be modified too.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

        <dev:type>

          <maml:name>String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>Credential input</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none">

        <maml:name>UsernameLabel</maml:name>

        <maml:description>

          <maml:para>Specifies a label for the username input.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

        <dev:type>

          <maml:name>String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>Enter your username</dev:defaultValue>

      </command:parameter>

    </command:parameters>

    <command:inputTypes />

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>System.Object</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para>## RELATED LINKS</maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>

        <dev:code>PS&gt; Write-CredentialForm -Action "/login"

&lt;script&gt;document.title='Credential input'&lt;/script&gt;

&lt;div class='container'&gt;

&lt;h2 class='mt-3'&gt;Credential input&lt;/h2&gt;

&lt;p&gt;Enter your credential&lt;/p&gt;

&lt;form method='post' action="/login"&gt;

&lt;div class='form-group'&gt;

&lt;label for='usernameInput'&gt;Enter your username&lt;/label&gt;

&lt;input type='text' class='form-control' id='usernameInput' name='userName' autofocus&gt;

&lt;/div&gt;

&lt;div class='form-group'&gt;

&lt;label for='passwordInput'&gt;Enter your pasword&lt;/label&gt;

&lt;input type='password' class='form-control' id='passwordInput' name='Password'&gt;

&lt;/div&gt;

&lt;button type='submit' class='btn btn-primary'&gt;Submit&lt;/button&gt;

&lt;/form&gt;

&lt;/div&gt;</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title>

        <dev:code>PS&gt; Write-CredentialForm -Action "/login" -Title "Login form" -Description "Please, enter your credential to log into the system"

&lt;script&gt;document.title='Login form'&lt;/script&gt;

&lt;div class='container'&gt;

&lt;h2 class='mt-3'&gt;Login form&lt;/h2&gt;

&lt;p&gt;Please, enter your credential to log into the system&lt;/p&gt;

&lt;form method='post' action="/login"&gt;

&lt;div class='form-group'&gt;

&lt;label for='usernameInput'&gt;Enter your username&lt;/label&gt;

&lt;input type='text' class='form-control' id='usernameInput' name='userName' autofocus&gt;

&lt;/div&gt;

&lt;div class='form-group'&gt;

&lt;label for='passwordInput'&gt;Enter your pasword&lt;/label&gt;

&lt;input type='password' class='form-control' id='passwordInput' name='Password'&gt;

&lt;/div&gt;

&lt;button type='submit' class='btn btn-primary'&gt;Submit&lt;/button&gt;

&lt;/form&gt;

&lt;/div&gt;</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title>

        <dev:code>PS&gt; Write-CredentialForm -Action "/login" -Title "Login form" -Description "Please, enter your credential to log into the system" -UsernameLabel "Enter your computer login username" -PasswordLabel "Enter your computer login password" -SubmitLabel "Login"

&lt;script&gt;document.title='Login form'&lt;/script&gt;

&lt;div class='container'&gt;

&lt;h2 class='mt-3'&gt;Login form&lt;/h2&gt;

&lt;p&gt;Please, enter your credential to log into the system&lt;/p&gt;

&lt;form method='post' action="/login"&gt;

&lt;div class='form-group'&gt;

&lt;label for='usernameInput'&gt;Enter your computer login username&lt;/label&gt;

&lt;input type='text' class='form-control' id='usernameInput' name='userName' autofocus&gt;

&lt;/div&gt;

&lt;div class='form-group'&gt;

&lt;label for='passwordInput'&gt;Enter your computer login pasword&lt;/label&gt;

&lt;input type='password' class='form-control' id='passwordInput' name='Password'&gt;

&lt;/div&gt;

&lt;button type='submit' class='btn btn-primary'&gt;Login&lt;/button&gt;

&lt;/form&gt;

&lt;/div&gt;</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

</helpItems>