Update GET-HELP script (#6)

Author: haanmoj

XAXD/VMsInUnknownPowerState/Get-VmInUnknownPowerState.ps1

@@ -1,4 +1,49 @@
-Param([string]$HypervisorConnectionName, [string]$BrokerCatalogName, [switch]$Fix)
+<#
+.SYNOPSIS
+    Diagnosing and (semi-) automatically resolving VMs on Citrix Virtual Apps and Desktops (CVAD) in an unknown power state. 
+.DESCRIPTION
+    Get-ProvVmInUnknownPowerState diagnoses the VMs on CVAD in an unknown power state, reports the causes, and (semi-) automatically fixes the causes. 
+    Specifically, Get-ProvVmInUnknownPowerState utilizes the names of VMs on CVAD to find the corresponding VMs on hypervisors and check three scenarios below that can make the power state of the VMs unknown.
+        Scenario 1: the state of the hypervisor connection is unavailable. such as connection credentials being invalid.
+        Scenario 2: the VMs on the hypervisor are deleted.
+        Scenario 3: the IDs of VMs on CVAD mismatches the corresponding IDs of the VM on hypervisors. 
+
+    In case of scenario 1 and 2, Get-ProvVmInUnknownPowerState reports the causes of the unknown power state and provide suggestions to help admins fix the issues, such as correcting the credentials or deleting the VMs on CVAD. 
+    In the case of scenario 3, Get-ProvVmInUnknownPowerState reports the causes and suggestions. 
+    If the "-Fix" parameter is specified, Get-ProvVmInUnknownPowerState fixes the causes of scenario 3 automatically.
+    The scenario 1, 2, and 3 are exclusive. If the connection is unavailable, it is not possible to access the hypervisor; consequently, check whether the corresponding VM on the hypervisor is deleted or the IDs are matched.
+.INPUTS
+    Get-ProvVmInUnknownPowerState can take a hypervisor connection name, a broker catalog name, and/or "-Fix" as input.
+.OUTPUTS
+    1. If either a hypervisor connection name or a broker catalog is given, then Get-ProvVmInUnknownPowerState reports the VMs in an unknown power state associated with the hypervisor connection name or the broker catalog.
+    2. If both a hypervisor connection name and a broker catalog are given, then Get-ProvVmInUnknownPowerState reports the VMs associated with the broker catalog, because the VMs on the catalog is a subset of the VMs on the hypervisor connection
+    3. Without the "-Fix" parameter, the admin can get the report that includes the list of the VMs with the unknown power states together with the causes and suggestions.
+    4. With the parameter "-Fix", the admin can get the report, and the script automatically resolved the issue of scenario 3 by updating the IDs of VMs. 
+.PARAMETER HypervisorConnectionName
+    The name of the hypervisor connection. Report the VMs associated with the hypervisor connection.
+.PARAMETER BrokerCatalogName
+    The name of the broker catalogue name. Report the VMs associated with the catalog.
+.PARAMETER Fix
+    Update the UUIDs of VMs automatically to resolve the mismatched UUID issue.
+.NOTES
+    Version      : 1.0.1
+    Author       : Citrix Systems, Inc.
+.EXAMPLE
+    Get-ProvVmInUnknownPowerState
+.EXAMPLE
+    Get-ProvVmInUnknownPowerState -Fix
+.EXAMPLE
+    Get-ProvVmInUnknownPowerState -HypervisorConnectionName "ExampleConnectionName" -Fix
+#>
+
+Param(
+    [Parameter(Mandatory=$false)]
+    [string]$HypervisorConnectionName,
+    [Parameter(Mandatory=$false)]
+    [string]$BrokerCatalogName, 
+    [Parameter(Mandatory=$false)]
+    [switch]$Fix
+)
 
 # Add XDHyp
 Add-PSSnapin -Name "Citrix.Broker.Admin.V2","Citrix.Host.Admin.V2"