Merge pull request #17 from wcarroll/aliasUpdates

Alias updates and param validation

Tests/Public/External-Help.Tests.ps1

@@ -0,0 +1,10 @@
+$filePath = (Split-Path -Parent $MyInvocation.MyCommand.Path) -replace 'Tests', 'ZertoApiWrapper'
+$publicFiles = Get-ChildItem "$filePath" -File
+
+describe "External Help Present" {
+    foreach ($file in $publicFiles) {
+        it "External Help File Defined" {
+            Get-Content -Path $file.fullName -First 1 | should be "<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>"
+        }
+    }
+}

ZertoApiWrapper/Public/Connect-ZertoServer.ps1

@@ -7,10 +7,12 @@ function Connect-ZertoServer {
             HelpMessage = "IP address or FQDN of your Zerto Management Server"
         )]
         [ValidateNotNullOrEmpty()]
+        [Alias("server", "zvm")]
         [string]$zertoServer,
         [Parameter(
             HelpMessage = "Zerto Virtual Manager management port. Default value is 9669."
         )]
+        [Alias("port")]
         [string]$zertoPort = "9669",
         [Parameter(
             Mandatory = $true,

ZertoApiWrapper/Public/Edit-ZertoVra.ps1

@@ -6,6 +6,7 @@ function Edit-ZertoVra {
             Mandatory = $true,
             HelpMessage = "Identifier of the VRA to be updated."
         )]
+        [Alias("vraId")]
         [string]$vraIdentifier,
         [Parameter(
             HelpMessage = "Bandwidth group to assign to the VRA. If unspecified will not modify current assignment"

ZertoApiWrapper/Public/Export-ZertoVpg.ps1

@@ -1,3 +1,4 @@
+<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
 function Export-ZertoVpg {
     [cmdletbinding()]
     param(

ZertoApiWrapper/Public/Get-ZertoAlert.ps1

@@ -42,16 +42,19 @@ function Get-ZertoAlert {
             ParameterSetName = "filter",
             HelpMessage = "Returns alerts for the specified vraIdentifier"
         )]
+        [Alias("vpgId")]
         [string]$vpgIdentifier,
         [Parameter(
             ParameterSetName = "filter",
             HelpMessage = "Returns alerts for the specified siteIdentifier"
         )]
+        [Alias("siteId")]
         [string]$siteIdentifier,
         [Parameter(
             ParameterSetName = "filter",
             HelpMessage = "Returns alerts for the specified zorgIdentifier"
         )]
+        [Alias("zorgId")]
         [string]$zorgIdentifier,
         [Parameter(
             ParameterSetName = "filter",
@@ -62,6 +65,7 @@ function Get-ZertoAlert {
             ParameterSetName = "filter",
             HelpMessage = "Returns alerts for the specified helpIdentifier"
         )]
+        [Alias("helpId")]
         [string]$helpIdentifier,
         [Parameter(
             ParameterSetName = "filter",

ZertoApiWrapper/Public/Get-ZertoDatastore.ps1

@@ -2,6 +2,7 @@
 function Get-ZertoDatastore {
     [cmdletbinding( DefaultParameterSetName = "main" )]
     param(
+        [Alias("datastoreId")]
         [Parameter(
             ParameterSetName = "datastoreIdentifier",
             HelpMessage = "datastoreIdentifier or array of datastoreIdentifiers to be queried"

ZertoApiWrapper/Public/Get-ZertoEvent.ps1

@@ -16,11 +16,13 @@ function Get-ZertoEvent {
             ParameterSetName = "filter",
             HelpMessage = "The name of the VPG for which you want to return events."
         )]
+        [Alias("vpgName")]
         [string]$vpg,
         [Parameter(
             ParameterSetName = "filter",
             HelpMessage = "The identifier of the VPG for which you want to return events."
         )]
+        [Alias("vpgId")]
         [string]$vpgIdentifier,
         [Parameter( ParameterSetName = "filter",
             HelpMessage = "The type of event. For the description of events, refer to the Zerto Virtual Replication documentation about alerts and events. Please see Zerto API Documentation for possible values."
@@ -35,16 +37,19 @@ function Get-ZertoEvent {
             ParameterSetName = "filter",
             HelpMessage = "The internal site identifier for which you want to return events."
         )]
+        [Alias("siteId")]
         [string]$siteIdentifier,
         [Parameter(
             ParameterSetName = "filter",
             HelpMessage = "The identifier of the ZORG, Zerto organization, defined in the Zerto Cloud Manager for which you want to return results."
         )]
+        [Alias("zorgId")]
         [string]$zorgIdentifier,
         [Parameter(
             ParameterSetName = "filter",
-            HelpMessage = "The type of entity for which you wish to return results. Possible Values are: '0' or 'VPG', '1' or 'VRA', '2' or 'Unknown', or '3' or 'Site'"
+            HelpMessage = "The type of entity for which you wish to return results. Possible Values are: 'VPG', 'VRA', 'Unknown', or 'Site'"
         )]
+        [ValidateSet("VPG", "VRA", "Unknown", "Site")]
         [string]$entityType,
         [Parameter(
             ParameterSetName = "filter",
@@ -53,18 +58,21 @@ function Get-ZertoEvent {
         [string]$userName,
         [Parameter(
             ParameterSetName = "filter",
-            HelpMessage = "The type of event to return. This filter behaves in the same way as the eventCategory filter. Possible Values are: Possible Values are: '0' or 'All', '1' or 'Events', '2' or 'Alerts'"
+            HelpMessage = "The type of event to return. This filter behaves in the same way as the eventCategory filter. Possible Values are: Possible Values are: 'All', 'Events', 'Alerts'"
         )]
+
         [string]$category,
         [Parameter(
             ParameterSetName = "filter",
-            HelpMessage = " This filter behaves in the same way as the category filter. If both category and eventCategory filters are specified, only the category filter value is used and the eventCategory filter value is ignored. The type of event to return. Possible Values are: '0' or 'All', '1' or 'Events', '2' or 'Alerts'"
+            HelpMessage = " This filter behaves in the same way as the category filter. If both category and eventCategory filters are specified, only the category filter value is used and the eventCategory filter value is ignored. The type of event to return. Possible Values are: 'All', 'Events', 'Alerts'"
         )]
+        [ValidateSet("All", "Events", "Alerts")]
         [string]$eventCategory,
         [Parameter(
             ParameterSetName = "filter",
             HelpMessage = "The internal alert identifier for the Event"
         )]
+        [Alias("alertId")]
         [string]$alertIdentifier,
         [Parameter(
             ParameterSetName = "eventId",

ZertoApiWrapper/Public/Get-ZertoPeerSite.ps1

@@ -15,6 +15,7 @@ function Get-ZertoPeerSite {
             ValueFromPipelineByPropertyName = $true,
             HelpMessage = "The identifier(s) of the peer site(s) for which information is to be returned."
         )]
+        [Alias("siteId")]
         [string[]]$siteIdentifier,
         [Parameter(
             ParameterSetName = "filter",

ZertoApiWrapper/Public/Get-ZertoProtectedVm.ps1

@@ -9,6 +9,7 @@ function Get-ZertoProtectedVm {
             ValueFromPipelineByPropertyName = $true,
             HelpMessage = "vmIdentifier(s) for which to return information"
         )]
+        [Alias("vmId")]
         [string[]]$vmIdentifier,
         [Parameter(
             ParameterSetName = "filter",
@@ -37,8 +38,9 @@ function Get-ZertoProtectedVm {
         [string]$organizationName,
         [Parameter(
             ParameterSetName = "filter",
-            HelpMessage = "The priority specified for the VPG. Possible values are: '0' or 'Low', '1' or 'Medium', '2' or 'High'"
+            HelpMessage = "The priority specified for the VPG. Possible values are: 'Low', 'Medium', or 'High'"
         )]
+        [ValidateSet("Low", "Medium", "High")]
         [string]$priority,
         [Parameter(
             ParameterSetName = "filter",
@@ -54,11 +56,13 @@ function Get-ZertoProtectedVm {
             ParameterSetName = "filter",
             HelpMessage = "The identifier of the protected site where the VPG virtual machines are protected."
         )]
+        [Alias("protectedSiteId")]
         [string]$protectedSiteIdentifier,
         [Parameter(
             ParameterSetName = "filter",
             HelpMessage = "The identifier of the recovery site where the VPG virtual machines are recovered."
         )]
+        [Alias("recoverySiteId")]
         [string]$recoverySiteIdentifier
     )
 

ZertoApiWrapper/Public/Get-ZertoRecoveryReport.ps1

@@ -36,6 +36,7 @@ function Get-ZertoRecoveryReport {
             ParameterSetName = "filter",
             HelpMessage = "The type of recovery operations. Possible values are: 'Failover', 'Failover Test', or 'Move'"
         )]
+        [ValidateSet("Failover", "Failover Test", "Move")]
         [string]$recoveryType,
         [Parameter(
             ParameterSetName = "filter",

ZertoApiWrapper/Public/Get-ZertoServiceProfile.ps1

@@ -6,6 +6,7 @@ function Get-ZertoServiceProfile {
             ParameterSetName = "siteIdentifier",
             HelpMessage = "The identifier of the site for which service profiles should be returned."
         )]
+        [Alias("siteId")]
         [string]$siteIdentifier,
         [Parameter(
             ParameterSetName = "serviceProfileId",

ZertoApiWrapper/Public/Get-ZertoTask.ps1

@@ -6,6 +6,7 @@ function Get-ZertoTask {
             ParameterSetName = "taskIdentifier",
             HelpMessage = "The identifier(s) for which task information is to be returned."
         )]
+        [Alias("taskId")]
         [string[]]$taskIdentifier,
         [Parameter(
             ParameterSetName = "types",
@@ -39,8 +40,9 @@ function Get-ZertoTask {
         [string]$type,
         [Parameter(
             ParameterSetName = "filter",
-            HelpMessage = "The status of the task. Possible values are: '1' or 'InProgress', '3' or 'Paused', '4' or 'Failed', '6' or 'Completed', '7' or 'Cancelling'"
+            HelpMessage = "The status of the task. Possible values are: 'InProgress', 'Paused', 'Failed', 'Completed', or 'Cancelling'"
         )]
+        [ValidateSet("InProgress", "Paused", "Failed", "Completed", "Cancelling")]
         [string]$status
     )
 

ZertoApiWrapper/Public/Get-ZertoVirtualizationSite.ps1

@@ -52,6 +52,7 @@ function Get-ZertoVirtualizationSite {
             Mandatory = $true,
             HelpMessage = "The identifier of the Zerto Virtual Manager site."
         )]
+        [Alias("siteId")]
         [string]$siteIdentifier,
         [Parameter(
             ParameterSetName = "datastoreClusters",
@@ -81,6 +82,7 @@ function Get-ZertoVirtualizationSite {
             Mandatory = $false,
             HelpMessage = "The identifier of the host at the selected site to return information for only one host."
         )]
+        [Alias("hostId")]
         [string]$hostIdentifier,
         [Parameter(
             ParameterSetName = "folders",

ZertoApiWrapper/Public/Get-ZertoVolume.ps1

@@ -11,21 +11,25 @@ function Get-ZertoVolume {
             ParameterSetName = "filter",
             HelpMessage = "The identifier of the VPG."
         )]
+        [Alias("vpgId")]
         [string]$vpgIdentifier,
         [Parameter(
             ParameterSetName = "filter",
             HelpMessage = "The identifier of the datastore."
         )]
+        [Alias("datastoreId", "dsId")]
         [string]$datastoreIdentifier,
         [Parameter(
             ParameterSetName = "filter",
             HelpMessage = "The identifier of the protected virtual machine."
         )]
+        [Alias("protectedVmId")]
         [string]$protectedVmIdentifier,
         [Parameter(
             ParameterSetName = "filter",
             HelpMessage = "The identifier of the owning virtual machine."
         )]
+        [Alias("owningVmId")]
         [string]$owningVmIdentifier
     )
 

ZertoApiWrapper/Public/Get-ZertoVpg.ps1

@@ -17,6 +17,7 @@ function Get-ZertoVpg {
             Mandatory = $true,
             HelpMessage = "The identifier(s) of the Virtual Protection Group to return"
         )]
+        [Alias("vpgId", "protectionGroupId", "pgId")]
         [string[]]$protectionGroupIdentifier,
         [Parameter(
             ParameterSetName = "checkpoints",
@@ -129,8 +130,9 @@ function Get-ZertoVpg {
         [string]$zorgIdentifier,
         [Parameter(
             ParameterSetName = "filter",
-            HelpMessage = "The VPG priority. Possible values are: '0' or 'Low', '1' or 'Medium', '2' or 'High'"
+            HelpMessage = "The VPG priority. Possible values are: 'Low', 'Medium', 'High'"
         )]
+        [ValidateSet("Low", "Medium", "High")]
         [string]$priority,
         [Parameter(
             ParameterSetName = "filter",

ZertoApiWrapper/Public/Get-ZertoVpgSetting.ps1

@@ -131,6 +131,7 @@ function Get-ZertoVpgSetting {
             Mandatory = $true,
             HelpMessage = "The identifier of the VPG settings object for which information is retrieved."
         )]
+        [Alias("vpgSettingsId", "settingsId")]
         [string]$vpgSettingsIdentifier,
         [Parameter(
             ParameterSetName = "backup",
@@ -229,6 +230,7 @@ function Get-ZertoVpgSetting {
             Mandatory = $true,
             HelpMessage = "VM Identifier"
         )]
+        [Alias("vmId")]
         [string]$vmIdentifier,
         [Parameter(
             ParameterSetName = "nics",
@@ -241,6 +243,7 @@ function Get-ZertoVpgSetting {
             Mandatory = $true,
             HelpMessage = "Return NIC information for specified NIC of the specified VM"
         )]
+        [Alias("nicId")]
         [string]$nicIdentifier,
         [Parameter(
             ParameterSetName = "volumes",
@@ -253,6 +256,7 @@ function Get-ZertoVpgSetting {
             Mandatory = $true,
             HelpMessage = "Return volume information for the specified volume of the specified VM"
         )]
+        [Alias("volumeId")]
         [string]$volumeIdentifier
     )
 

ZertoApiWrapper/Public/Get-ZertoVra.ps1

@@ -18,6 +18,7 @@ function Get-ZertoVra {
             ParameterSetName = "vraIdentifier",
             HelpMessage = "Returns information for provided VRA identifier(s)"
         )]
+        [Alias("vraId")]
         [string[]]$vraIdentifier,
         [Parameter(
             ParameterSetName = "filter",

ZertoApiWrapper/Public/Get-ZertoZorg.ps1

@@ -6,6 +6,7 @@ function Get-ZertoZorg {
             ParameterSetName = "zorgIdentifier",
             HelpMessage = "Identifier(s) of the ZORG."
         )]
+        [Alias("zorgId")]
         [string[]]$zorgIdentifier
     )
 

ZertoApiWrapper/Public/Get-ZertoZsspSession.ps1

@@ -6,6 +6,7 @@ function Get-ZertoZsspSession {
             ParameterSetName = "zsspSessionIdentifier",
             HelpMessage = "ZSSP Session Id(s) to get information."
         )]
+        [Alias("zsspSessionId")]
         [string[]]$zsspSessionIdentifier
     )
 

ZertoApiWrapper/Public/Import-ZertoVpg.ps1

@@ -1,3 +1,4 @@
+<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
 function Import-ZertoVpg {
     [cmdletbinding()]
     param(

ZertoApiWrapper/Public/Install-ZertoVra.ps1

@@ -1,5 +1,5 @@
-#TODO - Add ability to installed with root password.
 <# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
+#TODO - Add ability to installed with root password.
 function Install-ZertoVra {
     [cmdletbinding( SupportsShouldProcess = $true )]
     param(

ZertoApiWrapper/Public/Invoke-ZertoFailover.ps1

@@ -10,13 +10,15 @@ function Invoke-ZertoFailover {
         [Parameter(
             HelpMessage = "Checkpoint Identifier to use as the Point-In-Time to rollback to."
         )]
+        [Alias("checkpointId")]
         [string]$checkpointIdentifier,
         [Parameter(
-            HelpMessage = "0: After the seconds specified in the commitValue setting have elapsed, the failover is rolled back.
+            HelpMessage = "'Rollback': After the seconds specified in the commitValue setting have elapsed, the failover is rolled back.
-            1: After the seconds specified in the commitValue setting have elapsed, the failover continues, committing the virtual machines in the recovery site.
+            'Commit': After the seconds specified in the commitValue setting have elapsed, the failover continues, committing the virtual machines in the recovery site.
-            2: The virtual machines in the VPG being failed over remain in the Before Commit state until either they are committed with Commit a failover, or rolled back with Roll back a failover.
+            'None': The virtual machines in the VPG being failed over remain in the Before Commit state until either they are committed with Commit a failover, or rolled back with Roll back a failover.
             Default is the Site Settings setting."
         )]
+        [ValidateSet("Rollback", "Commit", "None")]
         [string]$commitPolicy,
         [Parameter(
             HelpMessage = "The amount of time in seconds the failover waits in a Before Commit state to enable checking that the failover is as required before performing the commitPolicy setting. Default is the Site Setting"
@@ -27,6 +29,7 @@ function Invoke-ZertoFailover {
         1: If the protected virtual machines have VMware Tools or Microsoft Integration Services available, the virtual machines are gracefully shut down, otherwise the failover operation fails. This is similar to performing a Move operation to a specified checkpoint.
         2: The protected virtual machines are forcibly shut down before starting the failover. If the protected virtual machines have VMware Tools or Microsoft Integration Services available, the procedure waits five minutes for the virtual machines to be gracefully shut down before forcibly powering them off. This is similar to performing a Move operation to a specified checkpoint."
         )]
+        [ValidateSet(0, 1, 2)]
         [int]$shutdownPolicy = 0,
         [Parameter(
             HelpMessage = "Time, in seconds, before VMs are forcibly turned off if the Force Shutdown option is seclected after attempting to gracefully shut down the VMs"
@@ -38,7 +41,7 @@ function Invoke-ZertoFailover {
         )]
         [bool]$reverseProtection,
         [Parameter(
-            HelpMessage = "Name(s) of VMs in the "
+            HelpMessage = "Name(s) of VMs in the VPG to failover"
         )]
         [string[]]$vmName
     )

ZertoApiWrapper/Public/Invoke-ZertoMove.ps1

@@ -8,8 +8,12 @@ function Invoke-ZertoMove {
         )]
         [string[]]$vpgName,
         [Parameter(
-            HelpMessage = "The policy to use after the move enters a 'Before Commit' state. If omitted, the site settings default will be applied. Valid values are: '0' or 'Rollback', '1' or 'Commit', '2' or 'None'. Please see Zerto API Documentation for additional information."
+            HelpMessage = "'Rollback': After the seconds specified in the commitValue setting have elapsed, the failover is rolled back.
+            'Commit': After the seconds specified in the commitValue setting have elapsed, the failover continues, committing the virtual machines in the recovery site.
+            'None': The virtual machines in the VPG being failed over remain in the Before Commit state until either they are committed with Commit a failover, or rolled back with Roll back a failover.
+            Default is the Site Settings setting."
         )]
+        [ValidateSet("Rollback", "Commit", "None")]
         [string]$commitPolicy,
         [Parameter(
             HelpMessage = "The amount of time, in seconds, the Move is in a 'Before Commit' state, before performing the commitPolicy setting. If omitted, the site settings default will be applied."
@@ -76,4 +80,4 @@ function Invoke-ZertoMove {
     end {
         # Nothing to do.
     }
-}
+}

ZertoApiWrapper/Public/New-ZertoVpg.ps1

@@ -21,7 +21,8 @@ function New-ZertoVpg {
             HelpMessage = "Name(s) of the VM(s) to be protected.",
             Mandatory = $true
         )]
-        [ValidateNotNullOrEmpty()][string[]]$protectedVm,
+        [ValidateNotNullOrEmpty()]
+        [string[]]$protectedVm,
         [Parameter(
             HelpMessage = "Name of the site where the VM(s) will be recovered",
             Mandatory = $true
@@ -100,11 +101,13 @@ function New-ZertoVpg {
         [Parameter(
             HelpMessage = "RPO alert"
         )]
-        [ValidateRange(60, 864200)][Int32]$rpoInSeconds = 300,
+        [ValidateRange(60, 864200)]
+        [Int32]$rpoInSeconds = 300,
         [Parameter(
             HelpMessage = "Minimum test interval for this VPG. Valid values are 0: Off, 43200: 1 Month, 131040: 3 Months, 262080: 6 Months, 294560: 9 Months, 252600: 12 Months"
         )]
-        [ValidateSet(0, 43200, 131040, 262080, 294560, 252600)][int]$testIntervalInMinutes = 262080,
+        [ValidateSet(0, 43200, 131040, 262080, 294560, 252600)]
+        [int]$testIntervalInMinutes = 262080,
         [Parameter(
             HelpMessage = "Service profile name to use."
         )]

ZertoApiWrapper/Public/New-ZertoVpgSettingsIdentifier.ps1

@@ -1,3 +1,4 @@
+<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
 function New-ZertoVpgSettingsIdentifier {
     [cmdletbinding()]
     param(
@@ -8,6 +9,7 @@ function New-ZertoVpgSettingsIdentifier {
             ValueFromPipeline = $true,
             ValueFromPipelineByPropertyName = $true
         )]
+        [Alias("vpgId")]
         [string]$vpgIdentifier,
         [Parameter(
             HelpMessage = "Use this switch when creating a vpgSettingsIdentifier for a new VPG",

ZertoApiWrapper/Public/Remove-ZertoVpg.ps1

@@ -17,15 +17,16 @@ function Remove-ZertoVpg {
             ValueFromPipelineByPropertyName = $true,
             HelpMessage = "vpgIdentifier(s) of the VPG(s) to delete."
         )]
+        [Alias("vpgId")]
         [string[]]$vpgidentifier,
         [Parameter(
             HelpMessage = "Use this parameter to keep the recovery volumes at the target site, by setting it to True.  If the virtual machines in the deleted VPG are reprotected, these volumes can be used as preseeded volumes to speed up the initial synchronization of the new VPG. Default is to remove Recovery Volumes"
         )]
-        [switch]$keepRecoveryVolumes = $false,
+        [switch]$keepRecoveryVolumes,
         [Parameter(
             HelpMessage = "Use this parameter to force delete the VPG, by setting this parameter equal to true."
         )]
-        [switch]$force = $false
+        [switch]$force
     )
 
     begin {

ZertoApiWrapper/Public/Save-ZertoVpgSettings.ps1

@@ -10,6 +10,7 @@ function Save-ZertoVpgSettings {
             ValueFromPipeline = $true,
             ValueFromPipelineByPropertyName = $true
         )]
+        [Alias("vpgSettingsId")]
         [string]$vpgSettingsIdentifier
     )
 
@@ -17,4 +18,4 @@ function Save-ZertoVpgSettings {
     if ($PSCmdlet.ShouldProcess("Commiting VPG Settings with Settigns identifier $vpgSettingsIdentifier")) {
         Invoke-ZertoRestRequest -uri $baseUri -method "POST"
     }
-}
+}

ZertoApiWrapper/Public/Set-ZertoAlert.ps1

@@ -9,6 +9,7 @@ function Set-ZertoAlert {
             Mandatory = $true,
             HelpMessage = "Alert identifier(s) to be dismissed or undismissed."
         )]
+        [Alias("alertIdentifier")]
         [string[]]$alertId,
         [Parameter(
             ParameterSetName = "dismiss",
@@ -40,4 +41,4 @@ function Set-ZertoAlert {
     end {
         # Nothing to do.
     }
-}
+}

ZertoApiWrapper/Public/Start-ZertoCloneVpg.ps1

@@ -10,6 +10,7 @@ function Start-ZertoCloneVpg {
         [Parameter(
             HelpMessage = "The identifier of the checkpoint to use for cloning. If unspecified, the latest checkpoint will be used."
         )]
+        [Alias("checkpointId")]
         [string]$checkpointIdentifier,
         [Parameter(
             HelpMessage = "The datastore name where the clone is to be created. If unspecified, will auto select the datastore with the most free space."

ZertoApiWrapper/Public/Start-ZertoFailoverTest.ps1

@@ -10,6 +10,7 @@ function Start-ZertoFailoverTest {
         [Parameter(
             HelpMessage = "The identifier of the checkpoint to use for testing. If unspecified, the latest checkpoint will be used."
         )]
+        [Alias("checkpointId")]
         [string]$checkpointIdentifier,
         [Parameter(
             HelpMessage = "The name(s) of the VMs within the selected VPG you wish to test. If unspecified, all VMs in the VPG will be tested."

docs/Connect-ZertoServer.md

@@ -68,7 +68,7 @@ Default value is 9669.
 ```yaml
 Type: String
 Parameter Sets: (All)
-Aliases:
+Aliases: port
 
 Required: False
 Position: 1
@@ -83,7 +83,7 @@ IP address or FQDN of your Zerto Management Server
 ```yaml
 Type: String
 Parameter Sets: (All)
-Aliases:
+Aliases: server, zvm
 
 Required: True
 Position: 0

docs/Edit-ZertoVra.md

@@ -110,7 +110,7 @@ Identifier of the VRA to be updated.
 ```yaml
 Type: String
 Parameter Sets: (All)
-Aliases:
+Aliases: vraId
 
 Required: True
 Position: Named

docs/Get-ZertoAlert.md

@@ -164,7 +164,7 @@ Returns alerts for the specified helpIdentifier
 ```yaml
 Type: String
 Parameter Sets: filter
-Aliases:
+Aliases: helpId
 
 Required: False
 Position: Named
@@ -239,7 +239,7 @@ Returns alerts for the specified siteIdentifier
 ```yaml
 Type: String
 Parameter Sets: filter
-Aliases:
+Aliases: siteId
 
 Required: False
 Position: Named
@@ -270,7 +270,7 @@ Returns alerts for the specified vraIdentifier
 ```yaml
 Type: String
 Parameter Sets: filter
-Aliases:
+Aliases: vpgId
 
 Required: False
 Position: Named
@@ -285,7 +285,7 @@ Returns alerts for the specified zorgIdentifier
 ```yaml
 Type: String
 Parameter Sets: filter
-Aliases:
+Aliases: zorgId
 
 Required: False
 Position: Named

docs/Get-ZertoDatastore.md

@@ -49,7 +49,7 @@ datastoreIdentifier or array of datastoreIdentifiers to be queried
 ```yaml
 Type: String[]
 Parameter Sets: datastoreIdentifier
-Aliases:
+Aliases: datastoreId
 
 Required: False
 Position: Named

docs/Get-ZertoEvent.md

@@ -81,7 +81,7 @@ The internal alert identifier for the Event
 ```yaml
 Type: String
 Parameter Sets: filter
-Aliases:
+Aliases: alertId
 
 Required: False
 Position: Named
@@ -106,9 +106,7 @@ Accept wildcard characters: False
 ```
 
 ### -category
-The type of event to return.
+The type of event to return. This filter behaves in the same way as the eventCategory filter. Possible Values are: Possible Values are: 'All', 'Events', 'Alerts'
-This filter behaves in the same way as the eventCategory filter.
-Possible Values are: Possible Values are: '0' or 'All', '1' or 'Events', '2' or 'Alerts'
 
 ```yaml
 Type: String
@@ -155,8 +153,7 @@ Accept wildcard characters: False
 ```
 
 ### -entityType
-The type of entity for which you wish to return results.
+The type of entity for which you wish to return results. Possible Values are: 'VPG', 'VRA', 'Unknown', or 'Site'
-Possible Values are: '0' or 'VPG', '1' or 'VRA', '2' or 'Unknown', or '3' or 'Site'
 
 ```yaml
 Type: String
@@ -171,10 +168,7 @@ Accept wildcard characters: False
 ```
 
 ### -eventCategory
-This filter behaves in the same way as the category filter.
+This filter behaves in the same way as the category filter. If both category and eventCategory filters are specified, only the category filter value is used and the eventCategory filter value is ignored. The type of event to return. Possible Values are: 'All', 'Events', 'Alerts'
-If both category and eventCategory filters are specified, only the category filter value is used and the eventCategory filter value is ignored.
-The type of event to return.
-Possible Values are: '0' or 'All', '1' or 'Events', '2' or 'Alerts'
 
 ```yaml
 Type: String
@@ -226,7 +220,7 @@ The internal site identifier for which you want to return events.
 ```yaml
 Type: String
 Parameter Sets: filter
-Aliases:
+Aliases: siteId
 
 Required: False
 Position: Named
@@ -304,7 +298,7 @@ The name of the VPG for which you want to return events.
 ```yaml
 Type: String
 Parameter Sets: filter
-Aliases:
+Aliases: vpgName
 
 Required: False
 Position: Named
@@ -319,7 +313,7 @@ The identifier of the VPG for which you want to return events.
 ```yaml
 Type: String
 Parameter Sets: filter
-Aliases:
+Aliases: vpgId
 
 Required: False
 Position: Named
@@ -334,7 +328,7 @@ The identifier of the ZORG, Zerto organization, defined in the Zerto Cloud Manag
 ```yaml
 Type: String
 Parameter Sets: filter
-Aliases:
+Aliases: zorgId
 
 Required: False
 Position: Named

docs/Get-ZertoPeerSite.md

@@ -152,7 +152,7 @@ The identifier(s) of the peer site(s) for which information is to be returned.
 ```yaml
 Type: String[]
 Parameter Sets: siteIdentifier
-Aliases:
+Aliases: siteId
 
 Required: True
 Position: Named

docs/Get-ZertoProtectedVm.md

@@ -82,8 +82,7 @@ Accept wildcard characters: False
 ```
 
 ### -priority
-The priority specified for the VPG.
+The priority specified for the VPG. Possible values are: 'Low', 'Medium', or 'High'
-Possible values are: '0' or 'Low', '1' or 'Medium', '2' or 'High'
 
 ```yaml
 Type: String
@@ -103,7 +102,7 @@ The identifier of the protected site where the VPG virtual machines are protecte
 ```yaml
 Type: String
 Parameter Sets: filter
-Aliases:
+Aliases: protectedSiteId
 
 Required: False
 Position: Named
@@ -134,7 +133,7 @@ The identifier of the recovery site where the VPG virtual machines are recovered
 ```yaml
 Type: String
 Parameter Sets: filter
-Aliases:
+Aliases: recoverySiteId
 
 Required: False
 Position: Named
@@ -198,7 +197,7 @@ vmIdentifier(s) for which to return information
 ```yaml
 Type: String[]
 Parameter Sets: vmIdentifier
-Aliases:
+Aliases: vmId
 
 Required: True
 Position: Named

docs/Get-ZertoServiceProfile.md

@@ -62,7 +62,7 @@ The identifier of the site for which service profiles should be returned.
 ```yaml
 Type: String
 Parameter Sets: siteIdentifier
-Aliases:
+Aliases: siteId
 
 Required: False
 Position: Named

docs/Get-ZertoTask.md

@@ -123,8 +123,7 @@ Accept wildcard characters: False
 ```
 
 ### -status
-The status of the task.
+The status of the task. Possible values are: 'InProgress', 'Paused', 'Failed', 'Completed', or 'Cancelling'
-Possible values are: '1' or 'InProgress', '3' or 'Paused', '4' or 'Failed', '6' or 'Completed', '7' or 'Cancelling'
 
 ```yaml
 Type: String
@@ -144,7 +143,7 @@ The identifier(s) for which task information is to be returned.
 ```yaml
 Type: String[]
 Parameter Sets: taskIdentifier
-Aliases:
+Aliases: taskId
 
 Required: False
 Position: Named

docs/Get-ZertoVirtualizationSite.md

@@ -162,7 +162,7 @@ The identifier of the host at the selected site to return information for only o
 ```yaml
 Type: String
 Parameter Sets: devices, hosts
-Aliases:
+Aliases: hostId
 
 Required: False
 Position: Named
@@ -223,7 +223,7 @@ The identifier of the Zerto Virtual Manager site.
 ```yaml
 Type: String
 Parameter Sets: folders, devices, vms, resourcePools, networks, hosts, hostClusters, datastores, datastoreClusters, siteIdentifier
-Aliases:
+Aliases: siteId
 
 Required: True
 Position: Named

docs/Get-ZertoVolume.md

@@ -57,7 +57,7 @@ The identifier of the datastore.
 ```yaml
 Type: String
 Parameter Sets: filter
-Aliases:
+Aliases: datastoreId, dsId
 
 Required: False
 Position: Named
@@ -72,7 +72,7 @@ The identifier of the owning virtual machine.
 ```yaml
 Type: String
 Parameter Sets: filter
-Aliases:
+Aliases: owningVmId
 
 Required: False
 Position: Named
@@ -87,7 +87,7 @@ The identifier of the protected virtual machine.
 ```yaml
 Type: String
 Parameter Sets: filter
-Aliases:
+Aliases: protectedVmId
 
 Required: False
 Position: Named
@@ -118,7 +118,7 @@ The identifier of the VPG.
 ```yaml
 Type: String
 Parameter Sets: filter
-Aliases:
+Aliases: vpgId
 
 Required: False
 Position: Named

docs/Get-ZertoVpg.md

@@ -265,8 +265,7 @@ Accept wildcard characters: False
 
 ### -priority
 
-The VPG priority.
+The VPG priority. Possible values are: 'Low', 'Medium', 'High'
-Possible values are: '0' or 'Low', '1' or 'Medium', '2' or 'High'
 
 ```yaml
 Type: String
@@ -321,7 +320,7 @@ The identifier(s) of the Virtual Protection Group to return
 ```yaml
 Type: String[]
 Parameter Sets: stats, checkpoints, protectionGroupIdentifier
-Aliases:
+Aliases: vpgId, protectionGroupId, pgId
 
 Required: True
 Position: Named

docs/Get-ZertoVpgSetting.md

@@ -249,7 +249,7 @@ Return NIC information for specified NIC of the specified VM
 ```yaml
 Type: String
 Parameter Sets: nicIdentifier
-Aliases:
+Aliases: nicId
 
 Required: True
 Position: Named
@@ -354,7 +354,7 @@ VM Identifier
 ```yaml
 Type: String
 Parameter Sets: volumeIdentifier, volumes, nicIdentifier, nics, vmIdentifier
-Aliases:
+Aliases: vmId
 
 Required: True
 Position: Named
@@ -384,7 +384,7 @@ Return volume information for the specified volume of the specified VM
 ```yaml
 Type: String
 Parameter Sets: volumeIdentifier
-Aliases:
+Aliases: volumeId
 
 Required: True
 Position: Named
@@ -414,7 +414,7 @@ The identifier of the VPG settings object for which information is retrieved.
 ```yaml
 Type: String
 Parameter Sets: volumeIdentifier, volumes, nicIdentifier, nics, vmIdentifier, vms, scripting, recovery, priority, networks, journal, bootGroup
-Aliases:
+Aliases: vpgSettingsId, settingsId
 
 Required: True
 Position: Named
@@ -426,7 +426,7 @@ Accept wildcard characters: False
 ```yaml
 Type: String
 Parameter Sets: basic, schedulerPeriod, retentionPeriod, dayOfWeek, backup, vpgSettingsIdentifier
-Aliases:
+Aliases: vpgSettingsId, settingsId
 
 Required: True
 Position: Named

docs/Get-ZertoVra.md

@@ -201,7 +201,7 @@ Returns information for provided VRA identifier(s)
 ```yaml
 Type: String[]
 Parameter Sets: vraIdentifier
-Aliases:
+Aliases: vraId
 
 Required: False
 Position: Named

docs/Get-ZertoZorg.md

@@ -49,7 +49,7 @@ Identifier(s) of the ZORG.
 ```yaml
 Type: String[]
 Parameter Sets: zorgIdentifier
-Aliases:
+Aliases: zorgId
 
 Required: False
 Position: Named

docs/Get-ZertoZsspSession.md

@@ -42,7 +42,7 @@ ZSSP Session Id(s) to get information.
 ```yaml
 Type: String[]
 Parameter Sets: zsspSessionIdentifier
-Aliases:
+Aliases: zsspSessionId
 
 Required: False
 Position: Named

docs/Invoke-ZertoFailover.md

@@ -38,7 +38,7 @@ Checkpoint Identifier to use as the Point-In-Time to rollback to.
 ```yaml
 Type: String
 Parameter Sets: (All)
-Aliases:
+Aliases: checkpointId
 
 Required: False
 Position: 1
@@ -48,11 +48,11 @@ Accept wildcard characters: False
 ```
 
 ### -commitPolicy
-0: After the seconds specified in the commitValue setting have elapsed, the failover is rolled back.
+'Rollback': After the seconds specified in the commitValue setting have elapsed, the failover is rolled back.
 
-1: After the seconds specified in the commitValue setting have elapsed, the failover continues, committing the virtual machines in the recovery site.
+'Commit': After the seconds specified in the commitValue setting have elapsed, the failover continues, committing the virtual machines in the recovery site.
 
-2: The virtual machines in the VPG being failed over remain in the Before Commit state until either they are committed with Commit a failover, or rolled back with Roll back a failover.
+'None': The virtual machines in the VPG being failed over remain in the Before Commit state until either they are committed with Commit a failover, or rolled back with Roll back a failover.
 
 Default is the Site Settings setting.
 
@@ -143,7 +143,7 @@ Accept wildcard characters: False
 ```
 
 ### -vmName
-Name(s) of VMs in the
+Name(s) of VMs in the VPG to failover
 
 ```yaml
 Type: String[]

docs/Invoke-ZertoMove.md

@@ -33,10 +33,13 @@ Starts a move operation of VPG "MyVpg"
 ## PARAMETERS
 
 ### -commitPolicy
-The policy to use after the move enters a 'Before Commit' state.
+'Rollback': After the seconds specified in the commitValue setting have elapsed, the failover is rolled back.
-If omitted, the site settings default will be applied.
+
-Valid values are: '0' or 'Rollback', '1' or 'Commit', '2' or 'None'.
+'Commit': After the seconds specified in the commitValue setting have elapsed, the failover continues, committing the virtual machines in the recovery site.
-Please see Zerto API Documentation for additional information.
+
+'None': The virtual machines in the VPG being failed over remain in the Before Commit state until either they are committed with Commit a failover, or rolled back with Roll back a failover.
+
+Default is the Site Settings setting.
 
 ```yaml
 Type: String

docs/New-ZertoVpgSettingsIdentifier.md

@@ -66,7 +66,7 @@ This would be used for creating a new VPG from scratch.
 ```yaml
 Type: String
 Parameter Sets: existingVpg
-Aliases:
+Aliases: vpgId
 
 Required: True
 Position: Named

docs/Remove-ZertoVpg.md

@@ -103,7 +103,7 @@ vpgIdentifier(s) of the VPG(s) to delete.
 ```yaml
 Type: String[]
 Parameter Sets: vpgIdentifier
-Aliases:
+Aliases: vpgId
 
 Required: True
 Position: Named

docs/Save-ZertoVpgSettings.md

@@ -36,7 +36,7 @@ VpgSettings Identifier to save
 ```yaml
 Type: String
 Parameter Sets: (All)
-Aliases:
+Aliases: vpgSettingsId
 
 Required: True
 Position: 0

docs/Set-ZertoAlert.md

@@ -49,7 +49,7 @@ Alert identifier(s) to be dismissed or undismissed.
 ```yaml
 Type: String[]
 Parameter Sets: (All)
-Aliases: identifier
+Aliases: alertIdentifier, identifier
 
 Required: True
 Position: Named

docs/Start-ZertoCloneVpg.md

@@ -38,7 +38,7 @@ If unspecified, the latest checkpoint will be used.
 ```yaml
 Type: String
 Parameter Sets: (All)
-Aliases:
+Aliases: checkpointId
 
 Required: False
 Position: 1

docs/Start-ZertoFailoverTest.md

@@ -38,7 +38,7 @@ If unspecified, the latest checkpoint will be used.
 ```yaml
 Type: String
 Parameter Sets: (All)
-Aliases:
+Aliases: checkpointId
 
 Required: False
 Position: 1