104 Commits

Author SHA1 Message Date
Wes Carroll fe4d8cf4dd Merge pull request #75 from ZertoPublic/ReleasePrep
April Release
2020-04-10 08:14:00 -04:00
Wes Carroll e35939e592 Bump Version 2020-04-09 14:37:38 -04:00
Wes Carroll c422e26903 Update Readme for release 2020-04-09 14:37:27 -04:00
Wes Carroll e37444249e Merge pull request #74 from ZertoPublic/VirtulizationSiteRepos
Add functionality for ZVM 8.0
2020-04-09 13:27:35 -04:00
Wes Carroll 616cdcf7a2 Update Tests for WindowPS 2020-04-09 13:22:57 -04:00
Wes Carroll e7658fcfec Update the version of Pester to latest version 2020-04-09 13:22:42 -04:00
Wes Carroll a306391a14 Fix Filename Case 2020-04-09 12:55:41 -04:00
Wes Carroll 83e9551692 Add tests for function 2020-04-09 12:48:33 -04:00
Wes Carroll 7fbc550390 Add Mocks for Tests 2020-04-09 12:48:04 -04:00
Wes Carroll e3cba682c7 DRY Refactor 2020-04-09 10:37:36 -04:00
Wes Carroll 96b3e65be2 Update RELEASENOTES.md 2020-04-08 15:26:10 -04:00
Wes Carroll d15111a883 Add new LTR API Endpoint
Added new LTR endpoint and help messages to indicate that it will only work with Version 8.0 and above. Also updated help message for backup settings indicating that backup settings only work with 7.5 and below.
2020-04-08 15:19:46 -04:00
Wes Carroll 90434b56a2 Updated for new Repositories endpoint 2020-04-07 17:35:55 -04:00
Wes Carroll 85e60adac1 Merge pull request #73 from ZertoPublic/UpdateServiceAccountPassword
Create function to Update service account password
2020-04-07 10:44:00 -04:00
Wes Carroll 0d6bc39c86 Add an additional example 2020-04-07 10:30:42 -04:00
Wes Carroll ad2073f404 Fixed submitted body formatting 2020-04-07 10:27:22 -04:00
Wes Carroll e12bf9d85e Fix script level variable 2020-04-07 10:18:37 -04:00
Wes Carroll a5f3ad4de0 Update RELEASENOTES.md 2020-04-07 10:05:34 -04:00
Wes Carroll 77fb3c8f67 Fix helpmessage typo 2020-04-07 10:05:31 -04:00
Wes Carroll b2e5fe7b5c Update Set-ZertoUserCredential.md 2020-04-07 10:04:55 -04:00
Wes Carroll f34f21bb85 Create Set-ZertoUserCredential.md 2020-04-07 07:49:13 -04:00
Wes Carroll 536a62f792 Create Set-ZertoUserCredential.Tests.ps1 2020-04-06 17:15:57 -04:00
Wes Carroll df83277c06 Create Set-ZertoUserCredential.ps1 2020-04-06 17:15:52 -04:00
Wes Carroll d55bc3e4b3 Merge branch 'UpdateVraWithPassword' 2020-04-04 10:42:56 -04:00
Wes Carroll 7488e7999f Updated Release notes with current changes 2020-04-04 10:36:51 -04:00
Wes Carroll dcba2b04a9 Added Edit Password Information 2020-04-04 10:30:46 -04:00
Wes Carroll bd94bfe5db Update Help Files 2020-04-04 10:26:56 -04:00
Wes Carroll fb722661a7 Update Edit-ZertoVra.Tests.ps1 2020-04-03 16:51:09 -04:00
Wes Carroll 6121940563 Added ability to updated Host Password 2020-04-03 10:35:44 -04:00
Wes Carroll 64fa03e4ea Merge pull request #71 from ZertoPublic/ZA-Planner
Updates for Zerto Analytics
2020-04-02 19:57:38 -04:00
Wes Carroll 86854442ef Update Online Link to Help 2020-04-02 17:56:57 -04:00
Wes Carroll bc46a512cd Update RELEASENOTES.md 2020-04-02 17:55:04 -04:00
Wes Carroll 0a84246d8e Add parameter validation 2020-04-02 17:44:16 -04:00
Wes Carroll f299aecb9b Add parameter validation 2020-04-02 17:44:00 -04:00
Wes Carroll 646476e74e Remove unused parameter 2020-04-02 17:43:50 -04:00
Wes Carroll 285a82f280 Fix Parameter Test 2020-04-02 17:43:39 -04:00
Wes Carroll fbe9fb2af8 Fix Parameter Test 2020-04-02 17:43:28 -04:00
Wes Carroll 1af70b8c80 Create Tests 2020-04-02 17:38:35 -04:00
Wes Carroll 0ef71c25bb Update Get-ZAPlannerZcasReport.md 2020-04-02 17:16:14 -04:00
Wes Carroll 78e1cdb981 Update Get-ZAPlannerWanReport.md 2020-04-02 17:16:11 -04:00
Wes Carroll 1a66d4e64b Update Get-ZAPlannerStatsReport.md 2020-04-02 17:09:25 -04:00
Wes Carroll 2fef1dbc42 Create Get-ZAProtectedVmReport.md 2020-04-02 16:46:59 -04:00
Wes Carroll b00ededc7f Create Get-ZAProtectedVm.md 2020-04-02 16:44:08 -04:00
Wes Carroll 8e5ced9b87 Create Get-ZAProtectedVmReport.ps1 2020-04-02 15:12:52 -04:00
Wes Carroll 69fb384c89 Create Get-ZAProtectedVm.ps1 2020-04-02 15:12:43 -04:00
Wes Carroll a8b9ec3a00 Update Help File Formatting 2020-04-02 15:12:04 -04:00
Wes Carroll 355be7c1e5 Merge branch 'master' into ZA-Planner 2020-04-02 12:30:58 -04:00
Wes Carroll c94f04de77 Merge pull request #69 from ZertoPublic/MultiClusterSingleDatastore
Updates to Install-ZertoVra
2020-04-02 12:29:36 -04:00
Wes Carroll f4807f94fb Merge branch 'master' into MultiClusterSingleDatastore 2020-04-02 12:25:25 -04:00
Wes Carroll d39777cbb0 Merge pull request #70 from ZertoPublic/AzurePipelinesUpdates
Update build agents.
2020-04-02 12:22:14 -04:00
Wes Carroll 8b43856558 Update build agents. 2020-04-02 12:17:55 -04:00
Wes Carroll 83879a51e7 Update RELEASENOTES.md 2020-04-02 11:54:48 -04:00
Wes Carroll 2d1fb8e4db Update Install-ZertoVra.md 2020-04-02 10:51:05 -04:00
Wes Carroll e774cd861d Update Copy-ZertoVpg.md 2020-04-02 10:48:19 -04:00
Wes Carroll a660aa29b3 Update Common Parameters formatting 2020-04-02 10:48:02 -04:00
Wes Carroll 82458712f0 Update tests for new functionality 2020-04-02 10:46:40 -04:00
Wes Carroll bae9eb9b99 Update function to enable password installation 2020-04-02 10:27:20 -04:00
Wes Carroll 2ea7092b91 Update logic to only allow install to attached devices 2020-04-01 17:14:21 -04:00
Wes Carroll de08f0eece Ensure the right DSId is mapped to the target host. 2020-03-19 17:08:08 -04:00
Wes Carroll 3e980dc195 Add Online Help URI 2020-03-19 16:25:28 -04:00
Wes Carroll eccc5f27f3 Update Get-ZAPlannerNetworkPerformanceReport.md 2020-03-19 09:21:05 -04:00
Wes Carroll e516a24e38 Update Get-ZAPlannerJournalSizeReport.md 2020-03-19 09:19:48 -04:00
Wes Carroll 07f92583f8 Update Single Site URL 2020-03-18 13:57:12 -04:00
Wes Carroll c2f554dca1 Update Get-ZAPlannerSite.md 2020-03-18 13:54:58 -04:00
Wes Carroll 8bd865d83d Create Template Help Files 2020-03-08 22:45:51 -04:00
Wes Carroll 02e50d9cd6 Create Get-ZAPlannerZcasReport.ps1 2020-03-08 17:33:36 -04:00
Wes Carroll 7fc0a5f579 Create Get-ZAPlannerWanReport.ps1 2020-03-08 17:33:31 -04:00
Wes Carroll ce5a64c683 Create Get-ZAPlannerNetworkPerformanceReport.ps1 2020-03-08 17:33:27 -04:00
Wes Carroll 1317a6c039 Create Get-ZAPlannerJournalSizeReport.ps1 2020-03-08 17:33:24 -04:00
Wes Carroll 169e628c7b Remove Debugging Output 2020-03-08 14:57:19 -04:00
Wes Carroll d35d9d7cf4 Create Get-ZAPlannerStatsReport.ps1 2020-03-08 14:40:22 -04:00
Wes Carroll a891a4914d Create Get-ZAPlannerSite.ps1 2020-03-08 14:39:34 -04:00
Wes Carroll 71352cae7b Merge pull request #68 from ZertoPublic/IZRR-to-public
Move RestRequest functions into Public
2020-03-06 17:22:53 -05:00
Wes Carroll b0edd9026f Update RELEASENOTES.md 2020-03-06 14:08:12 -05:00
Wes Carroll 7cde687d70 Create Documentation for Newly Public Functions 2020-03-06 13:42:58 -05:00
Wes Carroll 569d9e264c Update ZertoRestRequest and associated Tests 2020-03-06 13:42:39 -05:00
Wes Carroll 40331c26f9 Update ZARestRequest and associated tests. 2020-03-06 13:42:20 -05:00
Wes Carroll 526093afc6 Fix the Tests extension 2020-03-06 13:31:59 -05:00
Wes Carroll dc4dd1ad05 Move IZRR function to public 2020-03-06 10:40:21 -05:00
Wes Carroll 779ee1415e Move IZRR to public 2020-03-06 10:38:41 -05:00
Wes Carroll 13592df6aa Move ZARestRequest to Public Function 2020-03-06 10:33:12 -05:00
Wes Carroll fad3ca0e27 Update RELEASENOTES.md 2020-03-06 10:01:17 -05:00
Wes Carroll 52782aa1e5 Merge pull request #67 from ZertoPublic/Refactor-GetVpg
Refactor Get-ZertoVpg
2020-03-06 09:11:10 -05:00
Wes Carroll bc02e796d6 Refactor for DRY 2020-03-05 21:43:52 -05:00
Wes Carroll 4c32bbe057 Update to PwSh Version 7 2020-03-05 21:43:32 -05:00
Wes Carroll cc9e53ac44 Merge branch 'fix-typos' 2020-03-02 10:30:12 -05:00
Wes Carroll 37165e18a7 Typo Correction Update 2020-03-02 10:00:45 -05:00
Wes Carroll 772848beef Updated help file to reflect typo correction 2020-03-02 09:53:55 -05:00
Wes Carroll 18185612bb Fixed recovery switch typo 2020-03-02 09:51:23 -05:00
Wes Carroll ecab2500c7 Merge pull request #65 from ZertoPublic/checkpoint-refactor
Checkpoint refactor
2020-03-02 09:46:34 -05:00
Wes Carroll fde7f67e45 Update RELEASENOTES.md 2020-03-02 09:41:09 -05:00
Wes Carroll e19f9b34f5 Update function to allow pipeline operations 2020-02-28 08:15:53 -05:00
Wes Carroll a36a7cb37a Cleanup documentation 2020-02-28 08:15:15 -05:00
Wes Carroll 1e80bb06fb Merge pull request #63 from ZertoPublic/ExportNicUpdate
Update Export and Import VpgNicSetting functions
2019-12-22 11:01:27 -05:00
Wes Carroll 4c98b75134 Update RELEASENOTES.md 2019-12-22 10:48:07 -05:00
Wes Carroll a7efc7c717 Merge branch 'master' into ExportNicUpdate 2019-12-22 10:37:44 -05:00
Wes Carroll 02f1c89d86 Merge pull request #62 from ZertoPublic/RecoveryReport
Remove -VpgIdentifier Parameter from Get-ZertoRecoveryReport function
2019-12-22 10:35:35 -05:00
Wes Carroll 5b9243a02f Updated releasenotes with changes 2019-12-22 10:16:27 -05:00
Wes Carroll 1962dda15c Remove vpgIdentifier Parameter
vpgIdentifier Parameter as added as a parameter by mistake. The API does not accecpt this as a filter.
2019-12-22 10:07:17 -05:00
Wes Carroll 801553178e Update Online Help Link 2019-12-20 22:56:20 -05:00
Wes Carroll 6c92dff447 Update Description with new logic 2019-12-20 22:56:04 -05:00
Wes Carroll 003396998c Eliminate Blank Output 2019-12-20 21:09:12 -05:00
Wes Carroll 05783a1f37 Update Import Logic 2019-12-19 18:49:13 -05:00
Wes Carroll 270470f858 Update Nic Object Logic 2019-12-18 13:06:11 -05:00
116 changed files with 8012 additions and 5044 deletions
+1 -1
View File
@@ -4,5 +4,5 @@
"editor.insertSpaces": true,
"editor.tabSize": 4,
"powershell.codeFormatting.preset": "OTBS",
"terminal.integrated.shell.windows": "c:/Program Files/PowerShell/6/pwsh.exe"
"terminal.integrated.shell.windows": "c:/Program Files/PowerShell/7/pwsh.exe"
}
+2 -1
View File
@@ -4,8 +4,8 @@ PowerShell wrapper for Zerto Virtual Manager API
## Current Build Status
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/0e31e5cdad534271ac688a82cc3ca17d)](https://app.codacy.com/app/wcarroll/ZertoApiWrapper?utm_source=github.com&utm_medium=referral&utm_content=wcarroll/ZertoApiWrapper&utm_campaign=Badge_Grade_Settings)
[![Build Status](https://dev.azure.com/ZertoPublic/ZertoApiWrapper/_apis/build/status/ZertoPublic.ZertoApiWrapper?branchName=master)](https://dev.azure.com/ZertoPublic/ZertoApiWrapper/_build/latest?definitionId=1&branchName=master)
![PowerShell Gallery](https://img.shields.io/powershellgallery/dt/ZertoApiWrapper?label=PowerShell%20Gallery%20Downloads)
## Legal Disclaimer
@@ -32,6 +32,7 @@ PS> Install-Module -name ZertoApiWrapper
## Recent Updates
* April 10th, 2020: April Release. See [Release Notes](https://github.com/ZertoPublic/ZertoApiWrapper/releases/tag/1.4.0.20200410).
* December 1st, 2019: November Release. See [Release Notes](https://github.com/ZertoPublic/ZertoApiWrapper/releases/tag/1.3.0.20191201).
* August 1st, 2019: August Release. See [Release Notes](https://github.com/ZertoPublic/ZertoApiWrapper/releases/tag/1.2.0.20190801).
* June 16th, 2019: Added functionality for Zerto Analytics.
+25 -6
View File
@@ -2,9 +2,28 @@
### Zerto Virtual Manager
* [Zerto version 7.5 has been released.](https://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Release%20Notes.pdf) As part of this release Zerto has added API functionality that requires the following updates.
* A token is now required to pair two sites together. The need is discussed in [Issue 46](https://github.com/ZertoPublic/ZertoApiWrapper/issues/46). To implement this change a `-token` parameter has been added to the `Add-ZertoPeerSite` function.
* A new function has been added; `New-ZertoPairingToken`. This function will allow users to generate a pairing authentication token from the target ZVM to be used in the pairing process. [Issue 47](https://github.com/ZertoPublic/ZertoApiWrapper/issues/47) covers additional details.
* A new function has been added; `Invoke-ZertoEvacuateVra`. This function will allow users to evacuate a target VRA by specifying a Host Name, VRA Name, or VRA Identifier. All VMs currently replicating to the specified location will be migrated to different targets. [Issue 51](https://github.com/ZertoPublic/ZertoApiWrapper/issues/51)
* A function has been added; `Copy-ZertoVpg`. This function will allow users to copy the settings of a single VPG and add new VMs to it. There is currently no customization beyond specifying the VMs to be placed in the newly created VPG. Should additional edits \ updates be required, they should be done post creation. [Issue 54](https://github.com/ZertoPublic/ZertoApiWrapper/issues/54)
* Fixed [issue 57](https://github.com/ZertoPublic/ZertoApiWrapper/issues/57) where a `Start-ZertoFailoverTest` would throw an error complaining about validating the body parameter. This has been fixed and tested against Zerto Virtual Manager 7.5 Update 1 with Windows PowerShell 5.1 and PowerShell Core 6.2.
* Addressed a reported [issue](https://github.com/ZertoPublic/ZertoApiWrapper/issues/60) in the `Get-ZertoRecoveryReport` function where the `-VpgIdentifier` parameter was not working. This parameter is not accepted by the API as a valid filter and is ignored. This parameter has been removed from the function.
* Addressed a reported [issue](https://github.com/ZertoPublic/ZertoApiWrapper/issues/61) where the `Export-ZertoVpgNicSetting` function would not properly execute when run against a VM with no NICs attached.
* In reviewing the `Export-ZertoVpgNicSetting`, a review of the `Import-ZertoVpgNicSetting` was completed and it was determined to update the import logic based on various test cases. Along with this, it is now possible to reset the NIC settings to the default state with the `Import-ZertoVpgNicSetting` command. Please review the [Import-ZertoVpgNicSetting help](https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Import-ZertoVmNicSetting.md) to review the updated options and import logic.
* Refactored the `Checkpoint-ZertoVpg` command to allow pipeline input (ByValue and ByProperty) for the VpgName parameter.
* Corrected a parameter typo in the `Get-ZertoVpgSetting` function. The misspelt parameter was added as an alias to ensure any existing scripts using the parameter continue to function.
* Refactored the `Get-ZertoVpg` command to remove repetitive commands and variables that are no longer required.
* Moved `Invoke-ZertoRestRequest` and `Invoke-ZARestRequest` to be public functions. As there become more and more scenarios where there are not prebuilt functions to accomplish complex specialized tasks, it became apparent that these functions could be leveraged to make the experience and workflow easier.
* Updated the `Install-ZertoVra` logic to ensure that the target datastore is available on the target host. There isn't currently any method to validate the target network, but if that becomes available in a later version of the API, the function will be updated.
* Updated the `Install-ZertoVra` function to allow for installation of the VRA using the host password method. Please review the [Install-ZertoVra](https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Install-ZertoVra.md) documentation for syntax and examples.
* Updated the `Edit-ZertoVra` function to allow for modification of the associated ESX host password if the need arises. Please review the [Edit-ZertoVra](https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Edit-ZertoVra.md) documentation for syntax and examples.
* Added a new function, `Set-ZertoUserCredential`, to allow the updating of the username and password used to connect the Zerto Virtual Manager to the paired hypervisor. Please see the [Set-ZertoUserCredential](https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Set-ZertoUserCredential.md) help for additional information.
* With the release of [Zerto 8.0](https://www.zerto.com/zerto-8-0-general-availability/) some additional API endpoints have become available.
* Updated `Get-ZertoVirtualizationSite` to add the `-repository` parameter to enable returning information for LTR repositories.
* Updated `Get-ZertoVpgSetting` to add the `-ltr` parameter to enable returning information for current LTR settings for the selected VPG.
### Zerto Analytics
* Added several functions for the newly added [Zerto Analytics](https://analytics.zerto.com) Planner.
* `Get-ZAPlannerSite` Help can be found here: [Get-ZAPlannerSite](https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAPlannerSite.md)
* `Get-ZAPlannerStatsReport` Help can be found here: [Get-ZAPlannerStatsReport](https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAPlannerStatsReport.md)
* `Get-ZAPlannerJournalSizeReport` Help can be found here: [Get-ZAPlannerJournalSizeReport](https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAPlannerJournalSizeReport.md)
* `Get-ZAPlannerNetworkPerformanceReport` Help can be found here: [Get-ZAPlannerNetworkPerformanceReport](https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAPlannerNetworkPerformanceReport.md)
* `Get-ZAPlannerWanReport` Help can be found here: [Get-ZAPlannerWanReport](https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAPlannerWanReport.md)
* `Get-ZAPlannerZcasReport` Help can be found here: [Get-ZAPlannerZcasReport](https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAPlannerZcasReport.md)
* Created `Get-ZAProtectedVm` and `Get-ZAProtectedVmReport` functions to leverage the newly released Zerto Analytics APIs for this data. Help files can be found here: [Get-ZAProtectedVm](https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAProtectedVm.md) and [Get-ZAProtectedVmReport](https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAProtectedVmReport.md)
+1 -1
View File
@@ -16,7 +16,7 @@ Describe $global:function -Tag 'Unit', 'Source', 'Built' {
Context "$($global:function)::Parameter Unit Tests" {
It "Has a parameter for the VpgName that is Mandatory" {
Get-Command $global:function | Should -HaveParameter vpgName -Mandatory -Type String
Get-Command $global:function | Should -HaveParameter vpgName -Mandatory -Type 'String[]'
}
It "Has a parameter for the CheckpointName that is Mandatory" {
+2 -1
View File
@@ -28,6 +28,7 @@ Describe $global:function -Tag 'Unit', 'Source', 'Built' {
@{ParameterName = 'vraIpAddress'; Type = 'String'; Mandatory = $false }
@{ParameterName = 'defaultGateway'; Type = 'String'; Mandatory = $false }
@{ParameterName = 'subnetMask'; Type = 'String'; Mandatory = $false }
@{ParameterName = 'HostRootPassword'; Type = 'securestring'; Mandatory = $false}
)
It "<ParameterName> parameter is of <Type> type" -TestCases $ParameterTestCases {
@@ -56,7 +57,7 @@ Describe $global:function -Tag 'Unit', 'Source', 'Built' {
param($ParameterName)
$attrs = (Get-Command $global:function).Parameters[$ParameterName].Attributes
$attrs.Where{ $_ -is [ValidateScript] }.Count | Should -Be 1
$attrs.Where{ $_ -is [ValidateScript] }.ScriptBlock | Should -Match '^\$_ \-match \[IPAddress\]\$_'
$attrs.Where{ $_ -is [ValidateScript] }.ScriptBlock | Should -Match '\$_ \-match \[IPAddress\]\$_'
}
}
@@ -0,0 +1,57 @@
#Requires -Modules Pester
$global:here = (Split-Path -Parent $MyInvocation.MyCommand.Path)
$global:function = ((Split-Path -leaf $MyInvocation.MyCommand.Path).Split('.'))[0]
Describe $global:function -Tag 'Unit', 'Source', 'Built' {
Context "$global:function::Parameter Unit Tests" {
It "$global:function should have exactly 17 parameters defined" {
(Get-Command $global:function).Parameters.Count | Should -Be 17
}
$ParameterTestCases = @(
@{ParameterName = 'siteIdentifier'; Type = 'String'; Mandatory = $true; Validation = 'NotNullOrEmpty' }
@{ParameterName = 'vmIdentifier'; Type = 'String[]'; Mandatory = $true; Validation = 'NotNullOrEmpty' }
@{ParameterName = 'recoveryType'; Type = 'String'; Mandatory = $true; Validation = 'Set' }
@{ParameterName = 'desiredJournalHistory'; Type = 'Int'; Mandatory = $false; Validation = 'Range' }
@{ParameterName = 'startDate'; Type = 'String'; Mandatory = $false; Validation = 'NotNullOrEmpty' }
@{ParameterName = 'endDate'; Type = 'String'; Mandatory = $false; Validation = 'NotNullOrEmpty' }
)
It "<ParameterName> parameter is of <Type> type" -TestCases $ParameterTestCases {
param($ParameterName, $Type, $Mandatory, $Validation)
Get-Command $global:function | Should -HaveParameter $ParameterName -Mandatory:$Mandatory -Type $Type
}
It "<ParameterName> parameter has correct validation setting" -TestCases $ParameterTestCases {
param($ParameterName, $Validation)
Switch ($Validation) {
'NotNullOrEmpty' {
$attrs = (Get-Command $global:function).Parameters[$ParameterName].Attributes
$attrs.Where{ $_ -is [ValidateNotNullOrEmpty] }.Count | Should -Be 1
}
'Range' {
$attrs = (Get-Command $global:function).Parameters[$ParameterName].Attributes
$attrs.Where{ $_ -is [ValidateRange] }.Count | Should -Be 1
}
'Set' {
$attrs = (Get-Command $global:function).Parameters[$ParameterName].Attributes
$attrs.Where{ $_ -is [ValidateSet] }.Count | Should -Be 1
}
default {
$true | Should be $false -Because "No Validation Selected. Review test cases"
}
}
}
}
Context "$global:function::Parameter Functional Tests" {
}
}
Remove-Variable -Name here -Scope Global
Remove-Variable -Name function -Scope Global
@@ -0,0 +1,57 @@
#Requires -Modules Pester
$global:here = (Split-Path -Parent $MyInvocation.MyCommand.Path)
$global:function = ((Split-Path -leaf $MyInvocation.MyCommand.Path).Split('.'))[0]
Describe $global:function -Tag 'Unit', 'Source', 'Built' {
Context "$global:function::Parameter Unit Tests" {
It "$global:function should have exactly 17 parameters defined" {
(Get-Command $global:function).Parameters.Count | Should -Be 17
}
$ParameterTestCases = @(
@{ParameterName = 'siteIdentifier'; Type = 'String'; Mandatory = $true; Validation = 'NotNullOrEmpty' }
@{ParameterName = 'vmIdentifier'; Type = 'String[]'; Mandatory = $true; Validation = 'NotNullOrEmpty' }
@{ParameterName = 'recoveryType'; Type = 'String'; Mandatory = $true; Validation = 'Set' }
@{ParameterName = 'interval'; Type = 'Int'; Mandatory = $false; Validation = 'Range' }
@{ParameterName = 'startDate'; Type = 'String'; Mandatory = $false; Validation = 'NotNullOrEmpty' }
@{ParameterName = 'endDate'; Type = 'String'; Mandatory = $false; Validation = 'NotNullOrEmpty' }
)
It "<ParameterName> parameter is of <Type> type" -TestCases $ParameterTestCases {
param($ParameterName, $Type, $Mandatory, $Validation)
Get-Command $global:function | Should -HaveParameter $ParameterName -Mandatory:$Mandatory -Type $Type
}
It "<ParameterName> parameter has correct validation setting" -TestCases $ParameterTestCases {
param($ParameterName, $Validation)
Switch ($Validation) {
'NotNullOrEmpty' {
$attrs = (Get-Command $global:function).Parameters[$ParameterName].Attributes
$attrs.Where{ $_ -is [ValidateNotNullOrEmpty] }.Count | Should -Be 1
}
'Range' {
$attrs = (Get-Command $global:function).Parameters[$ParameterName].Attributes
$attrs.Where{ $_ -is [ValidateRange] }.Count | Should -Be 1
}
'Set' {
$attrs = (Get-Command $global:function).Parameters[$ParameterName].Attributes
$attrs.Where{ $_ -is [ValidateSet] }.Count | Should -Be 1
}
default {
$true | Should be $false -Because "No Validation Selected. Review test cases"
}
}
}
}
Context "$global:function::Parameter Functional Tests" {
}
}
Remove-Variable -Name here -Scope Global
Remove-Variable -Name function -Scope Global
+42
View File
@@ -0,0 +1,42 @@
#Requires -Modules Pester
$global:here = (Split-Path -Parent $MyInvocation.MyCommand.Path)
$global:function = ((Split-Path -leaf $MyInvocation.MyCommand.Path).Split('.'))[0]
Describe $global:function -Tag 'Unit', 'Source', 'Built' {
Context "$global:function::Parameter Unit Tests" {
It "$global:function should have exactly 12 parameters defined" {
(Get-Command $global:function).Parameters.Count | Should -Be 12
}
$ParameterTestCases = @(
@{ParameterName = 'siteIdentifier'; Type = 'String[]'; Mandatory = $false; Validation = 'NotNullOrEmpty' }
)
It "<ParameterName> parameter is of <Type> type" -TestCases $ParameterTestCases {
param($ParameterName, $Type, $Mandatory, $Validation)
Get-Command $global:function | Should -HaveParameter $ParameterName -Mandatory:$Mandatory -Type $Type
}
It "<ParameterName> parameter has correct validation setting" -TestCases $ParameterTestCases {
param($ParameterName, $Validation)
Switch ($Validation) {
'NotNullOrEmpty' {
$attrs = (Get-Command $global:function).Parameters[$ParameterName].Attributes
$attrs.Where{ $_ -is [ValidateNotNullOrEmpty] }.Count | Should -Be 1
}
default {
$true | Should be $false -Because "No Validation Selected. Review test cases"
}
}
}
}
Context "$global:function::Parameter Functional Tests" {
}
}
Remove-Variable -Name here -Scope Global
Remove-Variable -Name function -Scope Global
@@ -0,0 +1,57 @@
#Requires -Modules Pester
$global:here = (Split-Path -Parent $MyInvocation.MyCommand.Path)
$global:function = ((Split-Path -leaf $MyInvocation.MyCommand.Path).Split('.'))[0]
Describe $global:function -Tag 'Unit', 'Source', 'Built' {
Context "$global:function::Parameter Unit Tests" {
It "$global:function should have exactly 17 parameters defined" {
(Get-Command $global:function).Parameters.Count | Should -Be 17
}
$ParameterTestCases = @(
@{ParameterName = 'siteIdentifier'; Type = 'String'; Mandatory = $true; Validation = 'NotNullOrEmpty' }
@{ParameterName = 'vmIdentifier'; Type = 'String[]'; Mandatory = $true; Validation = 'NotNullOrEmpty' }
@{ParameterName = 'recoveryType'; Type = 'String'; Mandatory = $true; Validation = 'Set' }
@{ParameterName = 'desiredJournalHistory'; Type = 'Int'; Mandatory = $false; Validation = 'Range' }
@{ParameterName = 'startDate'; Type = 'String'; Mandatory = $false; Validation = 'NotNullOrEmpty' }
@{ParameterName = 'endDate'; Type = 'String'; Mandatory = $false; Validation = 'NotNullOrEmpty' }
)
It "<ParameterName> parameter is of <Type> type" -TestCases $ParameterTestCases {
param($ParameterName, $Type, $Mandatory, $Validation)
Get-Command $global:function | Should -HaveParameter $ParameterName -Mandatory:$Mandatory -Type $Type
}
It "<ParameterName> parameter has correct validation setting" -TestCases $ParameterTestCases {
param($ParameterName, $Validation)
Switch ($Validation) {
'NotNullOrEmpty' {
$attrs = (Get-Command $global:function).Parameters[$ParameterName].Attributes
$attrs.Where{ $_ -is [ValidateNotNullOrEmpty] }.Count | Should -Be 1
}
'Range' {
$attrs = (Get-Command $global:function).Parameters[$ParameterName].Attributes
$attrs.Where{ $_ -is [ValidateRange] }.Count | Should -Be 1
}
'Set' {
$attrs = (Get-Command $global:function).Parameters[$ParameterName].Attributes
$attrs.Where{ $_ -is [ValidateSet] }.Count | Should -Be 1
}
default {
$true | Should be $false -Because "No Validation Selected. Review test cases"
}
}
}
}
Context "$global:function::Parameter Functional Tests" {
}
}
Remove-Variable -Name here -Scope Global
Remove-Variable -Name function -Scope Global
@@ -0,0 +1,56 @@
#Requires -Modules Pester
$global:here = (Split-Path -Parent $MyInvocation.MyCommand.Path)
$global:function = ((Split-Path -leaf $MyInvocation.MyCommand.Path).Split('.'))[0]
Describe $global:function -Tag 'Unit', 'Source', 'Built' {
Context "$global:function::Parameter Unit Tests" {
It "$global:function should have exactly 14 parameters defined" {
(Get-Command $global:function).Parameters.Count | Should -Be 16
}
$ParameterTestCases = @(
@{ParameterName = 'siteIdentifier'; Type = 'String'; Mandatory = $true; Validation = 'NotNullOrEmpty' }
@{ParameterName = 'vmIdentifier'; Type = 'String[]'; Mandatory = $true; Validation = 'NotNullOrEmpty' }
@{ParameterName = 'recoveryType'; Type = 'String'; Mandatory = $true; Validation = 'Set' }
@{ParameterName = 'startDate'; Type = 'String'; Mandatory = $false; Validation = 'NotNullOrEmpty' }
@{ParameterName = 'endDate'; Type = 'String'; Mandatory = $false; Validation = 'NotNullOrEmpty' }
)
It "<ParameterName> parameter is of <Type> type" -TestCases $ParameterTestCases {
param($ParameterName, $Type, $Mandatory, $Validation)
Get-Command $global:function | Should -HaveParameter $ParameterName -Mandatory:$Mandatory -Type $Type
}
It "<ParameterName> parameter has correct validation setting" -TestCases $ParameterTestCases {
param($ParameterName, $Validation)
Switch ($Validation) {
'NotNullOrEmpty' {
$attrs = (Get-Command $global:function).Parameters[$ParameterName].Attributes
$attrs.Where{ $_ -is [ValidateNotNullOrEmpty] }.Count | Should -Be 1
}
'Range' {
$attrs = (Get-Command $global:function).Parameters[$ParameterName].Attributes
$attrs.Where{ $_ -is [ValidateRange] }.Count | Should -Be 1
}
'Set' {
$attrs = (Get-Command $global:function).Parameters[$ParameterName].Attributes
$attrs.Where{ $_ -is [ValidateSet] }.Count | Should -Be 1
}
default {
$true | Should be $false -Because "No Validation Selected. Review test cases"
}
}
}
}
Context "$global:function::Parameter Functional Tests" {
}
}
Remove-Variable -Name here -Scope Global
Remove-Variable -Name function -Scope Global
@@ -0,0 +1,56 @@
#Requires -Modules Pester
$global:here = (Split-Path -Parent $MyInvocation.MyCommand.Path)
$global:function = ((Split-Path -leaf $MyInvocation.MyCommand.Path).Split('.'))[0]
Describe $global:function -Tag 'Unit', 'Source', 'Built' {
Context "$global:function::Parameter Unit Tests" {
It "$global:function should have exactly 16 parameters defined" {
(Get-Command $global:function).Parameters.Count | Should -Be 16
}
$ParameterTestCases = @(
@{ParameterName = 'siteIdentifier'; Type = 'String'; Mandatory = $true; Validation = 'NotNullOrEmpty' }
@{ParameterName = 'vmIdentifier'; Type = 'String[]'; Mandatory = $true; Validation = 'NotNullOrEmpty' }
@{ParameterName = 'recoveryType'; Type = 'String'; Mandatory = $true; Validation = 'Set' }
@{ParameterName = 'startDate'; Type = 'String'; Mandatory = $false; Validation = 'NotNullOrEmpty' }
@{ParameterName = 'endDate'; Type = 'String'; Mandatory = $false; Validation = 'NotNullOrEmpty' }
)
It "<ParameterName> parameter is of <Type> type" -TestCases $ParameterTestCases {
param($ParameterName, $Type, $Mandatory, $Validation)
Get-Command $global:function | Should -HaveParameter $ParameterName -Mandatory:$Mandatory -Type $Type
}
It "<ParameterName> parameter has correct validation setting" -TestCases $ParameterTestCases {
param($ParameterName, $Validation)
Switch ($Validation) {
'NotNullOrEmpty' {
$attrs = (Get-Command $global:function).Parameters[$ParameterName].Attributes
$attrs.Where{ $_ -is [ValidateNotNullOrEmpty] }.Count | Should -Be 1
}
'Range' {
$attrs = (Get-Command $global:function).Parameters[$ParameterName].Attributes
$attrs.Where{ $_ -is [ValidateRange] }.Count | Should -Be 1
}
'Set' {
$attrs = (Get-Command $global:function).Parameters[$ParameterName].Attributes
$attrs.Where{ $_ -is [ValidateSet] }.Count | Should -Be 1
}
default {
$true | Should be $false -Because "No Validation Selected. Review test cases"
}
}
}
}
Context "$global:function::Parameter Functional Tests" {
}
}
Remove-Variable -Name here -Scope Global
Remove-Variable -Name function -Scope Global
+41
View File
@@ -0,0 +1,41 @@
#Requires -Modules Pester
$global:here = (Split-Path -Parent $MyInvocation.MyCommand.Path)
$global:function = ((Split-Path -leaf $MyInvocation.MyCommand.Path).Split('.'))[0]
Describe $global:function -Tag 'Unit', 'Source', 'Built' {
Context "$global:function::Parameter Unit Tests" {
It "$global:function should have exactly 14 parameters defined" {
(Get-Command $global:function).Parameters.Count | Should -Be 14
}
$ParameterTestCases = @(
@{ParameterName = 'AllVms'; Type = 'Switch'; Mandatory = $false; Validation = $Null }
@{ParameterName = 'vmIdentifier'; Type = 'String[]'; Mandatory = $true; Validation = 'NotNullOrEmpty' }
@{ParameterName = 'Volumes'; Type = 'Switch'; Mandatory = $false; Validation = $Null }
)
It "<ParameterName> parameter is of <Type> type" -TestCases $ParameterTestCases {
param($ParameterName, $Type, $Mandatory, $Validation)
Get-Command $global:function | Should -HaveParameter $ParameterName -Mandatory:$Mandatory -Type $Type
}
It "<ParameterName> parameter has correct validation setting" -TestCases $ParameterTestCases {
param($ParameterName, $Validation)
Switch ($Validation) {
'NotNullOrEmpty' {
$attrs = (Get-Command $global:function).Parameters[$ParameterName].Attributes
$attrs.Where{ $_ -is [ValidateNotNullOrEmpty] }.Count | Should -Be 1
}
}
}
}
Context "$global:function::Parameter Functional Tests" {
}
}
Remove-Variable -Name here -Scope Global
Remove-Variable -Name function -Scope Global
@@ -0,0 +1,39 @@
#Requires -Modules Pester
$global:here = (Split-Path -Parent $MyInvocation.MyCommand.Path)
$global:function = ((Split-Path -leaf $MyInvocation.MyCommand.Path).Split('.'))[0]
Describe $global:function -Tag 'Unit', 'Source', 'Built' {
Context "$global:function::Parameter Unit Tests" {
It "$global:function should have exactly 12 parameters defined" {
(Get-Command $global:function).Parameters.Count | Should -Be 12
}
$ParameterTestCases = @(
@{ParameterName = 'vmIdentifier'; Type = 'String[]'; Mandatory = $true; Validation = 'NotNullOrEmpty' }
)
It "<ParameterName> parameter is of <Type> type" -TestCases $ParameterTestCases {
param($ParameterName, $Type, $Mandatory, $Validation)
Get-Command $global:function | Should -HaveParameter $ParameterName -Mandatory:$Mandatory -Type $Type
}
It "<ParameterName> parameter has correct validation setting" -TestCases $ParameterTestCases {
param($ParameterName, $Validation)
Switch ($Validation) {
'NotNullOrEmpty' {
$attrs = (Get-Command $global:function).Parameters[$ParameterName].Attributes
$attrs.Where{ $_ -is [ValidateNotNullOrEmpty] }.Count | Should -Be 1
}
}
}
}
Context "$global:function::Parameter Functional Tests" {
}
}
Remove-Variable -Name here -Scope Global
Remove-Variable -Name function -Scope Global
@@ -3,13 +3,257 @@ $global:here = (Split-Path -Parent $MyInvocation.MyCommand.Path)
$global:function = ((Split-Path -leaf $MyInvocation.MyCommand.Path).Split('.'))[0]
Describe $global:function -Tag 'Unit', 'Source', 'Built' {
BeforeAll {
$script:ScriptBlock = (Get-Command $global:function).ScriptBlock
}
Context "$global:function::Parameter Unit Tests" {
It "$global:function should have exactly 23 parameters defined" {
(Get-Command $global:function).Parameters.Count | Should -Be 23
}
$ParameterTestCases = @(
@{ParameterName = 'siteIdentifier'; Type = 'String'; Mandatory = $true; Validation = 'NotNullOrEmpty' }
@{ParameterName = 'hostIdentifier'; Type = 'String'; Mandatory = $false; Validation = 'NotNullOrEmpty' }
@{ParameterName = 'folders'; Type = 'Switch'; Mandatory = $true; Validation = $Null }
@{ParameterName = 'hostClusters'; Type = 'Switch'; Mandatory = $true; Validation = $Null }
@{ParameterName = 'hosts'; Type = 'Switch'; Mandatory = $true; Validation = $Null }
@{ParameterName = 'networks'; Type = 'Switch'; Mandatory = $true; Validation = $Null }
@{ParameterName = 'resourcePools'; Type = 'Switch'; Mandatory = $true; Validation = $Null }
@{ParameterName = 'vms'; Type = 'Switch'; Mandatory = $true; Validation = $Null }
@{ParameterName = 'repositories'; Type = 'Switch'; Mandatory = $true; Validation = $Null }
)
It "<ParameterName> parameter is of <Type> type" -TestCases $ParameterTestCases {
param($ParameterName, $Type, $Mandatory)
Get-Command $global:function | Should -HaveParameter $ParameterName -Mandatory:$Mandatory -Type $Type
}
It "<ParameterName> parameter has correct validation setting of <Validation>" -TestCases $ParameterTestCases {
param($ParameterName, $Type, $Validation)
$attrs = (Get-Command $global:function).Parameters[$ParameterName].Attributes
Switch ($Validation) {
'NotNullOrEmpty' {
$attrs.Where{ $_ -is [ValidateNotNullOrEmpty] }.Count | Should -Be 1
}
$Null {
$Type -match 'Switch' | Should -BeTrue -Because "Only Switch Parameters should not have validation"
}
default {
$true | Should -BeFalse -Because "No Validation Selected. Review test cases"
}
}
}
It "$($global:function) does not have 'SupportsShouldProcess'" {
Get-Command $global:function | Should -not -HaveParameter WhatIf
Get-Command $global:function | Should -not -HaveParameter Confirm
$script:ScriptBlock | Should -not -match 'SupportsShouldProcess'
$script:ScriptBlock | Should -not -match '\$PSCmdlet\.ShouldProcess\(.+\)'
}
}
Context "$global:function::Parameter Functional Tests" {
Mock -ModuleName ZertoApiWrapper -CommandName Invoke-ZertoRestRequest -ParameterFilter {
$uri -eq 'virtualizationsites'
} {
return (Get-Content "$global:here\Mocks\VirtualSite-NoParams.json" -Raw) | ConvertFrom-Json
} -Verifiable
Mock -ModuleName ZertoApiWrapper -CommandName Invoke-ZertoRestRequest -ParameterFilter {
$uri -eq 'virtualizationsites/1234/devices'
} {
return (Get-Content "$global:here\Mocks\VirtualSite-devices.json" -Raw) | ConvertFrom-Json
} -Verifiable
Mock -ModuleName ZertoApiWrapper -CommandName Invoke-ZertoRestRequest -ParameterFilter {
$uri -eq 'virtualizationsites/1234/devices?hostIdentifier=4567'
} {
return (Get-Content "$global:here\Mocks\VirtualSite-devices-hostid.json" -Raw) | ConvertFrom-Json
} -Verifiable
Mock -ModuleName ZertoApiWrapper -CommandName Invoke-ZertoRestRequest -ParameterFilter {
$uri -eq 'virtualizationsites/1234/hosts'
} {
return (Get-Content "$global:here\Mocks\VirtualSite-hosts.json" -Raw) | ConvertFrom-Json
} -Verifiable
Mock -ModuleName ZertoApiWrapper -CommandName Invoke-ZertoRestRequest -ParameterFilter {
$uri -eq 'virtualizationsites/1234/hosts/4567'
} {
return (Get-Content "$global:here\Mocks\VirtualSite-hosts-hostid.json" -Raw) | ConvertFrom-Json
} -Verifiable
Mock -ModuleName ZertoApiWrapper -CommandName Invoke-ZertoRestRequest -ParameterFilter {
$uri -eq 'virtualizationsites/1234'
} {
return (Get-Content "$global:here\Mocks\VirtualSite-SiteId.json" -Raw) | ConvertFrom-Json
} -Verifiable
Mock -ModuleName ZertoApiWrapper -CommandName Invoke-ZertoRestRequest -ParameterFilter {
$uri -eq 'virtualizationsites/1234/datastores'
} {
return (Get-Content "$global:here\Mocks\VirtualSite-datastores.json" -Raw) | ConvertFrom-Json
} -Verifiable
Mock -ModuleName ZertoApiWrapper -CommandName Invoke-ZertoRestRequest -ParameterFilter {
$uri -eq 'virtualizationsites/1234/datastoreclusters'
} {
return (Get-Content "$global:here\Mocks\VirtualSite-datastoreClusters.json" -Raw) | ConvertFrom-Json
} -Verifiable
Mock -ModuleName ZertoApiWrapper -CommandName Invoke-ZertoRestRequest -ParameterFilter {
$uri -eq 'virtualizationsites/1234/networks'
} {
return (Get-Content "$global:here\Mocks\VirtualSite-Networks.json" -Raw) | ConvertFrom-Json
} -Verifiable
Mock -ModuleName ZertoApiWrapper -CommandName Invoke-ZertoRestRequest -ParameterFilter {
$uri -eq 'virtualizationsites/1234/folders'
} {
return (Get-Content "$global:here\Mocks\VirtualSite-Folders.json" -Raw) | ConvertFrom-Json
} -Verifiable
Mock -ModuleName ZertoApiWrapper -CommandName Invoke-ZertoRestRequest -ParameterFilter {
$uri -eq 'virtualizationsites/1234/hostclusters'
} {
return (Get-Content "$global:here\Mocks\VirtualSite-hostClusters.json" -Raw) | ConvertFrom-Json
} -Verifiable
Mock -ModuleName ZertoApiWrapper -CommandName Invoke-ZertoRestRequest -ParameterFilter {
$uri -eq 'virtualizationsites/1234/resourcepools'
} {
return (Get-Content "$global:here\Mocks\VirtualSite-ResourcePools.json" -Raw) | ConvertFrom-Json
} -Verifiable
Mock -ModuleName ZertoApiWrapper -CommandName Invoke-ZertoRestRequest -ParameterFilter {
$uri -eq 'virtualizationsites/1234/vms'
} {
return (Get-Content "$global:here\Mocks\VirtualSite-VMs.json" -Raw) | ConvertFrom-Json
} -Verifiable
Mock -ModuleName ZertoApiWrapper -CommandName Invoke-ZertoRestRequest -ParameterFilter {
$uri -eq 'virtualizationsites/1234/repositories'
} {
return (Get-Content "$global:here\Mocks\VirtualSite-repositories.json" -Raw) | ConvertFrom-Json
} -Verifiable
It "Should return all known sites when called without parameters" {
$results = Get-ZertoVirtualizationSite
$results.Count | Should -BeExactly 2
}
It "Should return a single site when a siteIdentifier is provided" {
$results = Get-ZertoVirtualizationSite -siteIdentifier '1234'
$results.VirtualizationSiteName | Should -BeExactly 'cavc.nc.lab'
$results.siteIdentifier | Should -BeExactly '8e1c9f53-4973-4a4a-b2dd-1ebb293614d8'
}
It "Should return a list of devices with the '-devices' switch" {
$results = Get-ZertoVirtualizationSite -siteIdentifier '1234' -devices
$results.Count | Should -BeExactly 5
}
It "Should return a list of devices with the '-devices' switch and hostIdentifier provided" {
$results = Get-ZertoVirtualizationSite -siteIdentifier '1234' -devices -hostIdentifier '4567'
$results.Count | Should -BeExactly 5
}
It "Should return a list of hosts with the '-hosts' switch" {
$results = Get-ZertoVirtualizationSite -siteIdentifier '1234' -hosts
$results.Count | Should -BeExactly 3
}
It "Should return a single host with the '-hosts' switch and hostIdentifier provided" {
$results = Get-ZertoVirtualizationSite -siteIdentifier '1234' -hosts -hostIdentifier '4567'
$results.VirtualizationHostName | Should -BeExactly "caesx3.nc.lab"
$results.hostIdentifier | Should -BeExactly "09db6c5b-b956-430f-9589-b58876ca377a.host-18"
}
It "Should return a list of datastores with the '-datastores' switch" {
$results = Get-ZertoVirtualizationSite -siteIdentifier '1234' -datastores
$results.Count | Should -BeExactly 8
}
It "Should return a list of datastores with the '-datastoreClusters' switch" {
$results = Get-ZertoVirtualizationSite -siteIdentifier '1234' -datastoreClusters
$results.DatastoreClusterIdentifier | Should -BeExactly "09db6c5b-b956-430f-9589-b58876ca377a.group-p44"
$results.DatastoreClusterName | Should -BeExactly "CA_DS_Cluster"
}
It "Should return a list of Networks with the '-networks' switch" {
$results = Get-ZertoVirtualizationSite -siteIdentifier '1234' -networks
$results.NetworkIdentifier | Should -BeExactly "09db6c5b-b956-430f-9589-b58876ca377a.network-20"
$results.VirtualizationNetworkName | Should -BeExactly "VM Network"
}
It "Should return a list of folders with the '-folders' switch" {
$results = Get-ZertoVirtualizationSite -siteIdentifier '1234' -folders
$results.Count | Should -BeExactly 3
}
It "Should return a list of Host Clusters with the '-hostClusters' switch" {
$results = Get-ZertoVirtualizationSite -siteIdentifier '1234' -hostClusters
$results.ClusterIdentifier | Should -BeExactly "09db6c5b-b956-430f-9589-b58876ca377a.domain-c7"
$results.VirtualizationClusterName | Should -BeExactly "CA Cluster"
}
It "Should return a list of Resource Pools with the '-resourcePools' switch" {
$results = Get-ZertoVirtualizationSite -siteIdentifier '1234' -resourcePools
$results.ResourcePoolIdentifier | Should -BeExactly "09db6c5b-b956-430f-9589-b58876ca377a.resgroup-8"
$results.ResourcePoolName | Should -BeExactly "Resources"
}
It "Should return a list of VMs with the '-VMs' switch" {
$results = Get-ZertoVirtualizationSite -siteIdentifier '1234' -vms
$results.Count | Should -BeExactly 4
}
It "Should return a list of LTR Repositories with the '-repositories' switch" {
$results = Get-ZertoVirtualizationSite -siteIdentifier '1234' -repositories
$results.ConnectionType | Should -BeExactly "ServerMessageBlock"
$results.RepositoryIdentifier | Should -BeExactly "120355ce-fcd0-4820-a971-787d0470793b"
$results.RepositoryName | Should -BeExactly "Synology"
$results.StorageType | Should -BeExactly "NetworkShare"
$results.Path | Should -not -be $null
}
Assert-VerifiableMock
Assert-MockCalled -ModuleName ZertoApiWrapper -CommandName Invoke-ZertoRestRequest -ParameterFilter {
$uri -eq 'virtualizationsites'
} -Exactly 1
Assert-MockCalled -ModuleName ZertoApiWrapper -CommandName Invoke-ZertoRestRequest -ParameterFilter {
$uri -eq 'virtualizationsites/1234'
} -Exactly 1
Assert-MockCalled -ModuleName ZertoApiWrapper -CommandName Invoke-ZertoRestRequest -ParameterFilter {
$uri -eq 'virtualizationsites/1234/devices'
} -Exactly 1
Assert-MockCalled -ModuleName ZertoApiWrapper -CommandName Invoke-ZertoRestRequest -ParameterFilter {
$uri -eq 'virtualizationsites/1234/devices?hostIdentifier=4567'
} -Exactly 1
Assert-MockCalled -ModuleName ZertoApiWrapper -CommandName Invoke-ZertoRestRequest -ParameterFilter {
$uri -eq 'virtualizationsites/1234/hosts'
} -Exactly 1
Assert-MockCalled -ModuleName ZertoApiWrapper -CommandName Invoke-ZertoRestRequest -ParameterFilter {
$uri -eq 'virtualizationsites/1234/hosts/4567'
} -Exactly 1
Assert-MockCalled -ModuleName ZertoApiWrapper -CommandName Invoke-ZertoRestRequest -ParameterFilter {
$uri -eq 'virtualizationsites/1234/datastores'
} -Exactly 1
Assert-MockCalled -ModuleName ZertoApiWrapper -CommandName Invoke-ZertoRestRequest -ParameterFilter {
$uri -eq 'virtualizationsites/1234/datastoreclusters'
} -Exactly 1
Assert-MockCalled -ModuleName ZertoApiWrapper -CommandName Invoke-ZertoRestRequest -ParameterFilter {
$uri -eq 'virtualizationsites/1234/networks'
} -Exactly 1
Assert-MockCalled -ModuleName ZertoApiWrapper -CommandName Invoke-ZertoRestRequest -ParameterFilter {
$uri -eq 'virtualizationsites/1234/folders'
} -Exactly 1
Assert-MockCalled -ModuleName ZertoApiWrapper -CommandName Invoke-ZertoRestRequest -ParameterFilter {
$uri -eq 'virtualizationsites/1234/hostclusters'
} -Exactly 1
Assert-MockCalled -ModuleName ZertoApiWrapper -CommandName Invoke-ZertoRestRequest -ParameterFilter {
$uri -eq 'virtualizationsites/1234/resourcepools'
} -Exactly 1
Assert-MockCalled -ModuleName ZertoApiWrapper -CommandName Invoke-ZertoRestRequest -ParameterFilter {
$uri -eq 'virtualizationsites/1234/vms'
} -Exactly 1
Assert-MockCalled -ModuleName ZertoApiWrapper -CommandName Invoke-ZertoRestRequest -ParameterFilter {
$uri -eq 'virtualizationsites/1234/repositories'
} -Exactly 1
}
}
+6 -4
View File
@@ -5,8 +5,8 @@ $global:function = ((Split-Path -leaf $MyInvocation.MyCommand.Path).Split('.'))[
Describe $global:function -Tag 'Unit', 'Source', 'Built' {
Context "$global:function::Parameter Unit Tests" {
it "$global:function should have exactly 22 parameters defined" {
(get-command $global:function).Parameters.Count | Should -Be 22
It "$global:function should have exactly 24 parameters defined" {
(Get-Command $global:function).Parameters.Count | Should -Be 24
}
$ParameterTestCases = @(
@@ -17,6 +17,8 @@ Describe $global:function -Tag 'Unit', 'Source', 'Built' {
@{ParameterName = 'vraIpAddress'; Type = 'String'; Mandatory = $true; Validation = 'IpAddr' }
@{ParameterName = 'subnetMask'; Type = 'String'; Mandatory = $true; Validation = 'IpAddr' }
@{ParameterName = 'defaultGateway'; Type = 'String'; Mandatory = $true; Validation = 'IpAddr' }
@{ParameterName = 'UseRootCredential'; Type = 'Switch'; Mandatory = $true; Validation = $null }
@{ParameterName = 'HostRootPassword'; Type = 'SecureString'; Mandatory = $true; Validation = 'NotNullOrEmpty' }
)
It "<ParameterName> parameter is of <Type> type" -TestCases $ParameterTestCases {
@@ -35,12 +37,12 @@ Describe $global:function -Tag 'Unit', 'Source', 'Built' {
'IpAddr' {
$attrs = (Get-Command $global:function).Parameters[$ParameterName].Attributes
$attrs.Where{ $_ -is [ValidateScript] }.Count | Should -Be 1
$attrs.Where{ $_ -is [ValidateScript] }.ScriptBlock | Should -Match '^\$_ \-match \[IPAddress\]\$_'
$attrs.Where{ $_ -is [ValidateScript] }.ScriptBlock | Should -Match '\$_ \-match \[IPAddress\]\$_'
}
$null {
$attrs = (Get-Command $global:function).Parameters[$ParameterName].Attributes
$attrs.TypeId.Count | Should -Be 2
$attrs.TypeId.Count | Should -Be 3
}
}
}
@@ -12,7 +12,6 @@ Describe $global:function -Tag 'Unit', 'Source', 'Built' {
@{ParameterName = 'uri'; Type = 'String'; Mandatory = $true; TestName = 'URI' }
@{ParameterName = 'method'; Type = 'String'; Mandatory = $false; TestName = 'Method' }
@{ParameterName = 'body'; Type = 'String'; Mandatory = $false; TestName = 'Body' }
@{ParameterName = 'contentType'; Type = 'String'; Mandatory = $false; TestName = 'contentType' }
)
It "Parameter present and Type test for: <TestName> " -TestCases $testCases {
@@ -29,14 +28,9 @@ Describe $global:function -Tag 'Unit', 'Source', 'Built' {
Get-Command $global:function | Should -HaveParameter Method -DefaultValue "GET"
}
It "ContentType parameter default is 'application/json'" {
Get-Command $global:function | Should -HaveParameter contentType -DefaultValue "application/json"
}
$NotNullOrEmptyTests = @(
@{ParameterName = 'uri'; TestName = 'Uri' }
@{ParameterName = 'body'; TestName = 'Body' }
@{ParameterName = 'contentType'; TestName = 'ContentType' }
)
It "<TestName> parameter does not accecpt a null or empty value" -TestCases $NotNullOrEmptyTests {
@@ -14,9 +14,7 @@ Describe $global:function -Tag 'Unit', 'Source', 'Built' {
$ParameterNameTestCases = @(
@{ParameterName = "uri"; Type = "String"; Mandatory = $true; DefaultValue = $null; TestName = "URI" }
@{ParameterName = "method"; Type = "String"; Mandatory = $false; DefaultValue = 'GET'; TestName = "Method" }
@{ParameterName = "apiVersion"; Type = "String"; Mandatory = $false; DefaultValue = 'v1'; TestName = "API Version" }
@{ParameterName = "body"; Type = "String"; Mandatory = $false; DefaultValue = $null; TestName = "Body" }
@{ParameterName = "contentType"; Type = "String"; Mandatory = $false; DefaultValue = 'application/json'; TestName = "Content Type" }
@{ParameterName = "credential"; Type = "PSCredential"; Mandatory = $false; DefaultValue = $null; TestName = "Credential" }
@{ParameterName = "returnHeaders"; Type = "Switch"; Mandatory = $false; DefaultValue = $null; TestName = "Return Headers" }
)
@@ -36,9 +34,7 @@ Describe $global:function -Tag 'Unit', 'Source', 'Built' {
$ParameterValidationTestCases = @(
@{ParameterName = "URI"; TestName = "URI" }
@{ParameterName = "apiVersion"; TestName = "Api Version" }
@{ParameterName = "body"; TestName = "Body" }
@{ParameterName = "contentType"; TestName = "Content Type" }
)
It "<TestName> parameter cannot be null or empty" -TestCases $ParameterValidationTestCases {
@@ -0,0 +1,14 @@
[
{
"FolderIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.group-v3",
"FolderName": "/"
},
{
"FolderIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.group-v27",
"FolderName": "Templates"
},
{
"FolderIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.group-v9",
"FolderName": "Discovered virtual machine"
}
]
@@ -0,0 +1,4 @@
{
"NetworkIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.network-20",
"VirtualizationNetworkName": "VM Network"
}
@@ -0,0 +1,10 @@
[
{
"SiteIdentifier": "8e1c9f53-4973-4a4a-b2dd-1ebb293614d8",
"VirtualizationSiteName": "cavc.nc.lab"
},
{
"SiteIdentifier": "15aa0d43-69cd-400a-8b99-fe94bbac3e19",
"VirtualizationSiteName": "ncvc.nc.lab"
}
]
@@ -0,0 +1,4 @@
{
"ResourcePoolIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.resgroup-8",
"ResourcepoolName": "Resources"
}
@@ -0,0 +1,4 @@
{
"SiteIdentifier": "8e1c9f53-4973-4a4a-b2dd-1ebb293614d8",
"VirtualizationSiteName": "cavc.nc.lab"
}
+18
View File
@@ -0,0 +1,18 @@
[
{
"VmIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.vm-55",
"VmName": "TimeSeries"
},
{
"VmIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.vm-53",
"VmName": "AnsibleTarget"
},
{
"VmIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.vm-28",
"VmName": "cazvm.nc.lab"
},
{
"VmIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.vm-26",
"VmName": "WinTemplate"
}
]
@@ -0,0 +1,4 @@
{
"DatastoreClusterIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.group-p44",
"DatastoreClusterName": "CA_DS_Cluster"
}
@@ -0,0 +1,34 @@
[
{
"DatastoreIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.datastore-40",
"DatastoreName": "MgmtLUN"
},
{
"DatastoreIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.datastore-23",
"DatastoreName": "LabPool"
},
{
"DatastoreIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.datastore-22",
"DatastoreName": "datastore1 (2)"
},
{
"DatastoreIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.datastore-21",
"DatastoreName": "datastore1 (1)"
},
{
"DatastoreIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.datastore-19",
"DatastoreName": "datastore1"
},
{
"DatastoreIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.datastore-41",
"DatastoreName": "CA_DS_01"
},
{
"DatastoreIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.datastore-42",
"DatastoreName": "CA_DS_02"
},
{
"DatastoreIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.datastore-43",
"DatastoreName": "CA_DS_03"
}
]
@@ -0,0 +1,62 @@
[
{
"DatastoreIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.datastore-40",
"DeviceIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.naa.6001405a18009ded4f84d4177d8893d6",
"DeviceName": "SYNOLOGY iSCSI Disk (naa.6001405a18009ded4f84d4177d8893d6)",
"HostIdentifiers": [
"09db6c5b-b956-430f-9589-b58876ca377a.host-18",
"09db6c5b-b956-430f-9589-b58876ca377a.host-15",
"09db6c5b-b956-430f-9589-b58876ca377a.host-12"
],
"SizeInBytes": 1073741824000,
"VmIdentifier": null
},
{
"DatastoreIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.datastore-22",
"DeviceIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.mpx.vmhba1:C0:T0:L0",
"DeviceName": "Local VMware Disk (mpx.vmhba1:C0:T0:L0)",
"HostIdentifiers": [
"09db6c5b-b956-430f-9589-b58876ca377a.host-18",
"09db6c5b-b956-430f-9589-b58876ca377a.host-15",
"09db6c5b-b956-430f-9589-b58876ca377a.host-12"
],
"SizeInBytes": 42949672960,
"VmIdentifier": null
},
{
"DatastoreIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.datastore-42",
"DeviceIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.naa.6001405922cd662dc343d4683d9aecd1",
"DeviceName": "SYNOLOGY iSCSI Disk (naa.6001405922cd662dc343d4683d9aecd1)",
"HostIdentifiers": [
"09db6c5b-b956-430f-9589-b58876ca377a.host-18",
"09db6c5b-b956-430f-9589-b58876ca377a.host-15",
"09db6c5b-b956-430f-9589-b58876ca377a.host-12"
],
"SizeInBytes": 536870912000,
"VmIdentifier": null
},
{
"DatastoreIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.datastore-41",
"DeviceIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.naa.6001405522c4ad5d65a6d4113d9657dc",
"DeviceName": "SYNOLOGY iSCSI Disk (naa.6001405522c4ad5d65a6d4113d9657dc)",
"HostIdentifiers": [
"09db6c5b-b956-430f-9589-b58876ca377a.host-18",
"09db6c5b-b956-430f-9589-b58876ca377a.host-15",
"09db6c5b-b956-430f-9589-b58876ca377a.host-12"
],
"SizeInBytes": 536870912000,
"VmIdentifier": null
},
{
"DatastoreIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.datastore-43",
"DeviceIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.naa.600140533d732abd8caed42cfda50ed1",
"DeviceName": "SYNOLOGY iSCSI Disk (naa.600140533d732abd8caed42cfda50ed1)",
"HostIdentifiers": [
"09db6c5b-b956-430f-9589-b58876ca377a.host-18",
"09db6c5b-b956-430f-9589-b58876ca377a.host-15",
"09db6c5b-b956-430f-9589-b58876ca377a.host-12"
],
"SizeInBytes": 536870912000,
"VmIdentifier": null
}
]
@@ -0,0 +1,62 @@
[
{
"DatastoreIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.datastore-40",
"DeviceIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.naa.6001405a18009ded4f84d4177d8893d6",
"DeviceName": "SYNOLOGY iSCSI Disk (naa.6001405a18009ded4f84d4177d8893d6)",
"HostIdentifiers": [
"09db6c5b-b956-430f-9589-b58876ca377a.host-18",
"09db6c5b-b956-430f-9589-b58876ca377a.host-15",
"09db6c5b-b956-430f-9589-b58876ca377a.host-12"
],
"SizeInBytes": 1073741824000,
"VmIdentifier": null
},
{
"DatastoreIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.datastore-22",
"DeviceIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.mpx.vmhba1:C0:T0:L0",
"DeviceName": "Local VMware Disk (mpx.vmhba1:C0:T0:L0)",
"HostIdentifiers": [
"09db6c5b-b956-430f-9589-b58876ca377a.host-18",
"09db6c5b-b956-430f-9589-b58876ca377a.host-15",
"09db6c5b-b956-430f-9589-b58876ca377a.host-12"
],
"SizeInBytes": 42949672960,
"VmIdentifier": null
},
{
"DatastoreIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.datastore-42",
"DeviceIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.naa.6001405922cd662dc343d4683d9aecd1",
"DeviceName": "SYNOLOGY iSCSI Disk (naa.6001405922cd662dc343d4683d9aecd1)",
"HostIdentifiers": [
"09db6c5b-b956-430f-9589-b58876ca377a.host-18",
"09db6c5b-b956-430f-9589-b58876ca377a.host-15",
"09db6c5b-b956-430f-9589-b58876ca377a.host-12"
],
"SizeInBytes": 536870912000,
"VmIdentifier": null
},
{
"DatastoreIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.datastore-41",
"DeviceIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.naa.6001405522c4ad5d65a6d4113d9657dc",
"DeviceName": "SYNOLOGY iSCSI Disk (naa.6001405522c4ad5d65a6d4113d9657dc)",
"HostIdentifiers": [
"09db6c5b-b956-430f-9589-b58876ca377a.host-18",
"09db6c5b-b956-430f-9589-b58876ca377a.host-15",
"09db6c5b-b956-430f-9589-b58876ca377a.host-12"
],
"SizeInBytes": 536870912000,
"VmIdentifier": null
},
{
"DatastoreIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.datastore-43",
"DeviceIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.naa.600140533d732abd8caed42cfda50ed1",
"DeviceName": "SYNOLOGY iSCSI Disk (naa.600140533d732abd8caed42cfda50ed1)",
"HostIdentifiers": [
"09db6c5b-b956-430f-9589-b58876ca377a.host-18",
"09db6c5b-b956-430f-9589-b58876ca377a.host-15",
"09db6c5b-b956-430f-9589-b58876ca377a.host-12"
],
"SizeInBytes": 536870912000,
"VmIdentifier": null
}
]
@@ -0,0 +1,4 @@
{
"ClusterIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.domain-c7",
"VirtualizationClusterName": "CA Cluster"
}
@@ -0,0 +1,4 @@
{
"HostIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.host-18",
"VirtualizationHostName": "caesx3.nc.lab"
}
+14
View File
@@ -0,0 +1,14 @@
[
{
"HostIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.host-18",
"VirtualizationHostName": "caesx3.nc.lab"
},
{
"HostIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.host-15",
"VirtualizationHostName": "caesx2.nc.lab"
},
{
"HostIdentifier": "09db6c5b-b956-430f-9589-b58876ca377a.host-12",
"VirtualizationHostName": "caesx1.nc.lab"
}
]
@@ -0,0 +1,7 @@
{
"ConnectionType": "ServerMessageBlock",
"Path": "\\\\192.168.1.150\\zBackups",
"RepositoryIdentifier": "120355ce-fcd0-4820-a971-787d0470793b",
"RepositoryName": "Synology",
"StorageType": "NetworkShare"
}
@@ -0,0 +1,42 @@
#Requires -Modules Pester
$global:here = (Split-Path -Parent $MyInvocation.MyCommand.Path)
$global:function = ((Split-Path -leaf $MyInvocation.MyCommand.Path).Split('.'))[0]
Describe $global:function -Tag 'Unit', 'Source', 'Built' {
InModuleScope -ModuleName ZertoApiWrapper {
Context "$global:function::Parameter Unit Tests" {
BeforeAll {
$script:ScriptBlock = (Get-Command $global:function).ScriptBlock
}
It "$global:function should have exactly 14 parameters defined" {
(Get-Command $global:function).Parameters.Count | Should -Be 14
}
$ParameterTestCases = @(
@{ParameterName = 'UserCredential'; Type = 'pscredential'; Mandatory = $true }
)
It "<ParameterName> parameter is of <Type> type" -TestCases $ParameterTestCases {
param($ParameterName, $Type, $Mandatory, $Validation)
Get-Command $global:function | Should -HaveParameter $ParameterName -Mandatory:$Mandatory -Type $Type
}
It "Supports 'SupportsShouldProcess'" {
Get-Command $global:function | Should -HaveParameter WhatIf
Get-Command $global:function | Should -HaveParameter Confirm
$script:ScriptBlock | Should -match 'SupportsShouldProcess'
$script:ScriptBlock | Should -match '\$PSCmdlet\.ShouldProcess\(.+\)'
}
}
Context "$global:function::Parameter Functional Tests" {
}
}
}
Remove-Variable -Name here -Scope Global
Remove-Variable -Name function -Scope Global
+1 -1
View File
@@ -19,7 +19,7 @@
SkipPublisherCheck = $true
}
Target = 'CurrentUser'
Version = '4.8.1'
Version = '4.10.1'
Tags = 'Bootstrap'
}
+13 -9
View File
@@ -4,10 +4,12 @@ function Checkpoint-ZertoVpg {
param(
[Parameter(
Mandatory = $true,
HelpMessage = "Name of the VPG to tag."
HelpMessage = "Name of the VPG to tag.",
ValueFromPipeline = $true,
ValueFromPipelineByPropertyName = $true
)]
[ValidateNotNullOrEmpty()]
[string]$vpgName,
[string[]]$vpgName,
[Parameter(
Mandatory = $true,
HelpMessage = "Text to tag the checkpoint with."
@@ -18,16 +20,18 @@ function Checkpoint-ZertoVpg {
begin {
$baseUri = "vpgs"
$vpgIdentifier = $(get-zertovpg -name $vpgName).vpgIdentifier
$body = @{"checkpointName" = $checkpointName}
}
process {
if ($vpgIdentifier) {
$uri = "{0}/{1}/Checkpoints" -f $baseUri, $vpgIdentifier
Invoke-ZertoRestRequest -uri $uri -body $($body | ConvertTo-Json) -method "POST"
} else {
Write-Output "Cannot find VPG named $vpgName. Please check the name and try again."
foreach ($name in $vpgName) {
$vpgIdentifier = $(get-zertovpg -name $name).vpgIdentifier
if ($vpgIdentifier) {
$uri = "{0}/{1}/Checkpoints" -f $baseUri, $vpgIdentifier
$body = @{"checkpointName" = $checkpointName}
Invoke-ZertoRestRequest -uri $uri -body $($body | ConvertTo-Json) -method "POST"
} else {
Write-Output "Cannot find VPG named $name. Please check the name and try again."
}
}
}
+19 -7
View File
@@ -18,20 +18,26 @@ function Edit-ZertoVra {
ParameterSetName = "StaticIp",
HelpMessage = "Static IP address to assign to the VRA."
)]
[ValidateScript( {$_ -match [IPAddress]$_ })]
[ValidateScript( { $_ -match [IPAddress]$_ })]
[string]$vraIpAddress,
[Parameter(
ParameterSetName = "StaticIp",
HelpMessage = "Default gateway to assign to the VRA"
)]
[ValidateScript( {$_ -match [IPAddress]$_ })]
[ValidateScript( { $_ -match [IPAddress]$_ })]
[string]$defaultGateway,
[Parameter(
ParameterSetName = "StaticIp",
HelpMessage = "Subnetmask to be assigned to the VRA"
)]
[ValidateScript( {$_ -match [IPAddress]$_ })]
[string]$subnetMask
[ValidateScript( { $_ -match [IPAddress]$_ })]
[string]$subnetMask,
[Parameter(
HelpMessage = "Updated ESXi host root password."
)]
[ValidateNotNullOrEmpty()]
[securestring]$HostRootPassword
)
begin {
@@ -45,8 +51,8 @@ function Edit-ZertoVra {
process {
# Create ordered hashtables to be converted later to JSON.
$vraUpdate = [ordered]@{}
$vraNetwork = [ordered]@{}
$vraUpdate = [ordered]@{ }
$vraNetwork = [ordered]@{ }
# If a new group name is specified, update.
if ( $PSBoundParameters.ContainsKey('GroupName')) {
$vraUpdate['GroupName'] = $groupName
@@ -77,8 +83,14 @@ function Edit-ZertoVra {
$vraNetwork['VraIPConfigurationTypeApi'] = "Dhcp"
$vraUpdate['VraNetworkDataApi'] = $vraNetwork
}
if ($PSBoundParameters.ContainsKey('HostRootPassword')) {
$HostRootCredential = [pscredential]::New('root', $HostRootPassword)
$vraUpdate['UsePublicKeyInsteadOfCredentials'] = $false
$vraUpdate['HostRootPassword'] = $HostRootCredential.GetNetworkCredential().Password
}
# -WhatIf processing and submit!
if ($PSCmdlet.ShouldProcess( "Updating " + $vra.vraName + " with these settings: $($vraUpdate | convertTo-Json)")) {
if ($PSCmdlet.ShouldProcess( $vra.vraName )) {
Invoke-ZertoRestRequest -uri $baseUri -body $($vraUpdate | ConvertTo-Json) -method "PUT"
}
}
@@ -45,33 +45,37 @@ function Export-ZertoVmNicSetting {
$null = Remove-ZertoVpgSettingsIdentifier -vpgSettingsIdentifier $settingsId
$networkMap = Get-Map -InputObject $networks -key "NetworkIdentifier" -value "VirtualizationNetworkName"
foreach ($vm in $vmSettings) {
$nicInfo = [PSCustomObject]@{
VPGName = $group.VPGName
VMName = $vmMap[$($vm.vmIdentifier)]
NicIdentifier = $vm.nics.NicIdentifier
LiveNetwork = $networkMap[$vm.nics.failover.Hypervisor.NetworkIdentifier]
LiveShouldReplaceMac = $vm.nics.failover.Hypervisor.ShouldReplaceMacAddress
LiveIsDHCP = $vm.Nics.failover.Hypervisor.IpConfig.IsDhcp
LiveIpAddress = $vm.nics.failover.Hypervisor.IpConfig.StaticIp
LiveIpSubnetMask = $vm.nics.failover.Hypervisor.IpConfig.SubnetMask
LiveIpDefaultGateway = $vm.nics.failover.Hypervisor.IpConfig.Gateway
LivePrimaryDns = $vm.nics.failover.Hypervisor.IpConfig.PrimaryDns
LiveSecondayDns = $vm.nics.failover.Hypervisor.IpConfig.SecondaryDns
LiveDnsSuffix = $vm.nics.failover.Hypervisor.DnsSuffix
TestNetwork = $networkMap[$vm.nics.failoverTest.Hypervisor.NetworkIdentifier]
TestShouldReplaceMac = $vm.nics.failoverTest.Hypervisor.ShouldReplaceMacAddress
TestIsDHCP = $vm.Nics.failoverTest.Hypervisor.IpConfig.IsDhcp
TestIpAddress = $vm.nics.failoverTest.Hypervisor.IpConfig.StaticIp
TestIpSubnetMask = $vm.nics.failoverTest.Hypervisor.IpConfig.SubnetMask
TestIpDefaultGateway = $vm.nics.failoverTest.Hypervisor.IpConfig.Gateway
TestPrimaryDns = $vm.nics.failoverTest.Hypervisor.IpConfig.PrimaryDns
TestSecondayDns = $vm.nics.failoverTest.Hypervisor.IpConfig.SecondaryDns
TestDnsSuffix = $vm.nics.failoverTest.Hypervisor.DnsSuffix
if ($vm.nics.count -gt 0) {
foreach ($nic in $vm.nics) {
$nicInfo = [PSCustomObject]@{
VPGName = $group.VPGName
VMName = $vmMap[$vm.vmIdentifier]
NicIdentifier = $nic.NicIdentifier
LiveNetwork = $networkMap[$nic.failover.Hypervisor.NetworkIdentifier]
LiveShouldReplaceMac = $nic.failover.Hypervisor.ShouldReplaceMacAddress
LiveIsDHCP = $nic.failover.Hypervisor.IpConfig.IsDhcp
LiveIpAddress = $nic.failover.Hypervisor.IpConfig.StaticIp
LiveIpSubnetMask = $nic.failover.Hypervisor.IpConfig.SubnetMask
LiveIpDefaultGateway = $nic.failover.Hypervisor.IpConfig.Gateway
LivePrimaryDns = $nic.failover.Hypervisor.IpConfig.PrimaryDns
LiveSecondayDns = $nic.failover.Hypervisor.IpConfig.SecondaryDns
LiveDnsSuffix = $nic.failover.Hypervisor.DnsSuffix
TestNetwork = $networkMap[$nic.failoverTest.Hypervisor.NetworkIdentifier]
TestShouldReplaceMac = $nic.failoverTest.Hypervisor.ShouldReplaceMacAddress
TestIsDHCP = $nic.failoverTest.Hypervisor.IpConfig.IsDhcp
TestIpAddress = $nic.failoverTest.Hypervisor.IpConfig.StaticIp
TestIpSubnetMask = $nic.failoverTest.Hypervisor.IpConfig.SubnetMask
TestIpDefaultGateway = $nic.failoverTest.Hypervisor.IpConfig.Gateway
TestPrimaryDns = $nic.failoverTest.Hypervisor.IpConfig.PrimaryDns
TestSecondayDns = $nic.failoverTest.Hypervisor.IpConfig.SecondaryDns
TestDnsSuffix = $nic.failoverTest.Hypervisor.DnsSuffix
}
$nicInfo
}
}
$nicInfo
}
}
$nicSettings | Export-Csv -Path $OutputFile
$nicSettings | Export-Csv -Path $OutputFile -NoTypeInformation
}
end {
@@ -0,0 +1,58 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Get-ZAPlannerJournalSizeReport {
[cmdletbinding()]
param(
[Parameter(
Mandatory,
HelpMessage = "The site identifier(s) for which to return detailed information."
)]
[ValidateNotNullOrEmpty()]
[string]$siteIdentifier,
[Parameter(
Mandatory,
HelpMessage = "Type of target recovery site."
)]
[ValidateSet('azure', 'vcenter', 'vcd', 'scvmm', 'aws')]
[string]$recoveryType,
[Parameter(
Mandatory,
HelpMessage = "Identifiers of the VMs you want to recover at the target recovery site."
)]
[ValidateNotNullOrEmpty()]
[string[]]$vmIdentifier,
[Parameter(
HelpMessage = "The desired journal history in hours. The default is 24 hours. Limited to a 1 hour up to 720 hours, or the equivalent of 30 days"
)]
[ValidateRange(1, 720)]
[Int]$desiredJournalHistory = 24,
[Parameter(
HelpMessage = "The earliest timestamp of an event to return, in RFC 3339 standard. ('1970-01-01T00:00:00Z'). The default is one year ago."
)]
[ValidateNotNullOrEmpty()]
[string]$startDate,
[Parameter(
HelpMessage = "The latest timestamp of an event to return, in RFC 3339 standard. ('1970-01-01T00:00:00Z'). The default is the current time."
)]
[ValidateNotNullOrEmpty()]
[string]$endDate
)
$uri = "planner/reports/stats/journal-size"
$body = @{
siteIdentifier = $siteIdentifier
recoveryType = $recoveryType
desiredJournalHistory = $desiredJournalHistory
vms = New-Object System.Collections.Generic.List[psobject]
}
if ( -not [String]::IsNullOrEmpty($startDate) ) {
$body['startDate'] = $startDate
}
if ( -not [String]::IsNullOrEmpty($endDate) ) {
$body['endDate'] = $endDate
}
foreach ($vmId in $vmIdentifier) {
$body['vms'].Add(@{'identifier' = $vmId; 'desiredJournalHistory' = $desiredJournalHistory })
}
$reportId = Invoke-ZARestRequest -uri $uri -method POST -body ($body | ConvertTo-Json)
$uri = '{0}?reportId={1}' -f $uri, $reportId.reportId
Invoke-ZARestRequest -uri $uri
}
@@ -0,0 +1,58 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Get-ZAPlannerNetworkPerformanceReport {
[cmdletbinding()]
param(
[Parameter(
Mandatory,
HelpMessage = "The site identifier(s) for which to return detailed information."
)]
[ValidateNotNullOrEmpty()]
[string]$siteIdentifier,
[Parameter(
Mandatory,
HelpMessage = "Type of target recovery site."
)]
[ValidateSet('azure', 'vcenter', 'vcd', 'scvmm', 'aws')]
[string]$recoveryType,
[Parameter(
Mandatory,
HelpMessage = "Identifiers of the VMs you want to recover at the target recovery site."
)]
[ValidateNotNullOrEmpty()]
[string[]]$vmIdentifier,
[Parameter(
HelpMessage = "The desired sample interval in seconds. The default is 3600 seconds (1 Hour). Limited to a 60 second to 86,400 second (24 Hour) interval"
)]
[ValidateRange(60, 86400)]
[Int]$interval = 3600,
[Parameter(
HelpMessage = "The earliest timestamp of an event to return, in RFC 3339 standard. ('1970-01-01T00:00:00Z'). The default is one year ago."
)]
[ValidateNotNullOrEmpty()]
[string]$startDate,
[Parameter(
HelpMessage = "The latest timestamp of an event to return, in RFC 3339 standard. ('1970-01-01T00:00:00Z'). The default is the current time."
)]
[ValidateNotNullOrEmpty()]
[string]$endDate
)
$uri = "planner/reports/network-performance"
$body = @{
siteIdentifier = $siteIdentifier
recoveryType = $recoveryType
interval = $interval
vmIdentifiers = New-Object System.Collections.Generic.List[psobject]
}
if ( -not [String]::IsNullOrEmpty($startDate) ) {
$body['startDate'] = $startDate
}
if ( -not [String]::IsNullOrEmpty($endDate) ) {
$body['endDate'] = $endDate
}
foreach ($vmId in $vmIdentifier) {
$body['vmIdentifiers'].Add($vmId)
}
$reportId = Invoke-ZARestRequest -uri $uri -method POST -body ($body | ConvertTo-Json)
$uri = '{0}?reportId={1}' -f $uri, $reportId.reportId
Invoke-ZARestRequest -uri $uri
}
@@ -0,0 +1,22 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Get-ZAPlannerSite {
[cmdletbinding()]
param(
[Parameter(
HelpMessage = "The site identifier(s) for which to return detailed information."
)]
[ValidateNotNullOrEmpty()]
[string[]]$siteIdentifier
)
$uri = "planner/sites"
if ( -not [String]::IsNullorEmpty($siteIdentifier) ) {
$entry = foreach ($id in $siteIdentifier) {
"{0}/{1}" -f $uri, $id
}
} else {
$entry = $uri
}
foreach ($uri in $entry) {
Invoke-ZARestRequest -uri $uri
}
}
@@ -0,0 +1,58 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Get-ZAPlannerStatsReport {
[cmdletbinding()]
param(
[Parameter(
Mandatory,
HelpMessage = "The site identifier(s) for which to return detailed information."
)]
[ValidateNotNullOrEmpty()]
[string]$siteIdentifier,
[Parameter(
Mandatory,
HelpMessage = "Type of target recovery site."
)]
[ValidateSet('azure', 'vcenter', 'vcd', 'scvmm', 'aws')]
[string]$recoveryType,
[Parameter(
Mandatory,
HelpMessage = "Identifiers of the VMs you want to recover at the target recovery site."
)]
[ValidateNotNullOrEmpty()]
[string[]]$vmIdentifier,
[Parameter(
HelpMessage = "The desired journal history in hours. The default is 24 hours. Limited to a 1 hour up to 720 hours, or the equivalent of 30 days"
)]
[ValidateRange(1, 720)]
[Int]$desiredJournalHistory = 24,
[Parameter(
HelpMessage = "The earliest timestamp of an event to return, in RFC 3339 standard. ('1970-01-01T00:00:00Z'). The default is one year ago."
)]
[ValidateNotNullOrEmpty()]
[string]$startDate,
[Parameter(
HelpMessage = "The latest timestamp of an event to return, in RFC 3339 standard. ('1970-01-01T00:00:00Z'). The default is the current time."
)]
[ValidateNotNullOrEmpty()]
[string]$endDate
)
$uri = "planner/reports/stats"
$body = @{
siteIdentifier = $siteIdentifier
recoveryType = $recoveryType
desiredJournalHistory = $desiredJournalHistory
vms = New-Object System.Collections.Generic.List[psobject]
}
if ( -not [String]::IsNullOrEmpty($startDate) ) {
$body['startDate'] = $startDate
}
if ( -not [String]::IsNullOrEmpty($endDate) ) {
$body['endDate'] = $endDate
}
foreach ($vmId in $vmIdentifier) {
$body['vms'].Add(@{'identifier' = $vmId; 'desiredJournalHistory' = $desiredJournalHistory })
}
$reportId = Invoke-ZARestRequest -uri $uri -method POST -body ($body | ConvertTo-Json)
$uri = '{0}?reportId={1}' -f $uri, $reportId.reportId
Invoke-ZARestRequest -uri $uri
}
@@ -0,0 +1,52 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Get-ZAPlannerWanReport {
[cmdletbinding()]
param(
[Parameter(
Mandatory,
HelpMessage = "The site identifier(s) for which to return detailed information."
)]
[ValidateNotNullOrEmpty()]
[string]$siteIdentifier,
[Parameter(
Mandatory,
HelpMessage = "Type of target recovery site."
)]
[ValidateSet('azure', 'vcenter', 'vcd', 'scvmm', 'aws')]
[string]$recoveryType,
[Parameter(
Mandatory,
HelpMessage = "Identifiers of the VMs you want to recover at the target recovery site."
)]
[ValidateNotNullOrEmpty()]
[string[]]$vmIdentifier,
[Parameter(
HelpMessage = "The earliest timestamp of an event to return, in RFC 3339 standard. ('1970-01-01T00:00:00Z'). The default is one year ago."
)]
[ValidateNotNullOrEmpty()]
[string]$startDate,
[Parameter(
HelpMessage = "The latest timestamp of an event to return, in RFC 3339 standard. ('1970-01-01T00:00:00Z'). The default is the current time."
)]
[ValidateNotNullOrEmpty()]
[string]$endDate
)
$uri = "planner/reports/stats/wan"
$body = @{
siteIdentifier = $siteIdentifier
recoveryType = $recoveryType
vmIdentifiers = New-Object System.Collections.Generic.List[psobject]
}
if ( -not [String]::IsNullOrEmpty($startDate) ) {
$body['startDate'] = $startDate
}
if ( -not [String]::IsNullOrEmpty($endDate) ) {
$body['endDate'] = $endDate
}
foreach ($vmId in $vmIdentifier) {
$body['vmIdentifiers'].Add($vmId)
}
$reportId = Invoke-ZARestRequest -uri $uri -method POST -body ($body | ConvertTo-Json)
$uri = '{0}?reportId={1}' -f $uri, $reportId.reportId
Invoke-ZARestRequest -uri $uri
}
@@ -0,0 +1,54 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Get-ZAPlannerZcasReport {
[cmdletbinding()]
param(
[Parameter(
Mandatory,
HelpMessage = "The site identifier(s) for which to return detailed information."
)]
[ValidateNotNullOrEmpty()]
[string]$siteIdentifier,
[Parameter(
Mandatory,
HelpMessage = "Type of target recovery site."
)]
[ValidateSet('azure', 'vcenter', 'vcd', 'scvmm', 'aws')]
[string]$recoveryType,
[Parameter(
Mandatory,
HelpMessage = "Identifiers of the VMs you want to recover at the target recovery site."
)]
[ValidateNotNullOrEmpty()]
[string[]]$vmIdentifier,
[Parameter(
HelpMessage = "The earliest timestamp of an event to return, in RFC 3339 standard. ('1970-01-01T00:00:00Z'). The default is one year ago."
)]
[ValidateNotNullOrEmpty()]
[string]$startDate,
[Parameter(
HelpMessage = "The latest timestamp of an event to return, in RFC 3339 standard. ('1970-01-01T00:00:00Z'). The default is the current time."
)]
[ValidateNotNullOrEmpty()]
[string]$endDate
)
$uri = "planner/reports/stats/zcas"
$body = @{
siteIdentifier = $siteIdentifier
recoveryType = $recoveryType
vmIdentifiers = New-Object System.Collections.Generic.List[psobject]
}
if ( -not [String]::IsNullOrEmpty($startDate) ) {
$body['startDate'] = $startDate
}
if ( -not [String]::IsNullOrEmpty($endDate) ) {
$body['endDate'] = $endDate
}
foreach ($vmId in $vmIdentifier) {
$body['vmIdentifiers'].Add($vmId)
}
#$body | ConvertTo-Json
$reportId = Invoke-ZARestRequest -uri $uri -method POST -body ($body | ConvertTo-Json)
#Start-Sleep 10
$uri = '{0}?reportId={1}' -f $uri, $reportId.reportId
Invoke-ZARestRequest -uri $uri
}
@@ -0,0 +1,51 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Get-ZAProtectedVm {
[cmdletbinding(DefaultParameterSetName = "AllVMs")]
param(
[Parameter(
ParameterSetName = "AllVMs",
HelpMessage = "Use this switch when you want a list of all protected VMs. Please be warned this list can be quite large."
)]
[switch]$AllVms,
[Parameter(
ParameterSetName = "IndividualVMs",
Mandatory,
HelpMessage = "A list of VM identifiers to query"
)]
[ValidateNotNullOrEmpty()]
[string[]]$VMIdentifier,
[Parameter(
ParameterSetName = "IndividualVMs",
HelpMessage = "Specify this switch when you would like protected vms' volume information returned"
)]
[switch]$Volumes
)
Begin {
}
Process {
$BaseUri = "monitoring/protected-vms"
switch ($PSCmdlet.ParameterSetName) {
"AllVMs" {
Invoke-ZARestRequest -uri $BaseUri
}
"IndividualVMs" {
foreach ($identifier in $VMIdentifier) {
if ($Volumes.IsPresent) {
$Uri = "{0}/{1}/volumes" -f $BaseUri, $identifier
} else {
$uri = $Uri = "{0}/{1}" -f $BaseUri, $identifier
}
Invoke-ZARestRequest -uri $Uri
}
}
}
}
End {
}
}
@@ -0,0 +1,32 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Get-ZAProtectedVmReport {
[cmdletbinding()]
param(
[Parameter(
ParameterSetName = "GenerateReport",
Mandatory,
HelpMessage = "A list of VM identifiers to include in the report."
)]
[ValidateNotNullOrEmpty()]
[string[]]$VMIdentifier
)
Begin {
}
Process {
$BaseUri = "monitoring/protected-vms"
$Body = @{
vmsIdentifiers = $VMIdentifier
}
$reportId = Invoke-ZARestRequest -uri $BaseUri -method POST -body ($Body | ConvertTo-Json)
Start-Sleep 1
$Uri = "{0}?reportId={1}" -f $BaseUri, $reportId.reportId
Invoke-ZARestRequest -uri $Uri
}
End {
}
}
@@ -26,12 +26,6 @@ function Get-ZertoRecoveryReport {
)]
[ValidateNotNullOrEmpty()]
[string]$pageSize,
[Parameter(
ParameterSetName = "filter",
HelpMessage = "The internal identifier of the VPG. You can specify more than one VPG, separated by commas."
)]
[ValidateNotNullOrEmpty()]
[string]$vpgIdentifier,
[Parameter(
ParameterSetName = "filter",
HelpMessage = "The name of the VPG. You can specify more than one VPG, separated by commas."
@@ -52,6 +52,11 @@ function Get-ZertoVirtualizationSite {
Mandatory = $true,
HelpMessage = "The identifier of the Zerto Virtual Manager site."
)]
[Parameter(
ParameterSetName = "repositories",
Mandatory = $true,
HelpMessage = "The identifier of the Zerto Virtual Manager site."
)]
[ValidateNotNullOrEmpty()]
[Alias("siteId")]
[string]$siteIdentifier,
@@ -121,33 +126,34 @@ function Get-ZertoVirtualizationSite {
Mandatory = $true,
HelpMessage = "Return all VMs at the selected site."
)]
[switch]$vms
[switch]$vms,
[Parameter(
ParameterSetName = "repositories",
Mandatory = $true,
HelpMessage = "The identifier of the Zerto Virtual Manager site."
)]
[switch]$repositories
)
begin {
$baseUri = "virtualizationsites"
$returnObject = @()
}
process {
# Return information based on ParameterSetName invoked.
$baseUri = "virtualizationsites"
switch ( $PSCmdlet.ParameterSetName ) {
# If no ParameterSetName is specified, return all data
"main" {
$returnObject = Invoke-ZertoRestRequest -uri $baseUri
$uri = $baseUri
}
# If devices is specified along with a hostId, build return just that host information, otherwise return all devices at the site
#TODO - remove foreach, only one siteIdentifier can be specified.
"devices" {
$returnObject = foreach ( $id in $siteIdentifier ) {
if ( $PSBoundParameters.ContainsKey( "hostIdentifier" ) ) {
$uri = "{0}/{1}/devices?hostIdentifier={2}" -f $baseUri, $siteIdentifier, $hostIdentifier
} else {
$uri = "{0}/{1}/devices" -f $baseUri, $siteIdentifier
}
Invoke-ZertoRestRequest -uri $uri
if ( $PSBoundParameters.ContainsKey( "hostIdentifier" ) ) {
$uri = "{0}/{1}/devices?hostIdentifier={2}" -f $baseUri, $siteIdentifier, $hostIdentifier
} else {
$uri = "{0}/{1}/devices" -f $baseUri, $siteIdentifier
}
}
@@ -158,24 +164,22 @@ function Get-ZertoVirtualizationSite {
} else {
$uri = "{0}/{1}/hosts" -f $baseUri, $siteIdentifier
}
$returnObject = Invoke-ZertoRestRequest -uri $uri
}
# If siteIdentifier is specified, return information for that site.
"siteIdentifier" {
$uri = "{0}/{1}" -f $baseUri, $siteIdentifier
$returnObject = Invoke-ZertoRestRequest -uri $uri
}
# If a different ParameterSetName is selected, use that information to build the URI and return that information
default {
$uri = "{0}/{1}/{2}" -f $baseUri, $siteIdentifier, $PSCmdlet.ParameterSetName.ToLower()
$returnObject = Invoke-ZertoRestRequest -uri $uri
}
}
Invoke-ZertoRestRequest -uri $uri
}
end {
return $returnObject
}
}
+12 -16
View File
@@ -160,7 +160,6 @@ function Get-ZertoVpg {
)
begin {
$baseUri = "vpgs"
$returnObject = @()
}
Process {
@@ -169,14 +168,13 @@ function Get-ZertoVpg {
# When called with no parameters, return all values
"main" {
$returnObject = Invoke-ZertoRestRequest -uri $baseUri
$uri = $baseUri
}
# When called with protectionGroupIdentifier, query for each id provided
"protectionGroupIdentifier" {
$returnObject = foreach ( $vpgId in $protectionGroupIdentifier ) {
$uri = "{0}/{1}" -f $baseUri, $vpgId
Invoke-ZertoRestRequest -uri $uri
$uri = foreach ( $vpgId in $protectionGroupIdentifier ) {
"{0}/{1}" -f $baseUri, $vpgId
}
}
@@ -185,7 +183,7 @@ function Get-ZertoVpg {
$filter = $false
if ( $PSBoundParameters.ContainsKey("startDate") -or $PSBoundParameters.ContainsKey("endDate") ) {
$filter = $true
$filterTable = @{}
$filterTable = @{ }
foreach ( $param in $PSBoundParameters.GetEnumerator() ) {
if ( $param.key -eq "startDate" -or $param.key -eq "endDate") {
$filterTable[$param.key] = $param.value
@@ -193,21 +191,19 @@ function Get-ZertoVpg {
}
$filter = Get-ZertoApiFilter -filterTable $filterTable
}
$returnObject = foreach ( $id in $protectionGroupIdentifier ) {
$uri = foreach ( $id in $protectionGroupIdentifier ) {
if ( $filter ) {
$uri = "{0}/{1}/checkpoints{2}" -f $baseUri, $id, $filter
"{0}/{1}/checkpoints{2}" -f $baseUri, $id, $filter
} else {
$uri = "{0}/{1}/checkpoints" -f $baseUri, $id
"{0}/{1}/checkpoints" -f $baseUri, $id
}
Invoke-ZertoRestRequest -uri $uri
}
}
# When stats are requested
"stats" {
$returnObject = foreach ( $id in $protectionGroupIdentifier ) {
$uri = "{0}/{1}/checkpoints/stats" -f $baseUri, $id
Invoke-ZertoRestRequest -uri $uri
$uri = foreach ( $id in $protectionGroupIdentifier ) {
"{0}/{1}/checkpoints/stats" -f $baseUri, $id
}
}
@@ -215,18 +211,18 @@ function Get-ZertoVpg {
"filter" {
$filter = Get-ZertoApiFilter -filterTable $PSBoundParameters
$uri = "{0}{1}" -f $baseUri, $filter
$returnObject = Invoke-ZertoRestRequest -uri $uri
}
# Default is to build URI based on ParameterSetName and return results.
default {
$uri = "{0}/{1}" -f $baseUri, $PSCmdlet.ParameterSetName.ToLower()
$returnObject = Invoke-ZertoRestRequest -uri $uri
}
}
foreach ($entry in $uri) {
Invoke-ZertoRestRequest -uri $entry
}
}
End {
return $returnObject
}
}
+23 -7
View File
@@ -19,7 +19,7 @@ function Get-ZertoVpgSetting {
ValueFromPipelineByPropertyName = $true,
ValueFromRemainingArguments = $true,
Mandatory = $true,
HelpMessage = "The identifier of the VPG settings object for which information is retrieved."
HelpMessage = "The identifier of the VPG settings object for which information is retrieved. Please note, this parameter is ONLY available in Zerto version 7.5 and earlier. Attempting to run this switch against a Zerto Virtual Manager version 8.0 or higher result in an error."
)]
[Parameter(
ParameterSetName = "dayOfWeek",
@@ -149,31 +149,39 @@ function Get-ZertoVpgSetting {
Mandatory = $true,
HelpMessage = "The identifier of the VPG settings object for which information is retrieved."
)]
[Parameter(
ParameterSetName = "ltr",
ValueFromPipeline = $true,
ValueFromPipelineByPropertyName = $true,
ValueFromRemainingArguments = $true,
Mandatory = $true,
HelpMessage = "The identifier of the VPG settings object for which information is retrieved."
)]
[ValidateNotNullOrEmpty()]
[Alias("vpgSettingsId", "settingsId")]
[string[]]$vpgSettingsIdentifier,
[Parameter(
ParameterSetName = "backup",
Mandatory = $true,
HelpMessage = "Return backup information for VPG identifier specified"
HelpMessage = "Return backup information for VPG identifier specified. Please note, this parameter is ONLY available in Zerto version 7.5 and earlier. Attempting to run this switch against a Zerto Virtual Manager version 8.0 or higher result in an error."
)]
[switch]$backup,
[Parameter(
ParameterSetName = "dayOfWeek",
Mandatory = $true,
HelpMessage = "Get the day of week a backup is scheduled"
HelpMessage = "Get the day of week a backup is scheduled. Please note, this parameter is ONLY available in Zerto version 7.5 and earlier. Attempting to run this switch against a Zerto Virtual Manager version 8.0 or higher result in an error."
)]
[switch]$dayOfWeek,
[Parameter(
ParameterSetName = "retentionPeriod",
Mandatory = $true,
HelpMessage = "Get the retention period for a backup"
HelpMessage = "Get the retention period for a backup. Please note, this parameter is ONLY available in Zerto version 7.5 and earlier. Attempting to run this switch against a Zerto Virtual Manager version 8.0 or higher result in an error."
)]
[switch]$retentionPeriod,
[Parameter(
ParameterSetName = "schedulerPeriod",
Mandatory = $true,
HelpMessage = "Get the backup schedule"
HelpMessage = "Get the backup schedule. Please note, this parameter is ONLY available in Zerto version 7.5 and earlier. Attempting to run this switch against a Zerto Virtual Manager version 8.0 or higher result in an error."
)]
[switch]$schedulerPeriod,
[Parameter(
@@ -211,7 +219,8 @@ function Get-ZertoVpgSetting {
Mandatory = $true,
HelpMessage = "Get VPG Recovery Settings"
)]
[switch]$rcovery,
[Alias("rcovery")]
[switch]$recovery,
[Parameter(
ParameterSetName = "scripting",
Mandatory = $true,
@@ -279,7 +288,14 @@ function Get-ZertoVpgSetting {
)]
[ValidateNotNullOrEmpty()]
[Alias("volumeId")]
[string]$volumeIdentifier
[string]$volumeIdentifier,
[Parameter(
ParameterSetName = "ltr",
Mandatory = $true,
HelpMessage = "Return LTR information for the specified VPG. Please note, this parameter is ONLY available in Zerto version 8.0 and later. Attempting to run this switch against a Zerto Virtual Manager version 7.5 or lower will result in an error."
)]
[switch]$ltr
)
begin {
@@ -44,15 +44,28 @@ function Import-ZertoVmNicSetting {
[string]::IsNullOrWhiteSpace($Vm.LiveShouldReplaceMac) -or
[string]::IsNullOrWhiteSpace($Vm.TestNetwork) -or
[string]::IsNullOrWhiteSpace($Vm.TestShouldReplaceMac)) {
Write-Error "$($Vm.VMName) does not contain all the required data. Please check the CSV entry for this item and try again." -ErrorAction Continue
Write-Error "$($Vm.VMName) does not contain all the required data. Please check the CSV entry for this item and try again. You are required to provide the VPGName, VMName, NicIdentifier, LiveNetwork, and ShouldReplaceMacAddress for each Nic." -ErrorAction Continue
} else {
$uri = "vpgSettings/{0}/vms/{1}" -f $vpgSettingsId, $vmMap[$vm.VMName]
$VmNicSettings = Get-ZertoVpgSetting -vpgSettingsIdentifier $vpgSettingsId -vmIdentifier $vmMap[$vm.VMName]
foreach ($nic in $VmNicSettings.nics) {
if ($nic.NicIdentifier -eq $vm.NicIdentifier) {
$nic.failover.Hypervisor.NetworkIdentifier = $NetworkMap[$vm.LiveNetwork]
$nic.failover.Hypervisor.ShouldReplaceMacAddress = $vm.LiveShouldReplaceMac
if ($null -eq $nic.failover.Hypervisor.IpConfig -and ($null -ne $vm.LiveIsDHCP -or $null -ne $vm.LiveIpAddress)) {
$NicUri = "{0}/nics/{1}" -f $uri, $nic.NicIdentifier
Invoke-ZertoRestRequest -uri $NicUri -Method "DELETE" > $null
$nicSettings = Invoke-ZertoRestRequest -uri $NicUri -Method "GET"
$nicSettings.failover.Hypervisor.NetworkIdentifier = $NetworkMap[$vm.LiveNetwork]
$nicSettings.failover.Hypervisor.ShouldReplaceMacAddress = $vm.LiveShouldReplaceMac
if ($vm.LiveIsDHCP -imatch "true") {
$IpConfig = [PSCustomObject]@{
IsDhcp = $vm.LiveIsDHCP
PrimaryDns = $vm.LivePrimaryDns
SecondaryDns = $vm.LiveSecondayDns
}
$nicSettings.failover.Hypervisor.IpConfig = $IpConfig
$nicSettings.failover.Hypervisor.DnsSuffix = $vm.LiveDnsSuffix
} elseif (($vm.LiveIsDHCP -imatch "false" -or
[string]::IsNullOrWhiteSpace($vm.LiveIsDHCP)) -and
-not [string]::IsNullOrWhiteSpace($vm.LiveIpAddress)) {
$IpConfig = [PSCustomObject]@{
IsDhcp = $vm.LiveIsDHCP
StaticIp = $vm.LiveIpAddress
@@ -61,21 +74,22 @@ function Import-ZertoVmNicSetting {
PrimaryDns = $vm.LivePrimaryDns
SecondaryDns = $vm.LiveSecondayDns
}
$nic.failover.Hypervisor.IpConfig = $IpConfig
} elseif ($null -eq $nic.failover.Hypervisor.IpConfig -and $null -eq $vm.LiveIsDHCP -and $null -eq $vm.LiveIpAddress) {
$nic.failover.Hypervisor.IpConfig = $null
} else {
$nic.failover.Hypervisor.IpConfig.IsDhcp = $vm.LiveIsDHCP
$nic.failover.Hypervisor.IpConfig.StaticIp = $vm.LiveIpAddress
$nic.failover.Hypervisor.IpConfig.SubnetMask = $vm.LiveIpSubnetMask
$nic.failover.Hypervisor.IpConfig.Gateway = $vm.LiveIpDefaultGateway
$nic.failover.Hypervisor.IpConfig.PrimaryDns = $vm.LivePrimaryDns
$nic.failover.Hypervisor.IpConfig.SecondaryDns = $vm.LiveSecondayDns
$nicSettings.failover.Hypervisor.IpConfig = $IpConfig
$nicSettings.failover.Hypervisor.DnsSuffix = $vm.LiveDnsSuffix
}
$nic.failover.Hypervisor.DnsSuffix = $vm.LiveDnsSuffix
$nic.failoverTest.Hypervisor.NetworkIdentifier = $NetworkMap[$vm.TestNetwork]
$nic.failoverTest.Hypervisor.ShouldReplaceMacAddress = $vm.TestShouldReplaceMac
if ($null -eq $nic.failoverTest.Hypervisor.IpConfig -and ($null -ne $vm.TestIsDHCP -or $null -ne $vm.TestIpAddress)) {
$nicSettings.failoverTest.Hypervisor.NetworkIdentifier = $NetworkMap[$vm.TestNetwork]
$nicSettings.failoverTest.Hypervisor.ShouldReplaceMacAddress = $vm.TestShouldReplaceMac
if ($vm.TestIsDHCP -imatch "true" ) {
$IpConfig = [PsCustomObject]@{
IsDhcp = $vm.TestIsDHCP
PrimaryDns = $vm.TestPrimaryDns
SecondaryDns = $vm.TestSecondayDns
}
$nicSettings.failoverTest.Hypervisor.IpConfig = $IpConfig
$nicSettings.failoverTest.Hypervisor.DnsSuffix = $vm.TestDnsSuffix
} elseif (($vm.TestIsDHCP -imatch "false" -or
[string]::IsNullOrWhiteSpace($vm.TestIsDHCP)) -and
-not [string]::IsNullOrWhiteSpace($vm.TestIpAddress)) {
$IpConfig = [PsCustomObject]@{
IsDhcp = $vm.TestIsDHCP
StaticIp = $vm.TestIpAddress
@@ -84,24 +98,15 @@ function Import-ZertoVmNicSetting {
PrimaryDns = $vm.TestPrimaryDns
SecondaryDns = $vm.TestSecondayDns
}
$nic.failoverTest.Hypervisor.IpConfig = $IpConfig
} elseif ($null -eq $nic.failoverTest.Hypervisor.IpConfig -and $null -eq $vm.TestIsDHCP -and $null -eq $vm.TestIpAddress) {
$nic.failoverTest.Hypervisor.IpConfig = $null
} else {
$nic.failoverTest.Hypervisor.IpConfig.IsDhcp = $vm.TestIsDHCP
$nic.failoverTest.Hypervisor.IpConfig.StaticIp = $vm.TestIpAddress
$nic.failoverTest.Hypervisor.IpConfig.SubnetMask = $vm.TestIpSubnetMask
$nic.failoverTest.Hypervisor.IpConfig.Gateway = $vm.TestIpDefaultGateway
$nic.failoverTest.Hypervisor.IpConfig.PrimaryDns = $vm.TestPrimaryDns
$nic.failoverTest.Hypervisor.IpConfig.SecondaryDns = $vm.TestSecondayDns
$nicSettings.failoverTest.Hypervisor.IpConfig = $IpConfig
$nicSettings.failoverTest.Hypervisor.DnsSuffix = $vm.TestDnsSuffix
}
Write-Verbose "Putting Updated Config for VM: $($vm.name), NIC: $($nic.nicidentifier) in VPG: $Vpg"
if ($PSCmdlet.ShouldProcess($vm.NicIdentifier, "Updating Nic")) {
Invoke-ZertoRestRequest -uri $NicUri -Method "PUT" -Body ($nicSettings | ConvertTo-Json -Depth 10) > $null
}
$nic.failoverTest.Hypervisor.DnsSuffix = $vm.TestDnsSuffix
}
}
Write-Verbose "Putting Updated Config for VM: $($vm.vmname) in Vpg: $Vpg"
if ($PSCmdlet.ShouldProcess($vm.NicIdentifier, "Updating Nic")) {
Invoke-ZertoRestRequest -uri $uri -Method "PUT" -Body ($VmNicSettings | ConvertTo-Json -Depth 10) > $null
}
}
}
Write-Verbose "Saving updated configuration for VPG: $Vpg"
+146 -49
View File
@@ -1,72 +1,169 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
#TODO - Add ability to installed with root password, Move to Begin, Process, End Format
function Install-ZertoVra {
[cmdletbinding( SupportsShouldProcess = $true )]
[cmdletbinding( SupportsShouldProcess )]
param(
[Parameter( Mandatory = $true, HelpMessage = "Host name where the VRA is to be installed." )]
[Parameter(
Mandatory,
HelpMessage = "Host name where the VRA is to be installed."
)]
[ValidateNotNullOrEmpty()]
[string]$hostName,
[Parameter( Mandatory = $true, HelpMessage = "Datastore name where the VRA is to be installed." )]
[Parameter(
Mandatory,
HelpMessage = "Datastore name where the VRA is to be installed."
)]
[ValidateNotNullOrEmpty()]
[string]$datastoreName,
[Parameter( Mandatory = $true, HelpMessage = "Network name the VRA is to be assigned." )]
[Parameter(
Mandatory,
HelpMessage = "Network name the VRA is to be assigned."
)]
[ValidateNotNullOrEmpty()]
[string]$networkName,
[Parameter( HelpMessage = "Initial amount of memory to assign to the VRA in GB. Default is 3, Minimum is 1, Maximum is 16" )]
[Parameter(
HelpMessage = "Initial amount of memory to assign to the VRA in GB. Default is 3, Minimum is 1, Maximum is 16"
)]
[ValidateRange(1, 16)]
[int]$memoryInGB = 3,
[Parameter( HelpMessage = "Bandwidth group to assign to the VRA. If unspecified will assign to the 'default_group'" )]
[Parameter(
HelpMessage = "Bandwidth group to assign to the VRA. If unspecified will assign to the 'default_group'"
)]
[ValidateNotNullOrEmpty()]
[string]$groupName,
[Parameter( ParameterSetName = "Dhcp", Mandatory = $true, HelpMessage = "Assign a DHCP address to the VRA." )]
[Parameter(
ParameterSetName = "Dhcp",
Mandatory,
HelpMessage = "Assign a DHCP address to the VRA."
)]
[Parameter(
ParameterSetName = "DhcpWithRoot",
Mandatory,
HelpMessage = "Assign a DHCP address to the VRA."
)]
[switch]$Dhcp,
[Parameter( ParameterSetName = "StaticIp", Mandatory = $true, HelpMessage = "Static IP address to assign to the VRA." )]
[ValidateScript( {$_ -match [IPAddress]$_ })]
[Parameter(
ParameterSetName = "StaticIp",
Mandatory,
HelpMessage = "Static IP address to assign to the VRA."
)]
[Parameter(
ParameterSetName = "StaticIpWithRoot",
Mandatory,
HelpMessage = "Static IP address to assign to the VRA."
)]
[ValidateScript( { $_ -match [IPAddress]$_ })]
[string]$vraIpAddress,
[Parameter( ParameterSetName = "StaticIp", Mandatory = $true, HelpMessage = "Default gateway to assign to the VRA" )]
[ValidateScript( {$_ -match [IPAddress]$_ })]
[Parameter(
ParameterSetName = "StaticIp",
Mandatory,
HelpMessage = "Default gateway to assign to the VRA"
)]
[Parameter(
ParameterSetName = "StaticIpWithRoot",
Mandatory,
HelpMessage = "Default gateway to assign to the VRA"
)]
[ValidateScript( { $_ -match [IPAddress]$_ })]
[string]$defaultGateway,
[Parameter( ParameterSetName = "StaticIp", Mandatory = $true, HelpMessage = "Subnetmask to be assigned to the VRA" )]
[ValidateScript( {$_ -match [IPAddress]$_ })]
[string]$subnetMask
[Parameter(
ParameterSetName = "StaticIp",
Mandatory,
HelpMessage = "Subnetmask to be assigned to the VRA"
)]
[Parameter(
ParameterSetName = "StaticIpWithRoot",
Mandatory,
HelpMessage = "Subnetmask to be assigned to the VRA"
)]
[ValidateScript( { $_ -match [IPAddress]$_ })]
[string]$subnetMask,
[Parameter(
ParameterSetName = "StaticIpWithRoot",
Mandatory,
HelpMessage = "Use this switch to install the VRA using the root password install method."
)]
[Parameter(
ParameterSetName = "DhcpWithRoot",
Mandatory,
HelpMessage = "Use this switch to install the VRA using the root password install method."
)]
[switch]$UseRootCredential,
[Parameter(
ParameterSetName = "StaticIpWithRoot",
Mandatory,
HelpMessage = "The password for the root user of the ESXi host where the VRA is to be installed."
)]
[Parameter(
ParameterSetName = "DhcpWithRoot",
Mandatory,
HelpMessage = "The password for the root user of the ESXi host where the VRA is to be installed."
)]
[ValidateNotNullOrEmpty()]
[securestring]$HostRootPassword
)
# Build the VRA Name.
$vraName = "Z-VRA-{0}" -f $hostName
# If the VRA does not exist, proceed with the installation. If it does exist, bypass and
if ( -not (Get-ZertoVra -vraName $vraName) ) {
# Get identifiers for each item provided by name.
$siteIdentifier = $script:zvmLocalInfo.SiteIdentifier
$hostIdentifier = Get-ZertoVirtualizationSite -siteIdentifier $siteIdentifier -hosts | Where-Object {$_.VirtualizationHostName -eq $hostName} | Select-Object hostIdentifier -ExpandProperty hostIdentifier
$networkIdentifier = Get-ZertoVirtualizationSite -siteIdentifier $siteIdentifier -networks | Where-Object {$_.VirtualizationNetworkName -eq $networkName} | Select-Object NetworkIdentifier -ExpandProperty NetworkIdentifier
$datastoreIdentifier = Get-ZertoVirtualizationSite -siteIdentifier $siteIdentifier -datastores | Where-Object {$_.DatastoreName -eq $datastoreName} | Select-Object DatastoreIdentifier -ExpandProperty DatastoreIdentifier
# Build the JSON object through an Ordered Hashtable.
$vraBasic = [ordered]@{}
$vraBasic['DatastoreIdentifier'] = $datastoreIdentifier.toString()
if ($PSBoundParameters.ContainsKey('groupName')) {
$vraBasic['GroupName'] = $groupName
}
$vraBasic['HostIdentifier'] = $hostIdentifier.toString()
$vraBasic['MemoryInGB'] = $memoryInGB
$vraBasic['NetworkIdentifier'] = $networkIdentifier.toString()
$vraBasic['UsePublicKeyInsteadOfCredentials'] = $true
$vraBasicNetwork = [ordered]@{}
if ( $PSCmdlet.ParameterSetName -eq "StaticIp" ) {
$vraBasicNetwork['DefaultGateway'] = $defaultGateway.toString()
$vraBasicNetwork['SubnetMask'] = $subnetMask.toString()
$vraBasicNetwork['VraIPAddress'] = $vraIpAddress.toString()
$vraBasicNetwork['VraIPConfigurationTypeApi'] = "Static"
begin {
}
Process {
# Build the VRA Name.
$vraName = "Z-VRA-{0}" -f $hostName
# If the VRA does not exist, proceed with the installation. If it does exist, bypass and
if ( -not (Get-ZertoVra -vraName $vraName) ) {
# Get identifiers for each item provided by name.
$siteIdentifier = $script:zvmLocalInfo.SiteIdentifier
$hostIdentifier = Get-ZertoVirtualizationSite -siteIdentifier $siteIdentifier -hosts | Where-Object { $_.VirtualizationHostName -eq $hostName } | Select-Object hostIdentifier -ExpandProperty hostIdentifier
$networkIdentifier = Get-ZertoVirtualizationSite -siteIdentifier $siteIdentifier -networks | Where-Object { $_.VirtualizationNetworkName -eq $networkName } | Select-Object NetworkIdentifier -ExpandProperty NetworkIdentifier
$datastoreIdentifier = Get-ZertoVirtualizationSite -siteIdentifier $siteIdentifier -datastores | Where-Object { $_.DatastoreName -eq $datastoreName } | Select-Object DatastoreIdentifier -ExpandProperty DatastoreIdentifier
if ($datastoreIdentifier.count -gt 1) {
$hostDevices = Get-ZertoVirtualizationSite -siteIdentifier $siteIdentifier -devices -hostIdentifier $hostIdentifier
$datastoreIdentifier = foreach ($identifier in $datastoreIdentifier) {
if ($identifier -in $hostDevices.DatastoreIdentifier) {
$identifier
}
}
if ($datastoreIdentifier.count -gt 1) {
Write-Error "Datastore $datastoreName has more than one identifier associated with it on the specified host. Please review and try again."
Break
}
}
# Build the JSON object through an Ordered Hashtable.
$vraBasic = [ordered]@{ }
$vraBasic['DatastoreIdentifier'] = $datastoreIdentifier.toString()
if ($PSBoundParameters.ContainsKey('groupName')) {
$vraBasic['GroupName'] = $groupName
}
$vraBasic['HostIdentifier'] = $hostIdentifier.toString()
$vraBasic['MemoryInGB'] = $memoryInGB
$vraBasic['NetworkIdentifier'] = $networkIdentifier.toString()
$vraBasic['UsePublicKeyInsteadOfCredentials'] = $true
$vraBasicNetwork = [ordered]@{ }
if ( $PSCmdlet.ParameterSetName -eq "StaticIp" -or $PSCmdlet.ParameterSetName -eq "StaticIpWithRoot") {
$vraBasicNetwork['DefaultGateway'] = $defaultGateway.toString()
$vraBasicNetwork['SubnetMask'] = $subnetMask.toString()
$vraBasicNetwork['VraIPAddress'] = $vraIpAddress.toString()
$vraBasicNetwork['VraIPConfigurationTypeApi'] = "Static"
} else {
$vraBasicNetwork['VraIPConfigurationTypeApi'] = "Dhcp"
}
$vraBasic['VraNetworkDataApi'] = $vraBasicNetwork
if ($PSCmdlet.ParameterSetName -eq "StaticIpWithRoot" -or $PSCmdlet.ParameterSetName -eq "DhcpWithRoot") {
$HostRootCredential = [pscredential]::new('root', $HostRootPassword)
$vraBasic['UsePublicKeyInsteadOfCredentials'] = $false
$vraBasic['HostRootPassword'] = $HostRootCredential.GetNetworkCredential().Password
}
# Leverage WhatIf functionality to see what might happen, if WhatIf is not specified, attempt to install.
if ($PSCmdlet.ShouldProcess($hostName)) {
Invoke-ZertoRestRequest -uri "vras" -method POST -body $($vraBasic | ConvertTo-Json)
}
} else {
$vraBasicNetwork['VraIPConfigurationTypeApi'] = "Dhcp"
Write-Error "Host $hostName already has a VRA installed. Aborting Install Call"
}
$vraBasic['VraNetworkDataApi'] = $vraBasicNetwork
}
End {
# Leverage WhatIf functionality to see what might happen, if WhatIf is not specified, attempt to install.
if ($PSCmdlet.ShouldProcess("Preforming operation 'Install-Vra' on Host $hostName with the following data \n $($vraBasic | convertto-json)")) {
Invoke-ZertoRestRequest -uri "vras" -method POST -body $($vraBasic | ConvertTo-Json)
}
} else {
Write-Error "Host $hostName already has a VRA installed. Aborting Install Call"
}
}
@@ -1,26 +1,38 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Invoke-ZARestRequest {
[cmdletbinding()]
param(
# Parameter help description
[Parameter(Mandatory)]
[Parameter(
Mandatory,
Helpmessage = "URI endpoint to be utilized. When submitting the URI, only the endpoint needs to be submitted. Please review the help documentation for examples."
)]
[ValidateNotNullOrEmpty()]
[string]$uri,
[Parameter(
Helpmessage = "API method to be used. GET, PUT, POST, or DELETE. Refer to documentation for the API endpoint to ensure the correct method is being used. If unspecified, defaults to GET"
)]
[ValidateSet("GET", "PUT", "POST", "DELETE")]
[string]$method = "GET",
[Parameter(
Helpmessage = "Body to be submitted to the REST API endpoint. This needs to be submitted in JSON format"
)]
[ValidateNotNullOrEmpty()]
[string]$body,
[ValidateNotNullOrEmpty()]
[string]$contentType = "application/json"
[string]$body
)
# While the API can use XML or JSON, this module is built on JSON functionality. Currently forcing all
# content types and language to JSON.
[string]$contentType = "application/json"
# Check to see if the required variables are present and currently valid
if ( -not ((Test-Path variable:script:zaLastActionTime) -and (Test-Path variable:script:zaHeaders)) ) {
Throw "Zerto Analytics Connection does not Exist. Please run Connect-ZertoAnalytics first to establish a connection"
} elseif ( (Test-Path variable:script:zaHeaders) -and $([datetime]$script:zaLastActionTime).addMinutes(60) -lt $(get-date) ) {
} elseif ( (Test-Path variable:script:zaHeaders) -and $([datetime]$script:zaLastActionTime).addMinutes(60) -lt $(Get-Date) ) {
Throw "Authorization Token has Expired. Please re-authorize to the Zerto Analytics Portal"
} else {
# Update the last action time and submit the request based on PS Version.
Set-Variable -Name zaLastActionTime -Scope Script -Value $(Get-date).Ticks
Set-Variable -Name zaLastActionTime -Scope Script -Value $(Get-Date).Ticks
$submittedUri = "https://analytics.api.zerto.com/v2/{0}" -f $uri
if ($PSVersionTable.PSVersion.Major -ge 6) {
Invoke-RestMethod -Uri $submittedUri -Method $method -Body $body -Headers $Script:zaHeaders -ContentType $contentType -TimeoutSec 100
@@ -1,20 +1,39 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Invoke-ZertoRestRequest {
[cmdletbinding()]
param(
# Parameter help description
[Parameter(
Helpmessage = "API method to be used. GET, PUT, POST, or DELETE. Refer to documentation for the API endpoint to ensure the correct method is being used. If unspecified, defaults to GET"
)]
[ValidateSet("GET", "PUT", "POST", "DELETE")]
[string]$method = "GET",
[Parameter(Mandatory)]
[Parameter(
Mandatory,
Helpmessage = "URI endpoint to be utilized. When submitting the URI, only the endpoint needs to be submitted. Please review the help documentation for examples."
)]
[ValidateNotNullOrEmpty()]
[string]$uri,
[ValidateNotNullOrEmpty()]
[string]$apiVersion = "v1",
[Parameter(
Helpmessage = "Body to be submitted to the REST API endpoint. This needs to be submitted in JSON format"
)]
[ValidateNotNullOrEmpty()]
[string]$body,
[ValidateNotNullOrEmpty()]
[string]$contentType = "application/json",
[Parameter(
Helpmessage = "PSCredential object. This is ONLY used when authenticating with the ZVM. No other endpoints require this and generally is not used."
)]
[PSCredential]$credential,
[Parameter(
Helpmessage = "Use this switch if you would like the request headers returned along with the body. Useful for troubleshooting to get HTTP error codes."
)]
[switch]$returnHeaders
)
# API version. Currently this is locked at v1 in all versions of Zerto. Should this change, will look
# at making this as parameter to be selected during function call.
$apiVersion = "v1"
# While the API can use XML or JSON, this module is built on JSON functionality. Currently forcing all
# content types and language to JSON.
$contentType = "application/json"
$callerErrorActionPreference = $ErrorActionPreference
# If the ZVM server and Port not defined, Stop Call
if ( -not ((Test-Path variable:script:zvmServer) -and (Test-Path variable:script:zvmPort)) ) {
@@ -22,7 +41,7 @@ function Invoke-ZertoRestRequest {
}
# If the Headers exist and the Last action was more than 30 minutes ago, Session is Expired
if ( (Test-Path variable:script:zvmHeaders) -and $([datetime]$script:zvmLastAction).addMinutes(30) -lt $(get-date) ) {
if ( (Test-Path variable:script:zvmHeaders) -and $([datetime]$script:zvmLastAction).addMinutes(30) -lt $(Get-Date) ) {
Throw "Authorization Token has Expired. Please re-authorize to the Zerto Virtual Manager"
} else {
@@ -30,7 +49,7 @@ function Invoke-ZertoRestRequest {
$submittedURI = "https://{0}:{1}/{2}/{3}" -f $script:zvmServer, $script:zvmPort, $apiVersion, $uri
try {
# Set the zvmLastAction time and try to submit the REST Request
$script:zvmLastAction = (get-date).Ticks
$script:zvmLastAction = (Get-Date).Ticks
# If running PwSh - Use this Invoke-RestMethod with passed Variables
if ($PSVersionTable.PSVersion.Major -ge 6) {
$apiRequestResults = Invoke-RestMethod -Uri $submittedURI -Headers $script:zvmHeaders -Method $method -Body $body -ContentType $contentType -Credential $credential -SkipCertificateCheck -ResponseHeadersVariable responseHeaders -TimeoutSec 100
@@ -0,0 +1,35 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Set-ZertoUserCredential {
[cmdletbinding(
SupportsShouldProcess,
ConfirmImpact = 'High'
)]
param(
[Parameter(
HelpMessage = "PSCredential Object that contains the username and password for the updated credentials.",
Mandatory
)]
[pscredential]$UserCredential
)
begin {
}
process {
$uri = '/localsite/virtualizationsettings'
$body = @{
Credentials = @{
UserName = $UserCredential.UserName
Password = $UserCredential.GetNetworkCredential().Password
}
}
if ( $PSCmdlet.ShouldProcess( $script:zvmServer, "Updating hypervisor service account credentials" )) {
Invoke-ZertoRestRequest -uri $uri -Method PUT -body ($body | ConvertTo-Json)
}
}
end {
}
}
+8 -8
View File
@@ -18,11 +18,11 @@ pr:
jobs:
# Windows PowerShell 5.1 Build Job
- job: Build_PS_Win2016
- job: Build_PS_Windows
timeoutInMinutes: 10
cancelTimeoutInMinutes: 2
pool:
vmImage: vs2017-win2016
vmImage: windows-latest
steps:
# Run build.ps1 script in PowerShell Core
- powershell: |
@@ -46,11 +46,11 @@ jobs:
# Windows PowerShell Core Build Job
- job: Build_PSCore_Win2016
- job: Build_PSCore_Windows
timeoutInMinutes: 10
cancelTimeoutInMinutes: 2
pool:
vmImage: vs2017-win2016
vmImage: windows-latest
steps:
# Run build.ps1 script in PowerShell Core
- pwsh: |
@@ -73,11 +73,11 @@ jobs:
condition: always()
# Linux Build Job
- job: Build_PSCore_Ubuntu1604
- job: Build_PSCore_Ubuntu
timeoutInMinutes: 10
cancelTimeoutInMinutes: 2
pool:
vmImage: ubuntu-16.04
vmImage: ubuntu-latest
steps:
# Run build.ps1 script in PowerShell Core
- pwsh: |
@@ -112,11 +112,11 @@ jobs:
condition: always()
# MacOS Build Job
- job: Build_PSCore_MacOS1013
- job: Build_PSCore_MacOS
timeoutInMinutes: 10
cancelTimeoutInMinutes: 2
pool:
vmImage: xcode9-macos10.13
vmImage: macOS-latest
steps:
# Run build.ps1 script in PowerShell Core
- pwsh: |
+3 -3
View File
@@ -13,7 +13,7 @@ Add a tagged checkpoint to a specified VPG
## SYNTAX
```
Checkpoint-ZertoVpg [-vpgName] <String> [-checkpointName] <String> [<CommonParameters>]
Checkpoint-ZertoVpg [-vpgName] <String[]> [-checkpointName] <String> [<CommonParameters>]
```
## DESCRIPTION
@@ -49,14 +49,14 @@ Accept wildcard characters: False
Name of the VPG to tag.
```yaml
Type: String
Type: String[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
```
+61 -61
View File
@@ -1,61 +1,61 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Connect-ZertoAnalytics.md
schema: 2.0.0
---
# Connect-ZertoAnalytics
## SYNOPSIS
All requests to the server, apart from the request to authenticate, must contain a security token which is provided on successful authentication.
In order to authenticate, the user sends myZerto credentials (user/password).
## SYNTAX
```
Connect-ZertoAnalytics [-credential] <PSCredential> [<CommonParameters>]
```
## DESCRIPTION
All requests to the server, apart from the request to authenticate, must contain a security token which is provided on successful authentication.
In order to authenticate, the user sends myZerto credentials (user/password). Once this call has been completed successfully, the header authentication token will be stored as a variable and automatically passed during future calls to the Zerto Analytics platform. This token will automatically expire after 60 minutes of inactivity and need to be reauthorized by calling this function again.
## EXAMPLES
### Example 1
```powershell
PS C:\> Connect-ZertoAnalytics -credential $myCredential
```
Connects to the Zerto Analytics site and gets a Bearer Authorization token that is automatically stored as a variable for future calls to the Zerto Analytics REST API. This token will automatically expire after 60 minutes of inactivity and need to be reauthorized by calling this function again.
## PARAMETERS
### -credential
PSCredential Object containing username and password authorized for the Zerto Analytics site
```yaml
Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Authentication](https://docs.api.zerto.com/#/Authentication/post_v2_auth_token)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Connect-ZertoAnalytics.md
schema: 2.0.0
---
# Connect-ZertoAnalytics
## SYNOPSIS
All requests to the server, apart from the request to authenticate, must contain a security token which is provided on successful authentication.
In order to authenticate, the user sends myZerto credentials (user/password).
## SYNTAX
```
Connect-ZertoAnalytics [-credential] <PSCredential> [<CommonParameters>]
```
## DESCRIPTION
All requests to the server, apart from the request to authenticate, must contain a security token which is provided on successful authentication.
In order to authenticate, the user sends myZerto credentials (user/password). Once this call has been completed successfully, the header authentication token will be stored as a variable and automatically passed during future calls to the Zerto Analytics platform. This token will automatically expire after 60 minutes of inactivity and need to be reauthorized by calling this function again.
## EXAMPLES
### Example 1
```powershell
PS C:\> Connect-ZertoAnalytics -credential $myCredential
```
Connects to the Zerto Analytics site and gets a Bearer Authorization token that is automatically stored as a variable for future calls to the Zerto Analytics REST API. This token will automatically expire after 60 minutes of inactivity and need to be reauthorized by calling this function again.
## PARAMETERS
### -credential
PSCredential Object containing username and password authorized for the Zerto Analytics site
```yaml
Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Authentication](https://docs.api.zerto.com/#/Authentication/post_v2_auth_token)
+127 -127
View File
@@ -1,127 +1,127 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Copy-ZertoVpg.md
schema: 2.0.0
---
# Copy-ZertoVpg
## SYNOPSIS
Copy an existing VPG settings object to create a new VPG with the same settings. New VMs must be added to the copied VPG.
## SYNTAX
```
Copy-ZertoVpg -SourceVpgName <String> -NewVpgName <String> [-VMs] <String[]> [-WhatIf] [-Confirm]
[<CommonParameters>]
```
## DESCRIPTION
Copy an existing VPG settings object to create a new VPG with the same settings. New VMs must be added to the copied VPG.
## EXAMPLES
### Example 1
```powershell
PS C:\> Copy-ZertoVpg -SourceVpgName 'MyVpg' -NewVpgName 'MyNewVpg' -VMs 'VmToAdd01'
```
Copies the settings of 'MyVpg' into a new VPG 'MyNewVpg' adding one VM, 'VmToAdd01'
### Example 2
```powershell
PS C:\> Copy-ZertoVpg -SourceVpgName 'MyVpg' -NewVpgName 'MyNewVpg' -VMs 'VmToAdd01', 'VmToAdd02'
```
Copies the settings of 'MyVpg' into a new VPG 'MyNewVpg' adding two VMs, 'VmToAdd01' and 'VmToAdd02'
## PARAMETERS
### -NewVpgName
Name to assign the newly created VPG
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -SourceVpgName
Name of the VPG to clone
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -VMs
Name of VMs to add to the VPG
```yaml
Type: String[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Clone VPG API Endpoint Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/index.html#page/RestfulAPIs%2FStatusAPIs.5.119.html%23)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Copy-ZertoVpg.md
schema: 2.0.0
---
# Copy-ZertoVpg
## SYNOPSIS
Copy an existing VPG settings object to create a new VPG with the same settings. New VMs must be added to the copied VPG.
## SYNTAX
```
Copy-ZertoVpg [-SourceVpgName] <String> [-NewVpgName] <String> [-VMs] <String[]> [-WhatIf] [-Confirm]
[<CommonParameters>]
```
## DESCRIPTION
Copy an existing VPG settings object to create a new VPG with the same settings. New VMs must be added to the copied VPG.
## EXAMPLES
### Example 1
```powershell
PS C:\> Copy-ZertoVpg -SourceVpgName 'MyVpg' -NewVpgName 'MyNewVpg' -VMs 'VmToAdd01'
```
Copies the settings of 'MyVpg' into a new VPG 'MyNewVpg' adding one VM, 'VmToAdd01'
### Example 2
```powershell
PS C:\> Copy-ZertoVpg -SourceVpgName 'MyVpg' -NewVpgName 'MyNewVpg' -VMs 'VmToAdd01', 'VmToAdd02'
```
Copies the settings of 'MyVpg' into a new VPG 'MyNewVpg' adding two VMs, 'VmToAdd01' and 'VmToAdd02'
## PARAMETERS
### -NewVpgName
Name to assign the newly created VPG
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -SourceVpgName
Name of the VPG to clone
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -VMs
Name of VMs to add to the VPG
```yaml
Type: String[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Clone VPG API Endpoint Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/index.html#page/RestfulAPIs%2FStatusAPIs.5.119.html%23)
+26 -2
View File
@@ -8,13 +8,13 @@ schema: 2.0.0
# Edit-ZertoVra
## SYNOPSIS
Updates a VRA with updated settings
Updates a VRA with updated settings. Use of this function will cause a reboot of the associated VRA.
## SYNTAX
```
Edit-ZertoVra -vraIdentifier <String> [-groupName <String>] [-vraIpAddress <String>] [-defaultGateway <String>]
[-subnetMask <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
[-subnetMask <String>] [-HostRootPassword <SecureString>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@@ -24,6 +24,8 @@ It is possible to update the Bandwidth group with the -groupName setting. If the
It is possible to update the static IP address, default gateway, or subnetmask.
This function can be used if the VRA was installed with host credentials to update the password to connect to the host if it has changed.
It is suggested that you use Get-ZertoVra to get the vraIdentifer parameter.
## EXAMPLES
@@ -56,6 +58,13 @@ PS C:\>Edit-ZertoVra -vraIdentifier $vraIdentifier -defaultGateway "192.168.1.1"
Updates the VRA default gateway to 192.168.1.1
### Example 5
```powershell
PS C:\>Edit-ZertoVra -HostRootPassword $HostRootPassword
```
Updates the VRA default gateway to 192.168.1.1
## PARAMETERS
### -defaultGateway
@@ -89,6 +98,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -HostRootPassword
Updated ESXi host root password.
```yaml
Type: SecureString
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -subnetMask
Subnetmask to be assigned to the VRA
+79 -79
View File
@@ -1,79 +1,79 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/Master/docs/Export-ZertoVmNicSettings.md
schema: 2.0.0
---
# Export-ZertoVmNicSetting
## SYNOPSIS
Queries VPGs and associated Virtual Machines to export all protected virtual machine NIC settings to a Comma Separated Value (CSV) file.
## SYNTAX
```
Export-ZertoVmNicSetting [[-VpgName] <String[]>] [-OutputFile] <String> [<CommonParameters>]
```
## DESCRIPTION
Queries VPGs and associated Virtual Machines to export all protected virtual machine NIC settings to a Comma Separated Value (CSV) file. This file can be used with the Import-ZertoVmNicSetting function to bulk update.
## EXAMPLES
### Example 1
```powershell
PS C:\> Export-ZertoVmNicSetting -OutputFile "C:\ZertoInfo\VMNicSettings.csv"
```
Exports VM Nic Settings for ALL Virtual Protection Groups to a file located at "C:\ZertoInfo\VMNicSettings.csv"
### Example 2
```powershell
PS C:\> Export-ZertoVmNicSetting -OutputFile "C:\ZertoInfo\VMNicSettings.csv" -VpgName "Exchange", "Support Forum"
```
Exports VM Nic Settings for Exchange and Support Forum Virtual Protection Groups to a file located at "C:\ZertoInfo\VMNicSettings.csv"
## PARAMETERS
### -OutputFile
Output file information
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -VpgName
Vpg(s) to export. If no VPG was named, all data will be exported.
```yaml
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/Master/docs/Export-ZertoVmNicSettings.md
schema: 2.0.0
---
# Export-ZertoVmNicSetting
## SYNOPSIS
Queries VPGs and associated Virtual Machines to export all protected virtual machine NIC settings to a Comma Separated Value (CSV) file.
## SYNTAX
```
Export-ZertoVmNicSetting [[-VpgName] <String[]>] [-OutputFile] <String> [<CommonParameters>]
```
## DESCRIPTION
Queries VPGs and associated Virtual Machines to export all protected virtual machine NIC settings to a Comma Separated Value (CSV) file. This file can be used with the Import-ZertoVmNicSetting function to bulk update.
## EXAMPLES
### Example 1
```powershell
PS C:\> Export-ZertoVmNicSetting -OutputFile "C:\ZertoInfo\VMNicSettings.csv"
```
Exports VM Nic Settings for ALL Virtual Protection Groups to a file located at "C:\ZertoInfo\VMNicSettings.csv"
### Example 2
```powershell
PS C:\> Export-ZertoVmNicSetting -OutputFile "C:\ZertoInfo\VMNicSettings.csv" -VpgName "Exchange", "Support Forum"
```
Exports VM Nic Settings for Exchange and Support Forum Virtual Protection Groups to a file located at "C:\ZertoInfo\VMNicSettings.csv"
## PARAMETERS
### -OutputFile
Output file information
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -VpgName
Vpg(s) to export. If no VPG was named, all data will be exported.
```yaml
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
+125 -125
View File
@@ -1,125 +1,125 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAAlert.md
schema: 2.0.0
---
# Get-ZAAlert
## SYNOPSIS
Retrieve information about all existing alerts.
## SYNTAX
### zOrg (Default)
```
Get-ZAAlert [-zOrgIdentifier <String>] [-limitTo <Int32>] [<CommonParameters>]
```
### alertId
```
Get-ZAAlert -alertIdentifier <String> [<CommonParameters>]
```
## DESCRIPTION
Retrieve information about all existing alerts.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAAlert
```
Returns all alerts.
### Example 2
```powershell
PS C:\> Get-ZAAlert -limitTo 10
```
Returns 10 alerts.
### Example 3
```powershell
PS C:\> Get-ZAAlert -zOrgIdentifier "1234-5678-9012"
```
Returns all alerts for the zOrg with Identifier "1234-5678-9012".
### Example 4
```powershell
PS C:\> Get-ZAAlert -zOrgIdentifier "1234-5678-9012" -limitTo 10
```
Returns 10 alerts for the zOrg with Identifier "1234-5678-9012".
### Example 3
```powershell
PS C:\> Get-ZAAlert -alertId "1234-5678-9012"
```
Returns one alert with identifier "1234-5678-9012".
## PARAMETERS
### -alertIdentifier
The VPG Idnetifier
```yaml
Type: String
Parameter Sets: alertId
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -limitTo
The maximum number of alerts to return.
```yaml
Type: Int32
Parameter Sets: zOrg
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -zOrgIdentifier
The ZORG identifier by which to filter the alert list.
If the ZORG identifier is omitted, a list of all the alerts is retrieved.
```yaml
Type: String
Parameter Sets: zOrg
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Alerts](https://docs.api.zerto.com/#/Monitoring/get_v2_monitoring_alerts)
[Zerto Analytics REST API Endpoint for Alerts by Identifier](https://docs.api.zerto.com/#/Monitoring/get_v2_monitoring_alerts__alertIdentifier_)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAAlert.md
schema: 2.0.0
---
# Get-ZAAlert
## SYNOPSIS
Retrieve information about all existing alerts.
## SYNTAX
### zOrg (Default)
```
Get-ZAAlert [-zOrgIdentifier <String>] [-limitTo <Int32>] [<CommonParameters>]
```
### alertId
```
Get-ZAAlert -alertIdentifier <String> [<CommonParameters>]
```
## DESCRIPTION
Retrieve information about all existing alerts.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAAlert
```
Returns all alerts.
### Example 2
```powershell
PS C:\> Get-ZAAlert -limitTo 10
```
Returns 10 alerts.
### Example 3
```powershell
PS C:\> Get-ZAAlert -zOrgIdentifier "1234-5678-9012"
```
Returns all alerts for the zOrg with Identifier "1234-5678-9012".
### Example 4
```powershell
PS C:\> Get-ZAAlert -zOrgIdentifier "1234-5678-9012" -limitTo 10
```
Returns 10 alerts for the zOrg with Identifier "1234-5678-9012".
### Example 3
```powershell
PS C:\> Get-ZAAlert -alertId "1234-5678-9012"
```
Returns one alert with identifier "1234-5678-9012".
## PARAMETERS
### -alertIdentifier
The VPG Idnetifier
```yaml
Type: String
Parameter Sets: alertId
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -limitTo
The maximum number of alerts to return.
```yaml
Type: Int32
Parameter Sets: zOrg
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -zOrgIdentifier
The ZORG identifier by which to filter the alert list.
If the ZORG identifier is omitted, a list of all the alerts is retrieved.
```yaml
Type: String
Parameter Sets: zOrg
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Alerts](https://docs.api.zerto.com/#/Monitoring/get_v2_monitoring_alerts)
[Zerto Analytics REST API Endpoint for Alerts by Identifier](https://docs.api.zerto.com/#/Monitoring/get_v2_monitoring_alerts__alertIdentifier_)
+123 -123
View File
@@ -1,123 +1,123 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZATask.md
schema: 2.0.0
---
# Get-ZADatastore
## SYNOPSIS
Get a list of datastore/s, filtered by site. Enter a site identifier only to get the list of all datastores. Enter a site identifier and cluster identifier to get a list of datastores in the cluster. Enter a site identifier and datastore identifier to get specific datastore info.
## SYNTAX
### AllInfo (Default)
```
Get-ZADatastore -siteIdentifier <String> [<CommonParameters>]
```
### datastore
```
Get-ZADatastore -siteIdentifier <String> -datastoreIdentifier <String> [<CommonParameters>]
```
### cluster
```
Get-ZADatastore -siteIdentifier <String> -clusterIdentifier <String> [<CommonParameters>]
```
## DESCRIPTION
Get a list of datastore/s, filtered by site. Enter a site identifier only to get the list of all datastores. Enter a site identifier and cluster identifier to get a list of datastores in the cluster. Enter a site identifier and datastore identifier to get specific datastore info.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZADatastore -siteIdentifier "7890-1234-5678"
```
Returns all datastore clusters and datastores associated with site identifier "7890-1234-5678"
### Example 2
```powershell
PS C:\> Get-ZADatastore -siteIdentifier "7890-1234-5678" -clusterIdentifier "3456-7890-1234"
```
Returns datastore cluster information with identifier "3456-7890-1234" associated with site identifier "7890-1234-5678"
### Example 3
```powershell
PS C:\> Get-ZADatastore -siteIdentifier "7890-1234-5678" -datastoreIdentifier "5678-9012-3456"
```
Returns all datastore information with identifier "5678-9012-3456" associated with site identifier "7890-1234-5678"
## PARAMETERS
### -clusterIdentifier
The datastore cluster identifier.
Gets a list of datastores in the cluster.
```yaml
Type: String
Parameter Sets: cluster
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -datastoreIdentifier
The datastore identifer.
Gets the datastore info.
```yaml
Type: String
Parameter Sets: datastore
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -siteIdentifier
The site identifier.
The site identifier is mandatory.
Omit the datastore and datastore cluster identifiers to view site level storage information.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### None
## OUTPUTS
### System.Object
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Datastores](https://docs.api.zerto.com/#/Monitoring/get_v2_monitoring_datastores)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZATask.md
schema: 2.0.0
---
# Get-ZADatastore
## SYNOPSIS
Get a list of datastore/s, filtered by site. Enter a site identifier only to get the list of all datastores. Enter a site identifier and cluster identifier to get a list of datastores in the cluster. Enter a site identifier and datastore identifier to get specific datastore info.
## SYNTAX
### AllInfo (Default)
```
Get-ZADatastore -siteIdentifier <String> [<CommonParameters>]
```
### datastore
```
Get-ZADatastore -siteIdentifier <String> -datastoreIdentifier <String> [<CommonParameters>]
```
### cluster
```
Get-ZADatastore -siteIdentifier <String> -clusterIdentifier <String> [<CommonParameters>]
```
## DESCRIPTION
Get a list of datastore/s, filtered by site. Enter a site identifier only to get the list of all datastores. Enter a site identifier and cluster identifier to get a list of datastores in the cluster. Enter a site identifier and datastore identifier to get specific datastore info.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZADatastore -siteIdentifier "7890-1234-5678"
```
Returns all datastore clusters and datastores associated with site identifier "7890-1234-5678"
### Example 2
```powershell
PS C:\> Get-ZADatastore -siteIdentifier "7890-1234-5678" -clusterIdentifier "3456-7890-1234"
```
Returns datastore cluster information with identifier "3456-7890-1234" associated with site identifier "7890-1234-5678"
### Example 3
```powershell
PS C:\> Get-ZADatastore -siteIdentifier "7890-1234-5678" -datastoreIdentifier "5678-9012-3456"
```
Returns all datastore information with identifier "5678-9012-3456" associated with site identifier "7890-1234-5678"
## PARAMETERS
### -clusterIdentifier
The datastore cluster identifier.
Gets a list of datastores in the cluster.
```yaml
Type: String
Parameter Sets: cluster
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -datastoreIdentifier
The datastore identifer.
Gets the datastore info.
```yaml
Type: String
Parameter Sets: datastore
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -siteIdentifier
The site identifier.
The site identifier is mandatory.
Omit the datastore and datastore cluster identifiers to view site level storage information.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### None
## OUTPUTS
### System.Object
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Datastores](https://docs.api.zerto.com/#/Monitoring/get_v2_monitoring_datastores)
+140 -140
View File
@@ -1,140 +1,140 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAEvent.md
schema: 2.0.0
---
# Get-ZAEvent
## SYNOPSIS
Retrieve details of all existing events.
## SYNTAX
```
Get-ZAEvent [[-zOrgIdentifier] <String>] [[-category] <String>] [[-limitTo] <Int32>] [[-startDate] <String>]
[[-endDate] <String>] [<CommonParameters>]
```
## DESCRIPTION
Retrieve details of all existing events.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAEvent
```
Retrieve details of all existing events.
### Example 2
```powershell
PS C:\> Get-ZAEvent -zOrgIdentifier "1234-5678-9012"
```
Retrieve details of all existing events for zOrg with Identifier "1234-5678-9012"
### Example 3
```powershell
PS C:\> Get-ZAEvent -category events -startDate "2019-03-01" -endDate "2019-04-01" -limitTo 400
```
Retrieve details of all events between March 1st and April 1st and limit results to 400.
## PARAMETERS
### -category
The event category (events/alertsHistory).
Default displays the list of all.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -endDate
The latest timestamp of an event to return, in RFC 3339 standard ('1970-01-01T00:00:00Z').
Default is the present time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -limitTo
The maximum number of events to return.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The earliest timestamp of an event to return, in RFC 3339 standard ('1970-01-01T00:00:00Z').
Default is one year ago.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -zOrgIdentifier
The ZORG identifier by which to filter the user's events.
If the ZORG identifier is omitted, events is retrieved.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Events](https://docs.api.zerto.com/#/Monitoring/get_v2_monitoring_events)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAEvent.md
schema: 2.0.0
---
# Get-ZAEvent
## SYNOPSIS
Retrieve details of all existing events.
## SYNTAX
```
Get-ZAEvent [[-zOrgIdentifier] <String>] [[-category] <String>] [[-limitTo] <Int32>] [[-startDate] <String>]
[[-endDate] <String>] [<CommonParameters>]
```
## DESCRIPTION
Retrieve details of all existing events.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAEvent
```
Retrieve details of all existing events.
### Example 2
```powershell
PS C:\> Get-ZAEvent -zOrgIdentifier "1234-5678-9012"
```
Retrieve details of all existing events for zOrg with Identifier "1234-5678-9012"
### Example 3
```powershell
PS C:\> Get-ZAEvent -category events -startDate "2019-03-01" -endDate "2019-04-01" -limitTo 400
```
Retrieve details of all events between March 1st and April 1st and limit results to 400.
## PARAMETERS
### -category
The event category (events/alertsHistory).
Default displays the list of all.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -endDate
The latest timestamp of an event to return, in RFC 3339 standard ('1970-01-01T00:00:00Z').
Default is the present time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -limitTo
The maximum number of events to return.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The earliest timestamp of an event to return, in RFC 3339 standard ('1970-01-01T00:00:00Z').
Default is one year ago.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -zOrgIdentifier
The ZORG identifier by which to filter the user's events.
If the ZORG identifier is omitted, events is retrieved.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Events](https://docs.api.zerto.com/#/Monitoring/get_v2_monitoring_events)
+123 -123
View File
@@ -1,123 +1,123 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAJournalAverageHistory.md
schema: 2.0.0
---
# Get-ZAJournalAverageHistory
## SYNOPSIS
Retrieves the list of historical average journal history values for a specific VPG, filtered by start date, end date, and optional interval. The interval defines the journal history samples interval.
## SYNTAX
```
Get-ZAJournalAverageHistory [-vpgIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>]
[[-interval] <Int32>] [<CommonParameters>]
```
## DESCRIPTION
Retrieves the list of historical average journal history values for a specific VPG, filtered by start date, end date, and optional interval. The interval defines the journal history samples interval.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAJournalAverageHistory -vpgIdentifier "9876-5432-1098"
```
Returns Journal Average History information for VPG with identifier "9876-5432-1098"
### Example 2
```powershell
PS C:\> Get-ZAJournalAverageHistory -vpgIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08"
```
Returns Journal Average History for VPG with identifier "9876-5432-1098" between the dates specified.
### Example 3
```powershell
PS C:\> Get-ZAJournalAverageHistory -vpgIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08" -interval 7200
```
Returns Journal Average History for VPG with identifier "9876-5432-1098" between the dates specified with a 2 hour interval.
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -interval
The interval selected within the duration of the report. The interval can be per hour, for up to 15 days' time frame or per day, for between 15 to 30 days' time frame. Submit value in Seconds
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
The identifier of the VPG.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Journal Average History](https://docs.api.zerto.com/#/Journal_Reports/get_v2_reports_journal_history_average)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAJournalAverageHistory.md
schema: 2.0.0
---
# Get-ZAJournalAverageHistory
## SYNOPSIS
Retrieves the list of historical average journal history values for a specific VPG, filtered by start date, end date, and optional interval. The interval defines the journal history samples interval.
## SYNTAX
```
Get-ZAJournalAverageHistory [-vpgIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>]
[[-interval] <Int32>] [<CommonParameters>]
```
## DESCRIPTION
Retrieves the list of historical average journal history values for a specific VPG, filtered by start date, end date, and optional interval. The interval defines the journal history samples interval.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAJournalAverageHistory -vpgIdentifier "9876-5432-1098"
```
Returns Journal Average History information for VPG with identifier "9876-5432-1098"
### Example 2
```powershell
PS C:\> Get-ZAJournalAverageHistory -vpgIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08"
```
Returns Journal Average History for VPG with identifier "9876-5432-1098" between the dates specified.
### Example 3
```powershell
PS C:\> Get-ZAJournalAverageHistory -vpgIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08" -interval 7200
```
Returns Journal Average History for VPG with identifier "9876-5432-1098" between the dates specified with a 2 hour interval.
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -interval
The interval selected within the duration of the report. The interval can be per hour, for up to 15 days' time frame or per day, for between 15 to 30 days' time frame. Submit value in Seconds
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
The identifier of the VPG.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Journal Average History](https://docs.api.zerto.com/#/Journal_Reports/get_v2_reports_journal_history_average)
+123 -123
View File
@@ -1,123 +1,123 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAJournalAverageSize.md
schema: 2.0.0
---
# Get-ZAJournalAverageSize
## SYNOPSIS
Retrieves the list of historical average journal storage values for a specific VPG, filtered by start date, end date, and optional interval. The interval defines the journal storage samples interval.
## SYNTAX
```
Get-ZAJournalAverageSize [-vpgIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>]
[[-interval] <Int32>] [<CommonParameters>]
```
## DESCRIPTION
Retrieves the list of historical average journal storage values for a specific VPG, filtered by start date, end date, and optional interval. The interval defines the journal storage samples interval.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAJournalAverageSize -vpgIdentifier "9876-5432-1098"
```
Returns Journal Average Size information for VPG with identifier "9876-5432-1098"
### Example 2
```powershell
PS C:\> Get-ZAJournalAverageSize -vpgIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08"
```
Returns Journal Average Size for VPG with identifier "9876-5432-1098" between the dates specified.
### Example 3
```powershell
PS C:\> Get-ZAJournalAverageSize -vpgIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08" -interval 7200
```
Returns Journal Average Size for VPG with identifier "9876-5432-1098" between the dates specified with a 2 hour interval.
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -interval
The interval selected within the duration of the report. The interval can be per hour, for up to 15 days' time frame or per day, for between 15 to 30 days' time frame. Submit value in Seconds
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
The identifier of the VPG.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Journal Average Size](https://docs.api.zerto.com/#/Journal_Reports/get_v2_reports_journal_size_average)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAJournalAverageSize.md
schema: 2.0.0
---
# Get-ZAJournalAverageSize
## SYNOPSIS
Retrieves the list of historical average journal storage values for a specific VPG, filtered by start date, end date, and optional interval. The interval defines the journal storage samples interval.
## SYNTAX
```
Get-ZAJournalAverageSize [-vpgIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>]
[[-interval] <Int32>] [<CommonParameters>]
```
## DESCRIPTION
Retrieves the list of historical average journal storage values for a specific VPG, filtered by start date, end date, and optional interval. The interval defines the journal storage samples interval.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAJournalAverageSize -vpgIdentifier "9876-5432-1098"
```
Returns Journal Average Size information for VPG with identifier "9876-5432-1098"
### Example 2
```powershell
PS C:\> Get-ZAJournalAverageSize -vpgIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08"
```
Returns Journal Average Size for VPG with identifier "9876-5432-1098" between the dates specified.
### Example 3
```powershell
PS C:\> Get-ZAJournalAverageSize -vpgIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08" -interval 7200
```
Returns Journal Average Size for VPG with identifier "9876-5432-1098" between the dates specified with a 2 hour interval.
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -interval
The interval selected within the duration of the report. The interval can be per hour, for up to 15 days' time frame or per day, for between 15 to 30 days' time frame. Submit value in Seconds
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
The identifier of the VPG.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Journal Average Size](https://docs.api.zerto.com/#/Journal_Reports/get_v2_reports_journal_size_average)
+101 -101
View File
@@ -1,101 +1,101 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAJournalBreach.md
schema: 2.0.0
---
# Get-ZAJournalBreach
## SYNOPSIS
Retrieves the journal history breaches over the selected timeframe.
## SYNTAX
```
Get-ZAJournalBreach [-vpgIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>]
[<CommonParameters>]
```
## DESCRIPTION
Retrieves the journal history breaches over the selected timeframe.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAJournalBreach -vpgIdentifier "9876-5432-1098"
```
Returns Journal Breach information for VPG with identifier "9876-5432-1098"
### Example 2
```powershell
PS C:\> Get-ZAJournalBreach -vpgIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08"
```
Returns Journal Breach information for VPG with identifier "9876-5432-1098" between the dates specified.
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
The identifier of the VPG.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Journal Breach](https://docs.api.zerto.com/#/Journal_Reports/get_v2_reports_journal_breach)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAJournalBreach.md
schema: 2.0.0
---
# Get-ZAJournalBreach
## SYNOPSIS
Retrieves the journal history breaches over the selected timeframe.
## SYNTAX
```
Get-ZAJournalBreach [-vpgIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>]
[<CommonParameters>]
```
## DESCRIPTION
Retrieves the journal history breaches over the selected timeframe.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAJournalBreach -vpgIdentifier "9876-5432-1098"
```
Returns Journal Breach information for VPG with identifier "9876-5432-1098"
### Example 2
```powershell
PS C:\> Get-ZAJournalBreach -vpgIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08"
```
Returns Journal Breach information for VPG with identifier "9876-5432-1098" between the dates specified.
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
The identifier of the VPG.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Journal Breach](https://docs.api.zerto.com/#/Journal_Reports/get_v2_reports_journal_breach)
+101 -101
View File
@@ -1,101 +1,101 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAJournalHistoryStat.md
schema: 2.0.0
---
# Get-ZAJournalHistoryStat
## SYNOPSIS
Retrieves Journal history min, max and avg Statistics over the selected timeframe.
## SYNTAX
```
Get-ZAJournalHistoryStat [-vpgIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>]
[<CommonParameters>]
```
## DESCRIPTION
Retrieves Journal history min, max and avg Statistics over the selected timeframe.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAJournalHistoryStat -vpgIdentifier "9876-5432-1098"
```
Returns Journal History Stats for VPG with identifier "9876-5432-1098"
### Example 2
```powershell
PS C:\> Get-ZAJournalHistoryStat -vpgIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08"
```
Returns Journal History Stats for VPG with identifier "9876-5432-1098" between the dates specified.
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
The identifier of the VPG.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Journal History Stats](https://docs.api.zerto.com/#/Journal_Reports/get_v2_reports_stats_journal_history)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAJournalHistoryStat.md
schema: 2.0.0
---
# Get-ZAJournalHistoryStat
## SYNOPSIS
Retrieves Journal history min, max and avg Statistics over the selected timeframe.
## SYNTAX
```
Get-ZAJournalHistoryStat [-vpgIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>]
[<CommonParameters>]
```
## DESCRIPTION
Retrieves Journal history min, max and avg Statistics over the selected timeframe.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAJournalHistoryStat -vpgIdentifier "9876-5432-1098"
```
Returns Journal History Stats for VPG with identifier "9876-5432-1098"
### Example 2
```powershell
PS C:\> Get-ZAJournalHistoryStat -vpgIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08"
```
Returns Journal History Stats for VPG with identifier "9876-5432-1098" between the dates specified.
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
The identifier of the VPG.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Journal History Stats](https://docs.api.zerto.com/#/Journal_Reports/get_v2_reports_stats_journal_history)
+123 -123
View File
@@ -1,123 +1,123 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAJournalSiteAverageHistory.md
schema: 2.0.0
---
# Get-ZAJournalSiteAverageHistory
## SYNOPSIS
Get list of samples of average Journal History values for all VPGs replicating to a specified recovery site, filtered by start date, end date, and optional interval. The interval defines the Journal History samples interval.
## SYNTAX
```
Get-ZAJournalSiteAverageHistory [-recoverySiteIdentifier] <String> [[-startDate] <String>]
[[-endDate] <String>] [[-interval] <Int32>] [<CommonParameters>]
```
## DESCRIPTION
Get list of samples of average Journal History values for all VPGs replicating to a specified recovery site, filtered by start date, end date, and optional interval. The interval defines the Journal History samples interval.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAJournalSiteAverageHistory -recoverySiteIdentifier "9876-5432-1098"
```
Returns Journal Average History information for the recovery site with identifier "9876-5432-1098"
### Example 2
```powershell
PS C:\> Get-ZAJournalSiteAverageHistory -recoverySiteIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08"
```
Returns Journal Average History information for the recovery site with identifier "9876-5432-1098" between the dates specified.
### Example 3
```powershell
PS C:\> Get-ZAJournalSiteAverageHistory -recoverySiteIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08" -interval 7200
```
Returns Journal Average History information for the recovery site with identifier "9876-5432-1098" between the dates specified with a 2 hour interval.
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -interval
The interval selected within the duration of the report. The interval can be per hour, for up to 15 days' time frame or per day, for between 15 to 30 days' time frame. Submit value in Seconds
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -recoverySiteIdentifier
The identifier of the recovery site.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Journal Average Site History](https://docs.api.zerto.com/#/Journal_Reports/get_v2_reports_site_journal_history_average)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAJournalSiteAverageHistory.md
schema: 2.0.0
---
# Get-ZAJournalSiteAverageHistory
## SYNOPSIS
Get list of samples of average Journal History values for all VPGs replicating to a specified recovery site, filtered by start date, end date, and optional interval. The interval defines the Journal History samples interval.
## SYNTAX
```
Get-ZAJournalSiteAverageHistory [-recoverySiteIdentifier] <String> [[-startDate] <String>]
[[-endDate] <String>] [[-interval] <Int32>] [<CommonParameters>]
```
## DESCRIPTION
Get list of samples of average Journal History values for all VPGs replicating to a specified recovery site, filtered by start date, end date, and optional interval. The interval defines the Journal History samples interval.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAJournalSiteAverageHistory -recoverySiteIdentifier "9876-5432-1098"
```
Returns Journal Average History information for the recovery site with identifier "9876-5432-1098"
### Example 2
```powershell
PS C:\> Get-ZAJournalSiteAverageHistory -recoverySiteIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08"
```
Returns Journal Average History information for the recovery site with identifier "9876-5432-1098" between the dates specified.
### Example 3
```powershell
PS C:\> Get-ZAJournalSiteAverageHistory -recoverySiteIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08" -interval 7200
```
Returns Journal Average History information for the recovery site with identifier "9876-5432-1098" between the dates specified with a 2 hour interval.
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -interval
The interval selected within the duration of the report. The interval can be per hour, for up to 15 days' time frame or per day, for between 15 to 30 days' time frame. Submit value in Seconds
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -recoverySiteIdentifier
The identifier of the recovery site.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Journal Average Site History](https://docs.api.zerto.com/#/Journal_Reports/get_v2_reports_site_journal_history_average)
+123 -123
View File
@@ -1,123 +1,123 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAJournalSiteAverageSize.md
schema: 2.0.0
---
# Get-ZAJournalSiteAverageSize
## SYNOPSIS
Get list of samples of total Journal Size of all VPGs replicating to a specified recovery site, filtered by start date, end date, and optional interval. The interval defines the Journal Size samples interval.
## SYNTAX
```
Get-ZAJournalSiteAverageSize [-recoverySiteIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>]
[[-interval] <Int32>] [<CommonParameters>]
```
## DESCRIPTION
Get list of samples of total Journal Size of all VPGs replicating to a specified recovery site, filtered by start date, end date, and optional interval. The interval defines the Journal Size samples interval.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAJournalSiteAverageSize -recoverySiteIdentifier "9876-5432-1098"
```
Returns Journal Average Size information for the recovery site with identifier "9876-5432-1098"
### Example 2
```powershell
PS C:\> Get-ZAJournalSiteAverageSize -recoverySiteIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08"
```
Returns Journal Average Size information for the recovery site with identifier "9876-5432-1098" between the dates specified.
### Example 3
```powershell
PS C:\> Get-ZAJournalSiteAverageSize -recoverySiteIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08" -interval 7200
```
Returns Journal Average Size information for the recovery site with identifier "9876-5432-1098" between the dates specified with a 2 hour interval.
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -interval
The interval selected within the duration of the report. The interval can be per hour, for up to 15 days' time frame or per day, for between 15 to 30 days' time frame. Submit value in Seconds
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -recoverySiteIdentifier
The identifier of the recovery Site.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Journal Average Site Size](https://docs.api.zerto.com/#/Journal_Reports/get_v2_reports_site_journal_size_average)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAJournalSiteAverageSize.md
schema: 2.0.0
---
# Get-ZAJournalSiteAverageSize
## SYNOPSIS
Get list of samples of total Journal Size of all VPGs replicating to a specified recovery site, filtered by start date, end date, and optional interval. The interval defines the Journal Size samples interval.
## SYNTAX
```
Get-ZAJournalSiteAverageSize [-recoverySiteIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>]
[[-interval] <Int32>] [<CommonParameters>]
```
## DESCRIPTION
Get list of samples of total Journal Size of all VPGs replicating to a specified recovery site, filtered by start date, end date, and optional interval. The interval defines the Journal Size samples interval.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAJournalSiteAverageSize -recoverySiteIdentifier "9876-5432-1098"
```
Returns Journal Average Size information for the recovery site with identifier "9876-5432-1098"
### Example 2
```powershell
PS C:\> Get-ZAJournalSiteAverageSize -recoverySiteIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08"
```
Returns Journal Average Size information for the recovery site with identifier "9876-5432-1098" between the dates specified.
### Example 3
```powershell
PS C:\> Get-ZAJournalSiteAverageSize -recoverySiteIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08" -interval 7200
```
Returns Journal Average Size information for the recovery site with identifier "9876-5432-1098" between the dates specified with a 2 hour interval.
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -interval
The interval selected within the duration of the report. The interval can be per hour, for up to 15 days' time frame or per day, for between 15 to 30 days' time frame. Submit value in Seconds
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -recoverySiteIdentifier
The identifier of the recovery Site.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Journal Average Site Size](https://docs.api.zerto.com/#/Journal_Reports/get_v2_reports_site_journal_size_average)
+123 -123
View File
@@ -1,123 +1,123 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAJournalSiteHistoryStat.md
schema: 2.0.0
---
# Get-ZAJournalSiteHistoryStat
## SYNOPSIS
Get Max, Avg. and Min Journal History statistics for all VPGs replicating to a specified recovery site, filtered by start date, end date, and optional interval. The interval defines the journal history samples interval.
## SYNTAX
```
Get-ZAJournalSiteHistoryStat [-recoverySiteIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>]
[[-interval] <Int32>] [<CommonParameters>]
```
## DESCRIPTION
Get Max, Avg. and Min Journal History statistics for all VPGs replicating to a specified recovery site, filtered by start date, end date, and optional interval. The interval defines the journal history samples interval.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAJournalSiteHistoryStat -recoverySiteIdentifier "9876-5432-1098"
```
Returns Journal Average History information for the recovery site with identifier "9876-5432-1098"
### Example 2
```powershell
PS C:\> Get-ZAJournalSiteHistoryStat -recoverySiteIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08"
```
Returns Journal Average History information for the recovery site with identifier "9876-5432-1098" between the dates specified.
### Example 3
```powershell
PS C:\> Get-ZAJournalSiteHistoryStat -recoverySiteIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08" -interval 7200
```
Returns Journal Average History information for the recovery site with identifier "9876-5432-1098" between the dates specified with a 2 hour interval.
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -interval
The interval selected within the duration of the report. The interval can be per hour, for up to 15 days' time frame or per day, for between 15 to 30 days' time frame. Submit value in Seconds
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -recoverySiteIdentifier
The identifier of the recovery site.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Journal Site History Stats](https://docs.api.zerto.com/#/Journal_Reports/get_v2_reports_site_journal_history_stats)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAJournalSiteHistoryStat.md
schema: 2.0.0
---
# Get-ZAJournalSiteHistoryStat
## SYNOPSIS
Get Max, Avg. and Min Journal History statistics for all VPGs replicating to a specified recovery site, filtered by start date, end date, and optional interval. The interval defines the journal history samples interval.
## SYNTAX
```
Get-ZAJournalSiteHistoryStat [-recoverySiteIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>]
[[-interval] <Int32>] [<CommonParameters>]
```
## DESCRIPTION
Get Max, Avg. and Min Journal History statistics for all VPGs replicating to a specified recovery site, filtered by start date, end date, and optional interval. The interval defines the journal history samples interval.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAJournalSiteHistoryStat -recoverySiteIdentifier "9876-5432-1098"
```
Returns Journal Average History information for the recovery site with identifier "9876-5432-1098"
### Example 2
```powershell
PS C:\> Get-ZAJournalSiteHistoryStat -recoverySiteIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08"
```
Returns Journal Average History information for the recovery site with identifier "9876-5432-1098" between the dates specified.
### Example 3
```powershell
PS C:\> Get-ZAJournalSiteHistoryStat -recoverySiteIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08" -interval 7200
```
Returns Journal Average History information for the recovery site with identifier "9876-5432-1098" between the dates specified with a 2 hour interval.
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -interval
The interval selected within the duration of the report. The interval can be per hour, for up to 15 days' time frame or per day, for between 15 to 30 days' time frame. Submit value in Seconds
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -recoverySiteIdentifier
The identifier of the recovery site.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Journal Site History Stats](https://docs.api.zerto.com/#/Journal_Reports/get_v2_reports_site_journal_history_stats)
+123 -123
View File
@@ -1,123 +1,123 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAJournalSiteHistorySummary.md
schema: 2.0.0
---
# Get-ZAJournalSiteHistorySummary
## SYNOPSIS
Get a Journal History executive summary for all VPGs replicating to a specified recovery site.
## SYNTAX
```
Get-ZAJournalSiteHistorySummary [-recoverySiteIdentifier] <String> [[-startDate] <String>]
[[-endDate] <String>] [[-interval] <Int32>] [<CommonParameters>]
```
## DESCRIPTION
Get a Journal History executive summary for all VPGs replicating to a specified recovery site.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAJournalSiteHistorySummary -recoverySiteIdentifier "9876-5432-1098"
```
Returns Journal History Executive Summary information for the recovery site with identifier "9876-5432-1098"
### Example 2
```powershell
PS C:\> Get-ZAJournalSiteHistorySummary -recoverySiteIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08"
```
Returns Journal History Executive Summary information for the recovery site with identifier "9876-5432-1098" between the dates specified.
### Example 3
```powershell
PS C:\> Get-ZAJournalSiteHistorySummary -recoverySiteIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08" -interval 7200
```
Returns Journal History Executive Summary information for the recovery site with identifier "9876-5432-1098" between the dates specified with a 2 hour interval.
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -interval
The interval selected within the duration of the report. The interval can be per hour, for up to 15 days' time frame or per day, for between 15 to 30 days' time frame. Submit value in Seconds
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -recoverySiteIdentifier
The identifier of the recovery site.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Journal Site History Summary](https://docs.api.zerto.com/#/Journal_Reports/get_v2_reports_site_journal_history_summary)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAJournalSiteHistorySummary.md
schema: 2.0.0
---
# Get-ZAJournalSiteHistorySummary
## SYNOPSIS
Get a Journal History executive summary for all VPGs replicating to a specified recovery site.
## SYNTAX
```
Get-ZAJournalSiteHistorySummary [-recoverySiteIdentifier] <String> [[-startDate] <String>]
[[-endDate] <String>] [[-interval] <Int32>] [<CommonParameters>]
```
## DESCRIPTION
Get a Journal History executive summary for all VPGs replicating to a specified recovery site.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAJournalSiteHistorySummary -recoverySiteIdentifier "9876-5432-1098"
```
Returns Journal History Executive Summary information for the recovery site with identifier "9876-5432-1098"
### Example 2
```powershell
PS C:\> Get-ZAJournalSiteHistorySummary -recoverySiteIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08"
```
Returns Journal History Executive Summary information for the recovery site with identifier "9876-5432-1098" between the dates specified.
### Example 3
```powershell
PS C:\> Get-ZAJournalSiteHistorySummary -recoverySiteIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08" -interval 7200
```
Returns Journal History Executive Summary information for the recovery site with identifier "9876-5432-1098" between the dates specified with a 2 hour interval.
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -interval
The interval selected within the duration of the report. The interval can be per hour, for up to 15 days' time frame or per day, for between 15 to 30 days' time frame. Submit value in Seconds
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -recoverySiteIdentifier
The identifier of the recovery site.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Journal Site History Summary](https://docs.api.zerto.com/#/Journal_Reports/get_v2_reports_site_journal_history_summary)
+123 -123
View File
@@ -1,123 +1,123 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAJournalSiteSizeStat.md
schema: 2.0.0
---
# Get-ZAJournalSiteSizeStat
## SYNOPSIS
Get Max, Avg. and Min of total Journal Size statistics for all VPGs replicating to a specified recovery site, filtered by start date, end date, and optional interval. The interval defines the journal history samples interval.
## SYNTAX
```
Get-ZAJournalSiteSizeStat [-recoverySiteIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>]
[[-interval] <Int32>] [<CommonParameters>]
```
## DESCRIPTION
Get Max, Avg. and Min of total Journal Size statistics for all VPGs replicating to a specified recovery site, filtered by start date, end date, and optional interval. The interval defines the journal history samples interval.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAJournalSiteSizeStat -recoverySiteIdentifier "9876-5432-1098"
```
Returns Journal Size Statistics information for the recovery site with identifier "9876-5432-1098"
### Example 2
```powershell
PS C:\> Get-ZAJournalSiteSizeStat -recoverySiteIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08"
```
Returns Journal Size Statistics information for the recovery site with identifier "9876-5432-1098" between the dates specified.
### Example 3
```powershell
PS C:\> Get-ZAJournalSiteSizeStat -recoverySiteIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08" -interval 7200
```
Returns Journal Size Statistics information for the recovery site with identifier "9876-5432-1098" between the dates specified with a 2 hour interval.
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -interval
The interval selected within the duration of the report. The interval can be per hour, for up to 15 days' time frame or per day, for between 15 to 30 days' time frame. Submit value in Seconds
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -recoverySiteIdentifier
The identifier of the recovery site.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Journal Site size Stats](https://docs.api.zerto.com/#/Journal_Reports/get_v2_reports_site_journal_size_stats)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAJournalSiteSizeStat.md
schema: 2.0.0
---
# Get-ZAJournalSiteSizeStat
## SYNOPSIS
Get Max, Avg. and Min of total Journal Size statistics for all VPGs replicating to a specified recovery site, filtered by start date, end date, and optional interval. The interval defines the journal history samples interval.
## SYNTAX
```
Get-ZAJournalSiteSizeStat [-recoverySiteIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>]
[[-interval] <Int32>] [<CommonParameters>]
```
## DESCRIPTION
Get Max, Avg. and Min of total Journal Size statistics for all VPGs replicating to a specified recovery site, filtered by start date, end date, and optional interval. The interval defines the journal history samples interval.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAJournalSiteSizeStat -recoverySiteIdentifier "9876-5432-1098"
```
Returns Journal Size Statistics information for the recovery site with identifier "9876-5432-1098"
### Example 2
```powershell
PS C:\> Get-ZAJournalSiteSizeStat -recoverySiteIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08"
```
Returns Journal Size Statistics information for the recovery site with identifier "9876-5432-1098" between the dates specified.
### Example 3
```powershell
PS C:\> Get-ZAJournalSiteSizeStat -recoverySiteIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08" -interval 7200
```
Returns Journal Size Statistics information for the recovery site with identifier "9876-5432-1098" between the dates specified with a 2 hour interval.
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -interval
The interval selected within the duration of the report. The interval can be per hour, for up to 15 days' time frame or per day, for between 15 to 30 days' time frame. Submit value in Seconds
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -recoverySiteIdentifier
The identifier of the recovery site.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Journal Site size Stats](https://docs.api.zerto.com/#/Journal_Reports/get_v2_reports_site_journal_size_stats)
+101 -101
View File
@@ -1,101 +1,101 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAJournalStatusProportion.md
schema: 2.0.0
---
# Get-ZAJournalStatusProportion
## SYNOPSIS
Retrieves journal history SLA status distribution over selected timeframe.
## SYNTAX
```
Get-ZAJournalStatusProportion [-vpgIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>]
[<CommonParameters>]
```
## DESCRIPTION
Retrieves journal history SLA status distribution over selected timeframe.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAJournalStatusProportion -vpgIdentifier "9876-5432-1098"
```
Returns Journal history SLA status distribution for VPG with identifier "9876-5432-1098"
### Example 2
```powershell
PS C:\> Get-ZAJournalStatusProportion -vpgIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08"
```
Returns Journalhistory SLA status distribution for VPG with identifier "9876-5432-1098" between the dates specified.
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
The identifier of the VPG.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Journal Statuses Proportions](https://docs.api.zerto.com/#/Journal_Reports/get_v2_reports_journal_statuses_proportions)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAJournalStatusProportion.md
schema: 2.0.0
---
# Get-ZAJournalStatusProportion
## SYNOPSIS
Retrieves journal history SLA status distribution over selected timeframe.
## SYNTAX
```
Get-ZAJournalStatusProportion [-vpgIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>]
[<CommonParameters>]
```
## DESCRIPTION
Retrieves journal history SLA status distribution over selected timeframe.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAJournalStatusProportion -vpgIdentifier "9876-5432-1098"
```
Returns Journal history SLA status distribution for VPG with identifier "9876-5432-1098"
### Example 2
```powershell
PS C:\> Get-ZAJournalStatusProportion -vpgIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08"
```
Returns Journalhistory SLA status distribution for VPG with identifier "9876-5432-1098" between the dates specified.
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
The identifier of the VPG.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Journal Statuses Proportions](https://docs.api.zerto.com/#/Journal_Reports/get_v2_reports_journal_statuses_proportions)
+101 -101
View File
@@ -1,101 +1,101 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAJournalStorageStat.md
schema: 2.0.0
---
# Get-ZAJournalStorageStat
## SYNOPSIS
Retrieves Journal Storage minimum, maximum and average. Statistics over the selected timeframe.
## SYNTAX
```
Get-ZAJournalStorageStat [-vpgIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>]
[<CommonParameters>]
```
## DESCRIPTION
Retrieves Journal Storage minimum, maximum and average. Statistics over the selected timeframe.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAJournalStorageStat -vpgIdentifier "9876-5432-1098"
```
Returns Journal Storage Stats for VPG with identifier "9876-5432-1098"
### Example 2
```powershell
PS C:\> Get-ZAJournalStorageStat -vpgIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08"
```
Returns Journal Storage Stats for VPG with identifier "9876-5432-1098" between the dates specified.
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
The identifier of the VPG.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Journal Storage Stats](https://docs.api.zerto.com/#/Journal_Reports/get_v2_reports_stats_journal_storage)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAJournalStorageStat.md
schema: 2.0.0
---
# Get-ZAJournalStorageStat
## SYNOPSIS
Retrieves Journal Storage minimum, maximum and average. Statistics over the selected timeframe.
## SYNTAX
```
Get-ZAJournalStorageStat [-vpgIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>]
[<CommonParameters>]
```
## DESCRIPTION
Retrieves Journal Storage minimum, maximum and average. Statistics over the selected timeframe.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAJournalStorageStat -vpgIdentifier "9876-5432-1098"
```
Returns Journal Storage Stats for VPG with identifier "9876-5432-1098"
### Example 2
```powershell
PS C:\> Get-ZAJournalStorageStat -vpgIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08"
```
Returns Journal Storage Stats for VPG with identifier "9876-5432-1098" between the dates specified.
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
The identifier of the VPG.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Journal Storage Stats](https://docs.api.zerto.com/#/Journal_Reports/get_v2_reports_stats_journal_storage)
+101 -101
View File
@@ -1,101 +1,101 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAJournalSummary.md
schema: 2.0.0
---
# Get-ZAJournalSummary
## SYNOPSIS
Retrieves journal historical statistics for a given VPG.
## SYNTAX
```
Get-ZAJournalSummary [-vpgIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>]
[<CommonParameters>]
```
## DESCRIPTION
Retrieves journal historical statistics for a given VPG.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAJournalSummary -vpgIdentifier "9876-5432-1098"
```
Returns Journal Summary information for VPG with identifier "9876-5432-1098"
### Example 2
```powershell
PS C:\> Get-ZAJournalSummary -vpgIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08"
```
Returns Journal Summary information for VPG with identifier "9876-5432-1098" between the dates specified.
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
The identifier of the VPG.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Journal Summary](https://docs.api.zerto.com/#/Journal_Reports/get_v2_reports_journal_summary)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAJournalSummary.md
schema: 2.0.0
---
# Get-ZAJournalSummary
## SYNOPSIS
Retrieves journal historical statistics for a given VPG.
## SYNTAX
```
Get-ZAJournalSummary [-vpgIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>]
[<CommonParameters>]
```
## DESCRIPTION
Retrieves journal historical statistics for a given VPG.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAJournalSummary -vpgIdentifier "9876-5432-1098"
```
Returns Journal Summary information for VPG with identifier "9876-5432-1098"
### Example 2
```powershell
PS C:\> Get-ZAJournalSummary -vpgIdentifier "9876-5432-1098" -startDate "2019-06-01" -endDate "2019-06-08"
```
Returns Journal Summary information for VPG with identifier "9876-5432-1098" between the dates specified.
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
The identifier of the VPG.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Journal Summary](https://docs.api.zerto.com/#/Journal_Reports/get_v2_reports_journal_summary)
+45 -45
View File
@@ -1,45 +1,45 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZALicense.md
schema: 2.0.0
---
# Get-ZALicense
## SYNOPSIS
Retrieve a list of all licenses.
## SYNTAX
```
Get-ZALicense [<CommonParameters>]
```
## DESCRIPTION
Retrieve a list of all licenses.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZALicense
```
Returns all licenses and associated information
## PARAMETERS
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API License End Point Documentation](https://docs.api.zerto.com/#/Licenses/get_v2_licenses)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZALicense.md
schema: 2.0.0
---
# Get-ZALicense
## SYNOPSIS
Retrieve a list of all licenses.
## SYNTAX
```
Get-ZALicense [<CommonParameters>]
```
## DESCRIPTION
Retrieve a list of all licenses.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZALicense
```
Returns all licenses and associated information
## PARAMETERS
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API License End Point Documentation](https://docs.api.zerto.com/#/Licenses/get_v2_licenses)
+69 -69
View File
@@ -1,69 +1,69 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAMonitoring.md
schema: 2.0.0
---
# Get-ZAMonitoring
## SYNOPSIS
Retrieve statistics related to all the user's sites - belonging to a single account.
## SYNTAX
```
Get-ZAMonitoring [[-zOrgIdentifier] <String>] [<CommonParameters>]
```
## DESCRIPTION
Retrieve statistics related to all the user's sites - belonging to a single account.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAMonitoring
```
Retrieve statistics related to all the user's sites - belonging to a single account.
### Example 1
```powershell
PS C:\> Get-ZAMonitoring -zOrgIdentifier "1234-5678-9012"
```
Retrieve statistics related to the zOrgIdentifier provided
## PARAMETERS
### -zOrgIdentifier
The ZORG identifier by which to filter the user's statistics for a single account.
If the ZORG identifier is omitted, statistics related to all sites, for a single account, is retrieved.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Monitoring](https://docs.api.zerto.com/#/Monitoring/get_v2_monitoring_)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAMonitoring.md
schema: 2.0.0
---
# Get-ZAMonitoring
## SYNOPSIS
Retrieve statistics related to all the user's sites - belonging to a single account.
## SYNTAX
```
Get-ZAMonitoring [[-zOrgIdentifier] <String>] [<CommonParameters>]
```
## DESCRIPTION
Retrieve statistics related to all the user's sites - belonging to a single account.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAMonitoring
```
Retrieve statistics related to all the user's sites - belonging to a single account.
### Example 1
```powershell
PS C:\> Get-ZAMonitoring -zOrgIdentifier "1234-5678-9012"
```
Retrieve statistics related to the zOrgIdentifier provided
## PARAMETERS
### -zOrgIdentifier
The ZORG identifier by which to filter the user's statistics for a single account.
If the ZORG identifier is omitted, statistics related to all sites, for a single account, is retrieved.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Monitoring](https://docs.api.zerto.com/#/Monitoring/get_v2_monitoring_)
+183 -183
View File
@@ -1,183 +1,183 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZANetworkSiteAverageIOPS.md
schema: 2.0.0
---
# Get-ZANetworkSiteAverageIOPS
## SYNOPSIS
Get average and maximum IOPS performance for sites, filtered by start date and end date, and optional intervals.
## SYNTAX
### ProtectedSite (Default)
```
Get-ZANetworkSiteAverageIOPS -protectedSiteIdentifier <String> [-recoverySiteIdentifier <String>]
[-startDate <String>] [-endDate <String>] [-zOrgIdentifier <String>] [-interval <Int32>] [<CommonParameters>]
```
### RecoverySite
```
Get-ZANetworkSiteAverageIOPS [-protectedSiteIdentifier <String>] -recoverySiteIdentifier <String>
[-startDate <String>] [-endDate <String>] [-zOrgIdentifier <String>] [-interval <Int32>] [<CommonParameters>]
```
## DESCRIPTION
Get average and maximum IOPS performance for sites, filtered by start date and end date, and optional intervals.
The following options are available:
* To view average and maximum IOPS performance of all outgoing traffic from a protected site to all its replicating sites, specify only the protected site identifier.
* To view average and maximum IOPS performance between two sites, specify both the protected site identifier and the recovery site identifier.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZANetworkSiteAverageIOPS -protectedSiteIdentifier "7890-1234-5678"
```
Returns outgoing networks IOPS average from site with identifier "7890-1234-5678"
### Example 2
```powershell
PS C:\> Get-ZANetworkSiteAverageIOPS -protectedSiteIdentifier "7890-1234-5678" -recoverySiteIdentifier "9876-5432-1098"
```
Returns network IOPS average between sites with identifiers "7890-1234-5678" and "9876-5432-1098"
## PARAMETERS
### -endDate
End date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the end date is omitted, the default end date is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -interval
The interval selected within the duration of the report. The interval can be per hour, for up to 15 days' time frame or per day, for between 15 to 30 days' time frame. Submit value in Seconds
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -protectedSiteIdentifier
Protected site identifier.
A site identification is required for at least one of the sites.
```yaml
Type: String
Parameter Sets: ProtectedSite
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
```yaml
Type: String
Parameter Sets: RecoverySite
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -recoverySiteIdentifier
Recovery site identifier.
If the recovery site identifier is omitted, the API will show all outgoing traffic from the protected site to its replicating sites.
```yaml
Type: String
Parameter Sets: ProtectedSite
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
```yaml
Type: String
Parameter Sets: RecoverySite
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
Start date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the start date is omitted, the default start date is 7 days before the end date.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -zOrgIdentifier
The ZORG identifier by which to filter the executive summary.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Network Site Average IOPS](https://docs.api.zerto.com/#/Network_Reports/get_v2_reports_sites_network_iops_average)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZANetworkSiteAverageIOPS.md
schema: 2.0.0
---
# Get-ZANetworkSiteAverageIOPS
## SYNOPSIS
Get average and maximum IOPS performance for sites, filtered by start date and end date, and optional intervals.
## SYNTAX
### ProtectedSite (Default)
```
Get-ZANetworkSiteAverageIOPS -protectedSiteIdentifier <String> [-recoverySiteIdentifier <String>]
[-startDate <String>] [-endDate <String>] [-zOrgIdentifier <String>] [-interval <Int32>] [<CommonParameters>]
```
### RecoverySite
```
Get-ZANetworkSiteAverageIOPS [-protectedSiteIdentifier <String>] -recoverySiteIdentifier <String>
[-startDate <String>] [-endDate <String>] [-zOrgIdentifier <String>] [-interval <Int32>] [<CommonParameters>]
```
## DESCRIPTION
Get average and maximum IOPS performance for sites, filtered by start date and end date, and optional intervals.
The following options are available:
* To view average and maximum IOPS performance of all outgoing traffic from a protected site to all its replicating sites, specify only the protected site identifier.
* To view average and maximum IOPS performance between two sites, specify both the protected site identifier and the recovery site identifier.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZANetworkSiteAverageIOPS -protectedSiteIdentifier "7890-1234-5678"
```
Returns outgoing networks IOPS average from site with identifier "7890-1234-5678"
### Example 2
```powershell
PS C:\> Get-ZANetworkSiteAverageIOPS -protectedSiteIdentifier "7890-1234-5678" -recoverySiteIdentifier "9876-5432-1098"
```
Returns network IOPS average between sites with identifiers "7890-1234-5678" and "9876-5432-1098"
## PARAMETERS
### -endDate
End date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the end date is omitted, the default end date is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -interval
The interval selected within the duration of the report. The interval can be per hour, for up to 15 days' time frame or per day, for between 15 to 30 days' time frame. Submit value in Seconds
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -protectedSiteIdentifier
Protected site identifier.
A site identification is required for at least one of the sites.
```yaml
Type: String
Parameter Sets: ProtectedSite
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
```yaml
Type: String
Parameter Sets: RecoverySite
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -recoverySiteIdentifier
Recovery site identifier.
If the recovery site identifier is omitted, the API will show all outgoing traffic from the protected site to its replicating sites.
```yaml
Type: String
Parameter Sets: ProtectedSite
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
```yaml
Type: String
Parameter Sets: RecoverySite
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
Start date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the start date is omitted, the default start date is 7 days before the end date.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -zOrgIdentifier
The ZORG identifier by which to filter the executive summary.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Network Site Average IOPS](https://docs.api.zerto.com/#/Network_Reports/get_v2_reports_sites_network_iops_average)
+183 -183
View File
@@ -1,183 +1,183 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZANetworkSiteAveragePerformance.md
schema: 2.0.0
---
# Get-ZANetworkSiteAveragePerformance
## SYNOPSIS
Get list of samples of average and maximum network performance metrics (throughput and WAN traffic) for sites, filtered by start date and end date, and optional intervals.
## SYNTAX
### ProtectedSite (Default)
```
Get-ZANetworkSiteAveragePerformance -protectedSiteIdentifier <String> [-recoverySiteIdentifier <String>]
[-startDate <String>] [-endDate <String>] [-zOrgIdentifier <String>] [-interval <Int32>] [<CommonParameters>]
```
### RecoverySite
```
Get-ZANetworkSiteAveragePerformance [-protectedSiteIdentifier <String>] -recoverySiteIdentifier <String>
[-startDate <String>] [-endDate <String>] [-zOrgIdentifier <String>] [-interval <Int32>] [<CommonParameters>]
```
## DESCRIPTION
Get list of samples of average and maximum network performance metrics (throughput and WAN traffic) for sites, filtered by start date and end date, and optional intervals.
The following options are available:
* To view average and maximum network performance of throughput vs. WAN traffic of all outgoing traffic from a protected site to all its replicating sites, specify only the protected site identifier.
* To view average and maximum network performance of throughput and WAN traffic between two sites, specify both the protected site identifier and the recovery site identifier.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZANetworkSiteAveragePerformance -protectedSiteIdentifier "7890-1234-5678"
```
Returns outgoing networks performance average from site with identifier "7890-1234-5678"
### Example 2
```powershell
PS C:\> Get-ZANetworkSiteAveragePerformance -protectedSiteIdentifier "7890-1234-5678" -recoverySiteIdentifier "9876-5432-1098"
```
Returns network performance average between sites with identifiers "7890-1234-5678" and "9876-5432-1098"
## PARAMETERS
### -endDate
End date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the end date is omitted, the default end date is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -interval
The interval selected within the duration of the report. The interval can be per hour, for up to 15 days' time frame or per day, for between 15 to 30 days' time frame. Submit value in Seconds
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -protectedSiteIdentifier
Protected site identifier.
A site identification is required for at least one of the sites.
```yaml
Type: String
Parameter Sets: ProtectedSite
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
```yaml
Type: String
Parameter Sets: RecoverySite
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -recoverySiteIdentifier
Recovery site identifier.
If the recovery site identifier is omitted, the API will show all outgoing traffic from the protected site to its replicating sites.
```yaml
Type: String
Parameter Sets: ProtectedSite
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
```yaml
Type: String
Parameter Sets: RecoverySite
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
Start date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the start date is omitted, the default start date is 7 days before the end date.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -zOrgIdentifier
The ZORG identifier by which to filter the executive summary.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Network Site Average Performance](https://docs.api.zerto.com/#/Network_Reports/get_v2_reports_sites_network_performance_average)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZANetworkSiteAveragePerformance.md
schema: 2.0.0
---
# Get-ZANetworkSiteAveragePerformance
## SYNOPSIS
Get list of samples of average and maximum network performance metrics (throughput and WAN traffic) for sites, filtered by start date and end date, and optional intervals.
## SYNTAX
### ProtectedSite (Default)
```
Get-ZANetworkSiteAveragePerformance -protectedSiteIdentifier <String> [-recoverySiteIdentifier <String>]
[-startDate <String>] [-endDate <String>] [-zOrgIdentifier <String>] [-interval <Int32>] [<CommonParameters>]
```
### RecoverySite
```
Get-ZANetworkSiteAveragePerformance [-protectedSiteIdentifier <String>] -recoverySiteIdentifier <String>
[-startDate <String>] [-endDate <String>] [-zOrgIdentifier <String>] [-interval <Int32>] [<CommonParameters>]
```
## DESCRIPTION
Get list of samples of average and maximum network performance metrics (throughput and WAN traffic) for sites, filtered by start date and end date, and optional intervals.
The following options are available:
* To view average and maximum network performance of throughput vs. WAN traffic of all outgoing traffic from a protected site to all its replicating sites, specify only the protected site identifier.
* To view average and maximum network performance of throughput and WAN traffic between two sites, specify both the protected site identifier and the recovery site identifier.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZANetworkSiteAveragePerformance -protectedSiteIdentifier "7890-1234-5678"
```
Returns outgoing networks performance average from site with identifier "7890-1234-5678"
### Example 2
```powershell
PS C:\> Get-ZANetworkSiteAveragePerformance -protectedSiteIdentifier "7890-1234-5678" -recoverySiteIdentifier "9876-5432-1098"
```
Returns network performance average between sites with identifiers "7890-1234-5678" and "9876-5432-1098"
## PARAMETERS
### -endDate
End date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the end date is omitted, the default end date is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -interval
The interval selected within the duration of the report. The interval can be per hour, for up to 15 days' time frame or per day, for between 15 to 30 days' time frame. Submit value in Seconds
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -protectedSiteIdentifier
Protected site identifier.
A site identification is required for at least one of the sites.
```yaml
Type: String
Parameter Sets: ProtectedSite
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
```yaml
Type: String
Parameter Sets: RecoverySite
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -recoverySiteIdentifier
Recovery site identifier.
If the recovery site identifier is omitted, the API will show all outgoing traffic from the protected site to its replicating sites.
```yaml
Type: String
Parameter Sets: ProtectedSite
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
```yaml
Type: String
Parameter Sets: RecoverySite
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
Start date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the start date is omitted, the default start date is 7 days before the end date.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -zOrgIdentifier
The ZORG identifier by which to filter the executive summary.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Network Site Average Performance](https://docs.api.zerto.com/#/Network_Reports/get_v2_reports_sites_network_performance_average)
+167 -167
View File
@@ -1,167 +1,167 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAMonitoring.md
schema: 2.0.0
---
# Get-ZANetworkSiteStat
## SYNOPSIS
Get Max, Avg. and Min network statistics for Throughput, Wan and IOPS traffic for sites, filtered by start date and end date.
## SYNTAX
### ProtectedSite (Default)
```
Get-ZANetworkSiteStat -protectedSiteIdentifier <String> [-recoverySiteIdentifier <String>]
[-startDate <String>] [-endDate <String>] [-zOrgIdentifier <String>] [<CommonParameters>]
```
### RecoverySite
```
Get-ZANetworkSiteStat [-protectedSiteIdentifier <String>] -recoverySiteIdentifier <String>
[-startDate <String>] [-endDate <String>] [-zOrgIdentifier <String>] [<CommonParameters>]
```
## DESCRIPTION
Get Max, Avg. and Min network statistics for Throughput, Wan and IOPS traffic for sites, filtered by start date and end date. The following options are available:
* To view network stats of all outgoing traffic from a protected site to all its replicating sites, specify only the protected site identifier.
* To view network stats between two sites, specify both the protected site identifier and the recovery site identifier.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZANetworkSiteStat -protectedSiteIdentifier "7890-1234-5678"
```
Returns all outgoing networks stats from site with identifier "7890-1234-5678"
### Example 2
```powershell
PS C:\> Get-ZANetworkSiteStat -protectedSiteIdentifier "7890-1234-5678" -recoverySiteIdentifier "9876-5432-1098"
```
Returns all networks stats between sites with identifiers "7890-1234-5678" and "9876-5432-1098"
## PARAMETERS
### -endDate
End date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the end date is omitted, the default end date is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -protectedSiteIdentifier
Protected site identifier.
A site identification is required for at least one of the sites.
```yaml
Type: String
Parameter Sets: ProtectedSite
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
```yaml
Type: String
Parameter Sets: RecoverySite
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -recoverySiteIdentifier
Recovery site identifier.
If the recovery site identifier is omitted, the API will show all outgoing traffic from the protected site to its replicating sites.
```yaml
Type: String
Parameter Sets: ProtectedSite
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
```yaml
Type: String
Parameter Sets: RecoverySite
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
Start date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the start date is omitted, the default start date is 7 days before the end date.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -zOrgIdentifier
The ZORG identifier by which to filter the executive summary.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Network Site Summary](https://docs.api.zerto.com/#/Network_Reports/get_v2_reports_sites_network_stats)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAMonitoring.md
schema: 2.0.0
---
# Get-ZANetworkSiteStat
## SYNOPSIS
Get Max, Avg. and Min network statistics for Throughput, Wan and IOPS traffic for sites, filtered by start date and end date.
## SYNTAX
### ProtectedSite (Default)
```
Get-ZANetworkSiteStat -protectedSiteIdentifier <String> [-recoverySiteIdentifier <String>]
[-startDate <String>] [-endDate <String>] [-zOrgIdentifier <String>] [<CommonParameters>]
```
### RecoverySite
```
Get-ZANetworkSiteStat [-protectedSiteIdentifier <String>] -recoverySiteIdentifier <String>
[-startDate <String>] [-endDate <String>] [-zOrgIdentifier <String>] [<CommonParameters>]
```
## DESCRIPTION
Get Max, Avg. and Min network statistics for Throughput, Wan and IOPS traffic for sites, filtered by start date and end date. The following options are available:
* To view network stats of all outgoing traffic from a protected site to all its replicating sites, specify only the protected site identifier.
* To view network stats between two sites, specify both the protected site identifier and the recovery site identifier.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZANetworkSiteStat -protectedSiteIdentifier "7890-1234-5678"
```
Returns all outgoing networks stats from site with identifier "7890-1234-5678"
### Example 2
```powershell
PS C:\> Get-ZANetworkSiteStat -protectedSiteIdentifier "7890-1234-5678" -recoverySiteIdentifier "9876-5432-1098"
```
Returns all networks stats between sites with identifiers "7890-1234-5678" and "9876-5432-1098"
## PARAMETERS
### -endDate
End date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the end date is omitted, the default end date is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -protectedSiteIdentifier
Protected site identifier.
A site identification is required for at least one of the sites.
```yaml
Type: String
Parameter Sets: ProtectedSite
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
```yaml
Type: String
Parameter Sets: RecoverySite
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -recoverySiteIdentifier
Recovery site identifier.
If the recovery site identifier is omitted, the API will show all outgoing traffic from the protected site to its replicating sites.
```yaml
Type: String
Parameter Sets: ProtectedSite
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
```yaml
Type: String
Parameter Sets: RecoverySite
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
Start date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the start date is omitted, the default start date is 7 days before the end date.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -zOrgIdentifier
The ZORG identifier by which to filter the executive summary.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Network Site Summary](https://docs.api.zerto.com/#/Network_Reports/get_v2_reports_sites_network_stats)
+167 -167
View File
@@ -1,167 +1,167 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZANetworkSiteSummary.md
schema: 2.0.0
---
# Get-ZANetworkSiteSummary
## SYNOPSIS
Get a network executive summary for sites, filtered by start date and end date.
## SYNTAX
### ProtectedSite (Default)
```
Get-ZANetworkSiteSummary -protectedSiteIdentifier <String> [-recoverySiteIdentifier <String>]
[-startDate <String>] [-endDate <String>] [-zOrgIdentifier <String>] [<CommonParameters>]
```
### RecoverySite
```
Get-ZANetworkSiteSummary [-protectedSiteIdentifier <String>] -recoverySiteIdentifier <String>
[-startDate <String>] [-endDate <String>] [-zOrgIdentifier <String>] [<CommonParameters>]
```
## DESCRIPTION
Get a network executive summary for sites, filtered by start date and end date.The following options are available:
* To view the network executive summary of all outgoing traffic from a protected site to all its replicating sites, specify only the protected site identifier.
* To view the network executive summary between two sites, specify both the protected site identifier and the recovery site identifier.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZANetworkSiteSummary -protectedSiteIdentifier "7890-1234-5678"
```
Returns outgoing networks summary from site with identifier "7890-1234-5678"
### Example 2
```powershell
PS C:\> Get-ZANetworkSiteSummary -protectedSiteIdentifier "7890-1234-5678" -recoverySiteIdentifier "9876-5432-1098"
```
Returns network summary between sites with identifiers "7890-1234-5678" and "9876-5432-1098"
## PARAMETERS
### -endDate
End date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the end date is omitted, the default end date is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -protectedSiteIdentifier
Protected site identifier.
A site identification is required for at least one of the sites.
```yaml
Type: String
Parameter Sets: ProtectedSite
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
```yaml
Type: String
Parameter Sets: RecoverySite
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -recoverySiteIdentifier
Recovery site identifier.
If the recovery site identifier is omitted, the API will show all outgoing traffic from the protected site to its replicating sites.
```yaml
Type: String
Parameter Sets: ProtectedSite
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
```yaml
Type: String
Parameter Sets: RecoverySite
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
Start date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the start date is omitted, the default start date is 7 days before the end date.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -zOrgIdentifier
The ZORG identifier by which to filter the executive summary.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Network Site Summary](https://docs.api.zerto.com/#/Network_Reports/get_v2_reports_sites_network_summary)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZANetworkSiteSummary.md
schema: 2.0.0
---
# Get-ZANetworkSiteSummary
## SYNOPSIS
Get a network executive summary for sites, filtered by start date and end date.
## SYNTAX
### ProtectedSite (Default)
```
Get-ZANetworkSiteSummary -protectedSiteIdentifier <String> [-recoverySiteIdentifier <String>]
[-startDate <String>] [-endDate <String>] [-zOrgIdentifier <String>] [<CommonParameters>]
```
### RecoverySite
```
Get-ZANetworkSiteSummary [-protectedSiteIdentifier <String>] -recoverySiteIdentifier <String>
[-startDate <String>] [-endDate <String>] [-zOrgIdentifier <String>] [<CommonParameters>]
```
## DESCRIPTION
Get a network executive summary for sites, filtered by start date and end date.The following options are available:
* To view the network executive summary of all outgoing traffic from a protected site to all its replicating sites, specify only the protected site identifier.
* To view the network executive summary between two sites, specify both the protected site identifier and the recovery site identifier.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZANetworkSiteSummary -protectedSiteIdentifier "7890-1234-5678"
```
Returns outgoing networks summary from site with identifier "7890-1234-5678"
### Example 2
```powershell
PS C:\> Get-ZANetworkSiteSummary -protectedSiteIdentifier "7890-1234-5678" -recoverySiteIdentifier "9876-5432-1098"
```
Returns network summary between sites with identifiers "7890-1234-5678" and "9876-5432-1098"
## PARAMETERS
### -endDate
End date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the end date is omitted, the default end date is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -protectedSiteIdentifier
Protected site identifier.
A site identification is required for at least one of the sites.
```yaml
Type: String
Parameter Sets: ProtectedSite
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
```yaml
Type: String
Parameter Sets: RecoverySite
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -recoverySiteIdentifier
Recovery site identifier.
If the recovery site identifier is omitted, the API will show all outgoing traffic from the protected site to its replicating sites.
```yaml
Type: String
Parameter Sets: ProtectedSite
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
```yaml
Type: String
Parameter Sets: RecoverySite
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
Start date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the start date is omitted, the default start date is 7 days before the end date.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -zOrgIdentifier
The ZORG identifier by which to filter the executive summary.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Network Site Summary](https://docs.api.zerto.com/#/Network_Reports/get_v2_reports_sites_network_summary)
+109 -109
View File
@@ -1,109 +1,109 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZANetworkVpgAverageIOPS.md
schema: 2.0.0
---
# Get-ZANetworkVpgAverageIOPS
## SYNOPSIS
Get average and maximum IOPS performance for a specific VPG, filtered by start date and end date, and optional intervals.
## SYNTAX
```
Get-ZANetworkVpgAverageIOPS [-vpgIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>]
[[-interval] <Int32>] [<CommonParameters>]
```
## DESCRIPTION
Get average and maximum IOPS performance for a specific VPG, filtered by start date and end date, and optional intervals.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZANetworkVpgAverageIOPS -vpgIdentifier "3456-7890-1234" -interval 3600
```
Get Network VPG Average IOPS for VPG with Identifier "3456-7890-1234" for the last 7 days at an interval of 1 hour.
## PARAMETERS
### -endDate
End date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the end date is omitted, the default end date is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -interval
The interval selected within the duration of the report. The interval can be per minute - for up to 6 hours, per hour - for 6 hours to 15 days, or per day - for 15 days up to 30 days. If an interval is not specified, the default is 60 seconds. Submit value in Seconds.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
Start date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the start date is omitted, the default start date is 7 days before the end date.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
The VPG identifier.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Network VPG Average IOPS](https://docs.api.zerto.com/#/Network_Reports/get_v2_reports_vpg_network_iops_average)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZANetworkVpgAverageIOPS.md
schema: 2.0.0
---
# Get-ZANetworkVpgAverageIOPS
## SYNOPSIS
Get average and maximum IOPS performance for a specific VPG, filtered by start date and end date, and optional intervals.
## SYNTAX
```
Get-ZANetworkVpgAverageIOPS [-vpgIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>]
[[-interval] <Int32>] [<CommonParameters>]
```
## DESCRIPTION
Get average and maximum IOPS performance for a specific VPG, filtered by start date and end date, and optional intervals.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZANetworkVpgAverageIOPS -vpgIdentifier "3456-7890-1234" -interval 3600
```
Get Network VPG Average IOPS for VPG with Identifier "3456-7890-1234" for the last 7 days at an interval of 1 hour.
## PARAMETERS
### -endDate
End date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the end date is omitted, the default end date is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -interval
The interval selected within the duration of the report. The interval can be per minute - for up to 6 hours, per hour - for 6 hours to 15 days, or per day - for 15 days up to 30 days. If an interval is not specified, the default is 60 seconds. Submit value in Seconds.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
Start date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the start date is omitted, the default start date is 7 days before the end date.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
The VPG identifier.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Network VPG Average IOPS](https://docs.api.zerto.com/#/Network_Reports/get_v2_reports_vpg_network_iops_average)
+109 -109
View File
@@ -1,109 +1,109 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZANetworkVpgAveragePerformance.md
schema: 2.0.0
---
# Get-ZANetworkVpgAveragePerformance
## SYNOPSIS
Get average and maximum network performance of throughput vs. WAN traffic for a specific VPG filtered by start date and end date, and optional intervals.
## SYNTAX
```
Get-ZANetworkVpgAveragePerformance [-vpgIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>]
[[-interval] <Int32>] [<CommonParameters>]
```
## DESCRIPTION
Get average and maximum network performance of throughput vs. WAN traffic for a specific VPG filtered by start date and end date, and optional intervals
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZANetworkVpgAveragePerformance -vpgIdentifier "3456-7890-1234" -interval 3600
```
Get Network VPG Average Performance for VPG with Identifier "3456-7890-1234" for the last 7 days at an interval of 1 hour.
## PARAMETERS
### -endDate
End date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the end date is omitted, the default end date is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -interval
The interval selected within the duration of the report. The interval can be per minute - for up to 6 hours, per hour - for 6 hours to 15 days, or per day - for 15 days up to 30 days. If an interval is not specified, the default is 60 seconds. Submit value in Seconds.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
Start date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the start date is omitted, the default start date is 7 days before the end date.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
The VPG identifier.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Network VPG Average Performance](https://docs.api.zerto.com/#/Network_Reports/get_v2_reports_vpg_network_performance_average)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZANetworkVpgAveragePerformance.md
schema: 2.0.0
---
# Get-ZANetworkVpgAveragePerformance
## SYNOPSIS
Get average and maximum network performance of throughput vs. WAN traffic for a specific VPG filtered by start date and end date, and optional intervals.
## SYNTAX
```
Get-ZANetworkVpgAveragePerformance [-vpgIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>]
[[-interval] <Int32>] [<CommonParameters>]
```
## DESCRIPTION
Get average and maximum network performance of throughput vs. WAN traffic for a specific VPG filtered by start date and end date, and optional intervals
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZANetworkVpgAveragePerformance -vpgIdentifier "3456-7890-1234" -interval 3600
```
Get Network VPG Average Performance for VPG with Identifier "3456-7890-1234" for the last 7 days at an interval of 1 hour.
## PARAMETERS
### -endDate
End date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the end date is omitted, the default end date is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -interval
The interval selected within the duration of the report. The interval can be per minute - for up to 6 hours, per hour - for 6 hours to 15 days, or per day - for 15 days up to 30 days. If an interval is not specified, the default is 60 seconds. Submit value in Seconds.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
Start date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the start date is omitted, the default start date is 7 days before the end date.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
The VPG identifier.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Network VPG Average Performance](https://docs.api.zerto.com/#/Network_Reports/get_v2_reports_vpg_network_performance_average)
+94 -94
View File
@@ -1,94 +1,94 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZANetworkVpgStat.md
schema: 2.0.0
---
# Get-ZANetworkVpgStat
## SYNOPSIS
Get Max, Avg. and Min network statistics for Throughput, Wan and IOPS traffic for a given VPG, filtered by start date and end date.
## SYNTAX
```
Get-ZANetworkVpgStat [-vpgIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>]
[<CommonParameters>]
```
## DESCRIPTION
Get Max, Avg. and Min network statistics for Throughput, Wan and IOPS traffic for a given VPG, filtered by start date and end date.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZANetworkVpgStat -vpgIdentifier "3456-7890-1234"
```
Get Network VPG Stats for VPG with Identifier "3456-7890-1234" for the last 7 days.
## PARAMETERS
### -endDate
End date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the end date is omitted, the default end date is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
Start date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the start date is omitted, the default start date is 7 days before the end date.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
The VPG identifier.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Network VPG Summary](https://docs.api.zerto.com/#/Network_Reports/get_v2_reports_vpg_network_summary)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZANetworkVpgStat.md
schema: 2.0.0
---
# Get-ZANetworkVpgStat
## SYNOPSIS
Get Max, Avg. and Min network statistics for Throughput, Wan and IOPS traffic for a given VPG, filtered by start date and end date.
## SYNTAX
```
Get-ZANetworkVpgStat [-vpgIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>]
[<CommonParameters>]
```
## DESCRIPTION
Get Max, Avg. and Min network statistics for Throughput, Wan and IOPS traffic for a given VPG, filtered by start date and end date.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZANetworkVpgStat -vpgIdentifier "3456-7890-1234"
```
Get Network VPG Stats for VPG with Identifier "3456-7890-1234" for the last 7 days.
## PARAMETERS
### -endDate
End date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the end date is omitted, the default end date is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
Start date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the start date is omitted, the default start date is 7 days before the end date.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
The VPG identifier.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Network VPG Summary](https://docs.api.zerto.com/#/Network_Reports/get_v2_reports_vpg_network_summary)
+94 -94
View File
@@ -1,94 +1,94 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZANetworkVpgSummary.md
schema: 2.0.0
---
# Get-ZANetworkVpgSummary
## SYNOPSIS
Get a network executive summary for a given VPG, filtered by start date and end date.
## SYNTAX
```
Get-ZANetworkVpgSummary [-vpgIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>]
[<CommonParameters>]
```
## DESCRIPTION
Get a network executive summary for a given VPG, filtered by start date and end date.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZANetworkVpgSummary -vpgIdentifier "3456-7890-1234"
```
Get Network VPG Summary for VPG with Identifier "3456-7890-1234" for the last 7 days.
## PARAMETERS
### -endDate
End date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the end date is omitted, the default end date is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
Start date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the start date is omitted, the default start date is 7 days before the end date.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
The VPG identifier.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Network VPG Summary](https://docs.api.zerto.com/#/Network_Reports/get_v2_reports_vpg_network_summary)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZANetworkVpgSummary.md
schema: 2.0.0
---
# Get-ZANetworkVpgSummary
## SYNOPSIS
Get a network executive summary for a given VPG, filtered by start date and end date.
## SYNTAX
```
Get-ZANetworkVpgSummary [-vpgIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>]
[<CommonParameters>]
```
## DESCRIPTION
Get a network executive summary for a given VPG, filtered by start date and end date.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZANetworkVpgSummary -vpgIdentifier "3456-7890-1234"
```
Get Network VPG Summary for VPG with Identifier "3456-7890-1234" for the last 7 days.
## PARAMETERS
### -endDate
End date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the end date is omitted, the default end date is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
Start date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the start date is omitted, the default start date is 7 days before the end date.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
The VPG identifier.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Network VPG Summary](https://docs.api.zerto.com/#/Network_Reports/get_v2_reports_vpg_network_summary)
+163
View File
@@ -0,0 +1,163 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAPlannerJournalSizeReport.md
schema: 2.0.0
---
# Get-ZAPlannerJournalSizeReport
## SYNOPSIS
Create a report request to retrieve the Journal Size for a specific VMs list, and timeframe.
## SYNTAX
```
Get-ZAPlannerJournalSizeReport [-siteIdentifier] <String> [-recoveryType] <String> [-vmIdentifier] <String[]>
[[-desiredJournalHistory] <Int32>] [[-startDate] <String>] [[-endDate] <String>] [<CommonParameters>]
```
## DESCRIPTION
Create a report request to retrieve the Journal Size for a specific VMs list, and timeframe.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAPlannerJournalSizeReport -siteIdentifier '1234567890-01923141' -recoveryType VMware -vmIdentifier 'vmIdentifier1', 'vmIdentifier2'
```
Gets a Journal report for VMs with identifiers 'vmIdentifier1' and 'vmIdentifier2' at source siteIdentifier '1234567890-01923141' where the target recovery location is VMware. The report will cover a Journal History of 24 hours. This will use all data contained in Zerto Analytics to create the Journal report.
### Example 2
```powershell
PS C:\> Get-ZAPlannerJournalSizeReport -siteIdentifier '1234567890-01923141' -recoveryType VMware -vmIdentifier 'vmIdentifier1', 'vmIdentifier2' -desiredJournalHistory 96
```
Gets a Journal report for VMs with identifiers 'vmIdentifier1' and 'vmIdentifier2' at source siteIdentifier '1234567890-01923141' where the target recovery location is VMware. The report will cover a Journal History of 96 hours (4 days). This will use all data contained in Zerto Analytics to create the Journal report.
### Example 3
```powershell
PS C:\> Get-ZAPlannerJournalSizeReport -siteIdentifier '1234567890-01923141' -recoveryType VMware -vmIdentifier 'vmIdentifier1', 'vmIdentifier2' -desiredJournalHistory 96 -startDate '2020-01-01'
```
Gets a Journal report for VMs with identifiers 'vmIdentifier1' and 'vmIdentifier2' at source siteIdentifier '1234567890-01923141' where the target recovery location is VMware. The report will cover a Journal History of 96 hours (4 days). This will use all data starting from Jan 1st to today contained in Zerto Analytics to create the Journal report.
### Example 4
```powershell
PS C:\> Get-ZAPlannerJournalSizeReport -siteIdentifier '1234567890-01923141' -recoveryType VMware -vmIdentifier 'vmIdentifier1', 'vmIdentifier2' -desiredJournalHistory 96 -startDate '2020-01-01' -endDate '2020-01-30'
```
Gets a Journal report for VMs with identifiers 'vmIdentifier1' and 'vmIdentifier2' at source siteIdentifier '1234567890-01923141' where the target recovery location is VMware. The report will cover a Journal History of 96 hours (4 days). This will use all data starting from Jan 1st to Jan 30th contained in Zerto Analytics to create the Journal report.
## PARAMETERS
### -desiredJournalHistory
The desired journal history in hours.
The default is 24 hours.
Limited to a 1 hour up to 720 hours, or the equivalent of 30 days
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 24
Accept pipeline input: False
Accept wildcard characters: False
```
### -endDate
The latest timestamp of an event to return, in RFC 3339 standard.
('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -recoveryType
Type of target recovery site.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -siteIdentifier
The site identifier(s) for which to return detailed information.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The earliest timestamp of an event to return, in RFC 3339 standard.
('1970-01-01T00:00:00Z').
The default is one year ago.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vmIdentifier
Identifiers of the VMs you want to recover at the target recovery site.
```yaml
Type: String[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Planner Journal Size Report - Post](https://docs.api.zerto.com/#/Planner/post_v2_planner_reports_stats_journal_size)
[Zerto Planner Journal Size Report - Get](https://docs.api.zerto.com/#/Planner/get_v2_planner_reports_stats_journal_size)
@@ -0,0 +1,158 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAPlannerNetworkPerformanceReport.md
schema: 2.0.0
---
# Get-ZAPlannerNetworkPerformanceReport
## SYNOPSIS
Create a report request to retrieve the Network Performance for a specific VMs list, and timeframe.
## SYNTAX
```
Get-ZAPlannerNetworkPerformanceReport [-siteIdentifier] <String> [-recoveryType] <String>
[-vmIdentifier] <String[]> [[-interval] <Int32>] [[-startDate] <String>] [[-endDate] <String>]
[<CommonParameters>]
```
## DESCRIPTION
Create a report request to retrieve the Network Performance for a specific VMs list, and timeframe.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAPlannerNetworkPerformanceReport -siteIdentifier '1234567890-01923141' -recoveryType VMware -vmIdentifier 'vmIdentifier1', 'vmIdentifier2'
```
Gets a Network Performance report for VMs with identifiers 'vmIdentifier1' and 'vmIdentifier2' at source siteIdentifier '1234567890-01923141' where the target recovery location is VMware. This will use all data contained in Zerto Analytics to create the Journal report.
### Example 2
```powershell
PS C:\> Get-ZAPlannerNetworkPerformanceReport -siteIdentifier '1234567890-01923141' -recoveryType VMware -vmIdentifier 'vmIdentifier1', 'vmIdentifier2' -startDate '2020-01-01' -interval 86400
```
Gets a Network Performance report for VMs with identifiers 'vmIdentifier1' and 'vmIdentifier2' at source siteIdentifier '1234567890-01923141' where the target recovery location is VMware. This will use data contained in Zerto Analytics starting Jan 1st, 2020 ending on the day the report is run to create the Journal report. Sample reporting interval will be 86400 seconds (1 day).
### Example 3
```powershell
PS C:\> Get-ZAPlannerNetworkPerformanceReport -siteIdentifier '1234567890-01923141' -recoveryType VMware -vmIdentifier 'vmIdentifier1', 'vmIdentifier2' -startDate '2020-01-01' -endDate '2020-01-30' -interval 86400
```
Gets a Network Performance report for VMs with identifiers 'vmIdentifier1' and 'vmIdentifier2' at source siteIdentifier '1234567890-01923141' where the target recovery location is VMware. This will use data contained in Zerto Analytics starting Jan 1st, 2020 ending on Jan 30th, 2020 to create the Journal report. Sample reporting interval will be 86400 seconds (1 day).
## PARAMETERS
### -endDate
The latest timestamp of an event to return, in RFC 3339 standard.
('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -interval
The desired sample interval in seconds.
The default is 3600 seconds (1 Hour).
Limited to a 60 second to 86,400 second (24 Hour) interval
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 3600
Accept pipeline input: False
Accept wildcard characters: False
```
### -recoveryType
Type of target recovery site.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -siteIdentifier
The site identifier(s) for which to return detailed information.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The earliest timestamp of an event to return, in RFC 3339 standard.
('1970-01-01T00:00:00Z').
The default is one year ago.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vmIdentifier
Identifiers of the VMs you want to recover at the target recovery site.
```yaml
Type: String[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics Planner Network-Performance API Endpoint - POST](https://docs.api.zerto.com/#/Planner/post_v2_planner_reports_network_performance)
[Zerto Analytics Planner Network-Performance API Endpoint - GET](https://docs.api.zerto.com/#/Planner/get_v2_planner_reports_network_performance)
+67
View File
@@ -0,0 +1,67 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAPlannerSite.md
schema: 2.0.0
---
# Get-ZAPlannerSite
## SYNOPSIS
Retrieve all active Planner sites for a specific account - includes ID, Name and Type or retrieves datacenter, host, and VMs for a specific site.
## SYNTAX
```
Get-ZAPlannerSite [[-siteIdentifier] <String[]>] [<CommonParameters>]
```
## DESCRIPTION
Retrieve all active Planner sites for a specific account - includes ID, Name and Type or retrieves datacenter, host, and VMs for a specific site.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAPlannerSite
```
Retrieve all active Planner sites for a specific account
### Example 2
```powershell
PS C:\> Get-ZAPlannerSite -siteIdentifier '0123-45676-09876'
```
Retrieves datacenter, host, and VMs for site with Identifier '0123-45676-09876'.
## PARAMETERS
### -siteIdentifier
The site identifier(s) for which to return detailed information.
```yaml
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics Sites Planner Endpoint](https://docs.api.zerto.com/#/Planner/get_v2_planner_sites)
[Zerto Analytics Single Site Planner Endpoint](https://docs.api.zerto.com/#/Planner/get_v2_planner_sites__siteIdentifier_)
+149
View File
@@ -0,0 +1,149 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAPlannerStatsReport.md
schema: 2.0.0
---
# Get-ZAPlannerStatsReport
## SYNOPSIS
Create a report request for the selected VMs for a specific timeframe, retrieving all stats data for ZCAs, WAN, Journal size and array of VMs avg IOPs, avg throughput and journal size.
## SYNTAX
```
Get-ZAPlannerStatsReport [-siteIdentifier] <String> [-recoveryType] <String> [-vmIdentifier] <String[]>
[[-desiredJournalHistory] <Int32>] [[-startDate] <String>] [[-endDate] <String>] [<CommonParameters>]
```
## DESCRIPTION
Create a report request for the selected VMs for a specific timeframe, retrieving all stats data for ZCAs, WAN, Journal size and array of VMs avg IOPs, avg throughput and journal size.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAPlannerStatsReport -siteIdentifier '0123-45676-09876' -recoveryType vcenter -vmIdentifier 'vmIdentifier01', 'vmIdentifier02'
```
Will get a stats report for the two VMs listed recovering to a vCenter site with a 24 hour journal
### Example 2
```powershell
PS C:\> Get-ZAPlannerStatsReport -siteIdentifier '0123-45676-09876' -recoveryType Azure -vmIdentifier 'vmIdentifier01', 'vmIdentifier02' -desiredJournalHistory 72
```
Will get a stats report for the two VMs listed recovering to an Azure site with a 72 hour journal
## PARAMETERS
### -desiredJournalHistory
The desired journal history in hours.
The default is 24 hours.
Limited to a 1 hour up to 720 hours, or the equivalent of 30 days
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 24
Accept pipeline input: False
Accept wildcard characters: False
```
### -endDate
The latest timestamp of an event to return, in RFC 3339 standard.
('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -recoveryType
Type of target recovery site.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -siteIdentifier
The site identifier(s) for which to return detailed information.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The earliest timestamp of an event to return, in RFC 3339 standard.
('1970-01-01T00:00:00Z').
The default is one year ago.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vmIdentifier
Identifiers of the VMs you want to recover at the target recovery site.
```yaml
Type: String[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics Planner Stats API Endpoint - POST](https://docs.api.zerto.com/#/Planner/post_v2_planner_reports_stats)
[Zerto Analytics Planner Stats API Endpoint - GET](https://docs.api.zerto.com/#/Planner/get_v2_planner_reports_stats)
+125
View File
@@ -0,0 +1,125 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAPlannerWanReport.md
schema: 2.0.0
---
# Get-ZAPlannerWanReport
## SYNOPSIS
Create a report request to retrieve WAN for a specific VMs list, and timeframe.
## SYNTAX
```
Get-ZAPlannerWanReport [-siteIdentifier] <String> [-recoveryType] <String> [-vmIdentifier] <String[]>
[[-startDate] <String>] [[-endDate] <String>] [<CommonParameters>]
```
## DESCRIPTION
Create a report request to retrieve WAN for a specific VMs list, and timeframe.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAPlannerWanReport -siteIdentifier '12345-0987654-254364' -recoveryType vcenter -vmIdentifier '1234-98789-0987', '1234-98789-1252'
```
Get a WAN requirements report for VMs at the protected site.
## PARAMETERS
### -endDate
The latest timestamp of an event to return, in RFC 3339 standard.
('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -recoveryType
Type of target recovery site.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -siteIdentifier
The site identifier(s) for which to return detailed information.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The earliest timestamp of an event to return, in RFC 3339 standard.
('1970-01-01T00:00:00Z').
The default is one year ago.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vmIdentifier
Identifiers of the VMs you want to recover at the target recovery site.
```yaml
Type: String[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics Planner Wan Stats API Endpoint - POST](https://docs.api.zerto.com/#/Planner/post_v2_planner_reports_stats_wan)
[Zerto Analytics Planner Wan Stats API Endpoint - GET](https://docs.api.zerto.com/#/Planner/get_v2_planner_reports_stats_wan)
+125
View File
@@ -0,0 +1,125 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAPlannerZcasReport.md
schema: 2.0.0
---
# Get-ZAPlannerZcasReport
## SYNOPSIS
Create a report request to retrieve ZCAs for a specific VMs list, and timeframe.
## SYNTAX
```
Get-ZAPlannerZcasReport [-siteIdentifier] <String> [-recoveryType] <String> [-vmIdentifier] <String[]>
[[-startDate] <String>] [[-endDate] <String>] [<CommonParameters>]
```
## DESCRIPTION
Create a report request to retrieve ZCAs for a specific VMs list, and timeframe.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAPlannerZcasReport -siteIdentifier '12345-0987654-254364' -recoveryType azure -vmIdentifier '1234-98789-0987', '1234-98789-1252'
```
Get a report for the number of required ZCA's in Azure to protect the supplied VMs.
## PARAMETERS
### -endDate
The latest timestamp of an event to return, in RFC 3339 standard.
('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -recoveryType
Type of target recovery site.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -siteIdentifier
The site identifier(s) for which to return detailed information.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The earliest timestamp of an event to return, in RFC 3339 standard.
('1970-01-01T00:00:00Z').
The default is one year ago.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vmIdentifier
Identifiers of the VMs you want to recover at the target recovery site.
```yaml
Type: String[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics Planner ZCA Stats API Endpoint - POST](https://docs.api.zerto.com/#/Planner/post_v2_planner_reports_stats_zcas)
[Zerto Analytics Planner ZCA Stats API Endpoint - GET](https://docs.api.zerto.com/#/Planner/get_v2_planner_reports_stats_zcas)
+120
View File
@@ -0,0 +1,120 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAProtectedVm.md
schema: 2.0.0
---
# Get-ZAProtectedVm
## SYNOPSIS
Gets information about currently protected Virtual Machines in all sites. If desired a subset of VMs can be returned by providing VM Identifiers for each virtual machine.
## SYNTAX
### AllVMs (Default)
```
Get-ZAProtectedVm [-AllVms] [<CommonParameters>]
```
### IndividualVMs
```
Get-ZAProtectedVm -VMIdentifier <String[]> [-Volumes] [<CommonParameters>]
```
## DESCRIPTION
Gets information about currently protected Virtual Machines in all sites. If desired a subset of VMs can be returned by providing VM Identifiers for each virtual machine. Finally, when gathering information for individual virtual machines, the `-Volumes` parameter can be specified to return volume information for the protected VM.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAProtectedVm
```
Returns all protected virtual machines across all sites.
### Example 2
```powershell
PS C:\> Get-ZAProtectedVm -AllVMs
```
Returns all protected virtual machines across all sites.
### Example 3
```powershell
PS C:\> Get-ZAProtectedVm -VMIdentifier '09914-12345-12341235', '81238-12532-12355332'
```
Returns information for only the two specified virtual machines
### Example 4
```powershell
PS C:\> Get-ZAProtectedVm -VMIdentifier '09914-12345-12341235', '81238-12532-12355332' -Volumes
```
Returns volume information for the two specified virtual machines
## PARAMETERS
### -AllVms
Use this switch when you want a list of all protected VMs.
Please be warned this list can be quite large.
```yaml
Type: SwitchParameter
Parameter Sets: AllVMs
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -VMIdentifier
A list of VM identifiers to query
```yaml
Type: String[]
Parameter Sets: IndividualVMs
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Volumes
Specify this switch when you would like protected vms' volume information returned
```yaml
Type: SwitchParameter
Parameter Sets: IndividualVMs
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics Protected VMs API Endpoint - AllVMs](https://docs.api.zerto.com/#/Monitoring/get_v2_monitoring_protected_vms)
[Zerto Analytics Protected VMs API Endpoint - List of VMs](https://docs.api.zerto.com/#/Monitoring/get_v2_monitoring_protected_vms__vmIdentifier_)
[Zerto Analytics Protected VMs API Endpoint - Volumes of VMs](https://docs.api.zerto.com/#/Monitoring/get_v2_monitoring_protected_vms__vmIdentifier__volumes)
+60
View File
@@ -0,0 +1,60 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAProtectedVmReport.md
schema: 2.0.0
---
# Get-ZAProtectedVmReport
## SYNOPSIS
Creates a report of the requested protected virtual machines' volumes.
## SYNTAX
```
Get-ZAProtectedVmReport -VMIdentifier <String[]> [<CommonParameters>]
```
## DESCRIPTION
Creates a report of the requested protected virtual machines' volumes.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAProtectedVmReport -VMIdentifier '09914-12345-12341235', '81238-12532-12355332'
```
Generates a protected vm report for the virtual machines with the specified VMIdentifiers.
## PARAMETERS
### -VMIdentifier
A list of VM identifiers to include in the report.
```yaml
Type: String[]
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics Protected VMs Report API Endpoint - POST](https://docs.api.zerto.com/#/Monitoring/post_v2_monitoring_protected_vms)
[Zerto Analytics Protected VMs Report API Endpoint - GET](https://docs.api.zerto.com/#/Monitoring/get_v2_monitoring_protected_vms_reportId__reportId_)
+109 -109
View File
@@ -1,109 +1,109 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/Master/docs/Get-ZARPOAccountAverage.md
schema: 2.0.0
---
# Get-ZARPOAccountAverage
## SYNOPSIS
Get average RPO for all VPGs in a single account, filtered by last 30 days.
## SYNTAX
```
Get-ZARPOAccountAverage [[-zOrgIdentifier] <String>] [[-startDate] <String>] [[-endDate] <String>]
[<CommonParameters>]
```
## DESCRIPTION
Get average RPO for all VPGs in a single account, filtered by last 30 days.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZARPOAccountAverage
```
Get average RPO for all VPGs in a single account.
### Example 2
```powershell
PS C:\> Get-ZARPOAccountAverage -zOrgIdentifier "1234-5678-9012"
```
Get average RPO for all VPGs in zOrg with identifier "1234-5678-9012".
### Example 3
```powershell
PS C:\> Get-ZARPOAccountAverage -startDate "2019-06-01T00:00:00Z" -endDate "2019-06-02T00:00:00Z"
```
Get average RPO for all VPGs in a single account for June 6th, 2019
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -zOrgIdentifier
The ZORG identifier by which to filter the user's average RPO for a single account.
If the ZORG identifier is omitted, statistics related to all sites, for a single account, is retrieved.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Account RPO Average](https://docs.api.zerto.com/#/RPO_Reports/get_v2_reports_account_rpo_average)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/Master/docs/Get-ZARPOAccountAverage.md
schema: 2.0.0
---
# Get-ZARPOAccountAverage
## SYNOPSIS
Get average RPO for all VPGs in a single account, filtered by last 30 days.
## SYNTAX
```
Get-ZARPOAccountAverage [[-zOrgIdentifier] <String>] [[-startDate] <String>] [[-endDate] <String>]
[<CommonParameters>]
```
## DESCRIPTION
Get average RPO for all VPGs in a single account, filtered by last 30 days.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZARPOAccountAverage
```
Get average RPO for all VPGs in a single account.
### Example 2
```powershell
PS C:\> Get-ZARPOAccountAverage -zOrgIdentifier "1234-5678-9012"
```
Get average RPO for all VPGs in zOrg with identifier "1234-5678-9012".
### Example 3
```powershell
PS C:\> Get-ZARPOAccountAverage -startDate "2019-06-01T00:00:00Z" -endDate "2019-06-02T00:00:00Z"
```
Get average RPO for all VPGs in a single account for June 6th, 2019
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -zOrgIdentifier
The ZORG identifier by which to filter the user's average RPO for a single account.
If the ZORG identifier is omitted, statistics related to all sites, for a single account, is retrieved.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Account RPO Average](https://docs.api.zerto.com/#/RPO_Reports/get_v2_reports_account_rpo_average)
+118 -118
View File
@@ -1,118 +1,118 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/Master/docs/Get-ZARPOAverage.md
schema: 2.0.0
---
# Get-ZARPOAverage
## SYNOPSIS
Retrieves list of average RPO values for a specific VPG, filtered by start date, end date, and optional interval. The interval defines the RPO samples interval. by default a 1 minutes interval.
## SYNTAX
```
Get-ZARPOAverage [-vpgIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>] [[-interval] <Int32>]
[<CommonParameters>]
```
## DESCRIPTION
Retrieves list of average RPO values for a specific VPG, filtered by start date, end date, and optional interval. The interval defines the RPO samples interval. by default a 1 minutes interval.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZARPOAverage -vpgIdentifier "5678-9012-3456"
```
Returns RPO Average over the past 7 days for VPG with Identifier "5678-9012-3456"
### Example 2
```powershell
PS C:\> Get-ZARPOAverage -vpgIdentifier "5678-9012-3456" -startDate "2019-06-01T12:00:00Z" -endDate "2019-06-01T14:00:00Z" -interval 60
```
Returns RPO Average in one minute intervals for the time period between June 1st, 2019 at Noon to June 1st, 2019 at 14:00 for VPG with Identifier "5678-9012-3456"
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -interval
The interval selected within the duration of the report.
The interval can be 1-minute data granularity for up to 6 hours' time frame, 1-hour data granularity for 6 hours to 15 days' time frame or 1-day data granularity for 15 days up to 30 days' time frame.
Value should be submitted in Seconds
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
The identifier of the VPG.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for RPO Average](https://docs.api.zerto.com/#/RPO_Reports/get_v2_reports_rpo_average)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/Master/docs/Get-ZARPOAverage.md
schema: 2.0.0
---
# Get-ZARPOAverage
## SYNOPSIS
Retrieves list of average RPO values for a specific VPG, filtered by start date, end date, and optional interval. The interval defines the RPO samples interval. by default a 1 minutes interval.
## SYNTAX
```
Get-ZARPOAverage [-vpgIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>] [[-interval] <Int32>]
[<CommonParameters>]
```
## DESCRIPTION
Retrieves list of average RPO values for a specific VPG, filtered by start date, end date, and optional interval. The interval defines the RPO samples interval. by default a 1 minutes interval.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZARPOAverage -vpgIdentifier "5678-9012-3456"
```
Returns RPO Average over the past 7 days for VPG with Identifier "5678-9012-3456"
### Example 2
```powershell
PS C:\> Get-ZARPOAverage -vpgIdentifier "5678-9012-3456" -startDate "2019-06-01T12:00:00Z" -endDate "2019-06-01T14:00:00Z" -interval 60
```
Returns RPO Average in one minute intervals for the time period between June 1st, 2019 at Noon to June 1st, 2019 at 14:00 for VPG with Identifier "5678-9012-3456"
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -interval
The interval selected within the duration of the report.
The interval can be 1-minute data granularity for up to 6 hours' time frame, 1-hour data granularity for 6 hours to 15 days' time frame or 1-day data granularity for 15 days up to 30 days' time frame.
Value should be submitted in Seconds
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
The identifier of the VPG.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for RPO Average](https://docs.api.zerto.com/#/RPO_Reports/get_v2_reports_rpo_average)
+107 -107
View File
@@ -1,107 +1,107 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZARPOBreach.md
schema: 2.0.0
---
# Get-ZARPOBreach
## SYNOPSIS
Retrieves RPO breaches over the selected timeframe.
## SYNTAX
```
Get-ZARPOBreach [-vpgIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>] [<CommonParameters>]
```
## DESCRIPTION
Retrieves RPO breaches over the selected timeframe.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZARPOBreach -vpgIdentifier "3456-7890-1234"
```
Gets the RPO Breaches for the VPG with identifier "3456-7890-1234" for the past 7 days.
### Example 2
```powershell
PS C:\> Get-ZARPOBreach -vpgIdentifier "3456-7890-1234" -startDate "2019-01-01T00:00:00"
```
Gets the RPO Breaches for the VPG with identifier "3456-7890-1234" starting January 1st, 2019 till the date this command is run.
### Example 3
```powershell
PS C:\> Get-ZARPOBreach -vpgIdentifier "3456-7890-1234" -startDate "2019-01-01T00:00:00" -endDate "2019-02-01T00:00:00"
```
Gets the RPO Breaches for the VPG with identifier "3456-7890-1234" for the Month of January.
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
The identifier of the VPG.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for RPO Breach](https://docs.api.zerto.com/#/RPO_Reports/get_v2_reports_rpo_breach)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZARPOBreach.md
schema: 2.0.0
---
# Get-ZARPOBreach
## SYNOPSIS
Retrieves RPO breaches over the selected timeframe.
## SYNTAX
```
Get-ZARPOBreach [-vpgIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>] [<CommonParameters>]
```
## DESCRIPTION
Retrieves RPO breaches over the selected timeframe.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZARPOBreach -vpgIdentifier "3456-7890-1234"
```
Gets the RPO Breaches for the VPG with identifier "3456-7890-1234" for the past 7 days.
### Example 2
```powershell
PS C:\> Get-ZARPOBreach -vpgIdentifier "3456-7890-1234" -startDate "2019-01-01T00:00:00"
```
Gets the RPO Breaches for the VPG with identifier "3456-7890-1234" starting January 1st, 2019 till the date this command is run.
### Example 3
```powershell
PS C:\> Get-ZARPOBreach -vpgIdentifier "3456-7890-1234" -startDate "2019-01-01T00:00:00" -endDate "2019-02-01T00:00:00"
```
Gets the RPO Breaches for the VPG with identifier "3456-7890-1234" for the Month of January.
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
The identifier of the VPG.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for RPO Breach](https://docs.api.zerto.com/#/RPO_Reports/get_v2_reports_rpo_breach)
+107 -107
View File
@@ -1,107 +1,107 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZARPOStat.md
schema: 2.0.0
---
# Get-ZARPOStat
## SYNOPSIS
Retrieves Rpo min, max and avg. Stats.
## SYNTAX
```
Get-ZARPOStat [-vpgIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>] [<CommonParameters>]
```
## DESCRIPTION
Retrieves Rpo min, max and avg. Stats.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZARPOStat -vpgIdentifier "3456-7890-1234"
```
Gets the RPO Stats for the VPG with identifier "3456-7890-1234" for the past 7 days.
### Example 2
```powershell
PS C:\> Get-ZARPOStat -vpgIdentifier "3456-7890-1234" -startDate "2019-01-01T00:00:00"
```
Gets the RPO Stats for the VPG with identifier "3456-7890-1234" starting January 1st, 2019 till the date this command is run.
### Example 3
```powershell
PS C:\> Get-ZARPOStat -vpgIdentifier "3456-7890-1234" -startDate "2019-01-01T00:00:00" -endDate "2019-02-01T00:00:00"
```
Gets the RPO Stats for the VPG with identifier "3456-7890-1234" for the Month of January.
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
The identifier of the VPG.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for RPO Stats](https://docs.api.zerto.com/#/RPO_Reports/get_v2_reports_stats_rpo)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZARPOStat.md
schema: 2.0.0
---
# Get-ZARPOStat
## SYNOPSIS
Retrieves Rpo min, max and avg. Stats.
## SYNTAX
```
Get-ZARPOStat [-vpgIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>] [<CommonParameters>]
```
## DESCRIPTION
Retrieves Rpo min, max and avg. Stats.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZARPOStat -vpgIdentifier "3456-7890-1234"
```
Gets the RPO Stats for the VPG with identifier "3456-7890-1234" for the past 7 days.
### Example 2
```powershell
PS C:\> Get-ZARPOStat -vpgIdentifier "3456-7890-1234" -startDate "2019-01-01T00:00:00"
```
Gets the RPO Stats for the VPG with identifier "3456-7890-1234" starting January 1st, 2019 till the date this command is run.
### Example 3
```powershell
PS C:\> Get-ZARPOStat -vpgIdentifier "3456-7890-1234" -startDate "2019-01-01T00:00:00" -endDate "2019-02-01T00:00:00"
```
Gets the RPO Stats for the VPG with identifier "3456-7890-1234" for the Month of January.
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
The identifier of the VPG.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for RPO Stats](https://docs.api.zerto.com/#/RPO_Reports/get_v2_reports_stats_rpo)
+108 -108
View File
@@ -1,108 +1,108 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZARPOStatusProportion.md
schema: 2.0.0
---
# Get-ZARPOStatusProportion
## SYNOPSIS
Retrieves RPO SLA status distribution over the selected timeframe.
## SYNTAX
```
Get-ZARPOStatusProportion [-vpgIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>]
[<CommonParameters>]
```
## DESCRIPTION
Retrieves RPO SLA status distribution over the selected timeframe.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZARPOStatusProportion -vpgIdentifier "3456-7890-1234"
```
Gets the RPO Breaches for the VPG with identifier "3456-7890-1234" for the past 7 days.
### Example 2
```powershell
PS C:\> Get-ZARPOStatusProportion -vpgIdentifier "3456-7890-1234" -startDate "2019-01-01T00:00:00"
```
Gets the RPO Breaches for the VPG with identifier "3456-7890-1234" starting January 1st, 2019 till the date this command is run.
### Example 3
```powershell
PS C:\> Get-ZARPOStatusProportion -vpgIdentifier "3456-7890-1234" -startDate "2019-01-01T00:00:00" -endDate "2019-02-01T00:00:00"
```
Gets the RPO Breaches for the VPG with identifier "3456-7890-1234" for the Month of January.
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
The identifier of the VPG.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for RPO Statuses Proportions](https://docs.api.zerto.com/#/RPO_Reports/get_v2_reports_rpo_statuses_proportions)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZARPOStatusProportion.md
schema: 2.0.0
---
# Get-ZARPOStatusProportion
## SYNOPSIS
Retrieves RPO SLA status distribution over the selected timeframe.
## SYNTAX
```
Get-ZARPOStatusProportion [-vpgIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>]
[<CommonParameters>]
```
## DESCRIPTION
Retrieves RPO SLA status distribution over the selected timeframe.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZARPOStatusProportion -vpgIdentifier "3456-7890-1234"
```
Gets the RPO Breaches for the VPG with identifier "3456-7890-1234" for the past 7 days.
### Example 2
```powershell
PS C:\> Get-ZARPOStatusProportion -vpgIdentifier "3456-7890-1234" -startDate "2019-01-01T00:00:00"
```
Gets the RPO Breaches for the VPG with identifier "3456-7890-1234" starting January 1st, 2019 till the date this command is run.
### Example 3
```powershell
PS C:\> Get-ZARPOStatusProportion -vpgIdentifier "3456-7890-1234" -startDate "2019-01-01T00:00:00" -endDate "2019-02-01T00:00:00"
```
Gets the RPO Breaches for the VPG with identifier "3456-7890-1234" for the Month of January.
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
The identifier of the VPG.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for RPO Statuses Proportions](https://docs.api.zerto.com/#/RPO_Reports/get_v2_reports_rpo_statuses_proportions)
+107 -107
View File
@@ -1,107 +1,107 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAMonitoring.md
schema: 2.0.0
---
# Get-ZARPOSummary
## SYNOPSIS
Retrieves RPO historical statistics for a given VPG.
## SYNTAX
```
Get-ZARPOSummary [-vpgIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>] [<CommonParameters>]
```
## DESCRIPTION
Retrieves RPO historical statistics for a given VPG.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZARPOSummary -vpgIdentifier "3456-7890-1234"
```
Gets the RPO Summary for the VPG with identifier "3456-7890-1234" for the past 7 days.
### Example 2
```powershell
PS C:\> Get-ZARPOSummary -vpgIdentifier "3456-7890-1234" -startDate "2019-01-01T00:00:00"
```
Gets the RPO Summary for the VPG with identifier "3456-7890-1234" starting January 1st, 2019 till the date this command is run.
### Example 3
```powershell
PS C:\> Get-ZARPOSummary -vpgIdentifier "3456-7890-1234" -startDate "2019-01-01T00:00:00" -endDate "2019-02-01T00:00:00"
```
Gets the RPO Summary for the VPG with identifier "3456-7890-1234" for the Month of January.
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
The identifier of the VPG.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for RPO Summary](https://docs.api.zerto.com/#/RPO_Reports/get_v2_reports_rpo_summary)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAMonitoring.md
schema: 2.0.0
---
# Get-ZARPOSummary
## SYNOPSIS
Retrieves RPO historical statistics for a given VPG.
## SYNTAX
```
Get-ZARPOSummary [-vpgIdentifier] <String> [[-startDate] <String>] [[-endDate] <String>] [<CommonParameters>]
```
## DESCRIPTION
Retrieves RPO historical statistics for a given VPG.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZARPOSummary -vpgIdentifier "3456-7890-1234"
```
Gets the RPO Summary for the VPG with identifier "3456-7890-1234" for the past 7 days.
### Example 2
```powershell
PS C:\> Get-ZARPOSummary -vpgIdentifier "3456-7890-1234" -startDate "2019-01-01T00:00:00"
```
Gets the RPO Summary for the VPG with identifier "3456-7890-1234" starting January 1st, 2019 till the date this command is run.
### Example 3
```powershell
PS C:\> Get-ZARPOSummary -vpgIdentifier "3456-7890-1234" -startDate "2019-01-01T00:00:00" -endDate "2019-02-01T00:00:00"
```
Gets the RPO Summary for the VPG with identifier "3456-7890-1234" for the Month of January.
## PARAMETERS
### -endDate
The end date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
The default is the current time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
The starting date of the report, in RFC 3339 standard ('1970-01-01T00:00:00Z').
If only the end date is added, the start date by default will be the end date minus 7 days.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
The identifier of the VPG.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for RPO Summary](https://docs.api.zerto.com/#/RPO_Reports/get_v2_reports_rpo_summary)
+69 -69
View File
@@ -1,69 +1,69 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZASite.md
schema: 2.0.0
---
# Get-ZASite
## SYNOPSIS
Retrieve a list of all sites.
## SYNTAX
```
Get-ZASite [[-zOrgIdentifier] <String>] [<CommonParameters>]
```
## DESCRIPTION
Retrieve a list of all sites.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZASite
```
Retrieve a list of all sites.
### Example 2
```powershell
PS C:\> Get-ZASite -zOrgIdentifier "1234-5678-9012"
```
Retrieve a list of all sites managed under zOrgIdentifier "1234-5678-9012".
## PARAMETERS
### -zOrgIdentifier
The ZORG identifier by which to filter site list.
If the ZORG identifier is omitted, a list of all sites is retrieved.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Sites](https://docs.api.zerto.com/#/Monitoring/get_v2_monitoring_sites)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZASite.md
schema: 2.0.0
---
# Get-ZASite
## SYNOPSIS
Retrieve a list of all sites.
## SYNTAX
```
Get-ZASite [[-zOrgIdentifier] <String>] [<CommonParameters>]
```
## DESCRIPTION
Retrieve a list of all sites.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZASite
```
Retrieve a list of all sites.
### Example 2
```powershell
PS C:\> Get-ZASite -zOrgIdentifier "1234-5678-9012"
```
Retrieve a list of all sites managed under zOrgIdentifier "1234-5678-9012".
## PARAMETERS
### -zOrgIdentifier
The ZORG identifier by which to filter site list.
If the ZORG identifier is omitted, a list of all sites is retrieved.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Sites](https://docs.api.zerto.com/#/Monitoring/get_v2_monitoring_sites)
+104 -104
View File
@@ -1,104 +1,104 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZASitePair.md
schema: 2.0.0
---
# Get-ZASitePair
## SYNOPSIS
Get all the sites, protected and recovery, filtered by start date and end date.
## SYNTAX
```
Get-ZASitePair [[-zOrgIdentifier] <String>] [[-startDate] <String>] [[-endDate] <String>] [<CommonParameters>]
```
## DESCRIPTION
Get all the sites, protected and recovery, filtered by start date and end date.
* When startDate is omitted, the default startDate is 7 days before the endDate.
* When endDate is ommited, the default endDate is the current date.
* When both startDate and endDate are omitted, the default date range is the last 7 days.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZASitePair
```
Returns all site pairings.
### Example 1
```powershell
PS C:\> Get-ZASitePair -zOrgIdentifier "9876-5432-1098"
```
Returns all site pairings belonging to zOrg with Identifier "9876-5432-1098".
## PARAMETERS
### -endDate
End date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the end date is omitted, the default endDate is the current date.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
Start date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the start date is omitted, the default start date is 7 days before the end date.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -zOrgIdentifier
The ZORG identifier by which to filter the site list.
If the ZORG identifier is omitted, a list of all sites is retrieved.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Site Pairs](https://docs.api.zerto.com/#/Network_Reports/get_v2_reports_sites_list)
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZASitePair.md
schema: 2.0.0
---
# Get-ZASitePair
## SYNOPSIS
Get all the sites, protected and recovery, filtered by start date and end date.
## SYNTAX
```
Get-ZASitePair [[-zOrgIdentifier] <String>] [[-startDate] <String>] [[-endDate] <String>] [<CommonParameters>]
```
## DESCRIPTION
Get all the sites, protected and recovery, filtered by start date and end date.
* When startDate is omitted, the default startDate is 7 days before the endDate.
* When endDate is ommited, the default endDate is the current date.
* When both startDate and endDate are omitted, the default date range is the last 7 days.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZASitePair
```
Returns all site pairings.
### Example 1
```powershell
PS C:\> Get-ZASitePair -zOrgIdentifier "9876-5432-1098"
```
Returns all site pairings belonging to zOrg with Identifier "9876-5432-1098".
## PARAMETERS
### -endDate
End date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the end date is omitted, the default endDate is the current date.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
Start date in RFC 3339 standard ('1970-01-01T00:00:00Z').
If the start date is omitted, the default start date is 7 days before the end date.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -zOrgIdentifier
The ZORG identifier by which to filter the site list.
If the ZORG identifier is omitted, a list of all sites is retrieved.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Site Pairs](https://docs.api.zerto.com/#/Network_Reports/get_v2_reports_sites_list)

Some files were not shown because too many files have changed in this diff Show More