diff --git a/ZertoApiWrapper/Public/en-us/ZertoApiWrapper-help.xml b/ZertoApiWrapper/Public/en-us/ZertoApiWrapper-help.xml index 39806eb..d47de4f 100644 --- a/ZertoApiWrapper/Public/en-us/ZertoApiWrapper-help.xml +++ b/ZertoApiWrapper/Public/en-us/ZertoApiWrapper-help.xml @@ -285,7 +285,7 @@ Connect-ZertoServer - + zertoServer IP address or FQDN of your Zerto Management Server @@ -297,7 +297,7 @@ None - + zertoPort Zerto Virtual Manager management port. Default value is 9669. @@ -359,7 +359,7 @@ False - + zertoPort Zerto Virtual Manager management port. Default value is 9669. @@ -371,7 +371,7 @@ "9669" - + zertoServer IP address or FQDN of your Zerto Management Server @@ -554,7 +554,7 @@ None - + vraIdentifier Identifier of the VRA to be updated. @@ -639,7 +639,7 @@ None - + vraIdentifier Identifier of the VRA to be updated. @@ -967,7 +967,7 @@ None - + helpIdentifier Returns alerts for the specified helpIdentifier @@ -1003,7 +1003,7 @@ None - + siteIdentifier Returns alerts for the specified siteIdentifier @@ -1027,7 +1027,7 @@ None - + vpgIdentifier Returns alerts for the specified vraIdentifier @@ -1039,7 +1039,7 @@ None - + zorgIdentifier Returns alerts for the specified zorgIdentifier @@ -1144,7 +1144,7 @@ None - + helpIdentifier Returns alerts for the specified helpIdentifier @@ -1204,7 +1204,7 @@ False - + siteIdentifier Returns alerts for the specified siteIdentifier @@ -1228,7 +1228,7 @@ None - + vpgIdentifier Returns alerts for the specified vraIdentifier @@ -1240,7 +1240,7 @@ None - + zorgIdentifier Returns alerts for the specified zorgIdentifier @@ -1348,7 +1348,7 @@ Get-ZertoDatastore - + datastoreIdentifier datastoreIdentifier or array of datastoreIdentifiers to be queried @@ -1363,7 +1363,7 @@ - + datastoreIdentifier datastoreIdentifier or array of datastoreIdentifiers to be queried @@ -1444,7 +1444,7 @@ Get-ZertoEvent - + alertIdentifier The internal alert identifier for the Event @@ -1459,7 +1459,7 @@ category - 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' + 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 @@ -1483,7 +1483,7 @@ entityType - 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' + The type of entity for which you wish to return results. Possible Values are: 'VPG', 'VRA', 'Unknown', or 'Site' String @@ -1495,7 +1495,7 @@ eventCategory - 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' + 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' String @@ -1516,7 +1516,7 @@ None - + siteIdentifier The internal site identifier for which you want to return events. @@ -1564,7 +1564,7 @@ None - + vpg The name of the VPG for which you want to return events. @@ -1576,7 +1576,7 @@ None - + vpgIdentifier The identifier of the VPG for which you want to return events. @@ -1588,7 +1588,7 @@ None - + zorgIdentifier The identifier of the ZORG, Zerto organization, defined in the Zerto Cloud Manager for which you want to return results. @@ -1660,7 +1660,7 @@ - + alertIdentifier The internal alert identifier for the Event @@ -1687,7 +1687,7 @@ category - 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' + 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 @@ -1723,7 +1723,7 @@ entityType - 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' + The type of entity for which you wish to return results. Possible Values are: 'VPG', 'VRA', 'Unknown', or 'Site' String @@ -1735,7 +1735,7 @@ eventCategory - 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' + 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' String @@ -1768,7 +1768,7 @@ None - + siteIdentifier The internal site identifier for which you want to return events. @@ -1828,7 +1828,7 @@ None - + vpg The name of the VPG for which you want to return events. @@ -1840,7 +1840,7 @@ None - + vpgIdentifier The identifier of the VPG for which you want to return events. @@ -1852,7 +1852,7 @@ None - + zorgIdentifier The identifier of the ZORG, Zerto organization, defined in the Zerto Cloud Manager for which you want to return results. @@ -2166,7 +2166,7 @@ Get-ZertoPeerSite - + siteIdentifier The identifier(s) of the peer site(s) for which information is to be returned. @@ -2253,7 +2253,7 @@ None - + siteIdentifier The identifier(s) of the peer site(s) for which information is to be returned. @@ -2349,7 +2349,7 @@ priority - The priority specified for the VPG. Possible values are: '0' or 'Low', '1' or 'Medium', '2' or 'High' + The priority specified for the VPG. Possible values are: 'Low', 'Medium', or 'High' String @@ -2358,7 +2358,7 @@ None - + protectedSiteIdentifier The identifier of the protected site where the VPG virtual machines are protected. @@ -2382,7 +2382,7 @@ None - + recoverySiteIdentifier The identifier of the recovery site where the VPG virtual machines are recovered. @@ -2457,7 +2457,7 @@ Get-ZertoProtectedVm - + vmIdentifier vmIdentifier(s) for which to return information @@ -2487,7 +2487,7 @@ priority - The priority specified for the VPG. Possible values are: '0' or 'Low', '1' or 'Medium', '2' or 'High' + The priority specified for the VPG. Possible values are: 'Low', 'Medium', or 'High' String @@ -2496,7 +2496,7 @@ None - + protectedSiteIdentifier The identifier of the protected site where the VPG virtual machines are protected. @@ -2520,7 +2520,7 @@ None - + recoverySiteIdentifier The identifier of the recovery site where the VPG virtual machines are recovered. @@ -2568,7 +2568,7 @@ None - + vmIdentifier vmIdentifier(s) for which to return information @@ -3437,7 +3437,7 @@ Get-ZertoServiceProfile - + siteIdentifier The identifier of the site for which service profiles should be returned. @@ -3464,7 +3464,7 @@ None - + siteIdentifier The identifier of the site for which service profiles should be returned. @@ -3588,7 +3588,7 @@ status - The status of the task. Possible values are: '1' or 'InProgress', '3' or 'Paused', '4' or 'Failed', '6' or 'Completed', '7' or 'Cancelling' + The status of the task. Possible values are: 'InProgress', 'Paused', 'Failed', 'Completed', or 'Cancelling' String @@ -3612,7 +3612,7 @@ Get-ZertoTask - + taskIdentifier The identifier(s) for which task information is to be returned. @@ -3692,7 +3692,7 @@ status - The status of the task. Possible values are: '1' or 'InProgress', '3' or 'Paused', '4' or 'Failed', '6' or 'Completed', '7' or 'Cancelling' + The status of the task. Possible values are: 'InProgress', 'Paused', 'Failed', 'Completed', or 'Cancelling' String @@ -3701,7 +3701,7 @@ None - + taskIdentifier The identifier(s) for which task information is to be returned. @@ -3879,7 +3879,7 @@ False - + siteIdentifier The identifier of the Zerto Virtual Manager site. @@ -3905,7 +3905,7 @@ False - + siteIdentifier The identifier of the Zerto Virtual Manager site. @@ -3931,7 +3931,7 @@ False - + hostIdentifier The identifier of the host at the selected site to return information for only one host. @@ -3943,7 +3943,7 @@ None - + siteIdentifier The identifier of the Zerto Virtual Manager site. @@ -3969,7 +3969,7 @@ False - + siteIdentifier The identifier of the Zerto Virtual Manager site. @@ -3995,7 +3995,7 @@ False - + siteIdentifier The identifier of the Zerto Virtual Manager site. @@ -4010,7 +4010,7 @@ Get-ZertoVirtualizationSite - + hostIdentifier The identifier of the host at the selected site to return information for only one host. @@ -4033,7 +4033,7 @@ False - + siteIdentifier The identifier of the Zerto Virtual Manager site. @@ -4059,7 +4059,7 @@ False - + siteIdentifier The identifier of the Zerto Virtual Manager site. @@ -4085,7 +4085,7 @@ False - + siteIdentifier The identifier of the Zerto Virtual Manager site. @@ -4100,7 +4100,7 @@ Get-ZertoVirtualizationSite - + siteIdentifier The identifier of the Zerto Virtual Manager site. @@ -4126,7 +4126,7 @@ Get-ZertoVirtualizationSite - + siteIdentifier The identifier of the Zerto Virtual Manager site. @@ -4201,7 +4201,7 @@ False - + hostIdentifier The identifier of the host at the selected site to return information for only one host. @@ -4249,7 +4249,7 @@ False - + siteIdentifier The identifier of the Zerto Virtual Manager site. @@ -4334,7 +4334,7 @@ Get-ZertoVolume - + datastoreIdentifier The identifier of the datastore. @@ -4346,7 +4346,7 @@ None - + owningVmIdentifier The identifier of the owning virtual machine. @@ -4358,7 +4358,7 @@ None - + protectedVmIdentifier The identifier of the protected virtual machine. @@ -4382,7 +4382,7 @@ None - + vpgIdentifier The identifier of the VPG. @@ -4397,7 +4397,7 @@ - + datastoreIdentifier The identifier of the datastore. @@ -4409,7 +4409,7 @@ None - + owningVmIdentifier The identifier of the owning virtual machine. @@ -4421,7 +4421,7 @@ None - + protectedVmIdentifier The identifier of the protected virtual machine. @@ -4445,7 +4445,7 @@ None - + vpgIdentifier The identifier of the VPG. @@ -4570,7 +4570,7 @@ priority - The VPG priority. Possible values are: '0' or 'Low', '1' or 'Medium', '2' or 'High' + The VPG priority. Possible values are: 'Low', 'Medium', 'High' String @@ -4701,7 +4701,7 @@ None - + protectionGroupIdentifier The identifier(s) of the Virtual Protection Group to return @@ -4739,7 +4739,7 @@ False - + protectionGroupIdentifier The identifier(s) of the Virtual Protection Group to return @@ -4810,7 +4810,7 @@ Get-ZertoVpg - + protectionGroupIdentifier The identifier(s) of the Virtual Protection Group to return @@ -4990,7 +4990,7 @@ priority - The VPG priority. Possible values are: '0' or 'Low', '1' or 'Medium', '2' or 'High' + The VPG priority. Possible values are: 'Low', 'Medium', 'High' String @@ -5023,7 +5023,7 @@ None - + protectionGroupIdentifier The identifier(s) of the Virtual Protection Group to return @@ -5235,7 +5235,7 @@ False - + vpgSettingsIdentifier The identifier of the VPG settings object for which information is retrieved. @@ -5261,7 +5261,7 @@ False - + vpgSettingsIdentifier The identifier of the VPG settings object for which information is retrieved. @@ -5287,7 +5287,7 @@ False - + vpgSettingsIdentifier The identifier of the VPG settings object for which information is retrieved. @@ -5313,7 +5313,7 @@ False - + vpgSettingsIdentifier The identifier of the VPG settings object for which information is retrieved. @@ -5339,7 +5339,7 @@ False - + vpgSettingsIdentifier The identifier of the VPG settings object for which information is retrieved. @@ -5365,7 +5365,7 @@ False - + vpgSettingsIdentifier The identifier of the VPG settings object for which information is retrieved. @@ -5380,7 +5380,7 @@ Get-ZertoVpgSetting - + nicIdentifier Return NIC information for specified NIC of the specified VM @@ -5392,7 +5392,7 @@ None - + vmIdentifier VM Identifier @@ -5404,7 +5404,7 @@ None - + vpgSettingsIdentifier The identifier of the VPG settings object for which information is retrieved. @@ -5430,7 +5430,7 @@ False - + vmIdentifier VM Identifier @@ -5442,7 +5442,7 @@ None - + vpgSettingsIdentifier The identifier of the VPG settings object for which information is retrieved. @@ -5468,7 +5468,7 @@ False - + vpgSettingsIdentifier The identifier of the VPG settings object for which information is retrieved. @@ -5494,7 +5494,7 @@ False - + vpgSettingsIdentifier The identifier of the VPG settings object for which information is retrieved. @@ -5520,7 +5520,7 @@ False - + vpgSettingsIdentifier The identifier of the VPG settings object for which information is retrieved. @@ -5546,7 +5546,7 @@ False - + vpgSettingsIdentifier The identifier of the VPG settings object for which information is retrieved. @@ -5572,7 +5572,7 @@ False - + vpgSettingsIdentifier The identifier of the VPG settings object for which information is retrieved. @@ -5587,7 +5587,7 @@ Get-ZertoVpgSetting - + vmIdentifier VM Identifier @@ -5599,7 +5599,7 @@ None - + volumeIdentifier Return volume information for the specified volume of the specified VM @@ -5611,7 +5611,7 @@ None - + vpgSettingsIdentifier The identifier of the VPG settings object for which information is retrieved. @@ -5626,7 +5626,7 @@ Get-ZertoVpgSetting - + vmIdentifier VM Identifier @@ -5649,7 +5649,7 @@ False - + vpgSettingsIdentifier The identifier of the VPG settings object for which information is retrieved. @@ -5664,7 +5664,7 @@ Get-ZertoVpgSetting - + vmIdentifier VM Identifier @@ -5676,7 +5676,7 @@ None - + vpgSettingsIdentifier The identifier of the VPG settings object for which information is retrieved. @@ -5702,7 +5702,7 @@ False - + vpgSettingsIdentifier The identifier of the VPG settings object for which information is retrieved. @@ -5717,7 +5717,7 @@ Get-ZertoVpgSetting - + vpgSettingsIdentifier The identifier of the VPG settings object for which information is retrieved. @@ -5804,7 +5804,7 @@ False - + nicIdentifier Return NIC information for specified NIC of the specified VM @@ -5888,7 +5888,7 @@ False - + vmIdentifier VM Identifier @@ -5912,7 +5912,7 @@ False - + volumeIdentifier Return volume information for the specified volume of the specified VM @@ -5936,7 +5936,7 @@ False - + vpgSettingsIdentifier The identifier of the VPG settings object for which information is retrieved. @@ -6176,7 +6176,7 @@ Get-ZertoVra - + vraIdentifier Returns information for provided VRA identifier(s) @@ -6299,7 +6299,7 @@ None - + vraIdentifier Returns information for provided VRA identifier(s) @@ -6403,7 +6403,7 @@ Get-ZertoZorg - + zorgIdentifier Identifier(s) of the ZORG. @@ -6418,7 +6418,7 @@ - + zorgIdentifier Identifier(s) of the ZORG. @@ -6498,7 +6498,7 @@ Get-ZertoZsspSession - + zsspSessionIdentifier ZSSP Session Id(s) to get information. @@ -6513,7 +6513,7 @@ - + zsspSessionIdentifier ZSSP Session Id(s) to get information. @@ -7103,7 +7103,7 @@ None - + checkpointIdentifier Checkpoint Identifier to use as the Point-In-Time to rollback to. @@ -7118,9 +7118,9 @@ commitPolicy - 0: 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. - 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. + '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. String @@ -7184,7 +7184,7 @@ vmName - Name(s) of VMs in the + Name(s) of VMs in the VPG to failover String[] @@ -7196,7 +7196,7 @@ - + checkpointIdentifier Checkpoint Identifier to use as the Point-In-Time to rollback to. @@ -7211,9 +7211,9 @@ commitPolicy - 0: 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. - 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. + '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. String @@ -7277,7 +7277,7 @@ vmName - Name(s) of VMs in the + Name(s) of VMs in the VPG to failover String[] @@ -7668,7 +7668,10 @@ commitPolicy - 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. + '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. String @@ -7752,7 +7755,10 @@ commitPolicy - 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. + '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. String @@ -9923,7 +9929,7 @@ New-ZertoVpgSettingsIdentifier - + vpgIdentifier Identifier of the VPG to create a VPG settings identifier. If a vpgIdentifier is not provided, a new VPG settings object is created without any configured settings. This would be used for creating a new VPG from scratch. @@ -9950,7 +9956,7 @@ False - + vpgIdentifier Identifier of the VPG to create a VPG settings identifier. If a vpgIdentifier is not provided, a new VPG settings object is created without any configured settings. This would be used for creating a new VPG from scratch. @@ -10052,7 +10058,7 @@ False - + vpgidentifier vpgIdentifier(s) of the VPG(s) to delete. @@ -10172,7 +10178,7 @@ False - + vpgidentifier vpgIdentifier(s) of the VPG(s) to delete. @@ -10390,7 +10396,7 @@ Save-ZertoVpgSettings - + vpgSettingsIdentifier VpgSettings Identifier to save @@ -10427,7 +10433,7 @@ - + vpgSettingsIdentifier VpgSettings Identifier to save @@ -10524,7 +10530,7 @@ Set-ZertoAlert - + alertId Alert identifier(s) to be dismissed or undismissed. @@ -10572,7 +10578,7 @@ Set-ZertoAlert - + alertId Alert identifier(s) to be dismissed or undismissed. @@ -10620,7 +10626,7 @@ - + alertId Alert identifier(s) to be dismissed or undismissed. @@ -10894,7 +10900,7 @@ None - + checkpointIdentifier The identifier of the checkpoint to use for cloning. If unspecified, the latest checkpoint will be used. @@ -10933,7 +10939,7 @@ - + checkpointIdentifier The identifier of the checkpoint to use for cloning. If unspecified, the latest checkpoint will be used. @@ -11054,7 +11060,7 @@ None - + checkpointIdentifier The identifier of the checkpoint to use for testing. If unspecified, the latest checkpoint will be used. @@ -11081,7 +11087,7 @@ - + checkpointIdentifier The identifier of the checkpoint to use for testing. If unspecified, the latest checkpoint will be used. diff --git a/docs/Connect-ZertoServer.md b/docs/Connect-ZertoServer.md index 3cd7c14..41d75e8 100644 --- a/docs/Connect-ZertoServer.md +++ b/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 diff --git a/docs/Edit-ZertoVra.md b/docs/Edit-ZertoVra.md index bf40004..89b8866 100644 --- a/docs/Edit-ZertoVra.md +++ b/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 diff --git a/docs/Get-ZertoAlert.md b/docs/Get-ZertoAlert.md index 905ba14..a9cefa0 100644 --- a/docs/Get-ZertoAlert.md +++ b/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 diff --git a/docs/Get-ZertoDatastore.md b/docs/Get-ZertoDatastore.md index 9c81382..40adbe2 100644 --- a/docs/Get-ZertoDatastore.md +++ b/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 diff --git a/docs/Get-ZertoEvent.md b/docs/Get-ZertoEvent.md index f512d16..4e76263 100644 --- a/docs/Get-ZertoEvent.md +++ b/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. -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' +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' ```yaml Type: String @@ -155,8 +153,7 @@ Accept wildcard characters: False ``` ### -entityType -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' +The type of entity for which you wish to return results. Possible Values are: 'VPG', 'VRA', 'Unknown', 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. -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' +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' ```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 diff --git a/docs/Get-ZertoPeerSite.md b/docs/Get-ZertoPeerSite.md index 1e127de..e5e2936 100644 --- a/docs/Get-ZertoPeerSite.md +++ b/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 diff --git a/docs/Get-ZertoProtectedVm.md b/docs/Get-ZertoProtectedVm.md index db23650..daaa2c5 100644 --- a/docs/Get-ZertoProtectedVm.md +++ b/docs/Get-ZertoProtectedVm.md @@ -82,8 +82,7 @@ Accept wildcard characters: False ``` ### -priority -The priority specified for the VPG. -Possible values are: '0' or 'Low', '1' or 'Medium', '2' or 'High' +The priority specified for the VPG. Possible values are: 'Low', 'Medium', 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 diff --git a/docs/Get-ZertoServiceProfile.md b/docs/Get-ZertoServiceProfile.md index 4b19813..21a381c 100644 --- a/docs/Get-ZertoServiceProfile.md +++ b/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 diff --git a/docs/Get-ZertoTask.md b/docs/Get-ZertoTask.md index 6229464..6ff80af 100644 --- a/docs/Get-ZertoTask.md +++ b/docs/Get-ZertoTask.md @@ -123,8 +123,7 @@ Accept wildcard characters: False ``` ### -status -The status of the task. -Possible values are: '1' or 'InProgress', '3' or 'Paused', '4' or 'Failed', '6' or 'Completed', '7' or 'Cancelling' +The status of the task. Possible values are: 'InProgress', 'Paused', 'Failed', 'Completed', 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 diff --git a/docs/Get-ZertoVirtualizationSite.md b/docs/Get-ZertoVirtualizationSite.md index 59d46a0..049d2e9 100644 --- a/docs/Get-ZertoVirtualizationSite.md +++ b/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 diff --git a/docs/Get-ZertoVolume.md b/docs/Get-ZertoVolume.md index 91f3d52..5b17799 100644 --- a/docs/Get-ZertoVolume.md +++ b/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 diff --git a/docs/Get-ZertoVpg.md b/docs/Get-ZertoVpg.md index 737456a..4c8a3b5 100644 --- a/docs/Get-ZertoVpg.md +++ b/docs/Get-ZertoVpg.md @@ -265,8 +265,7 @@ Accept wildcard characters: False ### -priority -The VPG priority. -Possible values are: '0' or 'Low', '1' or 'Medium', '2' or 'High' +The VPG priority. Possible values are: 'Low', 'Medium', '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 diff --git a/docs/Get-ZertoVpgSetting.md b/docs/Get-ZertoVpgSetting.md index 989e250..d812532 100644 --- a/docs/Get-ZertoVpgSetting.md +++ b/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 diff --git a/docs/Get-ZertoVra.md b/docs/Get-ZertoVra.md index 1e3bf10..d44cd4e 100644 --- a/docs/Get-ZertoVra.md +++ b/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 diff --git a/docs/Get-ZertoZorg.md b/docs/Get-ZertoZorg.md index bb59509..fac0cfc 100644 --- a/docs/Get-ZertoZorg.md +++ b/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 diff --git a/docs/Get-ZertoZsspSession.md b/docs/Get-ZertoZsspSession.md index 1b356b6..b6463df 100644 --- a/docs/Get-ZertoZsspSession.md +++ b/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 diff --git a/docs/Invoke-ZertoFailover.md b/docs/Invoke-ZertoFailover.md index ac3aa84..ecc48e6 100644 --- a/docs/Invoke-ZertoFailover.md +++ b/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[] diff --git a/docs/Invoke-ZertoMove.md b/docs/Invoke-ZertoMove.md index fb989bf..4cfd149 100644 --- a/docs/Invoke-ZertoMove.md +++ b/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. -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. +'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. ```yaml Type: String diff --git a/docs/New-ZertoVpgSettingsIdentifier.md b/docs/New-ZertoVpgSettingsIdentifier.md index abae8dd..93f9beb 100644 --- a/docs/New-ZertoVpgSettingsIdentifier.md +++ b/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 diff --git a/docs/Remove-ZertoVpg.md b/docs/Remove-ZertoVpg.md index ec2bac7..95af5db 100644 --- a/docs/Remove-ZertoVpg.md +++ b/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 diff --git a/docs/Save-ZertoVpgSettings.md b/docs/Save-ZertoVpgSettings.md index 6a10f72..16d9dda 100644 --- a/docs/Save-ZertoVpgSettings.md +++ b/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 diff --git a/docs/Set-ZertoAlert.md b/docs/Set-ZertoAlert.md index 6498a31..9e68770 100644 --- a/docs/Set-ZertoAlert.md +++ b/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 diff --git a/docs/Start-ZertoCloneVpg.md b/docs/Start-ZertoCloneVpg.md index 4f1a709..467068c 100644 --- a/docs/Start-ZertoCloneVpg.md +++ b/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 diff --git a/docs/Start-ZertoFailoverTest.md b/docs/Start-ZertoFailoverTest.md index a14fafb..c5622da 100644 --- a/docs/Start-ZertoFailoverTest.md +++ b/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