Compare commits
149 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| fe4d8cf4dd | |||
| e35939e592 | |||
| c422e26903 | |||
| e37444249e | |||
| 616cdcf7a2 | |||
| e7658fcfec | |||
| a306391a14 | |||
| 83e9551692 | |||
| 7fbc550390 | |||
| e3cba682c7 | |||
| 96b3e65be2 | |||
| d15111a883 | |||
| 90434b56a2 | |||
| 85e60adac1 | |||
| 0d6bc39c86 | |||
| ad2073f404 | |||
| e12bf9d85e | |||
| a5f3ad4de0 | |||
| 77fb3c8f67 | |||
| b2e5fe7b5c | |||
| f34f21bb85 | |||
| 536a62f792 | |||
| df83277c06 | |||
| d55bc3e4b3 | |||
| 7488e7999f | |||
| dcba2b04a9 | |||
| bd94bfe5db | |||
| fb722661a7 | |||
| 6121940563 | |||
| 64fa03e4ea | |||
| 86854442ef | |||
| bc46a512cd | |||
| 0a84246d8e | |||
| f299aecb9b | |||
| 646476e74e | |||
| 285a82f280 | |||
| fbe9fb2af8 | |||
| 1af70b8c80 | |||
| 0ef71c25bb | |||
| 78e1cdb981 | |||
| 1a66d4e64b | |||
| 2fef1dbc42 | |||
| b00ededc7f | |||
| 8e5ced9b87 | |||
| 69fb384c89 | |||
| a8b9ec3a00 | |||
| 355be7c1e5 | |||
| c94f04de77 | |||
| f4807f94fb | |||
| d39777cbb0 | |||
| 8b43856558 | |||
| 83879a51e7 | |||
| 2d1fb8e4db | |||
| e774cd861d | |||
| a660aa29b3 | |||
| 82458712f0 | |||
| bae9eb9b99 | |||
| 2ea7092b91 | |||
| de08f0eece | |||
| 3e980dc195 | |||
| eccc5f27f3 | |||
| e516a24e38 | |||
| 07f92583f8 | |||
| c2f554dca1 | |||
| 8bd865d83d | |||
| 02e50d9cd6 | |||
| 7fc0a5f579 | |||
| ce5a64c683 | |||
| 1317a6c039 | |||
| 169e628c7b | |||
| d35d9d7cf4 | |||
| a891a4914d | |||
| 71352cae7b | |||
| b0edd9026f | |||
| 7cde687d70 | |||
| 569d9e264c | |||
| 40331c26f9 | |||
| 526093afc6 | |||
| dc4dd1ad05 | |||
| 779ee1415e | |||
| 13592df6aa | |||
| fad3ca0e27 | |||
| 52782aa1e5 | |||
| bc02e796d6 | |||
| 4c32bbe057 | |||
| cc9e53ac44 | |||
| 37165e18a7 | |||
| 772848beef | |||
| 18185612bb | |||
| ecab2500c7 | |||
| fde7f67e45 | |||
| e19f9b34f5 | |||
| a36a7cb37a | |||
| 1e80bb06fb | |||
| 4c98b75134 | |||
| a7efc7c717 | |||
| 02f1c89d86 | |||
| 5b9243a02f | |||
| 1962dda15c | |||
| 801553178e | |||
| 6c92dff447 | |||
| 003396998c | |||
| 05783a1f37 | |||
| 270470f858 | |||
| 579ba7a063 | |||
| 2cb35165a9 | |||
| 82cf4cb732 | |||
| 9d21eb6409 | |||
| abadc86ae8 | |||
| f094263882 | |||
| c47614727a | |||
| 7cad7eaf75 | |||
| d6862f75d1 | |||
| 5b8a89e1a3 | |||
| d6562de9bf | |||
| cdae203993 | |||
| 213b6029e4 | |||
| 11ab03be0a | |||
| 5f978d7b1a | |||
| 5c76c4c58c | |||
| 8b3a3b3b0b | |||
| 63d56cf862 | |||
| 10785df8a9 | |||
| 8a1593ceba | |||
| 1ca3d6704b | |||
| b4a7df970c | |||
| 3d8acf03f6 | |||
| 07de073bf1 | |||
| 7641d28307 | |||
| 30422d0421 | |||
| 4a0885f731 | |||
| 28d66806a5 | |||
| 42b923cef5 | |||
| 5984bc93c9 | |||
| 528bc66bcd | |||
| e706470395 | |||
| 29a79bbb92 | |||
| f907acd14a | |||
| 90a17045af | |||
| e1ba8412ff | |||
| 0a90d51735 | |||
| 9d34086e40 | |||
| 842c7ceeec | |||
| d78fc28b1c | |||
| 28fb42d56a | |||
| 0657607f3a | |||
| 32f6a6eebc | |||
| 6cc2e8d61d | |||
| b9598e7e0b |
Vendored
+1
-1
@@ -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"
|
||||
}
|
||||
|
||||
@@ -4,8 +4,8 @@ PowerShell wrapper for Zerto Virtual Manager API
|
||||
|
||||
## Current Build Status
|
||||
|
||||
[](https://app.codacy.com/app/wcarroll/ZertoApiWrapper?utm_source=github.com&utm_medium=referral&utm_content=wcarroll/ZertoApiWrapper&utm_campaign=Badge_Grade_Settings)
|
||||
[](https://dev.azure.com/ZertoPublic/ZertoApiWrapper/_build/latest?definitionId=1&branchName=master)
|
||||

|
||||
|
||||
## Legal Disclaimer
|
||||
|
||||
@@ -32,6 +32,9 @@ 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.
|
||||
* May 31st, 2019: Implement logic to allow use of this module in both Windows PowerShell 5.1 and PowerShell Core.
|
||||
* March 15th, 2019: Implement Export and Import Functionality. Please See [Export-ZertoVpg Help](https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Export-ZertoVpg.md) and [Import-ZertoVpg Help](https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Import-ZertoVpg.md) for assistance. No current pre-seed support.
|
||||
@@ -39,7 +42,6 @@ PS> Install-Module -name ZertoApiWrapper
|
||||
|
||||
## TODO
|
||||
|
||||
* Complete Help Markdown Files
|
||||
* JFLR Functionality
|
||||
* Create VPG (Per-VM modification and Backup Settings)
|
||||
* Edit VPG
|
||||
|
||||
+23
-12
@@ -2,17 +2,28 @@
|
||||
|
||||
### Zerto Virtual Manager
|
||||
|
||||
* Added two functions to aid in bulk updating of NIC information for protected VMs. ([Issue 38](https://github.com/ZertoPublic/ZertoApiWrapper/issues/38))
|
||||
* [Export-ZertoVmNicSetting](https://github.com/ZertoPublic/ZertoApiWrapper/blob/Master/docs/Export-ZertoVmNicSettings.md)
|
||||
* [Import-ZertoVmNicSetting](https://github.com/ZertoPublic/ZertoApiWrapper/blob/Master/docs/Import-ZertoVmNicSettings.md)
|
||||
* Fixed an [issue](https://github.com/ZertoPublic/ZertoApiWrapper/issues/43) where a VPG being created with a single VM member would not be parsed by the API correctly using PowerShell 5.1
|
||||
* 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
|
||||
### Zerto Analytics
|
||||
|
||||
* Fixed an [issue](https://github.com/ZertoPublic/ZertoApiWrapper/issues/36) where the Zerto Analytics Rest Request function was not checking for the token before attempting a connection.
|
||||
* Fixed an [issue](https://github.com/ZertoPublic/ZertoApiWrapper/issues/40) where the `Get-ZAVpg` method would return a 404 error when a `-vpgIdentifier` parameter was specified.
|
||||
|
||||
### General Updates
|
||||
|
||||
* Updated the way that tests are invoked and parsed to ensure that both source and built module files are tested. This will ensure that what is being shipped passes all tests along with testing of the source files.
|
||||
* Added additional parameter validation tests to several of the functions. On-going effort to complete stand alone unit testing of each function.
|
||||
* 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)
|
||||
|
||||
@@ -9,34 +9,55 @@ Describe $global:function -Tag 'Unit', 'Source', 'Built' {
|
||||
|
||||
Context "$global:function::Parameter Unit Tests" {
|
||||
|
||||
It "Has a mandatory string parameter for the target host" {
|
||||
Get-Command $global:function | Should -HaveParameter TargetHost -Mandatory -Type String
|
||||
It "$global:function should have exactly 16 parameters defined" {
|
||||
(Get-Command $global:function).Parameters.Count | Should -Be 16
|
||||
}
|
||||
|
||||
It "Will not take a non-ip address as a 'TargetHost'" {
|
||||
{ Add-ZertoPeerSite -targetHost 'MyZVMHost' -targetPort '9081' } | Should -Throw
|
||||
{ Add-ZertoPeerSite -targetHost '192.168.1.266' -targetPort '9081' } | Should -Throw
|
||||
{ Add-ZertoPeerSite -targetHost '192.168.1' -targetPort '9081' } | Should -Throw
|
||||
{ Add-ZertoPeerSite -targetHost $null -targetPort '9081' } | Should -Throw
|
||||
$ParameterTestCases = @(
|
||||
@{ParameterName = 'targetHost'; Type = 'String'; Mandatory = $true; Validation = 'Script' }
|
||||
@{ParameterName = 'targetPort'; Type = 'Int32'; Mandatory = $false; Validation = 'Range' }
|
||||
@{ParameterName = 'token'; 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 "Has a non-mandatory string parameter for the target port with default value of 9081" {
|
||||
Get-Command Add-ZertoPeerSite | Should -HaveParameter TargetPort -Not -Mandatory
|
||||
Get-Command Add-ZertoPeerSite | Should -HaveParameter TargetPort -Type Int32
|
||||
Get-Command Add-ZertoPeerSite | Should -HaveParameter TargetPort -DefaultValue 9081
|
||||
It "<ParameterName> parameter has correct validation setting" -TestCases $ParameterTestCases {
|
||||
param($ParameterName, $Validation)
|
||||
Switch ($Validation) {
|
||||
'Script' {
|
||||
$attrs = (Get-Command $global:function).Parameters[$ParameterName].Attributes
|
||||
$attrs.Where{ $_ -is [ValidateScript] }.Count | Should -Be 1
|
||||
}
|
||||
|
||||
'Range' {
|
||||
$attrs = (Get-Command $global:function).Parameters[$ParameterName].Attributes
|
||||
$attrs.Where{ $_ -is [ValidateRange] }.Count | Should -Be 1
|
||||
}
|
||||
|
||||
'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"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
It "Will not take a non-int as a port" {
|
||||
{ Add-ZertoPeerSite -targetHost '192.168.1.100' -targetPort 'string' } | Should -Throw
|
||||
{ Add-ZertoPeerSite -targetHost '192.168.1.100' -targetPort $true } | Should -Throw
|
||||
{ Add-ZertoPeerSite -targetHost '192.168.1.100' -targetPort $null } | Should -Throw
|
||||
It "targetPort Parameter should have a default value of 9081" {
|
||||
Get-Command $global:function | Should -HaveParameter targetPort -DefaultValue 9081
|
||||
}
|
||||
|
||||
It "Will fail if the specified port is outside of the range 1024 - 65535" {
|
||||
{ Add-ZertoPeerSite -targetHost '192.168.1.100' -targetPort 1023 } | Should -Throw
|
||||
{ Add-ZertoPeerSite -targetHost '192.168.1.100' -targetPort 65536 } | Should -Throw
|
||||
{ Add-ZertoPeerSite -targetHost '192.168.1.100' -targetPort 0 } | Should -Throw
|
||||
{ Add-ZertoPeerSite -targetHost '192.168.1.100' -targetPort -1 } | Should -Throw
|
||||
It "targetPort Parameter should have a Min value of 1024" {
|
||||
(Get-Command $global:function).Parameters['targetPort'].Attributes.Where{ $_ -is [ValidateRange] }.MinRange | Should Be 1024
|
||||
}
|
||||
|
||||
It "targetPort Parameter should have a Max value of 65535" {
|
||||
(Get-Command $global:function).Parameters['targetPort'].Attributes.Where{ $_ -is [ValidateRange] }.MaxRange | Should Be 65535
|
||||
}
|
||||
|
||||
It "Supports 'SupportsShouldProcess'" {
|
||||
@@ -52,19 +73,26 @@ Describe $global:function -Tag 'Unit', 'Source', 'Built' {
|
||||
return (Get-Content "$global:here\Mocks\TaskId.txt")
|
||||
}
|
||||
|
||||
It "Returns a string value" {
|
||||
It "Returns a string value when no Token Passed" {
|
||||
$results = Add-ZertoPeerSite -targetHost '192.168.1.100' -targetPort '9081'
|
||||
$results | Should -Not -BeNullOrEmpty
|
||||
$results | Should -BeOfType "String"
|
||||
$results | Should -BeExactly "7e79035e-fb8c-47fe-815c-12ddd41708e6.3e4cdd0d-1064-4022-921f-6265ad6d335a"
|
||||
}
|
||||
|
||||
It "Returns a string value when a Token is passed" {
|
||||
$results = Add-ZertoPeerSite -targetHost '192.168.1.100' -targetPort '9081' -token "NotARealTokenString"
|
||||
$results | Should -Not -BeNullOrEmpty
|
||||
$results | Should -BeOfType "String"
|
||||
$results | Should -BeExactly "7e79035e-fb8c-47fe-815c-12ddd41708e6.3e4cdd0d-1064-4022-921f-6265ad6d335a"
|
||||
}
|
||||
|
||||
It "Does not return a taskId if '-whatif' is used" {
|
||||
$results = Add-ZertoPeerSite -targetHost '192.168.1.100' -targetPort '9081' -WhatIf
|
||||
$results | Should -BeNullOrEmpty
|
||||
}
|
||||
|
||||
Assert-MockCalled -ModuleName ZertoApiWrapper -CommandName Invoke-ZertoRestRequest -Exactly 1
|
||||
Assert-MockCalled -ModuleName ZertoApiWrapper -CommandName Invoke-ZertoRestRequest -Exactly 2
|
||||
}
|
||||
}
|
||||
Remove-Variable -Name here -Scope Global
|
||||
|
||||
@@ -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" {
|
||||
|
||||
@@ -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' {
|
||||
BeforeAll {
|
||||
$script:ScriptBlock = (Get-Command $global:function).ScriptBlock
|
||||
}
|
||||
|
||||
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 = 'SourceVpgName'; Type = 'String'; Mandatory = $true; Validation = 'NotNullOrEmpty' }
|
||||
@{ParameterName = 'NewVpgName'; Type = 'String'; Mandatory = $true; Validation = 'NotNullOrEmpty' }
|
||||
@{ParameterName = 'VMs'; Type = 'String[]'; Mandatory = $true; Validation = 'NotNullOrEmpty' }
|
||||
)
|
||||
|
||||
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" -TestCases $ParameterTestCases {
|
||||
param($ParameterName, $Validation)
|
||||
Switch ($Validation) {
|
||||
'NotNullOrEmpty' {
|
||||
$attrs = (Get-Command $global:function).Parameters[$ParameterName].Attributes
|
||||
$attrs.Where{ $_ -is [ValidateNotNullOrEmpty] }.Count | Should -Be 1
|
||||
}
|
||||
|
||||
$null {
|
||||
$attrs = (Get-Command $global:function).Parameters[$ParameterName].Attributes
|
||||
$attrs.TypeId.Count | Should -Be 2
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
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)::Function Unit Tests" {
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
Remove-Variable -Name function -Scope Global
|
||||
Remove-Variable -Name here -Scope Global
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -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
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -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
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
-6
@@ -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 {
|
||||
@@ -0,0 +1,54 @@
|
||||
#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 = 'hostName'; Type = 'String'; Mandatory = $true; Validation = 'NotNullOrEmpty'; ParameterSet = @('hostName') }
|
||||
@{ParameterName = 'vraName'; Type = 'String'; Mandatory = $true; Validation = 'NotNullOrEmpty' ; ParameterSet = @('vraName') }
|
||||
@{ParameterName = 'vraIdentifier'; Type = 'String'; Mandatory = $true; Validation = 'NotNullOrEmpty' ; ParameterSet = @('vraIdentifier') }
|
||||
)
|
||||
|
||||
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
|
||||
}
|
||||
|
||||
$null {
|
||||
$attrs = (Get-Command $global:function).Parameters[$ParameterName].Attributes
|
||||
$attrs.TypeId.Count | Should -Be 2
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
It "<ParameterName> parameter is part of the correct ParameterSet(s)" -TestCases $ParameterTestCases {
|
||||
param($ParameterName, $ParameterSet)
|
||||
$commandParameterSets = (Get-Command $global:function).Parameters[$ParameterName].ParameterSets
|
||||
foreach ($Set in $ParameterSet) {
|
||||
$commandParameterSets.ContainsKey($Set) | Should -BeTrue
|
||||
}
|
||||
$commandParameterSets.Count | Should -Be $ParameterSet.Count
|
||||
}
|
||||
}
|
||||
|
||||
Context "$global:function::Parameter Functional Tests" {
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
Remove-Variable -Name here -Scope Global
|
||||
Remove-Variable -Name function -Scope Global
|
||||
-4
@@ -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,4 @@
|
||||
{
|
||||
"Token": "TH15ISN0T4R3AL70KEN",
|
||||
"UtcExpirationDate": "10/09/2019 12:55 PM"
|
||||
}
|
||||
@@ -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"
|
||||
}
|
||||
@@ -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"
|
||||
}
|
||||
@@ -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,51 @@
|
||||
#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' {
|
||||
BeforeAll {
|
||||
$script:ScriptBlock = (Get-Command $global:function).ScriptBlock
|
||||
}
|
||||
|
||||
Context "$global:function::Parameter Unit Tests" {
|
||||
It "$global:function should have exactly 13 parameters defined" {
|
||||
(Get-Command $global:function).Parameters.Count | Should -Be 13
|
||||
}
|
||||
|
||||
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" {
|
||||
Mock -ModuleName ZertoApiWrapper -CommandName Invoke-ZertoRestRequest {
|
||||
return (Get-Content -Raw "$global:here\Mocks\PairingToken.json" | ConvertFrom-Json)
|
||||
}
|
||||
|
||||
It "Returns a Token" {
|
||||
$Token = New-ZertoPairingToken
|
||||
$Token | Should -Not -Be $Null
|
||||
$Token.Token | Should -Be "TH15ISN0T4R3AL70KEN"
|
||||
}
|
||||
|
||||
It "Returns a ExpirationDate" {
|
||||
$Token = New-ZertoPairingToken
|
||||
$Token | Should -Not -Be $Null
|
||||
$Token.UtcExpirationDate | Should -Be "10/09/2019 12:55 PM"
|
||||
}
|
||||
|
||||
It "Does not return a taskId if '-whatif' is used" {
|
||||
$results = New-ZertoPairingToken -WhatIf
|
||||
$results | Should -BeNullOrEmpty
|
||||
}
|
||||
|
||||
Assert-MockCalled -ModuleName ZertoApiWrapper -CommandName Invoke-ZertoRestRequest -Exactly 2
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
Remove-Variable -Name here -Scope Global
|
||||
Remove-Variable -Name function -Scope Global
|
||||
@@ -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
|
||||
@@ -19,7 +19,7 @@
|
||||
SkipPublisherCheck = $true
|
||||
}
|
||||
Target = 'CurrentUser'
|
||||
Version = '4.8.1'
|
||||
Version = '4.10.1'
|
||||
Tags = 'Bootstrap'
|
||||
}
|
||||
|
||||
|
||||
@@ -6,21 +6,30 @@ function Add-ZertoPeerSite {
|
||||
Mandatory = $true,
|
||||
HelpMessage = "Target Hostname or IP address to pair the localsite to."
|
||||
)]
|
||||
[ValidateScript( {$_ -match [IPAddress]$_ } )]
|
||||
[ValidateScript( { $_ -match [IPAddress]$_ } )]
|
||||
[string]$targetHost,
|
||||
[Parameter(
|
||||
HelpMessage = "Target communication port. Default is 9081"
|
||||
)]
|
||||
[ValidateRange(1024, 65535)]
|
||||
[int]$targetPort = 9081
|
||||
[int]$targetPort = 9081,
|
||||
[Parameter(
|
||||
HelpMessage = "The generated token from the destination site. Note: This is only supported when both sites support pairing authentication. This was implemented to support ZVR 7.5 and later."
|
||||
)]
|
||||
[ValidateNotNullOrEmpty()]
|
||||
[string]$token
|
||||
)
|
||||
|
||||
begin {
|
||||
$baseUri = "peersites"
|
||||
$body = @{"HostName" = $targetHost; "Port" = $targetPort}
|
||||
}
|
||||
|
||||
process {
|
||||
$baseUri = "peersites"
|
||||
if ($PSBoundParameters.Keys.Contains("token")) {
|
||||
$body = @{ "HostName" = $targetHost; "Port" = $targetPort; "Token" = $token }
|
||||
} else {
|
||||
$body = @{ "HostName" = $targetHost; "Port" = $targetPort }
|
||||
}
|
||||
if ($PSCmdlet.ShouldProcess("Pairing with Site $targetHost")) {
|
||||
Invoke-ZertoRestRequest -uri $baseUri -body $($body | ConvertTo-Json) -method "POST"
|
||||
}
|
||||
|
||||
@@ -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."
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -0,0 +1,67 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Copy-ZertoVpg {
|
||||
[CmdletBinding(SupportsShouldProcess)]
|
||||
param (
|
||||
# VPG Name to Clone
|
||||
[Parameter(Mandatory,
|
||||
HelpMessage = "Name of the VPG to clone")]
|
||||
[ValidateNotNullOrEmpty()]
|
||||
[String]$SourceVpgName,
|
||||
# New VPG Name
|
||||
[Parameter(Mandatory,
|
||||
HelpMessage = "Name to assign the newly created VPG")]
|
||||
[ValidateNotNullOrEmpty()]
|
||||
[String]$NewVpgName, # Name of VMs to add to the VPG
|
||||
[Parameter(Mandatory,
|
||||
HelpMessage = "Name(s) of the Virtual Machine(s) to add to the VPG")]
|
||||
[ValidateNotNullOrEmpty()]
|
||||
[String[]]$VMs
|
||||
)
|
||||
|
||||
begin {
|
||||
|
||||
}
|
||||
|
||||
process {
|
||||
$VpgIdToCopy = @{ VpgIdentifier = (Get-ZertoVpg -vpgName $SourceVpgName).vpgIdentifier }
|
||||
if ( $null -eq $VpgIdToCopy.VpgIdentifier ) {
|
||||
Write-Error -Message "Unable to find a VPG with the name: $SourceVpgName. Please check the name and try again."
|
||||
Break
|
||||
} elseif ($VpgIdToCopy.VpgIdentifier.Count -gt 1) {
|
||||
Write-Error -Message "More than one VPG was returned when searching for the VPG name: $SourceVpgName. Please try again."
|
||||
Break
|
||||
}
|
||||
$BaseUri = "vpgSettings/copyVpgSettings"
|
||||
$UnprotectedVms = Get-ZertoUnprotectedVm
|
||||
$ProtectedVms = Get-ZertoProtectedVm
|
||||
$VMsToAdd = foreach ($VM in $VMs) {
|
||||
if ($UnprotectedVms.VmName -contains $VM) {
|
||||
$VmId = $UnprotectedVms | Where-Object { $_.VmName -like $VM } | Select-Object -ExpandProperty VmIdentifier
|
||||
} elseif ($ProtectedVms.VmName -contains $VM) {
|
||||
$VmId = $ProtectedVms | Where-Object { $_.VmName -like $VM } | Select-Object -ExpandProperty VmIdentifier
|
||||
} else {
|
||||
Write-Warning -Message "Unable to find VM with Name $VM. Skipping."
|
||||
}
|
||||
$returnObject = New-Object PSObject
|
||||
$returnObject | Add-Member -MemberType NoteProperty -Name "VmIdentifier" -Value $VmId
|
||||
$returnObject
|
||||
}
|
||||
if ($PSCmdlet.ShouldProcess("$VMsToAdd", "Copying $SourceVpgName to $NewVpgName with Settings")) {
|
||||
$NewVpgId = Invoke-ZertoRestRequest -Uri $BaseUri -Body ($VpgIdToCopy | ConvertTo-Json) -Method "POST"
|
||||
$Uri = "{0}/{1}/vms" -f "vpgSettings", $NewVpgId
|
||||
foreach ($VM in $VMsToAdd) {
|
||||
$null = Invoke-ZertoRestRequest -Uri $Uri -Body ($VM | ConvertTo-Json) -Method "POST"
|
||||
}
|
||||
$Uri = "vpgSettings/{0}" -f $NewVpgId
|
||||
$CurrentSettings = Invoke-ZertoRestRequest -Uri $Uri
|
||||
$CurrentSettings.Basic.Name = $NewVpgName
|
||||
$Null = Invoke-ZertoRestRequest -Uri $Uri -Method "Put" -Body $($CurrentSettings | ConvertTo-Json -Depth 20)
|
||||
Save-ZertoVpgSetting -vpgSettingsIdentifier $NewVpgId
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
end {
|
||||
|
||||
}
|
||||
}
|
||||
@@ -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
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
@@ -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
|
||||
}
|
||||
}
|
||||
|
||||
@@ -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"
|
||||
|
||||
@@ -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"
|
||||
}
|
||||
}
|
||||
|
||||
+18
-6
@@ -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
|
||||
@@ -0,0 +1,62 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Invoke-ZertoEvacuateVra {
|
||||
[CmdletBinding(SupportsShouldProcess, DefaultParameterSetName = "VraIdentifier")]
|
||||
param (
|
||||
# HostName Option
|
||||
[Parameter(
|
||||
Mandatory,
|
||||
HelpMessage = "Name of the Host to Evacuate",
|
||||
ParameterSetName = "HostName"
|
||||
)]
|
||||
[ValidateNotNullOrEmpty()]
|
||||
[String]$HostName,
|
||||
# VRA Option
|
||||
[Parameter(
|
||||
Mandatory,
|
||||
HelpMessage = "Name of the VRA to Evacuate",
|
||||
ParameterSetName = "VraName"
|
||||
)]
|
||||
[ValidateNotNullOrEmpty()]
|
||||
[String]$VraName,
|
||||
# VRAIdentifier Option
|
||||
[Parameter(
|
||||
Mandatory,
|
||||
HelpMessage = "Identifier of the VRA to be evacuated",
|
||||
ParameterSetName = "VraIdentifier",
|
||||
ValueFromPipelineByPropertyName,
|
||||
ValueFromPipeline
|
||||
)]
|
||||
[Alias("VraId", "Identifier")]
|
||||
[ValidateNotNullOrEmpty()]
|
||||
[String]$VraIdentifier
|
||||
)
|
||||
|
||||
begin {
|
||||
|
||||
}
|
||||
|
||||
process {
|
||||
switch ($PSCmdlet.ParameterSetName) {
|
||||
"HostName" {
|
||||
$VraName = "Z-VRA-" + $HostName
|
||||
Invoke-ZertoEvacuateVra -VraName $VraName
|
||||
}
|
||||
|
||||
"VraName" {
|
||||
$VraIdentifier = (Get-ZertoVra -vraName $VraName).VraIdentifier
|
||||
Invoke-ZertoEvacuateVra -VraIdentifier $VraIdentifier
|
||||
}
|
||||
|
||||
"VraIdentifier" {
|
||||
$Uri = "vras/{0}/changerecoveryvra/execute" -f $VraIdentifier
|
||||
if ($PSCmdlet.ShouldProcess($VraIdentifier, "Evacuating VRA with Identifier:")) {
|
||||
Invoke-ZertoRestRequest -Uri $Uri -Method "POST"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
end {
|
||||
|
||||
}
|
||||
}
|
||||
@@ -89,7 +89,7 @@ function Invoke-ZertoMove {
|
||||
Write-Error "VPG: $name not found. Please check the name and try again. Skipping"
|
||||
} else {
|
||||
$uri = "{0}/{1}/move" -f $baseUri, $vpgId
|
||||
if ($PSCmdlet.ShouldProcess("Moving VPG: $name wiht settings: $($body | convertto-json)")) {
|
||||
if ($PSCmdlet.ShouldProcess("Moving VPG: $name with settings: $($body | convertto-json)")) {
|
||||
Invoke-ZertoRestRequest -uri $uri -method "POST" -body $($body | ConvertTo-Json)
|
||||
}
|
||||
}
|
||||
|
||||
+26
-7
@@ -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,23 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function New-ZertoPairingToken {
|
||||
[CmdletBinding(SupportsShouldProcess = $true)]
|
||||
param (
|
||||
|
||||
)
|
||||
|
||||
begin {
|
||||
|
||||
}
|
||||
|
||||
process {
|
||||
$uri = "peersites/generatetoken"
|
||||
$body = @{ }
|
||||
if ($PSCmdlet.ShouldProcess("Obtaining Pairing token from $script:zvmServer")) {
|
||||
Invoke-ZertoRestRequest -uri $uri -method "POST" -body $($body | ConvertTo-Json)
|
||||
}
|
||||
}
|
||||
|
||||
end {
|
||||
|
||||
}
|
||||
}
|
||||
@@ -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 {
|
||||
|
||||
}
|
||||
}
|
||||
@@ -27,11 +27,12 @@ function Start-ZertoFailoverTest {
|
||||
if ( -not $vpgIdentifier) {
|
||||
Write-Error "VPG: $vpgName Not Found. Please check the name and try again!" -ErrorAction Stop
|
||||
}
|
||||
$body = @{ }
|
||||
if ( $PSBoundParameters.ContainsKey('vmName') ) {
|
||||
$vpgVmInformation = Get-ZertoProtectedVm -vpgName $vpgName
|
||||
[System.Collections.ArrayList]$vmIdentifiers = @()
|
||||
$vmIdentifiers = [System.Collections.Generic.List[string]]::new()
|
||||
foreach ( $name in $vmName ) {
|
||||
$selectedVm = $vpgVmInformation | Where-Object {$_.VmName.toLower() -eq $name.toLower()}
|
||||
$selectedVm = $vpgVmInformation | Where-Object { $_.VmName.toLower() -eq $name.toLower() }
|
||||
if ($null -eq $selectedVm) {
|
||||
Write-Error "VM: $name NOT found in VPG $vpgName. Check the name and try again." -ErrorAction Stop
|
||||
} elseif ($vmIdentifiers.Contains($selectedVm.vmIdentifier.toString())) {
|
||||
|
||||
+8
-8
@@ -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: |
|
||||
|
||||
@@ -13,7 +13,8 @@ Pairs the current Zerto Virtual Manager to the target Zerto Virtual Manager
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Add-ZertoPeerSite [-targetHost] <String> [[-targetPort] <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>]
|
||||
Add-ZertoPeerSite [-targetHost] <String> [[-targetPort] <Int32>] [-token <String>] [-WhatIf] [-Confirm]
|
||||
[<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
@@ -23,10 +24,17 @@ Pairs the current Zerto Virtual Manager to the target Zerto Virtual Manager by l
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Add-ZertoPeerSite -targetHost "192.168.2.100" -targetPort "9081"
|
||||
PS C:\> Add-ZertoPeerSite -targetHost "192.168.2.100"
|
||||
```
|
||||
|
||||
Pairs the current Zerto Virtual Manager to the Zerto Virtual Manager at IP address 192.168.2.100.
|
||||
Pairs the current Zerto Virtual Manager to the Zerto Virtual Manager at IP address 192.168.2.100. Use this method when pairing Zerto Virtual Managers that are prior to version 7.5
|
||||
|
||||
### Example 2
|
||||
```powershell
|
||||
PS C:\> Add-ZertoPeerSite -targetHost "192.168.2.100" -token "GeneratedFromTargetZVM"
|
||||
```
|
||||
|
||||
Pairs the current Zerto Virtual Manager to the Zerto Virtual Manager at IP address 192.168.2.100. Use this method when pairing Zerto Virtual Managers that are version 7.5 or later.
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
@@ -61,6 +69,21 @@ Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -token
|
||||
The generated token from the destination site. Note: This is only supported when both sites support pairing authentication. This was implemented to support ZVR 7.5 and later.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Confirm
|
||||
Prompts you for confirmation before running the cmdlet.
|
||||
|
||||
|
||||
@@ -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
|
||||
```
|
||||
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -106,5 +106,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
|
||||
## RELATED LINKS
|
||||
|
||||
[Zerto REST API Session End Point 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.068.html%23)
|
||||
|
||||
[PSCredential Documentation](https://docs.microsoft.com/en-us/dotnet/api/system.management.automation.pscredential?view=pscore-6.0.0)
|
||||
|
||||
[Get-Credential Documentation](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.security/get-credential?view=powershell-6)
|
||||
|
||||
@@ -0,0 +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: 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)
|
||||
+27
-3
@@ -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
|
||||
@@ -49,13 +51,20 @@ PS C:\>Edit-ZertoVra -vraIdentifier $vraIdentifier -vraIpAddress "192.168.1.101"
|
||||
|
||||
Updates the VRA IP address to 192.168.1.101, subnet mask to 255.255.252.0, and default gateway to 192.168.1.1
|
||||
|
||||
### Example 3
|
||||
### Example 4
|
||||
```powershell
|
||||
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
|
||||
|
||||
|
||||
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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
@@ -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)
|
||||
|
||||
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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_)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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
@@ -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
@@ -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
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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_)
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user