Help system (#4)
* Establish a help system * Continue to update Help System * Update Get-ZertoAlert.md * Update Get-ZertoDatastore.md * Add Link to Zerto API for Datastores * Update Get-ZertoLicense.md * Update Links to Zerto API documentation * Update the Readme Information * Continue to update README * Update README * Update README.md * Update Help Markdown Files * Correct API URL * Update ZertoApiWrapper-help.xml * Update Get-ZertoProtectedVm.md * Update Help Markdown files * Update Get-ZertoVpgSetting.md * Added online url to each help object. * Update Help Markdown Files * Update ZertoApiWrapper-help.xml
This commit is contained in:
Wes Carroll
GitHub
@@ -1,2 +1,46 @@
|
||||
# ZertoApiWrapper
|
||||
pwsh wrapper for Zerto Virtual Manager API
|
||||
PowerShell Core wrapper for Zerto Virtual Manager API
|
||||
|
||||
## Legal Disclaimer
|
||||
This script is an example script and is not supported under any Zerto support program or service. The author and Zerto further disclaim all implied warranties including, without limitation, any implied warranties of merchantability or of fitness for a particular purpose.
|
||||
|
||||
In no event shall Zerto, its authors or anyone else involved in the creation, production or delivery of the scripts be liable for any damages whatsoever (including, without limitation, damages for loss of business profits, business interruption, loss of business information, or other pecuniary loss) arising out of the use of or the inability to use the sample scripts or documentation, even if the author or Zerto has been advised of the possibility of such damages. The entire risk arising out of the use or performance of the sample scripts and documentation remains with you.
|
||||
|
||||
## Getting Started
|
||||
Place the folder and contents on your hard drive in a location known to you. From there run the following command to import the module into your session:
|
||||
```PowerShell
|
||||
PS C:\>Import-Module <path>\ZertoApiWrapper\ZertoApiWrapper\ZertoApiWrapper.psm1 -force
|
||||
```
|
||||
|
||||
This will import the module into your current session and make the function available to you use and test.
|
||||
|
||||
### Connecting to a ZVM
|
||||
Before any of the functions will work, you will need to connect to a Zerto Virtual Manager server. To do this you will use the `Connect-ZertoServer` function passing in a Server Name or IP address of the Zerto Virtual Manager. If you are using a non-standard port, you will need to provide that as well with the `-zertoPort` parameter. You will also need to supply credentials to authenticate against the Zerto Virtual Manager. If credentials are not provided, the user will be prompted for a username and password.
|
||||
|
||||
```PowerShell
|
||||
PS C:\>$credential = Get-Credential
|
||||
PS C:\>Connect-ZertoServer -zertoServer "192.168.222.20" -credential $credential
|
||||
```
|
||||
|
||||
After successful execution, a few Module level variables are set that are not currently exposed. These variables keep track of the Zerto Server connection information such as Server Name and Port information along with the authentication headers. A "Last Action" variable is also set to keep track of when the last call was made to the API to determine if the authentication information has expired or not. Should this command be run again with a different server, the old information will be overwritten and all commands from that point will be executed against the new server information.
|
||||
|
||||
### Using the Module
|
||||
A help system is currently under development. While each command has a help page, it may not be fully fleshed out yet. To see all possible functions you can use the following command after the module has been imported:
|
||||
|
||||
```PowerShell
|
||||
PS C:\>Get-Command -module ZertoApiWrapper
|
||||
```
|
||||
|
||||
Once you have found the command that you want to know about you can call `Get-Help <Command>` to take a look at the help page, or if you want to see syntax, `Get-Command <Command> -syntax`.
|
||||
|
||||
### Ending the Session
|
||||
If you are using this as part of a larger script, I highly suggest explicitly ending your session with the `Disconnect-ZertoSession` command. This will delete the token authorization from the Zerto Virtual Manager as well as clear all Module scoped variables.
|
||||
|
||||
## TODO:
|
||||
- Complete Help Markdown Files
|
||||
- JFLR Functionality
|
||||
- Create VPG
|
||||
- Edit VPG
|
||||
- Delete Zerto License
|
||||
- Flesh out Pester Tests
|
||||
- Complete Automated Build Process
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Add-ZertoPeerSite {
|
||||
[cmdletbinding( SupportsShouldProcess = $true )]
|
||||
param(
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Checkpoint-ZertoVpg {
|
||||
[cmdletbinding()]
|
||||
param(
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Connect-ZertoServer {
|
||||
[cmdletbinding()]
|
||||
param(
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Disconnect-ZertoServer {
|
||||
[cmdletbinding()]
|
||||
$uri = "session"
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Edit-ZertoVra {
|
||||
[cmdletbinding( SupportsShouldProcess = $true )]
|
||||
param(
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Get-ZertoAlert {
|
||||
[cmdletbinding( defaultParameterSetName = "main" )]
|
||||
param(
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Get-ZertoDatastore {
|
||||
[cmdletbinding( DefaultParameterSetName = "main" )]
|
||||
param(
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Get-ZertoEvent {
|
||||
[cmdletbinding( defaultParameterSetName = "main" )]
|
||||
param(
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Get-ZertoLicense {
|
||||
[cmdletbinding()]
|
||||
$uri = "license"
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Get-ZertoLocalSite {
|
||||
[cmdletbinding()]
|
||||
param(
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Get-ZertoPeerSite {
|
||||
[cmdletbinding( defaultParameterSetName = "main" )]
|
||||
param (
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Get-ZertoProtectedVm {
|
||||
[cmdletbinding( DefaultParameterSetName = "main" )]
|
||||
param (
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Get-ZertoRecoveryReport {
|
||||
[cmdletbinding( DefaultParameterSetName = "main" )]
|
||||
param(
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Get-ZertoResourcesReport {
|
||||
[cmdletbinding( DefaultParameterSetName = "main" )]
|
||||
param(
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Get-ZertoServiceProfile {
|
||||
[cmdletbinding( DefaultParameterSetName = "main" )]
|
||||
param (
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Get-ZertoTask {
|
||||
[cmdletbinding( DefaultParameterSetName = "main" )]
|
||||
param (
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Get-ZertoUnprotectedVm {
|
||||
[cmdletbinding()]
|
||||
$uri = "virtualizationsites/{0}/vms" -f $(Get-ZertoLocalSite).siteidentifier
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Get-ZertoVirtualizationSite {
|
||||
[cmdletbinding( DefaultParameterSetName = "main" )]
|
||||
param(
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Get-ZertoVolume {
|
||||
[cmdletbinding( DefaultParameterSetName = "main" )]
|
||||
param(
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Get-ZertoVpg {
|
||||
[cmdletbinding( DefaultParameterSetName = "main" )]
|
||||
param(
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Get-ZertoVpgSetting {
|
||||
[cmdletbinding(
|
||||
DefaultParameterSetName = "main",
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Get-ZertoVra {
|
||||
[cmdletbinding(
|
||||
DefaultParameterSetName = "main"
|
||||
@@ -82,7 +83,7 @@ function Get-ZertoVra {
|
||||
}
|
||||
|
||||
# When vra ids are provided, return for each id provided
|
||||
"vraIdentifier" {
|
||||
"vraIdentifierifierifier" {
|
||||
$returnObject = foreach ( $vraId in $vraIdentifier ) {
|
||||
$uri = "{0}/{1}" -f $baseUri, $vraId
|
||||
Invoke-ZertoRestRequest -uri $uri
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Get-ZertoZorg {
|
||||
[cmdletbinding( DefaultParameterSetName = "default" )]
|
||||
param(
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Get-ZertoZsspSession {
|
||||
[cmdletbinding( DefaultParameterSetName = "default" )]
|
||||
param(
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
#TODO - Add ability to installed with root password.
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Install-ZertoVra {
|
||||
[cmdletbinding( SupportsShouldProcess = $true )]
|
||||
param(
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Invoke-ZertoFailover {
|
||||
[cmdletbinding()]
|
||||
param(
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Invoke-ZertoFailoverCommit {
|
||||
[cmdletbiding()]
|
||||
[cmdletbinding()]
|
||||
param(
|
||||
[Parameter(
|
||||
HelpMessage = "Name(s) of the VPG(s) to commit.",
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Invoke-ZertoFailoverRollback {
|
||||
[cmdletbinding()]
|
||||
param(
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Invoke-ZertoForceSync {
|
||||
[cmdletbinding()]
|
||||
param(
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Invoke-ZertoMove {
|
||||
[CmdletBinding()]
|
||||
param(
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Invoke-ZertoMoveCommit {
|
||||
[cmdletbiding()]
|
||||
[cmdletbinding()]
|
||||
param(
|
||||
[Parameter(
|
||||
HelpMessage = "Name(s) of the VPG(s) to commit.",
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Invoke-ZertoMoveRollback {
|
||||
[cmdletbinding()]
|
||||
param(
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Remove-ZertoVpg {
|
||||
[cmdletbinding( SupportsShouldProcess = $true )]
|
||||
param(
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Resume-ZertoVpg {
|
||||
[cmdletbinding()]
|
||||
param(
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Set-ZertoAlert {
|
||||
[cmdletbinding( SupportsShouldProcess = $true )]
|
||||
param (
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Set-ZertoLicense {
|
||||
[cmdletbinding( SupportsShouldProcess = $true )]
|
||||
param (
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Start-ZertoCloneVpg {
|
||||
[cmdletbinding()]
|
||||
param(
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Start-ZertoFailoverTest {
|
||||
[cmdletbinding()]
|
||||
param(
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Stop-ZertoCloneVpg {
|
||||
param(
|
||||
[Parameter(
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Stop-ZertoFailoverTest {
|
||||
[cmdletbinding()]
|
||||
param(
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Suspend-ZertoVpg {
|
||||
[cmdletbinding()]
|
||||
param(
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Uninstall-ZertoVra {
|
||||
[cmdletbinding()]
|
||||
param(
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,108 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Add-ZertoPeerSite.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Add-ZertoPeerSite
|
||||
|
||||
## SYNOPSIS
|
||||
Pairs the current Zerto Virtual Manager to the target Zerto Virtual Manager
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Add-ZertoPeerSite [-targetHost] <String> [[-targetPort] <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Pairs the current Zerto Virtual Manager to the target Zerto Virtual Manager by leveraging the Zerto Peer Sites API end point.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Add-ZertoPeerSite -targetHost "192.168.2.100" -targetPort "9081"
|
||||
```
|
||||
|
||||
Pairs the current Zerto Virtual Manager to the Zerto Virtual Manager at IP address 192.168.2.100.
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -targetHost
|
||||
Target Hostname or IP address to pair the localsite to.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -targetPort
|
||||
Target communication port.
|
||||
Default is 9081
|
||||
|
||||
```yaml
|
||||
Type: Int32
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 1
|
||||
Default value: "9081"
|
||||
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
|
||||
|
||||
### None
|
||||
## OUTPUTS
|
||||
|
||||
### System.Object
|
||||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
[Zerto REST API Peer Site 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.044.html%23)
|
||||
@@ -0,0 +1,76 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Checkpoint-ZertoVpg.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Checkpoint-ZertoVpg
|
||||
|
||||
## SYNOPSIS
|
||||
Add a tagged checkpoint to a specified VPG
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Checkpoint-ZertoVpg [-vpgName] <String> [-checkpointName] <String> [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Add a tagged checkpoint to a specified VPG
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Checkpoint-ZertoVpg -vpgName "Example VPG" -checkpointName "My Tagged Checkpoint"
|
||||
```
|
||||
|
||||
Adds a tagged checkpoint to the "Example VPG" with the checkpoint name of "My Tagged Checkpoint"
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -checkpointName
|
||||
Text to tag the checkpoint with.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 1
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vpgName
|
||||
Name of the VPG to tag.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
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 REST API VPG End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.100.html#)
|
||||
@@ -0,0 +1,110 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Connect-ZertoServer.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Connect-ZertoServer
|
||||
|
||||
## SYNOPSIS
|
||||
Establishes a connection to a ZVM.
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Connect-ZertoServer [-zertoServer] <String> [[-zertoPort] <String>] [-credential] <PSCredential>
|
||||
[-returnHeaders] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Establishes a connection to a ZVM using credentials provided via a PSCredential Object leveraging the Zerto Session API end point.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Connect-ZertoServer -zertoServer "192.168.1.100" -zertoPort "9669" -credential $credential
|
||||
```
|
||||
|
||||
Establishes a connection to ZVM 192.168.1.100 on port 9669 with supplied PSCredential object.
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -credential
|
||||
Valid credentials to connect to the Zerto Management Server
|
||||
|
||||
```yaml
|
||||
Type: PSCredential
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 2
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -returnHeaders
|
||||
Use this switch to return the headers to a specified variable or to the default output.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -zertoPort
|
||||
Zerto Virtual Manager management port.
|
||||
Default value is 9669.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 1
|
||||
Default value: "9669"
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -zertoServer
|
||||
IP address or FQDN of your Zerto Management Server
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
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 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,42 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Disconnect-ZertoServer.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Disconnect-ZertoServer
|
||||
|
||||
## SYNOPSIS
|
||||
Disconnects the current session from the ZVM
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Disconnect-ZertoServer
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Disconnects the current session from the Zerto Virtual Manager
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Disconnect-ZertoServer
|
||||
```
|
||||
|
||||
Disconnects from the Zerto Server
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
## INPUTS
|
||||
|
||||
### None
|
||||
## OUTPUTS
|
||||
|
||||
### System.Object
|
||||
## NOTES
|
||||
|
||||
## 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)
|
||||
@@ -0,0 +1,181 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Edit-ZertoVra.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Edit-ZertoVra
|
||||
|
||||
## SYNOPSIS
|
||||
Updates a VRA with updated settings
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Edit-ZertoVra -vraIdentifier <String> [-groupName <String>] [-vraIpAddress <String>] [-defaultGateway <String>]
|
||||
[-subnetMask <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Updates a VRA with updated settings using the Zerto VRA end point.
|
||||
|
||||
It is possible to update the Bandwidth group with the -groupName setting. If the group does not currently exist, it will be created.
|
||||
|
||||
It is possible to update the static IP address, default gateway, or subnetmask.
|
||||
|
||||
It is suggested that you use Get-ZertoVra to get the vraIdentifer prameter.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Edit-ZertoVra -vraIdentifier $vraIdentifier -groupName "My Group Name"
|
||||
```
|
||||
|
||||
Updates the VRA Group Name to "My Group Name"
|
||||
|
||||
### Example 2
|
||||
```powershell
|
||||
PS C:\>Edit-ZertoVra -vraIdentifier $vraIdentifier -vraIpAddress "192.168.1.101"
|
||||
```
|
||||
|
||||
Updates the VRA IP address to "192.168.1.101"
|
||||
|
||||
### Example 3
|
||||
```powershell
|
||||
PS C:\>Edit-ZertoVra -vraIdentifier $vraIdentifier -vraIpAddress "192.168.1.101" -subnetMask "255.255.252.0" -defaultGateway "192.168.1.1"
|
||||
```
|
||||
|
||||
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
|
||||
```powershell
|
||||
PS C:\>Edit-ZertoVra -vraIdentifier $vraIdentifier -defaultGateway "192.168.1.1"
|
||||
```
|
||||
|
||||
Updates the VRA default gateway to 192.168.1.1
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -defaultGateway
|
||||
Default gateway to assign to the VRA
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -groupName
|
||||
Bandwidth group to assign to the VRA.
|
||||
If unspecified will not modify current assignment
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
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
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vraIdentifier
|
||||
Identifier of the VRA to be updated.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vraIpAddress
|
||||
Static IP address to assign to the VRA.
|
||||
|
||||
```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.
|
||||
|
||||
```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
|
||||
|
||||
### None
|
||||
## OUTPUTS
|
||||
|
||||
### System.Object
|
||||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
[Zerto REST API VRA End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.117.html#)
|
||||
@@ -0,0 +1,310 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Get-ZertoAlert.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Get-ZertoAlert
|
||||
|
||||
## SYNOPSIS
|
||||
Get Alerts from the Zerto Virtual Manager
|
||||
|
||||
## SYNTAX
|
||||
|
||||
### main (Default)
|
||||
```
|
||||
Get-ZertoAlert [<CommonParameters>]
|
||||
```
|
||||
|
||||
### alertId
|
||||
```
|
||||
Get-ZertoAlert -alertId <String[]> [<CommonParameters>]
|
||||
```
|
||||
|
||||
### entities
|
||||
```
|
||||
Get-ZertoAlert [-entities] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### helpIdentifiers
|
||||
```
|
||||
Get-ZertoAlert [-helpIdentifiers] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### levels
|
||||
```
|
||||
Get-ZertoAlert [-levels] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### filter
|
||||
```
|
||||
Get-ZertoAlert [-startDate <String>] [-endDate <String>] [-vpgIdentifier <String>] [-siteIdentifier <String>]
|
||||
[-zorgIdentifier <String>] [-level <String>] [-helpIdentifier <String>] [-entity <String>]
|
||||
[-isDismissed <Boolean>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
This function will return all alerts from the Zerto Virtual Manager when called witout any parameters.
|
||||
|
||||
When the filter parameter set is used it will return any alerts that suit the passed criteria depending on the parameters that are defined. The parameters are combined with "AND" logic so it will only return alerts that meet all the criteria passed.
|
||||
|
||||
Any of the other parameter sets used will return valid settings for each setting type.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Get-ZertoAlert
|
||||
```
|
||||
|
||||
Returns all current alerts.
|
||||
|
||||
### Example 2
|
||||
```powershell
|
||||
PS C:\> Get-ZertoAlert -startDate "2019-02-01T08:00:00.000" -endDate "2019-02-02T20:30:00.000"
|
||||
```
|
||||
|
||||
Returns all alerts that were started after Feb. 01, 2019 8 AM ZVM local time and Feb. 02 2019 8 PM ZVM local time.
|
||||
|
||||
### Example 3
|
||||
```powershell
|
||||
PS C:\> Get-ZertoAlert -alertId "Need to Fill This In"
|
||||
```
|
||||
|
||||
Returns information on the alert with alert identifier "Need to Fill This In"
|
||||
|
||||
### Example 4
|
||||
```powershell
|
||||
PS C:\> Get-ZertoAlert -entities
|
||||
```
|
||||
|
||||
Returns entities information
|
||||
|
||||
### Example 5
|
||||
```powershell
|
||||
PS C:\> Get-ZertoAlert -helpIdentifiers
|
||||
```
|
||||
|
||||
Returns Help Identifiers information
|
||||
|
||||
### Example 6
|
||||
```powershell
|
||||
PS C:\> Get-ZertoAlert -levels
|
||||
```
|
||||
|
||||
Returns information about alert levels
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -alertId
|
||||
AlertId or array of AlertIds to be queried
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: alertId
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByPropertyName, ByValue)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -endDate
|
||||
Returns Alerts before the End Date.
|
||||
Provide the string in the format of 'yyyy-MM-ddTHH:mm:ss.fff'
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -entities
|
||||
Switch to return the entities information from the API
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: entities
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -entity
|
||||
Returns alerts for the specified entity
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -helpIdentifier
|
||||
Returns alerts for the specified helpIdentifier
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -helpIdentifiers
|
||||
Switch to get the Help Identifiers information from the API
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: helpIdentifiers
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -isDismissed
|
||||
Returns alerts that are dismissed when set to $true an undismissed alerts when set to $false
|
||||
|
||||
```yaml
|
||||
Type: Boolean
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -level
|
||||
Returns alerts for the specified level
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -levels
|
||||
Switch to return Alert Levels information from the API
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: levels
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -siteIdentifier
|
||||
Returns alerts for the specified siteIdentifier
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -startDate
|
||||
Returns Alerts after the Start Date.
|
||||
Provide the string in the format of 'yyyy-MM-ddTHH:mm:ss.fff'
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vpgIdentifier
|
||||
Returns alerts for the specified vraIdentifier
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -zorgIdentifier
|
||||
Returns alerts for the specified zorgIdentifier
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
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
|
||||
|
||||
### System.String[]
|
||||
## OUTPUTS
|
||||
|
||||
### System.Object
|
||||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
[Zerto REST API Alerts 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.009.html%23)
|
||||
@@ -0,0 +1,74 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Get-ZertoDatastore.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Get-ZertoDatastore
|
||||
|
||||
## SYNOPSIS
|
||||
Returns datastore information for the local site.
|
||||
|
||||
## SYNTAX
|
||||
|
||||
### main (Default)
|
||||
```
|
||||
Get-ZertoDatastore [<CommonParameters>]
|
||||
```
|
||||
|
||||
### datastoreIdentifier
|
||||
```
|
||||
Get-ZertoDatastore [-datastoreIdentifier <String[]>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Returns datastore information for the local site or information for a single datastore when a datastore identifier is passed. If several datastore parameters are passed in an array, all requested datastores will be returned.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Get-ZertoDatastore
|
||||
```
|
||||
|
||||
Returns all datastore information for the local site.
|
||||
|
||||
### Example 2
|
||||
```powershell
|
||||
PS C:\> Get-ZertoDatastore -datastoreIdentifier "Need to fill this in"
|
||||
```
|
||||
|
||||
Returns all datastore information for the datastore associated with the passed identifier.
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -datastoreIdentifier
|
||||
datastoreIdentifier or array of datastoreIdentifiers to be queried
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: datastoreIdentifier
|
||||
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
|
||||
|
||||
### None
|
||||
## OUTPUTS
|
||||
|
||||
### System.Object
|
||||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
[Zerto REST API Datastore Information End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.016.html#)
|
||||
@@ -0,0 +1,359 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Get-ZertoEvent.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Get-ZertoEvent
|
||||
|
||||
## SYNOPSIS
|
||||
Returns events from the connected Zerto Virtual Manager
|
||||
|
||||
## SYNTAX
|
||||
|
||||
### main (Default)
|
||||
```
|
||||
Get-ZertoEvent [<CommonParameters>]
|
||||
```
|
||||
|
||||
### filter
|
||||
```
|
||||
Get-ZertoEvent [-startDate <String>] [-endDate <String>] [-vpg <String>] [-vpgIdentifier <String>]
|
||||
[-eventType <String>] [-siteName <String>] [-siteIdentifier <String>] [-zorgIdentifier <String>]
|
||||
[-entityType <String>] [-userName <String>] [-category <String>] [-eventCategory <String>]
|
||||
[-alertIdentifier <String>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### eventId
|
||||
```
|
||||
Get-ZertoEvent -eventId <String[]> [<CommonParameters>]
|
||||
```
|
||||
|
||||
### categories
|
||||
```
|
||||
Get-ZertoEvent [-categories] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### entities
|
||||
```
|
||||
Get-ZertoEvent [-entities] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### types
|
||||
```
|
||||
Get-ZertoEvent [-types] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Returns events from the connected Zerto Virtual Manager. If any of the switches are specified, it will return information about entities with that title. For example, if you select '-types' it will return all event types.
|
||||
|
||||
Should any of the parameters for the filter functionality be specified, only events that fulfill all of the submitted criteria will be returned.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Get-ZertoEvent
|
||||
```
|
||||
|
||||
Returns all events
|
||||
|
||||
### Example 2
|
||||
```powershell
|
||||
PS C:\> Get-ZertoEvent -eventId "Need an eventID"
|
||||
```
|
||||
|
||||
Returns information for each -eventID specified.
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Get-ZertoEvent -startDate "2019-01-01" -endDate "2019-01-07" -vpg "My Vpg"
|
||||
```
|
||||
|
||||
Returns all events between Jan. 01, 2019 and Jan. 07, 2019 (inclusive) for the vpg "My Vpg"
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -alertIdentifier
|
||||
The internal alert identifier for the Event
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -categories
|
||||
Returns possible Event Categories.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: categories
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -category
|
||||
The type of event to return.
|
||||
This filter behaves in the same way as the eventCategory filter.
|
||||
Possible Values are: Possible Values are: '0' or 'All', '1' or 'Events', '2' or 'Alerts'
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -endDate
|
||||
The end date for the list, supplied as a date with the format of the Zerto Virtual Manager where the API runs, for example, yyyy-MM-dd.
|
||||
You can also specify a local time with the following format: yyyy-MM-ddTHH:mm:ss.fffZ.
|
||||
Adding Z to the end of the time sets the time to UTC.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -entities
|
||||
Returns possible entity types.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: entities
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -entityType
|
||||
The type of entity for which you wish to return results.
|
||||
Possible Values are: '0' or 'VPG', '1' or 'VRA', '2' or 'Unknown', or '3' or 'Site'
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -eventCategory
|
||||
This filter behaves in the same way as the category filter.
|
||||
If both category and eventCategory filters are specified, only the category filter value is used and the eventCategory filter value is ignored.
|
||||
The type of event to return.
|
||||
Possible Values are: '0' or 'All', '1' or 'Events', '2' or 'Alerts'
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -eventId
|
||||
The identifier or identifiers of the event for which information is returned.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: eventId
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByPropertyName, ByValue)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -eventType
|
||||
The type of event.
|
||||
For the description of events, refer to the Zerto Virtual Replication documentation about alerts and events.
|
||||
Please see Zerto API Documentation for possible values.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -siteIdentifier
|
||||
The internal site identifier for which you want to return events.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -siteName
|
||||
The name of the site for which you want to return events.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -startDate
|
||||
The starting date for the list of events, supplied as a date with the format of the Zerto Virtual Manager where the API runs, for example, yyyy-MM-dd.
|
||||
You can also specify a local time with the following format: yyyy-MM-ddTHH:mm:ss.fffZ.
|
||||
Adding Z to the end of the time sets the time to UTC.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -types
|
||||
Returns possible event types.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: types
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -userName
|
||||
The name of the user for which the event occurred.
|
||||
If the event occurred as a result of a task started by the Zerto Virtual Manager, for example, when moving a VPG before the commit stage, the user is System.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vpg
|
||||
The name of the VPG for which you want to return events.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vpgIdentifier
|
||||
The identifier of the VPG for which you want to return events.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -zorgIdentifier
|
||||
The identifier of the ZORG, Zerto organization, defined in the Zerto Cloud Manager for which you want to return results.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
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
|
||||
|
||||
### System.String[]
|
||||
## OUTPUTS
|
||||
|
||||
### System.Object
|
||||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
[Zerto REST API Events End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.022.html#)
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Get-ZertoLicense.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Get-ZertoLicense
|
||||
|
||||
## SYNOPSIS
|
||||
Retrieve information about a Zerto Virtual Replication license.
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Get-ZertoLicense
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Retrieve information about a Zerto Virtual Replication license.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Get-ZertoLicense
|
||||
```
|
||||
|
||||
Retrieve information about a Zerto Virtual Replication license.
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
## INPUTS
|
||||
|
||||
### None
|
||||
## OUTPUTS
|
||||
|
||||
### System.Object
|
||||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
[Zerto REST API License Information](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.034.html#)
|
||||
@@ -0,0 +1,61 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Get-ZertoLocalSite.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Get-ZertoLocalSite
|
||||
|
||||
## SYNOPSIS
|
||||
Returns information about the local site.
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Get-ZertoLocalSite [-pairingstatuses] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Returns information about the local site. Please see the Zerto API Documentation for specifics on the information returned.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Get-ZertoLocalSite
|
||||
```
|
||||
|
||||
Returns information about the local site.
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -pairingstatuses
|
||||
Switch to return possible paiting statuses.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
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
|
||||
|
||||
### None
|
||||
## OUTPUTS
|
||||
|
||||
### System.Object
|
||||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
[Zerto REST API Local Site End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.038.html#)
|
||||
@@ -0,0 +1,177 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Get-ZertoPeerSite.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Get-ZertoPeerSite
|
||||
|
||||
## SYNOPSIS
|
||||
Returns information about the peer sites.
|
||||
|
||||
## SYNTAX
|
||||
|
||||
### main (Default)
|
||||
```
|
||||
Get-ZertoPeerSite [<CommonParameters>]
|
||||
```
|
||||
|
||||
### pairingStatuses
|
||||
```
|
||||
Get-ZertoPeerSite [-pairingStatuses] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### siteIdentifier
|
||||
```
|
||||
Get-ZertoPeerSite -siteIdentifier <String[]> [<CommonParameters>]
|
||||
```
|
||||
|
||||
### filter
|
||||
```
|
||||
Get-ZertoPeerSite [-peerName <String>] [-paringStatus <String>] [-location <String>] [-hostName <String>]
|
||||
[-port <String>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Returns information about a peer site. When called without any parameters, will return basic information about all peer sites.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Get-ZertoPeerSite
|
||||
```
|
||||
|
||||
Returns basic information about all sites connected to this site.
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Get-ZertoPeerSite -siteIdentifier "MySiteIdentifier"
|
||||
```
|
||||
|
||||
Returns basic information about site with site identifier "MySiteIdentifier"
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -hostName
|
||||
The IP address of a Zerto Virtual Manager, paired with this site, for which information is to be returned.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -location
|
||||
The site location, as specified in the site information, for which information is to be returned.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -pairingStatuses
|
||||
Switch to return possible paiting statuses.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: pairingStatuses
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -paringStatus
|
||||
The pairing status for which information is to be returned.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -peerName
|
||||
The name of a peer site for which information is to be returned.
|
||||
The name is case-sensitive.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -port
|
||||
The port used to access peer sites for which information is to be returned.
|
||||
The default port is 9081.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -siteIdentifier
|
||||
The identifier(s) of the peer site(s) for which information is to be returned.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: siteIdentifier
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByPropertyName, ByValue)
|
||||
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
|
||||
|
||||
### System.String[]
|
||||
## OUTPUTS
|
||||
|
||||
### System.Object
|
||||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
[Zerto REST API Peer Site End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.038.html#)
|
||||
@@ -0,0 +1,253 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Get-ZertoProtectedVm.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Get-ZertoProtectedVm
|
||||
|
||||
## SYNOPSIS
|
||||
Returns information about Virtual Machines protected by Zerto
|
||||
|
||||
## SYNTAX
|
||||
|
||||
### main (Default)
|
||||
```
|
||||
Get-ZertoProtectedVm [<CommonParameters>]
|
||||
```
|
||||
|
||||
### vmIdentifier
|
||||
```
|
||||
Get-ZertoProtectedVm -vmIdentifier <String[]> [<CommonParameters>]
|
||||
```
|
||||
|
||||
### filter
|
||||
```
|
||||
Get-ZertoProtectedVm [-vpgName <String>] [-vmName <String>] [-status <String>] [-substatus <String>]
|
||||
[-organizationName <String>] [-priority <String>] [-protectedSiteType <String>] [-recoverySiteType <String>]
|
||||
[-protectedSiteIdentifier <String>] [-recoverySiteIdentifier <String>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Returns information about virtual machines protected by Zerto. When called without parameters, will return all currently protected virtual machines. A single vmIdentifier or an array of vmIdentifiers can be used to only return information about those virtual machines.
|
||||
|
||||
If information is wanted for several virtual machines and you need to search for those machines, any of the parameters in the Filter parameter set can be used to find virtual machines that fit all the criteria passed to the function.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Get-ZertoProtectedVm
|
||||
```
|
||||
|
||||
Returns all virtual machines that are either protected to or protected from this site by Zerto
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Get-ZertoProtectedVm -vmIdentifier "MyVmIdentifier"
|
||||
```
|
||||
|
||||
Returns information about the protected virtual machine with identifier "MyVmIdentifier"
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Get-ZertoProtectedVm -vmIdentifier "MyVmIdentifier", "MyOtherVmIdentifier"
|
||||
```
|
||||
|
||||
Returns information about the protected virtual machines with identifiers "MyVmIdentifier" and "MyOtherVmIdentifier"
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Get-ZertoProtectedVm -vpgName "My Vpg"
|
||||
```
|
||||
|
||||
Returns all virtual machines that are members of the Virtual Protection Group "My Vpg"
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -organizationName
|
||||
The ZORG for this VPG.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -priority
|
||||
The priority specified for the VPG.
|
||||
Possible values are: '0' or 'Low', '1' or 'Medium', '2' or 'High'
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -protectedSiteIdentifier
|
||||
The identifier of the protected site where the VPG virtual machines are protected.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -protectedSiteType
|
||||
The protected site type.
|
||||
Please see Zerto API documentation for possible values.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -recoverySiteIdentifier
|
||||
The identifier of the recovery site where the VPG virtual machines are recovered.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -recoverySiteType
|
||||
The recovery site type.
|
||||
Please see Zerto API documentation for possible values.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -status
|
||||
The status of the VPG.
|
||||
Please see Zerto API documentation for possible values.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -substatus
|
||||
The substatus of the VPG, for example the VPG is in a bitmap sync.
|
||||
For the description of substatuses, refer to the Zerto Virtual Manager Administration Guide.
|
||||
Please see Zerto API documentation for possible values.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vmIdentifier
|
||||
vmIdentifier(s) for which to return information
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: vmIdentifier
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByPropertyName, ByValue)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vmName
|
||||
The name of the virtual machine.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vpgName
|
||||
The name of the VPG which protects the virtual machine.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
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
|
||||
|
||||
### System.String[]
|
||||
## OUTPUTS
|
||||
|
||||
### System.Object
|
||||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
[Zerto REST API Protected VMs End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.088.html#)
|
||||
@@ -0,0 +1,190 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Get-ZertoRecoveryReport.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Get-ZertoRecoveryReport
|
||||
|
||||
## SYNOPSIS
|
||||
Generate a recovery report and view information about recovery operations, such as failover, failover tests and moves.
|
||||
|
||||
## SYNTAX
|
||||
|
||||
### main (Default)
|
||||
```
|
||||
Get-ZertoRecoveryReport [<CommonParameters>]
|
||||
```
|
||||
|
||||
### filter
|
||||
```
|
||||
Get-ZertoRecoveryReport [-startTime <String>] [-endTime <String>] [-pageNumber <String>] [-pageSize <String>]
|
||||
[-vpgIdentifier <String>] [-vpgName <String>] [-recoveryType <String>] [-state <String>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Generate a recovery report and view information about recovery operations, such as failover, failover tests and moves.
|
||||
The report displays information by VPG, and then by virtual machine within the VPG.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Get-ZertoRecoveryReport
|
||||
```
|
||||
|
||||
Returns all recovery reports
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Get-ZertoRecoveryReport -vpgName "My VPG"
|
||||
```
|
||||
|
||||
Returns all recovery reports for VPG "My VPG"
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -endTime
|
||||
Operations performed between the specified start Time and end Time (inclusive) are displayed.
|
||||
Valid formats include: 'yyyy-MM-ddTHH:mm:ss.fffZ', 'yyyy-MM-ddTHH:mm:ssZ', 'yyyy-MM-ddTHH:mmZ', 'yyyy-MM-ddTHHZ', 'yyyy-MM-dd', 'yyyy-MM', 'yyyy'.
|
||||
Adding Z to the end of the time sets the time to UTC.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -pageNumber
|
||||
The page number the user wants to retrieve.
|
||||
Minimum value is 1.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -pageSize
|
||||
The number of reports to display in a single page.
|
||||
The maximum number of reports per page is 1000.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -recoveryType
|
||||
The type of recovery operations.
|
||||
Possible values are: 'Failover', 'Failover Test', or 'Move'
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -startTime
|
||||
Operations performed between the specified start Time and end Time (inclusive) are displayed.
|
||||
Valid formats include: 'yyyy-MM-ddTHH:mm:ss.fffZ', 'yyyy-MM-ddTHH:mm:ssZ', 'yyyy-MM-ddTHH:mmZ', 'yyyy-MM-ddTHHZ', 'yyyy-MM-dd', 'yyyy-MM', 'yyyy'.
|
||||
Adding Z to the end of the time sets the time to UTC.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -state
|
||||
Whether the recovery operation has completed.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vpgIdentifier
|
||||
The internal identifier of the VPG.
|
||||
You can specify more than one VPG, separated by commas.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vpgName
|
||||
The name of the VPG.
|
||||
You can specify more than one VPG, separated by commas.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
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
|
||||
|
||||
### None
|
||||
## OUTPUTS
|
||||
|
||||
### System.Object
|
||||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
[Zerto REST API Recovery Report End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.055.html#)
|
||||
@@ -0,0 +1,320 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Get-ZertoResourcesReport.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Get-ZertoResourcesReport
|
||||
|
||||
## SYNOPSIS
|
||||
The resources report API generates information about the resources that are used by the virtual machines that are recovered to the site where the report is run. If no virtual machines are recovered to the site where the report is run, the report is empty.
|
||||
|
||||
|
||||
## SYNTAX
|
||||
|
||||
### main (Default)
|
||||
```
|
||||
Get-ZertoResourcesReport [<CommonParameters>]
|
||||
```
|
||||
|
||||
### filter
|
||||
```
|
||||
Get-ZertoResourcesReport [-startTime <String>] [-endTime <String>] [-pageNumber <String>] [-pageSize <String>]
|
||||
[-zorgName <String>] [-vmName <String>] [-vpgName <String>] [-protectedSiteName <String>]
|
||||
[-protectedClusterName <String>] [-protectedHostName <String>] [-protectedOrgVdc <String>]
|
||||
[-protectedVdcOrg <String>] [-recoverySiteName <String>] [-recoveryClusterName <String>]
|
||||
[-recoveryHostName <String>] [-recoveryOrgVdc <String>] [-recoveryVdcOrg <String>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
The resources report API generates information about the resources that are used by the virtual machines that are recovered to the site where the report is run. If no virtual machines are recovered to the site where the report is run, the report is empty.
|
||||
|
||||
This information is collected at fixed times as defined in the Resources Report section of the Site Settings window. Information for the report is saved for 90 days when the sampling period is hourly, and for one year when the sampling period is daily.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Get-ZertoResourcesReport -vpgName "MyVpg"
|
||||
```
|
||||
|
||||
Returns resources report for VPG "MyVpg"
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -endTime
|
||||
Operations performed between the specified start Time and end Time (inclusive) are displayed.
|
||||
Valid formats include: 'yyyy-MM-ddTHH:mm:ss.fffZ', 'yyyy-MM-ddTHH:mm:ssZ', 'yyyy-MM-ddTHH:mmZ', 'yyyy-MM-ddTHHZ', 'yyyy-MM-dd', 'yyyy-MM', 'yyyy'.
|
||||
Adding Z to the end of the time sets the time to UTC.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -pageNumber
|
||||
The page number to retrieve.
|
||||
Minimum value is 1
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -pageSize
|
||||
The number of reports to display in a single page.
|
||||
The maximum number of reports per page is 1000.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -protectedClusterName
|
||||
The name of the cluster containing the host where the virtual machine in the recovery site resides.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -protectedHostName
|
||||
The address or DNS name of the host where the virtual machine in the recovery site resides.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -protectedOrgVdc
|
||||
The name of the vDC organization in the protected site.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -protectedSiteName
|
||||
The name of the protected site.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -protectedVdcOrg
|
||||
The name of the vCD organization in the protected site.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -recoveryClusterName
|
||||
The name of the cluster containing the host where the virtual machine in the recovery site resides.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -recoveryHostName
|
||||
The address or DNS name of the host where the virtual machine in the recovery site resides.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -recoveryOrgVdc
|
||||
The name of the vDC organization in the recovery site.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -recoverySiteName
|
||||
The name of the recovery site.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -recoveryVdcOrg
|
||||
The name of the recovery vCD organization.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -startTime
|
||||
Operations performed between the specified start Time and end Time (inclusive) are displayed.
|
||||
Valid formats include: 'yyyy-MM-ddTHH:mm:ss.fffZ', 'yyyy-MM-ddTHH:mm:ssZ', 'yyyy-MM-ddTHH:mmZ', 'yyyy-MM-ddTHHZ', 'yyyy-MM-dd', 'yyyy-MM', 'yyyy'.
|
||||
Adding Z to the end of the time sets the time to UTC.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vmName
|
||||
The name of the virtual machine.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vpgName
|
||||
The name of the VPG.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -zorgName
|
||||
The name of the organization set up in the Zerto Cloud Manager.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
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
|
||||
|
||||
### None
|
||||
## OUTPUTS
|
||||
|
||||
### System.Object
|
||||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
[Zerto REST API Resources Report End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.058.html#)
|
||||
@@ -0,0 +1,87 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Get-ZertoServiceProfile.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Get-ZertoServiceProfile
|
||||
|
||||
## SYNOPSIS
|
||||
Returns information about service profiles that are defined in the Zerto Cloud Manager that is connected to the site where the API runs.
|
||||
|
||||
## SYNTAX
|
||||
|
||||
### main (Default)
|
||||
```
|
||||
Get-ZertoServiceProfile [<CommonParameters>]
|
||||
```
|
||||
|
||||
### siteIdentifier
|
||||
```
|
||||
Get-ZertoServiceProfile [-siteIdentifier <String>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### serviceProfileId
|
||||
```
|
||||
Get-ZertoServiceProfile [-serviceProfileId <String[]>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Returns information about service profiles that are defined in the Zerto Cloud Manager that is connected to the site where the API runs.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Get-ZertoServiceProfile
|
||||
```
|
||||
|
||||
Returns service profile defined in the Zerto Cloud Manager connected to this site.
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -serviceProfileId
|
||||
The service profile ID for which information should be returned.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: serviceProfileId
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -siteIdentifier
|
||||
The identifier of the site for which service profiles should be returned.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: siteIdentifier
|
||||
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
|
||||
|
||||
### None
|
||||
## OUTPUTS
|
||||
|
||||
### System.Object
|
||||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
[Zerto REST API Service Profile End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.062.html#)
|
||||
@@ -0,0 +1,201 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Get-ZertoTask.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Get-ZertoTask
|
||||
|
||||
## SYNOPSIS
|
||||
Returns information about tasks run on the site.
|
||||
|
||||
## SYNTAX
|
||||
|
||||
### main (Default)
|
||||
```
|
||||
Get-ZertoTask [<CommonParameters>]
|
||||
```
|
||||
|
||||
### taskIdentifier
|
||||
```
|
||||
Get-ZertoTask [-taskIdentifier <String[]>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### types
|
||||
```
|
||||
Get-ZertoTask [-types] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### filter
|
||||
```
|
||||
Get-ZertoTask [-startedBeforeDate <String>] [-startedAfterDate <String>] [-completedAfterDate <String>]
|
||||
[-completedBeforeDate <String>] [-type <String>] [-status <String>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Returns information about tasks run on the site.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Get-ZertoTask
|
||||
```
|
||||
|
||||
Returns all current Zerto tasks
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Get-ZertoTask -taskIdentifier "MyTaskIdentifier"
|
||||
```
|
||||
|
||||
Returns information about task with taskIdentifier "MyTaskIdentifier"
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -completedAfterDate
|
||||
Tasks completed after this time (inclusive) are displayed.
|
||||
Valid formats include: 'yyyy-MM-ddTHH:mm:ss.fffZ', 'yyyy-MM-ddTHH:mm:ssZ', 'yyyy-MM-ddTHH:mmZ', 'yyyy-MM-ddTHHZ', 'yyyy-MM-dd', 'yyyy-MM', 'yyyy'.
|
||||
Adding Z to the end of the time sets the time to UTC.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -completedBeforeDate
|
||||
Tasks completed before this time (inclusive) are displayed.
|
||||
Valid formats include: 'yyyy-MM-ddTHH:mm:ss.fffZ', 'yyyy-MM-ddTHH:mm:ssZ', 'yyyy-MM-ddTHH:mmZ', 'yyyy-MM-ddTHHZ', 'yyyy-MM-dd', 'yyyy-MM', 'yyyy'.
|
||||
Adding Z to the end of the time sets the time to UTC.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -startedAfterDate
|
||||
Tasks started after this time (inclusive) are displayed.
|
||||
Valid formats include: 'yyyy-MM-ddTHH:mm:ss.fffZ', 'yyyy-MM-ddTHH:mm:ssZ', 'yyyy-MM-ddTHH:mmZ', 'yyyy-MM-ddTHHZ', 'yyyy-MM-dd', 'yyyy-MM', 'yyyy'.
|
||||
Adding Z to the end of the time sets the time to UTC.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -startedBeforeDate
|
||||
Tasks started before this time (inclusive) are displayed.
|
||||
Valid formats include: 'yyyy-MM-ddTHH:mm:ss.fffZ', 'yyyy-MM-ddTHH:mm:ssZ', 'yyyy-MM-ddTHH:mmZ', 'yyyy-MM-ddTHHZ', 'yyyy-MM-dd', 'yyyy-MM', 'yyyy'.
|
||||
Adding Z to the end of the time sets the time to UTC.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -status
|
||||
The status of the task.
|
||||
Possible values are: '1' or 'InProgress', '3' or 'Paused', '4' or 'Failed', '6' or 'Completed', '7' or 'Cancelling'
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -taskIdentifier
|
||||
The identifier(s) for which task information is to be returned.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: taskIdentifier
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -type
|
||||
The type of task.
|
||||
For the description of the tasks, refer to the Zerto Virtual Replication documentation about monitoring tasks.
|
||||
Please see Zerto API Documentation for possible types and values.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -types
|
||||
Returns all task types.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: types
|
||||
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
|
||||
|
||||
### None
|
||||
## OUTPUTS
|
||||
|
||||
### System.Object
|
||||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
[Zerto REST API Task End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.076.html#)
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Get-ZertoUnprotectedVm.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Get-ZertoUnprotectedVm
|
||||
|
||||
## SYNOPSIS
|
||||
Returns all virtual machines at the site not currently protected in a virtual protection group.
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Get-ZertoUnprotectedVm
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Returns all virtual machines at the site not currently protected in a virtual protection group.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Get-ZertoUnprotectedVm
|
||||
```
|
||||
|
||||
Returns all virtual machines at the site not currently protected in a virtual protection group.
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
## INPUTS
|
||||
|
||||
### None
|
||||
## OUTPUTS
|
||||
|
||||
### System.Object
|
||||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
[Zerto REST API Virtualization Sites End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.082.html#)
|
||||
@@ -0,0 +1,263 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Get-ZertoVirtualizationSite.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Get-ZertoVirtualizationSite
|
||||
|
||||
## SYNOPSIS
|
||||
{{Fill in the Synopsis}}
|
||||
|
||||
## SYNTAX
|
||||
|
||||
### main (Default)
|
||||
```
|
||||
Get-ZertoVirtualizationSite [<CommonParameters>]
|
||||
```
|
||||
|
||||
### folders
|
||||
```
|
||||
Get-ZertoVirtualizationSite -siteIdentifier <String> [-folders] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### devices
|
||||
```
|
||||
Get-ZertoVirtualizationSite -siteIdentifier <String> [-devices] [-hostIdentifier <String>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### vms
|
||||
```
|
||||
Get-ZertoVirtualizationSite -siteIdentifier <String> [-vms] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### resourcePools
|
||||
```
|
||||
Get-ZertoVirtualizationSite -siteIdentifier <String> [-resourcePools] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### networks
|
||||
```
|
||||
Get-ZertoVirtualizationSite -siteIdentifier <String> [-networks] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### hosts
|
||||
```
|
||||
Get-ZertoVirtualizationSite -siteIdentifier <String> [-hostIdentifier <String>] [-hosts] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### hostClusters
|
||||
```
|
||||
Get-ZertoVirtualizationSite -siteIdentifier <String> [-hostClusters] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### datastores
|
||||
```
|
||||
Get-ZertoVirtualizationSite -siteIdentifier <String> [-datastores] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### datastoreClusters
|
||||
```
|
||||
Get-ZertoVirtualizationSite -siteIdentifier <String> [-datastoreClusters] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### siteIdentifier
|
||||
```
|
||||
Get-ZertoVirtualizationSite -siteIdentifier <String> [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
{{Fill in the Description}}
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> {{ Add example code here }}
|
||||
```
|
||||
|
||||
{{ Add example description here }}
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -datastoreClusters
|
||||
When selected, will return all datastore clusters at the specified site.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: datastoreClusters
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -datastores
|
||||
When selected, will return all datastores at the specified site.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: datastores
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -devices
|
||||
When selected, will return all devices at the specified site.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: devices
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -folders
|
||||
Return all folders at the selected site.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: folders
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -hostClusters
|
||||
Return all host clusters at the selected site.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: hostClusters
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -hostIdentifier
|
||||
The identifier of the host at the selected site to return information for only one host.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: devices, hosts
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -hosts
|
||||
Return all hosts at the selected site.
|
||||
If a host identifier is provided, return only that host.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: hosts
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -networks
|
||||
Return all networks at the selected site.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: networks
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -resourcePools
|
||||
Return all resource pools at the selected site.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: resourcePools
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -siteIdentifier
|
||||
The identifier of the Zerto Virtual Manager site.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: folders, devices, vms, resourcePools, networks, hosts, hostClusters, datastores, datastoreClusters, siteIdentifier
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vms
|
||||
Return all VMs at the selected site.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: vms
|
||||
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 REST API Virtualization Sites End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.082.html#)
|
||||
@@ -0,0 +1,143 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Get-ZertoVolume.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Get-ZertoVolume
|
||||
|
||||
## SYNOPSIS
|
||||
Returns information about all volumes in the site processing the API.
|
||||
|
||||
## SYNTAX
|
||||
|
||||
### main (Default)
|
||||
```
|
||||
Get-ZertoVolume [<CommonParameters>]
|
||||
```
|
||||
|
||||
### filter
|
||||
```
|
||||
Get-ZertoVolume [-volumeType <String>] [-vpgIdentifier <String>] [-datastoreIdentifier <String>]
|
||||
[-protectedVmIdentifier <String>] [-owningVmIdentifier <String>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Returns information about all volumes in the site processing the API.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Get-ZertoVolume
|
||||
```
|
||||
|
||||
Returns information about all volumes in the site processing the API.
|
||||
|
||||
### Example 2
|
||||
```powershell
|
||||
PS C:\> Get-ZertoVolume -vpgIdentifier "MyVpgIdentifier"
|
||||
```
|
||||
|
||||
Returns information about all volumes associated with vpgIdentifier "MyVpgIdentifier" in the site processing the API.
|
||||
|
||||
### Example 3
|
||||
```powershell
|
||||
PS C:\> Get-ZertoVolume
|
||||
```
|
||||
|
||||
Returns information about all volumes in the site processing the API.
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -datastoreIdentifier
|
||||
The identifier of the datastore.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -owningVmIdentifier
|
||||
The identifier of the owning virtual machine.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -protectedVmIdentifier
|
||||
The identifier of the protected virtual machine.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -volumeType
|
||||
The type of volume.
|
||||
Please see Zerto API Documentation for possible values.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vpgIdentifier
|
||||
The identifier of the VPG.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
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
|
||||
|
||||
### None
|
||||
## OUTPUTS
|
||||
|
||||
### System.Object
|
||||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
[Zerto REST API Volumes End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.094.html#)
|
||||
@@ -0,0 +1,484 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Get-ZertoVpg.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Get-ZertoVpg
|
||||
|
||||
## SYNOPSIS
|
||||
Returns information about VPGs
|
||||
|
||||
## SYNTAX
|
||||
|
||||
### main (Default)
|
||||
```
|
||||
Get-ZertoVpg [<CommonParameters>]
|
||||
```
|
||||
|
||||
### stats
|
||||
```
|
||||
Get-ZertoVpg -protectionGroupIdentifier <String[]> [-checkpointsStats] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### checkpoints
|
||||
```
|
||||
Get-ZertoVpg -protectionGroupIdentifier <String[]> [-checkpoints] [-startDate <String>] [-endDate <String>]
|
||||
[<CommonParameters>]
|
||||
```
|
||||
|
||||
### protectionGroupIdentifier
|
||||
```
|
||||
Get-ZertoVpg -protectionGroupIdentifier <String[]> [<CommonParameters>]
|
||||
```
|
||||
|
||||
### entityTypes
|
||||
```
|
||||
Get-ZertoVpg [-entityTypes] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### failoverCommitPolicies
|
||||
```
|
||||
Get-ZertoVpg [-failoverCommitPolicies] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### failoverShutdownPolicies
|
||||
```
|
||||
Get-ZertoVpg [-failoverShutdownPolicies] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### priorities
|
||||
```
|
||||
Get-ZertoVpg [-priorities] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### retentionPolicies
|
||||
```
|
||||
Get-ZertoVpg [-retentionPolicies] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### statuses
|
||||
```
|
||||
Get-ZertoVpg [-statuses] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### subStatuses
|
||||
```
|
||||
Get-ZertoVpg [-subStatuses] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### filter
|
||||
```
|
||||
Get-ZertoVpg [-name <String>] [-status <String>] [-subStatus <String>] [-protectedSiteType <String>]
|
||||
[-recoverySiteType <String>] [-protectedSiteIdentifier <String>] [-recoverySiteIdentifier <String>]
|
||||
[-organizationName <String>] [-zorgIdentifier <String>] [-priority <String>]
|
||||
[-serviceProfileIdentifier <String>] [-backupEnabled] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
returns information about VPGs
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Get-ZertoVpg
|
||||
```
|
||||
|
||||
Returns information about all VPGs in the site processing the request
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Get-ZertoVpg -name "MyVpg"
|
||||
```
|
||||
|
||||
Returns information about VPG with the name "MyVpg"
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -backupEnabled
|
||||
If backup is enabled.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -checkpoints
|
||||
Return checkpoints for the selected Virtual Protection Group.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: checkpoints
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -checkpointsStats
|
||||
Return earliest and latest checkpoints for the selected Virtual Protection Group
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: stats
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -endDate
|
||||
Return checkpoints before the specified start date.
|
||||
Valid formats include: 'yyyy-MM-ddTHH:mm:ss.fffZ', 'yyyy-MM-ddTHH:mm:ssZ', 'yyyy-MM-ddTHH:mmZ', 'yyyy-MM-ddTHHZ', 'yyyy-MM-dd', 'yyyy-MM', 'yyyy'.
|
||||
Adding Z to the end of the time sets the time to UTC.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: checkpoints
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -entityTypes
|
||||
Return Valid VPG entityTypes
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: entityTypes
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -failoverCommitPolicies
|
||||
Valid Failover Commit Policies
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: failoverCommitPolicies
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -failoverShutdownPolicies
|
||||
Valid Failover Shutdown Policies
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: failoverShutdownPolicies
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -name
|
||||
The name of the VPG.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases: vpgName
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -organizationName
|
||||
The ZORG for this VPG.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -priorities
|
||||
Valid VPG priorities
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: priorities
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -priority
|
||||
The VPG priority.
|
||||
Possible values are: '0' or 'Low', '1' or 'Medium', '2' or 'High'
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -protectedSiteIdentifier
|
||||
The identifier of the protected site where the VPG virtual machines are protected.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -protectedSiteType
|
||||
The protected site environment.
|
||||
This filter behaves in the same way as the sourceType filter.
|
||||
Please see Zerto API Documentation for vaild values and discriptions.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -protectionGroupIdentifier
|
||||
The identifier(s) of the Virtual Protection Group to return
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: stats, checkpoints, protectionGroupIdentifier
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -recoverySiteIdentifier
|
||||
The identifier of the protected site where the VPG virtual machines are recovered.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -recoverySiteType
|
||||
The recovery site environment.
|
||||
This filter behaves in the same way as the sourceType filter.
|
||||
Please see Zerto API Documentation for vaild values and discriptions.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -retentionPolicies
|
||||
Valid retention policies
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: retentionPolicies
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -serviceProfileIdentifier
|
||||
The identifier of the service profile to use for the VPG when a Zerto Cloud Manager is used.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -startDate
|
||||
Return checkpoints after the specified start date.
|
||||
Valid formats include: 'yyyy-MM-ddTHH:mm:ss.fffZ', 'yyyy-MM-ddTHH:mm:ssZ', 'yyyy-MM-ddTHH:mmZ', 'yyyy-MM-ddTHHZ', 'yyyy-MM-dd', 'yyyy-MM', 'yyyy'.
|
||||
Adding Z to the end of the time sets the time to UTC.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: checkpoints
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -status
|
||||
The status of the VPG.
|
||||
Please use 'Get-ZertoVpg -statuses' for valid values
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -statuses
|
||||
Valid VPG statuses
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: statuses
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -subStatus
|
||||
The substatus of the VPG.
|
||||
Please use 'Get-ZertoVpg -substatuses' for valid values
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -subStatuses
|
||||
Valid VPG sub statuses
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: subStatuses
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -zorgIdentifier
|
||||
The internal identifier for the ZORG.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
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
|
||||
|
||||
### None
|
||||
## OUTPUTS
|
||||
|
||||
### System.Object
|
||||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
[Zerto REST API VPG End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.100.html#)
|
||||
@@ -0,0 +1,451 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Get-ZertoVpgSetting.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Get-ZertoVpgSetting
|
||||
|
||||
## SYNOPSIS
|
||||
Returns information when a VPG Settings object is created to create a new or edit an existing VPG.
|
||||
|
||||
## SYNTAX
|
||||
|
||||
### main (Default)
|
||||
```
|
||||
Get-ZertoVpgSetting [<CommonParameters>]
|
||||
```
|
||||
|
||||
### volumeIdentifier
|
||||
```
|
||||
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> -vmIdentifier <String> -volumeIdentifier <String>
|
||||
[<CommonParameters>]
|
||||
```
|
||||
|
||||
### volumes
|
||||
```
|
||||
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> -vmIdentifier <String> [-volumes] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### nicIdentifier
|
||||
```
|
||||
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> -vmIdentifier <String> -nicIdentifier <String>
|
||||
[<CommonParameters>]
|
||||
```
|
||||
|
||||
### nics
|
||||
```
|
||||
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> -vmIdentifier <String> [-nics] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### vmIdentifier
|
||||
```
|
||||
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> -vmIdentifier <String> [<CommonParameters>]
|
||||
```
|
||||
|
||||
### vms
|
||||
```
|
||||
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> [-vms] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### scripting
|
||||
```
|
||||
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> [-scripting] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### recovery
|
||||
```
|
||||
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> [-rcovery] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### priority
|
||||
```
|
||||
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> [-priority] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### networks
|
||||
```
|
||||
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> [-networks] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### journal
|
||||
```
|
||||
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> [-journal] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### bootGroup
|
||||
```
|
||||
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> [-bootgroup] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### basic
|
||||
```
|
||||
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> [-basic] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### schedulerPeriod
|
||||
```
|
||||
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> [-schedulerPeriod] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### retentionPeriod
|
||||
```
|
||||
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> [-retentionPeriod] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### dayOfWeek
|
||||
```
|
||||
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> [-dayOfWeek] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### backup
|
||||
```
|
||||
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> [-backup] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### vpgSettingsIdentifier
|
||||
```
|
||||
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Returns information when a VPG Settings object is created to create a new or edit an existing VPG. Depending on the parameter set being called, the data returned will either be the entire VPG settings information, or if a specific part of the VPG is requested using a specific parameter set, then only that information will be returned.
|
||||
|
||||
It is important to note that only once a VPG settings object has been created, will this function return data.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Get-ZertoVpgSettings -vpgSettingsIdentifier "MySettingsIdentifier"
|
||||
```
|
||||
|
||||
Returns all current settings for vpgSettingsIdentifier "MySettingsIdentifier"
|
||||
|
||||
### Example 2
|
||||
```powershell
|
||||
PS C:\> Get-ZertoVpgSettings -vpgSettingsIdentifier "MySettingsIdentifier" -vmIdentifier "MyVmId"
|
||||
```
|
||||
|
||||
Returns all current vm level settings for the vmIdentifier "MyVmId" in vpgSettingsIdentifier "MySettingsIdentifier"
|
||||
|
||||
### Example 3
|
||||
```powershell
|
||||
PS C:\> Get-ZertoVpgSettings -vpgSettingsIdentifier "MySettingsIdentifier" -vmIdentifier "MyVmId" -volumes
|
||||
```
|
||||
|
||||
Returns current vm level settings for volumes for vmId "MyVmId" in vpgSettingsIdentifier "MySettingsIdentifier"
|
||||
|
||||
### Example 4
|
||||
```powershell
|
||||
PS C:\> Get-ZertoVpgSettings -vpgSettingsIdentifier "MySettingsIdentifier" -nics
|
||||
```
|
||||
|
||||
Returns current vm level settings for nics for vmId "MyVmId" in vpgSettingsIdentifier "MySettingsIdentifier"
|
||||
|
||||
### Example 5
|
||||
```powershell
|
||||
PS C:\> Get-ZertoVpgSettings -vpgSettingsIdentifier "MySettingsIdentifier" -basic
|
||||
```
|
||||
|
||||
Returns current basic settings for vpgSettingsIdentifier "MySettingsIdentifier"
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -backup
|
||||
Return backup information for VPG identifier specified
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: backup
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -basic
|
||||
Get VPG Basic Settings
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: basic
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -bootgroup
|
||||
Get VPG Boot Settings
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: bootGroup
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -dayOfWeek
|
||||
Get the day of week a backup is scheduled
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: dayOfWeek
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -journal
|
||||
Get VPG Journal Settings
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: journal
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -networks
|
||||
Get VPG Network Settings
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: networks
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -nicIdentifier
|
||||
Return NIC information for specified NIC of the specified VM
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: nicIdentifier
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -nics
|
||||
Return NIC information for all NICs of the specified VM
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: nics
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -priority
|
||||
Get VPG Priority Settings
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: priority
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -rcovery
|
||||
Get VPG Recovery Settings
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: recovery
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -retentionPeriod
|
||||
Get the retention period for a backup
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: retentionPeriod
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -schedulerPeriod
|
||||
Get the backup schedule
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: schedulerPeriod
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -scripting
|
||||
Get VPG Recovery Settings
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: scripting
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vmIdentifier
|
||||
VM Identifier
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: volumeIdentifier, volumes, nicIdentifier, nics, vmIdentifier
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vms
|
||||
Get all settings for all VMs in a VPG.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: vms
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -volumeIdentifier
|
||||
Return volume information for the specified volume of the specified VM
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: volumeIdentifier
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -volumes
|
||||
Return Volume information for all volumes of the specified VM
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: volumes
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vpgSettingsIdentifier
|
||||
The identifier of the VPG settings object for which information is retrieved.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: volumeIdentifier, volumes, nicIdentifier, nics, vmIdentifier, vms, scripting, recovery, priority, networks, journal, bootGroup
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByValue)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: basic, schedulerPeriod, retentionPeriod, dayOfWeek, backup, vpgSettingsIdentifier
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByValue)
|
||||
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
|
||||
|
||||
### System.String
|
||||
## OUTPUTS
|
||||
|
||||
### System.Object
|
||||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
[Zerto REST API VPG Settings End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.108.html#)
|
||||
@@ -0,0 +1,256 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Get-ZertoVra.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Get-ZertoVra
|
||||
|
||||
## SYNOPSIS
|
||||
Returns information about VRAs at the site where the command is being run.
|
||||
|
||||
## SYNTAX
|
||||
|
||||
### main (Default)
|
||||
```
|
||||
Get-ZertoVra [<CommonParameters>]
|
||||
```
|
||||
|
||||
### ipConfigurationTypes
|
||||
```
|
||||
Get-ZertoVra [-ipconfigurationtypes] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### statuses
|
||||
```
|
||||
Get-ZertoVra [-statuses] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### vraIdentifier
|
||||
```
|
||||
Get-ZertoVra [-vraIdentifier <String[]>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### filter
|
||||
```
|
||||
Get-ZertoVra [-vraName <String>] [-status <String>] [-vraVersion <String>] [-hostVersion <String>]
|
||||
[-ipAddress <String>] [-vraGroup <String>] [-datastoreName <String>] [-datastoreClusterName <String>]
|
||||
[-networkName <String>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Returns information about VRAs at the site where the command is being run.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Get-ZertoVra
|
||||
```
|
||||
|
||||
Returns information about all VRAs in the site.
|
||||
|
||||
### Example 2
|
||||
```powershell
|
||||
PS C:\> Get-ZertoVra -vraName "Z-VRA-192.168.1.11"
|
||||
```
|
||||
|
||||
Returns information about vra "Z-VRA-192.168.1.11"
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -datastoreClusterName
|
||||
Search for VRAs on a specific datastore cluster
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -datastoreName
|
||||
Search for VRAs on a specific datastore
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -hostVersion
|
||||
Search for VRAs paired to a specific host version
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -ipAddress
|
||||
Search for a VRA with the specified IP address
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -ipconfigurationtypes
|
||||
Returns Valid VRA IP configuration types
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: ipConfigurationTypes
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -networkName
|
||||
Search for VRAs on a specific network
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -status
|
||||
Search for VRAs in a specific status
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -statuses
|
||||
Returns Valid VRA statuses
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: statuses
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vraGroup
|
||||
Search for VRAs belonging to a specific group
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vraIdentifier
|
||||
Returns information for provided VRA identifier(s)
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: vraIdentifier
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vraName
|
||||
VRA Name to return information for.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vraVersion
|
||||
Search for VRAs of a specific version
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
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
|
||||
|
||||
### None
|
||||
## OUTPUTS
|
||||
|
||||
### System.Object
|
||||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
[Zerto REST API VRA End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.117.html#)
|
||||
@@ -0,0 +1,74 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Get-ZertoZorg.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Get-ZertoZorg
|
||||
|
||||
## SYNOPSIS
|
||||
Returns information about Zerto organizations, ZORGs, defined in the Zerto Cloud Manager that is connected to the site where the API runs
|
||||
|
||||
## SYNTAX
|
||||
|
||||
### default (Default)
|
||||
```
|
||||
Get-ZertoZorg [<CommonParameters>]
|
||||
```
|
||||
|
||||
### zorgIdentifier
|
||||
```
|
||||
Get-ZertoZorg [-zorgIdentifier <String[]>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
returns information about Zerto organizations, ZORGs, defined in the Zerto Cloud Manager that is connected to the site where the API runs
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Get-ZertoZorg
|
||||
```
|
||||
|
||||
returns information about Zerto organizations, ZORGs, defined in the Zerto Cloud Manager that is connected to the site where the API runs
|
||||
|
||||
### Example 2
|
||||
```powershell
|
||||
PS C:\> Get-ZertoZorg -zorgIdentifier "myZorgIdentifier"
|
||||
```
|
||||
|
||||
returns information about Zerto Organization with identifier "MyZorgIdentifier"
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -zorgIdentifier
|
||||
Identifier(s) of the ZORG.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: zorgIdentifier
|
||||
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
|
||||
|
||||
### None
|
||||
## OUTPUTS
|
||||
|
||||
### System.Object
|
||||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
[Zerto REST API ZOrg End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.126.html#)
|
||||
@@ -0,0 +1,67 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Get-ZertpZsspSession.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Get-ZertoZsspSession
|
||||
|
||||
## SYNOPSIS
|
||||
Retrieve a list of existing session URLs.
|
||||
|
||||
## SYNTAX
|
||||
|
||||
### default (Default)
|
||||
```
|
||||
Get-ZertoZsspSession [<CommonParameters>]
|
||||
```
|
||||
|
||||
### zsspSessionIdentifier
|
||||
```
|
||||
Get-ZertoZsspSession [-zsspSessionIdentifier <String[]>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Retrieve a list of existing session URLs.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Get-ZertoZsspSession
|
||||
```
|
||||
|
||||
Retrieve a list of existing session URLs.
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -zsspSessionIdentifier
|
||||
ZSSP Session Id(s) to get information.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: zsspSessionIdentifier
|
||||
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
|
||||
|
||||
### None
|
||||
## OUTPUTS
|
||||
|
||||
### System.Object
|
||||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
[Zerto REST API ZSSP Session End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.132.html#)
|
||||
@@ -0,0 +1,230 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Install-ZertoVra.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Install-ZertoVra
|
||||
|
||||
## SYNOPSIS
|
||||
Install Zerto VRA to a single host in the site with either a Static IP address, or DHCP.
|
||||
|
||||
## SYNTAX
|
||||
|
||||
### Dhcp
|
||||
```
|
||||
Install-ZertoVra -hostName <String> -datastoreName <String> -networkName <String> [-memoryInGB <Int32>]
|
||||
[-groupName <String>] [-Dhcp] [-WhatIf] [-Confirm] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### StaticIp
|
||||
```
|
||||
Install-ZertoVra -hostName <String> -datastoreName <String> -networkName <String> [-memoryInGB <Int32>]
|
||||
[-groupName <String>] -vraIpAddress <String> -defaultGateway <String> -subnetMask <String> [-WhatIf]
|
||||
[-Confirm] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Install Zerto VRA to a single host in the site with either a Static IP address, or DHCP.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Install-ZertoVra -hostName "Host01" -datastoreName "Datastore01" -networkName "VM Network" -vraIpAddress "192.168.1.50" -defaultGateway "192.168.1.254" -subnetMask "255.255.255.0"
|
||||
```
|
||||
|
||||
Installs a VRA on the Host "Host01" using datastore "Datastore01" on network "VM Network" assigning an IP address if "192.168.1.50", subnetmask of "255.255.255.0" and default gateway of "192.168.1.254"
|
||||
|
||||
### Example 2
|
||||
```powershell
|
||||
PS C:\> Install-ZertoVra -hostName "Host01" -datastoreName "Datastore01" -networkName "VM Network" -dhcp
|
||||
```
|
||||
|
||||
Installs a VRA on the Host "Host01" using datastore "Datastore01" on network "VM Network" assigning a DHCP address.
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -datastoreName
|
||||
Datastore name where the VRA is to be installed.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -defaultGateway
|
||||
Default gateway to assign to the VRA
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: StaticIp
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Dhcp
|
||||
Assign a DHCP address to the VRA.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: Dhcp
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -groupName
|
||||
Bandwidth group to assign to the VRA.
|
||||
If unspecified will assign to the 'default_group'
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -hostName
|
||||
Host name where the VRA is to be installed.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -memoryInGB
|
||||
Initial amount of memory to assign to the VRA in GB.
|
||||
Default is 3, Minimum is 1, Maximum is 16
|
||||
|
||||
```yaml
|
||||
Type: Int32
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -networkName
|
||||
Network name the VRA is to be assigned.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -subnetMask
|
||||
Subnetmask to be assigned to the VRA
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: StaticIp
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vraIpAddress
|
||||
Static IP address to assign to the VRA.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: StaticIp
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
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
|
||||
|
||||
### None
|
||||
## OUTPUTS
|
||||
|
||||
### System.Object
|
||||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
[Zerto REST API VRA End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.117.html#)
|
||||
@@ -0,0 +1,188 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Invoke-ZertoFailover.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Invoke-ZertoFailover
|
||||
|
||||
## SYNOPSIS
|
||||
Start a failover of a VPG
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Invoke-ZertoFailover [-vpgName] <String> [[-checkpointIdentifier] <String>] [[-commitPolicy] <String>]
|
||||
[[-commitValue] <String>] [[-shutdownPolicy] <Int32>] [[-timeToWaitBeforeShutdownInSec] <Int64>]
|
||||
[[-reverseProtection] <Boolean>] [[-vmName] <String[]>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Start a failover of a VPG
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Invoke-ZertoFailover -vpgName "MyVpg"
|
||||
```
|
||||
|
||||
Start a failover of VPG "MyVpg" with the latest checkpoint and site default policies.
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -checkpointIdentifier
|
||||
Checkpoint Identifier to use as the Point-In-Time to rollback to.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 1
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -commitPolicy
|
||||
0: After the seconds specified in the commitValue setting have elapsed, the failover is rolled back.
|
||||
|
||||
1: After the seconds specified in the commitValue setting have elapsed, the failover continues, committing the virtual machines in the recovery site.
|
||||
|
||||
2: The virtual machines in the VPG being failed over remain in the Before Commit state until either they are committed with Commit a failover, or rolled back with Roll back a failover.
|
||||
|
||||
Default is the Site Settings setting.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 2
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -commitValue
|
||||
The amount of time in seconds the failover waits in a Before Commit state to enable checking that the failover is as required before performing the commitPolicy setting.
|
||||
Default is the Site Setting
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 3
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -reverseProtection
|
||||
True: Enable reverse protection.
|
||||
The virtual machines are recovered on the recovery site and then protected using the default reverse protection settings.
|
||||
|
||||
False: Do not enable reverse protection.
|
||||
The VPG definition is kept with the status Needs Configuration and the reverse settings in the VPG definition are not set.
|
||||
|
||||
```yaml
|
||||
Type: Boolean
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 6
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -shutdownPolicy
|
||||
0: The protected virtual machines are not touched before starting the failover.
|
||||
This assumes that you do not have access to the protected virtual machines.
|
||||
-- DEFAULT
|
||||
|
||||
1: If the protected virtual machines have VMware Tools or Microsoft Integration Services available, the virtual machines are gracefully shut down, otherwise the failover operation fails.
|
||||
This is similar to performing a Move operation to a specified checkpoint.
|
||||
|
||||
2: The protected virtual machines are forcibly shut down before starting the failover.
|
||||
If the protected virtual machines have VMware Tools or Microsoft Integration Services available, the procedure waits five minutes for the virtual machines to be gracefully shut down before forcibly powering them off.
|
||||
This is similar to performing a Move operation to a specified checkpoint.
|
||||
|
||||
```yaml
|
||||
Type: Int32
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 4
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -timeToWaitBeforeShutdownInSec
|
||||
Time, in seconds, before VMs are forcibly turned off if the Force Shutdown option is seclected after attempting to gracefully shut down the VMs
|
||||
|
||||
```yaml
|
||||
Type: Int64
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 5
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vmName
|
||||
Name(s) of VMs in the
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 7
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vpgName
|
||||
Name of the VPG to Failover
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
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 REST API VPG End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.100.html#)
|
||||
@@ -0,0 +1,83 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Invoke-ZertoFailoverCommit.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Invoke-ZertoFailoverCommit
|
||||
|
||||
## SYNOPSIS
|
||||
Commit a running VPG failover
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Invoke-ZertoFailoverCommit [-vpgName] <String[]> [-reverseProtect] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Commit a running VPG failover
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Invoke-ZertoFailoverCommit -vpgName "MyVpg"
|
||||
```
|
||||
|
||||
Commits VPG "MyVpg" without reverse protection
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Invoke-ZertoFailoverCommit -vpgName "MyVpg" -reverseProtect
|
||||
```
|
||||
|
||||
Commits a VPG with reverse protection
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -reverseProtect
|
||||
Use this switch to reverse protect the VPG(s) to the source site.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vpgName
|
||||
Name(s) of the VPG(s) to commit.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
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 REST API VPG End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.100.html#)
|
||||
@@ -0,0 +1,61 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Invoke-ZertoFailoverRollback.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Invoke-ZertoFailoverRollback
|
||||
|
||||
## SYNOPSIS
|
||||
Rollsback a VPG in a Before Commit Failover State
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Invoke-ZertoFailoverRollback [-vpgName] <String[]> [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Rollsback a VPG in a Before Commit Failover State
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Invoke-ZertoFailoverRollback -vpgName "MyVpg"
|
||||
```
|
||||
|
||||
Rollsback VPG "MyVPG" from a Before Commit State
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -vpgName
|
||||
Name(s) of VPG(s) to roll back from failing over
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
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 REST API VPG End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.100.html#)
|
||||
@@ -0,0 +1,61 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Invoke-ZertoForceSync.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Invoke-ZertoForceSync
|
||||
|
||||
## SYNOPSIS
|
||||
Starts a force sync process for a selected VPG
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Invoke-ZertoForceSync [-vpgName] <String[]> [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Starts a force sync process for a selected VPG
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Invoke-ZertoForceSync -vpgName "MyVpg"
|
||||
```
|
||||
|
||||
Starts a force sync on VPG "MyVpg"
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -vpgName
|
||||
Name(s) of VPG(s) to force sync
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
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 REST API VPG End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.100.html#)
|
||||
@@ -0,0 +1,177 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Invoke-ZertoMove.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Invoke-ZertoMove
|
||||
|
||||
## SYNOPSIS
|
||||
Start a move of a VPG.
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Invoke-ZertoMove [-vpgName] <String[]> [[-commitPolicy] <String>] [[-commitPolicyTimeout] <Int32>]
|
||||
[[-forceShutdown] <Boolean>] [[-reverseProtection] <Boolean>] [[-keepSourceVms] <Boolean>]
|
||||
[[-continueOnPreScriptFailure] <Boolean>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Start a move of a VPG.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Invoke-ZertoMove -vpgName "MyVpg"
|
||||
```
|
||||
|
||||
Starts a move operation of VPG "MyVpg"
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -commitPolicy
|
||||
The policy to use after the move enters a 'Before Commit' state.
|
||||
If omitted, the site settings default will be applied.
|
||||
Valid values are: '0' or 'Rollback', '1' or 'Commit', '2' or 'None'.
|
||||
Please see Zerto API Documentation for additional information.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 1
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -commitPolicyTimeout
|
||||
The amount of time, in seconds, the Move is in a 'Before Commit' state, before performing the commitPolicy setting.
|
||||
If omitted, the site settings default will be applied.
|
||||
|
||||
```yaml
|
||||
Type: Int32
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 2
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -continueOnPreScriptFailure
|
||||
False: Do not continue the Move operation in case of failure of script executing prior the operation.
|
||||
|
||||
True: Continue the Move operation in case of failure of script executing prior the operation.
|
||||
|
||||
Default: False
|
||||
|
||||
```yaml
|
||||
Type: Boolean
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 6
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -forceShutdown
|
||||
False: If a utility (VMware Tools) is installed on the protected virtual machines, the procedure waits five minutes for the virtual machines to be gracefully shut down before forcibly powering them off.
|
||||
|
||||
True: To force a shutdown of the virtual machines.
|
||||
|
||||
Default: True
|
||||
|
||||
```yaml
|
||||
Type: Boolean
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 3
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -keepSourceVms
|
||||
False: Remove the protected virtual machines from the protected site.
|
||||
|
||||
True: Prevent the protected virtual machines from being deleted in the protected site.
|
||||
|
||||
Default: False
|
||||
|
||||
```yaml
|
||||
Type: Boolean
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 5
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -reverseProtection
|
||||
False: Do not enable reverse protection.
|
||||
The VPG definition is kept with the status Needs Configuration and the reverse settings in the VPG definition are not set.
|
||||
|
||||
True: Enable reverse protection.
|
||||
The virtual machines are recovered on the recovery site and then protected using the default reverse protection settings.
|
||||
|
||||
Default Value: True
|
||||
|
||||
Note: If ReverseProtection is set to True, the KeepSourceVMs should be ignored because the virtual disks of the VMs are used for replication and cannot have VMs attached.
|
||||
|
||||
```yaml
|
||||
Type: Boolean
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 4
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vpgName
|
||||
Name(s) of the VPG(s) you want to move.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
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 REST API VPG End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.100.html#)
|
||||
@@ -0,0 +1,95 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: Invoke-ZertoMoveCommit.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Invoke-ZertoMoveCommit
|
||||
|
||||
## SYNOPSIS
|
||||
Commit a VPG currently undergoing a move operation.
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Invoke-ZertoMoveCommit [-vpgName] <String[]> [[-reverseProtect] <Boolean>] [-keepSourceVms]
|
||||
[<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Commit a VPG currently undergoing a move operation.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Invoke-ZertoMoveCommit -vpgName "MyVpg"
|
||||
```
|
||||
|
||||
Commit VPG "MyVpg" after a move has been started.
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -keepSourceVms
|
||||
Use this switch to keep the source VMs.
|
||||
If not set, they will be destroyed.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -reverseProtect
|
||||
Set this to True to reverse protect the VPG(s) to the source site.
|
||||
If not set, will use selection made during move initiation.
|
||||
True or False
|
||||
|
||||
```yaml
|
||||
Type: Boolean
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 1
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vpgName
|
||||
Name(s) of the VPG(s) to commit.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
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 REST API VPG End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.100.html#)
|
||||
@@ -0,0 +1,61 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Invoke-ZertoMoveRollback.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Invoke-ZertoMoveRollback
|
||||
|
||||
## SYNOPSIS
|
||||
Rollback a VPG currently undergoing a Move operation
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Invoke-ZertoMoveRollback [-vpgName] <String[]> [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Rollback a VPG currently undergoing a Move operation
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Invoke-ZertoMoveRollback -vpgName "MyVpg"
|
||||
```
|
||||
|
||||
Rollback VPG "MyVpg"
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -vpgName
|
||||
Name(s) of VPG(s) to roll back from failing over
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
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 REST API VPG End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.100.html#)
|
||||
@@ -0,0 +1,130 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Remove-ZertoVpg.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Remove-ZertoVpg
|
||||
|
||||
## SYNOPSIS
|
||||
Deletes a Zerto Virtual Protection Group
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Remove-ZertoVpg [-vpgName] <String> [-keepRecoveryVolumes] [-force] [-WhatIf] [-Confirm] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Deletes a Zerto Virtual Protection Group.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Remove-ZertoVpg -vpgName "MyVpg"
|
||||
```
|
||||
|
||||
Deletes Zerto Virtual Protection Group named "MyVpg". Recovery volumes at the recovery site will be deleted.
|
||||
|
||||
### Example 2
|
||||
```powershell
|
||||
PS C:\> Remove-ZertoVpg -vpgName "MyVpg" -keepRecoveryVolumes
|
||||
```
|
||||
|
||||
Deletes Zerto Virtual Protection Group named "MyVpg". Recovery volumes at the recovery site will be retained.
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -force
|
||||
Use this switch to force delete the VPG.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -keepRecoveryVolumes
|
||||
Use this switch to keep the recovery volumes at the target site.
|
||||
If the virtual machines in the deleted VPG are reprotected, these volumes can be used as preseeded volumes to speed up the initial synchronization of the new VPG.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vpgName
|
||||
Name of the VPG to delete.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
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
|
||||
|
||||
### None
|
||||
## OUTPUTS
|
||||
|
||||
### System.Object
|
||||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
[Zerto REST API VPG End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.100.html#)
|
||||
@@ -0,0 +1,61 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Resume-ZertoVpg.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Resume-ZertoVpg
|
||||
|
||||
## SYNOPSIS
|
||||
Resumes a Zerto Virtual Protection Group in a Paused State.
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Resume-ZertoVpg [-vpgName] <String[]> [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Resumes a Zerto Virtual Protection Group in a Paused State.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Resume-ZertoVpg -vpgName "MyVpg"
|
||||
```
|
||||
|
||||
Resumes paused Virtual Protection Group "MyVpg"
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -vpgName
|
||||
Name(s) of VPG(s) to resume replication
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
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 REST API VPG End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.100.html#)
|
||||
@@ -0,0 +1,135 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Set-ZertoAlert.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Set-ZertoAlert
|
||||
|
||||
## SYNOPSIS
|
||||
Dismisses or Undismisses a Zerto Alert
|
||||
|
||||
## SYNTAX
|
||||
|
||||
### dismiss
|
||||
```
|
||||
Set-ZertoAlert -alertId <String[]> [-dismiss] [-WhatIf] [-Confirm] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### undismiss
|
||||
```
|
||||
Set-ZertoAlert -alertId <String[]> [-undismiss] [-WhatIf] [-Confirm] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Dismisses or Undismisses a Zerto Alert
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Set-ZertoAlert -alertId "AlertId" -dismiss
|
||||
```
|
||||
|
||||
Dismiss alert with alert identifier "AlertId"
|
||||
|
||||
### Example 2
|
||||
```powershell
|
||||
PS C:\> Set-ZertoAlert -alertId "AlertId" -undismiss
|
||||
```
|
||||
|
||||
Undismiss alert with alert identifier "AlertId"
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -alertId
|
||||
Alert identifier(s) to be dismissed or undismissed.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: (All)
|
||||
Aliases: identifier
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByPropertyName, ByValue)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -dismiss
|
||||
Will dismiss the selected alert.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: dismiss
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -undismiss
|
||||
Will undismiss the selected alert.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: undismiss
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
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
|
||||
|
||||
### System.String[]
|
||||
## OUTPUTS
|
||||
|
||||
### System.Object
|
||||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
[Zerto REST API Alerts 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.009.html%23)
|
||||
@@ -0,0 +1,92 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Set-ZertoLicense.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Set-ZertoLicense
|
||||
|
||||
## SYNOPSIS
|
||||
Updates the Zerto License with a new key
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Set-ZertoLicense [-licenseKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Updates the Zerto License with a new key
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Set-ZertoLicense -licenseKey "MyNewLicenseKey"
|
||||
```
|
||||
|
||||
Sets the local license key to "MyNewLicenseKey"
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -licenseKey
|
||||
License Key to apply to the Zerto Virtual Manager
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
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
|
||||
|
||||
### None
|
||||
## OUTPUTS
|
||||
|
||||
### System.Object
|
||||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
[Zerto REST API License Information](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.034.html#)
|
||||
@@ -0,0 +1,110 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Start-ZertoCloneVpg.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Start-ZertoCloneVpg
|
||||
|
||||
## SYNOPSIS
|
||||
Start a Virtual Protection Group Clone operation
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Start-ZertoCloneVpg [-vpgName] <String> [[-checkpointIdentifier] <String>] [[-datastoreName] <String>]
|
||||
[[-vmName] <String[]>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Start a Virtual Protection Group Clone operation
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Start-ZertoCloneVpg -vpgName "MyVpg"
|
||||
```
|
||||
|
||||
Starts a clone operation of VPG "MyVpg" targeting the datastore with the most free space and the latest checkpoint.
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -checkpointIdentifier
|
||||
The identifier of the checkpoint to use for cloning.
|
||||
If unspecified, the latest checkpoint will be used.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 1
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -datastoreName
|
||||
The datastore name where the clone is to be created.
|
||||
If unspecified, will auto select the datastore with the most free space.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 2
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vmName
|
||||
The name(s) of the VMs you wish to clone.
|
||||
If unspecified, all VMs in the VPG will be cloned.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 3
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vpgName
|
||||
Name of the VPG you wish to clone.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
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 REST API VPG End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.100.html#)
|
||||
@@ -0,0 +1,94 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Start-ZertoFailoverTest.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Start-ZertoFailoverTest
|
||||
|
||||
## SYNOPSIS
|
||||
Start a Test Failover of a specific Virtual Protection Group
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Start-ZertoFailoverTest [-vpgName] <String> [[-checkpointIdentifier] <String>] [[-vmName] <String[]>]
|
||||
[<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Start a Test Failover of a specific Virtual Protection Group
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Start-ZertoFailoverTest -vpgName "MyVpg"
|
||||
```
|
||||
|
||||
Starts a Failover test of a Virtual Protection Group "MyVpg" at the latest checkpoint with all virtual machines.
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -checkpointIdentifier
|
||||
The identifier of the checkpoint to use for testing.
|
||||
If unspecified, the latest checkpoint will be used.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 1
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vmName
|
||||
The name(s) of the VMs within the selected VPG you wish to test.
|
||||
If unspecified, all VMs in the VPG will be tested.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 2
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vpgName
|
||||
Name of VPG to failover test
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
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 REST API VPG End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.100.html#)
|
||||
@@ -0,0 +1,61 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Stop-ZertoCloneVpg.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Stop-ZertoCloneVpg
|
||||
|
||||
## SYNOPSIS
|
||||
Stops a Virtual Protection Group Clone Operation currently running
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Stop-ZertoCloneVpg [-vpgName] <String> [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Stops a Virtual Protection Group Clone Operation currently running
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Stop-ZertoCloneVpg -vpgName "MyVpg'
|
||||
```
|
||||
|
||||
Stops a Virtual Protection Group Clone Operation currently running for Virtual Protection Group "MyVpg"
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -vpgName
|
||||
Name of the VPG to stop cloning
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
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 REST API VPG End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.100.html#)
|
||||
@@ -0,0 +1,94 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Stop-ZertoFailoverTest.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Stop-ZertoFailoverTest
|
||||
|
||||
## SYNOPSIS
|
||||
Stops a running Failover Test operation.
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Stop-ZertoFailoverTest [-vpgName] <String[]> [[-failoverTestSuccess] <Boolean>]
|
||||
[[-failoverTestSummary] <String>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Stops a running Failover Test operation.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Stop-ZertoFailoverTest -vpgName "MyVpg" -failoverTestSummary "All Good"
|
||||
```
|
||||
|
||||
Stop Failover Test for virtual protection group "MyVpg" indicating a success and making a note of "All Good"
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -failoverTestSuccess
|
||||
Was the test successful?
|
||||
True or False.
|
||||
True is Default.
|
||||
|
||||
```yaml
|
||||
Type: Boolean
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 1
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -failoverTestSummary
|
||||
Free text field for any notes to add to the test report.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 2
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vpgName
|
||||
Name(s) of VPG(s) to stop testing.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
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 REST API VPG End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.100.html#)
|
||||
@@ -0,0 +1,61 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Suspend-ZertoVpg.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Suspend-ZertoVpg
|
||||
|
||||
## SYNOPSIS
|
||||
Pauses a Virtual Protection Group replication operation
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Suspend-ZertoVpg [-vpgName] <String[]> [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Pauses a Virtual Protection Group replication operation
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Suspend-ZertoVpg -vpgName "MyVpg"
|
||||
```
|
||||
|
||||
Puts virtual protection group "MyVpg" into a paused state.
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -vpgName
|
||||
Name(s) of VPG(s) to pause replication
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
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 REST API VPG End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.100.html#)
|
||||
@@ -0,0 +1,61 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Uninstall-ZertoVra.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Uninstall-ZertoVra
|
||||
|
||||
## SYNOPSIS
|
||||
Uninstalls a Zerto Virtual Replication Appliance from a target host
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Uninstall-ZertoVra [-hostName] <String[]> [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Uninstalls a Zerto Virtual Replication Appliance from a target host
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Uninstall-ZertoVra -hostName "Host01"
|
||||
```
|
||||
|
||||
Uninstalls a Zerto Virtual Replication Appliance from host "Host01"
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -hostName
|
||||
Host Name attached to the VRA to be removed.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
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 REST API VRA End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.117.html#)
|
||||
Reference in New Issue
Block a user