Merge pull request #114 from ZertoPublic/wcarroll/where-fix

Wcarroll/where fix

CHANGELOG.md

@@ -5,6 +5,36 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project is transitioning to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.5.3]
+
+### Zerto Virtual Manager
+
+#### Fixed
+
+* Fixed an [issue](https://github.com/ZertoPublic/ZertoApiWrapper/issues/112) where `New-ZertoVpg` would fail when specifying the local site as the target site.
+* Updated the method where a Site Identifer is obtained during the `New-ZertoVpg` execution that would occasionally fail on some versions of PowerShell.
+
+#### Updated
+
+* Updated `New-ZertoVpg` function [help documentation](https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/New-ZertoVpg.md) to more clearly specify the return value and the requirement to pass it into the `Save-ZertoVpgSetting` function to commit the VPG.
+
+## [1.5.2]
+
+### Zerto Virtual Manager
+
+#### Fixed
+
+* Fixed an issue when attempting to export more than 100 VPGs with the `Export-ZertoVpg` function that would cause an error.
+
+## [1.5.1]
+
+### Zerto Virtual Manager
+
+#### Fixed
+
+* Fixed an [issue](https://github.com/ZertoPublic/ZertoApiWrapper/issues/108) with `New-ZertoVpg` where when specifying a single host as a recovery target, the host identifier was not properly assigned. - Thanks @jonsouzerto!
+* Fixed an [issue](https://github.com/ZertoPublic/ZertoApiWrapper/issues/86) with `Invoke-ZertoMoveVpg` where parameters should have been mandatory in certain workflows. - Thanks @gdbarron!
+
 ## [1.5.0]
 
 ### Zerto Virtual Manager

Tests/Public/Export-ZertoVpg.Tests.ps1

@@ -46,6 +46,10 @@ Describe $global:function -Tag 'Unit', 'Source', 'Built' {
             return "1024d377-afb8-4880-82f0-96eeff413ffd"
         }
 
+        Mock -ModuleName ZertoApiWrapper -CommandName Remove-ZertoVpgSettingsIdentifier {
+            return $null
+        }
+
         Mock -ModuleName ZertoApiWrapper -CommandName Get-ZertoVpgSetting {
             $returnObj = @{
                 Backup                = $null

Tests/Public/Invoke-ZertoMove.Tests.ps1

@@ -5,17 +5,18 @@ $global:function = ((Split-Path -leaf $PSCommandPath).Split('.'))[0]
 Describe $global:function -Tag 'Unit', 'Source', 'Built' {
 
     Context "$global:function::Parameter Unit Tests" {
-        It "$global:function should have exactly 20 parameters defined" {
-            (Get-Command $global:function).Parameters.Count | Should -Be 20
+        It "$global:function should have exactly 21 parameters defined" {
+            (Get-Command $global:function).Parameters.Count | Should -Be 21
         }
 
         $ParameterTestCases = @(
+            @{ParameterName = 'vpgIdentifier'; Type = 'Guid[]'; Mandatory = $true; Validation = 'NotNullOrEmpty' }
             @{ParameterName = 'vpgName'; Type = 'String[]'; Mandatory = $true; Validation = 'NotNullOrEmpty' }
             @{ParameterName = 'commitPolicy'; Type = 'String'; Mandatory = $false; Validation = 'Set' }
             @{ParameterName = 'commitPolicyTimeout'; Type = 'Int'; Mandatory = $false; Validation = 'Range' }
             @{ParameterName = 'forceShutdown'; Type = 'Switch'; Mandatory = $false; Validation = $null }
-            @{ParameterName = 'disableReverseProtection'; Type = 'Switch'; Mandatory = $true; Validation = $null }
-            @{ParameterName = 'keepSourceVms'; Type = 'Switch'; Mandatory = $true; Validation = $null }
+            @{ParameterName = 'disableReverseProtection'; Type = 'Switch'; Mandatory = $false; Validation = $null }
+            @{ParameterName = 'keepSourceVms'; Type = 'Switch'; Mandatory = $false; Validation = $null }
             @{ParameterName = 'ContinueOnPreScriptFailure'; Type = 'Switch'; Mandatory = $false; Validation = $null }
             @{ParameterName = 'whatIf'; Type = 'Switch'; Mandatory = $false; Validation = 'ShouldProcess' }
         )

ZertoApiWrapper/Public/Export-ZertoVpg.ps1

@@ -38,6 +38,7 @@ function Export-ZertoVpg {
             $vpgSettings = Get-ZertoVpgSetting -vpgSettingsIdentifier $vpgSettingsIdentifier
             $filePath = "{0}\{1}.json" -f $outputPath, $name
             $vpgSettings | Convertto-Json -depth 10 | Out-File -FilePath $filePath
+            $null = Remove-ZertoVpgSettingsIdentifier -vpgSettingsIdentifier $vpgSettingsIdentifier
         }
     }
 

ZertoApiWrapper/Public/Invoke-ZertoMove.ps1

@@ -1,22 +1,57 @@
 <# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
 function Invoke-ZertoMove {
-    [CmdletBinding( DefaultParameterSetName = "main", SupportsShouldProcess = $true )]
+    [CmdletBinding( DefaultParameterSetName = "id", SupportsShouldProcess = $true )]
     param(
         [Parameter(
+            ParameterSetName = 'name',
+            HelpMessage = "Name(s) of the VPG(s) you want to move.",
+            Mandatory
+        )]
+        [Parameter(
+            ParameterSetName = 'commitName',
             HelpMessage = "Name(s) of the VPG(s) you want to move.",
             Mandatory
         )]
         [ValidateNotNullOrEmpty()]
         [string[]]$vpgName,
         [Parameter(
+            ParameterSetName = 'id',
+            HelpMessage = "ID(s) of the VPG(s) you want to move.",
+            Mandatory,
+            ValueFromPipelineByPropertyName
+        )]
+        [Parameter(
+            ParameterSetName = 'commitId',
+            HelpMessage = "ID(s) of the VPG(s) you want to move.",
+            Mandatory,
+            ValueFromPipelineByPropertyName
+        )]
+        [ValidateNotNullOrEmpty()]
+        [guid[]]$vpgIdentifier,
+        [Parameter(
+            ParameterSetName = 'commitName',
             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."
+            Default is the Site Settings setting.",
+            Mandatory
+        )]
+        [Parameter(
+            ParameterSetName = 'commitId',
+            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.",
+            Mandatory
         )]
         [ValidateSet("Rollback", "Commit", "None")]
         [string]$commitPolicy,
         [Parameter(
+            ParameterSetName = 'commitName',
+            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."
+        )]
+        [Parameter(
+            ParameterSetName = 'commitId',
             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."
         )]
         # Min 5 Minutes, Max 24 Hours, Default Site Settigns.
@@ -27,15 +62,11 @@ function Invoke-ZertoMove {
         )]
         [switch]$forceShutdown,
         [Parameter(
-            ParameterSetName = "disableReverseProtection",
-            HelpMessage = "Do not enable reverse protection. The VPG definition is kept with the status Needs Configuration and the reverse settings in the VPG definition are not set.",
-            Mandatory
+            HelpMessage = "Do not enable reverse protection. The VPG definition is kept with the status Needs Configuration and the reverse settings in the VPG definition are not set."
         )]
         [switch]$disableReverseProtection,
         [Parameter(
-            ParameterSetName = "keepSourceVms",
-            HelpMessage = "Prevent the protected virtual machines from being deleted in the protected site. Using this setting disables reverse protection.",
-            Mandatory
+            HelpMessage = "Prevent the protected virtual machines from being deleted in the protected site. Using this setting disables reverse protection."
         )]
         [switch]$keepSourceVms,
         [Parameter(
@@ -46,52 +77,50 @@ function Invoke-ZertoMove {
 
     begin {
         $baseUri = "vpgs"
+        $body = @{
+            forceShutdown              = $forceShutdown.IsPresent
+            ContinueOnPreScriptFailure = $ContinueOnPreScriptFailure.IsPresent
+            keepSourceVms              = $keepSourceVms.IsPresent
+            reverseProtection          = -not $disableReverseProtection.IsPresent
+        }
+
+        if ( $keepSourceVms.IsPresent -and -not $disableReverseProtection.IsPresent ) {
+            Write-Verbose 'Disabling reverse protection as keepSourceVms requires it'
+            $body['reverseProtection'] = $false
+        }
+
+        if ($PSBoundParameters.ContainsKey('commitPolicy')) {
+            $body['commitPolicy'] = $commitPolicy
+            if ($PSBoundParameters.ContainsKey('commitPolicyTimeout')) {
+                $body['commitPolicyTimeout'] = $commitPolicyTimeout
+            }
+        }
     }
 
     process {
-        $body = @{ }
-        #TODO - use a foreach loop to populate the body without all the if statments
-        if ($PSBoundParameters.ContainsKey('commitPolicy')) {
-            $body['commitPolicy'] = $commitPolicy
-        }
-        if ($PSBoundParameters.ContainsKey('commitPolicyTimeout')) {
-            $body['commitPolicyTimeout'] = $commitPolicyTimeout
-        }
-        if ($PSBoundParameters.ContainsKey('forceShutdown')) {
-            $body['forceShutdown'] = $true
-        } else {
-            $body['forceShutdown'] = $false
-        }
-        if ($PSBoundParameters.ContainsKey('ContinueOnPreScriptFailure')) {
-            $body['ContinueOnPreScriptFailure'] = $true
-        } else {
-            $body['ContinueOnPreScriptFailure'] = $false
-        }
+
         switch ($PSCmdlet.ParameterSetName) {
-            "disableReverseProtection" {
-                $body['reverseProtection'] = $false
-                $body['keepSourceVms'] = $false
+            { $_ -in 'name', 'commitName' } {
+                $vpgIds = foreach ($name in $vpgName) {
+                    $vpgId = $(Get-ZertoVpg -name $name).vpgIdentifier
+                    if ( -not $vpgId ) {
+                        Write-Error "VPG: '$name' not found. Please check the name and try again. Skipping"
+                    } else {
+                        Write-Verbose "VPG: $name, ID: $vpgId"
+                        $vpgId
+                    }
+                }
             }
 
-            "keepSourceVms" {
-                $body['reverseProtection'] = $false
-                $body['keepSourceVms'] = $true
-            }
-
-            "main" {
-                $body['reverseProtection'] = $true
-                $body['keepSourceVms'] = $false
+            { $_ -in 'id', 'commitId' } {
+                $vpgIds = $vpgIdentifier
             }
         }
-        foreach ($name in $vpgName) {
-            $vpgId = $(Get-ZertoVpg -name $name).vpgIdentifier
-            if ( -not $vpgId ) {
-                Write-Error "VPG: $name not found. Please check the name and try again. Skipping"
-            } else {
-                $uri = "{0}/{1}/move" -f $baseUri, $vpgId
-                if ($PSCmdlet.ShouldProcess("Moving VPG: $name with settings: $($body | convertto-json)")) {
-                    Invoke-ZertoRestRequest -uri $uri -method "POST" -body $($body | ConvertTo-Json)
-                }
+
+        foreach ($thisId in $vpgIds) {
+            $uri = "{0}/{1}/move" -f $baseUri, $thisId
+            if ($PSCmdlet.ShouldProcess("Moving VPG: $thisId with settings: $($body | ConvertTo-Json)")) {
+                Invoke-ZertoRestRequest -uri $uri -method "POST" -body $($body | ConvertTo-Json)
             }
         }
     }

ZertoApiWrapper/Public/New-ZertoVpg.ps1

@@ -165,7 +165,7 @@ function New-ZertoVpg {
     begin {
         # Create an identifiers table, and start converting names to identifiers.
         $identifiersTable = @{ }
-        $identifiersTable['recoverySiteIdentifier'] = (Get-ZertoPeerSite).Where({$_.PeerSiteName -like $recoverySite}) | Select-Object -ExpandProperty SiteIdentifier
+        $identifiersTable['recoverySiteIdentifier'] = Get-ZertoVirtualizationSite | Where-Object { $_.VirtualizationSiteName -like $recoverySite } | Select-Object -ExpandProperty SiteIdentifier
         $peerSiteNetworks = $(Get-ZertoVirtualizationSite -siteIdentifier $identifiersTable['recoverySiteIdentifier'] -networks)
         $identifiersTable['failoverNetworkIdentifier'] = $peerSiteNetworks | Where-Object { $_.VirtualizationNetworkName -like $recoveryNetwork } | Select-Object -ExpandProperty NetworkIdentifier
         $identifiersTable['testNetworkIdentifier'] = $peerSiteNetworks | Where-Object { $_.VirtualizationNetworkName -like $testNetwork } | Select-Object -ExpandProperty NetworkIdentifier
@@ -295,11 +295,11 @@ function New-ZertoVpg {
 
             "recoveryHostDatastoreCluster" {
                 $baseSettings.Recovery.DefaultDatastoreClusterIdentifier = $identifiersTable['datastoreClusterIdentifier']
-                $baseSettings.Recovery.DefaultHostIdentifier = $identifiersTable['hostIdentifier']
+                $baseSettings.Recovery.DefaultHostIdentifier = $identifiersTable['recoveryHostIdentifier']
             }
 
             "recoveryHostDatastore" {
-                $baseSettings.Recovery.DefaultHostIdentifier = $identifiersTable['hostIdentifier']
+                $baseSettings.Recovery.DefaultHostIdentifier = $identifiersTable['recoveryHostIdentifier']
                 $baseSettings.Recovery.DefaultDatastoreIdentifier = $identifiersTable['datastoreIdentifier']
             }
 

docs/Invoke-ZertoMove.md

@@ -12,22 +12,30 @@ Start a move of a VPG.
 
 ## SYNTAX
 
-### main (Default)
+### id (Default)
 ```
-Invoke-ZertoMove -vpgName <String[]> [-commitPolicy <String>] [-commitPolicyTimeout <Int32>] [-forceShutdown]
+Invoke-ZertoMove -vpgIdentifier <Guid[]> [-forceShutdown] [-disableReverseProtection] [-keepSourceVms]
  [-ContinueOnPreScriptFailure] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
-### disableReverseProtection
+### commitName
 ```
-Invoke-ZertoMove -vpgName <String[]> [-commitPolicy <String>] [-commitPolicyTimeout <Int32>] [-forceShutdown]
- [-disableReverseProtection] [-ContinueOnPreScriptFailure] [-WhatIf] [-Confirm] [<CommonParameters>]
+Invoke-ZertoMove -vpgName <String[]> -commitPolicy <String> [-commitPolicyTimeout <Int32>] [-forceShutdown]
+ [-disableReverseProtection] [-keepSourceVms] [-ContinueOnPreScriptFailure] [-WhatIf] [-Confirm]
+ [<CommonParameters>]
 ```
 
-### keepSourceVms
+### name
 ```
-Invoke-ZertoMove -vpgName <String[]> [-commitPolicy <String>] [-commitPolicyTimeout <Int32>] [-forceShutdown]
- [-keepSourceVms] [-ContinueOnPreScriptFailure] [-WhatIf] [-Confirm] [<CommonParameters>]
+Invoke-ZertoMove -vpgName <String[]> [-forceShutdown] [-disableReverseProtection] [-keepSourceVms]
+ [-ContinueOnPreScriptFailure] [-WhatIf] [-Confirm] [<CommonParameters>]
+```
+
+### commitId
+```
+Invoke-ZertoMove -vpgIdentifier <Guid[]> -commitPolicy <String> [-commitPolicyTimeout <Int32>] [-forceShutdown]
+ [-disableReverseProtection] [-keepSourceVms] [-ContinueOnPreScriptFailure] [-WhatIf] [-Confirm]
+ [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -37,10 +45,24 @@ Start a move of a VPG.
 
 ### Example 1
 ```powershell
-PS C:\> Invoke-ZertoMove -vpgName "MyVpg"
+PS C:\> Invoke-ZertoMove -vpgName 'MyVpg'
 ```
 
-Starts a move operation of VPG "MyVpg"
+Specify the name of a vpg to move
+
+### Example 2
+```powershell
+PS C:\> Invoke-ZertoMove -vpgIdentifier '2fbbf6b5-cddc-4653-b1fe-564f069eeb64'
+```
+
+Specify the identifier of a vpg to move
+
+### Example 3
+```powershell
+PS C:\> Get-ZertoVpg | Invoke-ZertoMove
+```
+
+Utilize the pipeline to move multiple vpgs
 
 ## PARAMETERS
 
@@ -55,11 +77,11 @@ Default is the Site Settings setting.
 
 ```yaml
 Type: String
-Parameter Sets: (All)
+Parameter Sets: commitName, commitId
 Aliases:
 Accepted values: Rollback, Commit, None
 
-Required: False
+Required: True
 Position: Named
 Default value: None
 Accept pipeline input: False
@@ -72,7 +94,7 @@ If omitted, the site settings default will be applied.
 
 ```yaml
 Type: Int32
-Parameter Sets: (All)
+Parameter Sets: commitName, commitId
 Aliases:
 
 Required: False
@@ -102,10 +124,10 @@ Do not enable reverse protection. The VPG definition is kept with the status Nee
 
 ```yaml
 Type: SwitchParameter
-Parameter Sets: disableReverseProtection
+Parameter Sets: (All)
 Aliases:
 
-Required: True
+Required: False
 Position: Named
 Default value: None
 Accept pipeline input: False
@@ -132,13 +154,28 @@ Use this switch to Prevent the protected virtual machines from being deleted in
 
 ```yaml
 Type: SwitchParameter
-Parameter Sets: keepSourceVms
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -vpgIdentifier
+ID(s) of the VPG(s) you want to move.
+
+```yaml
+Type: Guid[]
+Parameter Sets: id, commitId
 Aliases:
 
 Required: True
 Position: Named
 Default value: None
-Accept pipeline input: False
+Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
@@ -147,7 +184,7 @@ Name(s) of the VPG(s) you want to move.
 
 ```yaml
 Type: String[]
-Parameter Sets: (All)
+Parameter Sets: commitName, name
 Aliases:
 
 Required: True

docs/New-ZertoVpg.md

@@ -8,7 +8,7 @@ schema: 2.0.0
 # New-ZertoVpg
 
 ## SYNOPSIS
-Creates a New VPG with default settings only. Customization of VM settings can be accomplished with other module level functions.
+Creates a New VPG with default settings only. Customization of VM settings can be accomplished with other module level functions. Returns a VpgSettingsIdentifier to be passed into the `Save-ZertoVpgSetting` function to create the VPG.
 
 ## SYNTAX
 

version.txt

@@ -1 +1 @@
-1.5.0
+1.5.3