From 48ec5188eb59e12c604844cfbdcb6602d62a1e7e Mon Sep 17 00:00:00 2001 From: Wes Carroll Date: Fri, 15 Mar 2019 12:24:33 -0400 Subject: [PATCH] Update Help for import \ export functions. --- .../Public/en-us/ZertoApiWrapper-help.xml | 372 +++++++++++++++++- docs/Export-ZertoVpg.md | 19 +- docs/Import-ZertoVpg.md | 12 +- docs/New-ZertoVpgSettingsIdentifier.md | 19 +- 4 files changed, 404 insertions(+), 18 deletions(-) diff --git a/ZertoApiWrapper/Public/en-us/ZertoApiWrapper-help.xml b/ZertoApiWrapper/Public/en-us/ZertoApiWrapper-help.xml index 1ae92cc..39806eb 100644 --- a/ZertoApiWrapper/Public/en-us/ZertoApiWrapper-help.xml +++ b/ZertoApiWrapper/Public/en-us/ZertoApiWrapper-help.xml @@ -754,6 +754,163 @@ + + + Export-ZertoVpg + Export + ZertoVpg + + Exports a VPG Settings Object to a JSON file. This file can be used to re-import the VPG at a later time. + + + + Exports a VPG Settings Object to a JSON file. This file can be used to re-import the VPG at a later time. + + + + Export-ZertoVpg + + allVpgs + + Export all VPGs at this site + + + SwitchParameter + + + False + + + outputFolder + + Location where to dump the resulting JSON files containing the VPG Settings + + String + + String + + + None + + + + Export-ZertoVpg + + outputFolder + + Location where to dump the resulting JSON files containing the VPG Settings + + String + + String + + + None + + + vpgName + + Name(s) of the VPG(s) to be exported + + String[] + + String[] + + + None + + + + + + allVpgs + + Export all VPGs at this site + + SwitchParameter + + SwitchParameter + + + False + + + outputFolder + + Location where to dump the resulting JSON files containing the VPG Settings + + String + + String + + + None + + + vpgName + + Name(s) of the VPG(s) to be exported + + String[] + + String[] + + + None + + + + + + System.Management.Automation.SwitchParameter + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:> Export-ZertoVpg -outputFolder "C:\ZertoVPGs" -vpgName "My Vpg", "My Other Vpg" + + Exports VPG settings for VPGs "My Vpg" and "My Other Vpg". Each settings object will be placed inside a JSON file at C:\ZertoVPGs\ with the name of the file being the name of the VPG. + + + + -------------------------- Example 2 -------------------------- + PS C:> Export-ZertoVpg -outputFolder "C:\ZertoVPGs" -allVpgs + + Exports VPG settings for all Vpgs replicated to or from this site. Each settings object will be placed inside a JSON file at C:\ZertoVPGs\ with the name of the file being the name of the VPG. If a VPG is in an un-editable state, it cannot be exported. + + + + + + Online Version: + https://github.com/wcarroll/ZertoApiWrapper/blob/Master/docs/Export-ZertoVpg.md + + + 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# + + + Get-ZertoAlert @@ -6414,6 +6571,94 @@ + + + Import-ZertoVpg + Import + ZertoVpg + + Reads in one or more JSON files and imports each one into a VPG. + + + + Reads in one or several JSON files and imports each one into a VPG. Currently this method does not support using pre-seed volumes. We are working through a method to get this working, but it may be a while until this happens. + + + + Import-ZertoVpg + + settingsFile + + VPG settings JSON file(s) to import. + + String[] + + String[] + + + None + + + + + + settingsFile + + VPG settings JSON file(s) to import. + + String[] + + String[] + + + None + + + + + + System.String[] + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:> Import-ZertoVpg -settingsFile "C:\ZertoVpgs\My Vpg.json" + + Reads in "My Vpg.json", creates a new VPG object, applies all the settings and saves the VPG. + + + + + + Online Version: + https://github.com/wcarroll/ZertoApiWrapper/blob/Master/docs/Import-ZertoVpg.md + + + 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# + + + Install-ZertoVra @@ -7223,11 +7468,11 @@ Invoke ZertoFailoverRollback - Rollsback a VPG in a Before Commit Failover State + Rolls back a VPG in a Before Commit Failover State - Rollsback a VPG in a Before Commit Failover State + Rolls back a VPG in a Before Commit Failover State @@ -7290,7 +7535,7 @@ -------------------------- Example 1 -------------------------- PS C:\> Invoke-ZertoFailoverRollback -vpgName "MyVpg" - Rollsback VPG "MyVPG" from a Before Commit State + Rolls back VPG "MyVPG" from a Before Commit State @@ -9649,6 +9894,127 @@ + + + New-ZertoVpgSettingsIdentifier + New + ZertoVpgSettingsIdentifier + + Creates and returns a VPG Settings Identifier either for an existing VPG or a new VPG. + + + + Creates and returns a VPG Settings Identifier either for an existing VPG or a new VPG. + + + + New-ZertoVpgSettingsIdentifier + + newVpg + + Use this switch when creating a vpgSettingsIdentifier for a new VPG + + + SwitchParameter + + + False + + + + New-ZertoVpgSettingsIdentifier + + vpgIdentifier + + Identifier of the VPG to create a VPG settings identifier. If a vpgIdentifier is not provided, a new VPG settings object is created without any configured settings. This would be used for creating a new VPG from scratch. + + String + + String + + + None + + + + + + newVpg + + Use this switch when creating a vpgSettingsIdentifier for a new VPG + + SwitchParameter + + SwitchParameter + + + False + + + vpgIdentifier + + Identifier of the VPG to create a VPG settings identifier. If a vpgIdentifier is not provided, a new VPG settings object is created without any configured settings. This would be used for creating a new VPG from scratch. + + String + + String + + + None + + + + + + System.String + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:> New-ZertoVpgSettingsIdentifier -newVpg + + Creates a Vpg Settings Identifier for a new, blank VPG. + + + + -------------------------- Example 2 -------------------------- + PS C:> New-ZertoVpgSettingsIdentifier -vpgIdentifier "MyVpgIdentifier" + + Creates a Vpg Settings Identifier for an existing VPG. This settings identifier points to a settings object that contains the current settings of the VPG. + + + + + + Online Version: + https://github.com/wcarroll/ZertoApiWrapper/blob/Master/docs/New-ZertoVpgSettingsIdentifier.md + + + 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# + + + Remove-ZertoVpg diff --git a/docs/Export-ZertoVpg.md b/docs/Export-ZertoVpg.md index 55ead29..9bd5be3 100644 --- a/docs/Export-ZertoVpg.md +++ b/docs/Export-ZertoVpg.md @@ -1,14 +1,14 @@ --- external help file: ZertoApiWrapper-help.xml Module Name: ZertoApiWrapper -online version: +online version: https://github.com/wcarroll/ZertoApiWrapper/blob/Master/docs/Export-ZertoVpg.md schema: 2.0.0 --- # Export-ZertoVpg ## SYNOPSIS -{{ Fill in the Synopsis }} +Exports a VPG Settings Object to a JSON file. This file can be used to re-import the VPG at a later time. ## SYNTAX @@ -23,16 +23,23 @@ Export-ZertoVpg -outputFolder [-allVpgs] [] ``` ## DESCRIPTION -{{ Fill in the Description }} +Exports a VPG Settings Object to a JSON file. This file can be used to re-import the VPG at a later time. ## EXAMPLES ### Example 1 ```powershell -PS C:> {{ Add example code here }} +PS C:> Export-ZertoVpg -outputFolder "C:\ZertoVPGs" -vpgName "My Vpg", "My Other Vpg" ``` -{{ Add example description here }} +Exports VPG settings for VPGs "My Vpg" and "My Other Vpg". Each settings object will be placed inside a JSON file at C:\ZertoVPGs\ with the name of the file being the name of the VPG. + +### Example 2 +```powershell +PS C:> Export-ZertoVpg -outputFolder "C:\ZertoVPGs" -allVpgs +``` + +Exports VPG settings for all Vpgs replicated to or from this site. Each settings object will be placed inside a JSON file at C:\ZertoVPGs\ with the name of the file being the name of the VPG. If a VPG is in an un-editable state, it cannot be exported. ## PARAMETERS @@ -94,3 +101,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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#) diff --git a/docs/Import-ZertoVpg.md b/docs/Import-ZertoVpg.md index 478181b..2649e3d 100644 --- a/docs/Import-ZertoVpg.md +++ b/docs/Import-ZertoVpg.md @@ -1,14 +1,14 @@ --- external help file: ZertoApiWrapper-help.xml Module Name: ZertoApiWrapper -online version: +online version: https://github.com/wcarroll/ZertoApiWrapper/blob/Master/docs/Import-ZertoVpg.md schema: 2.0.0 --- # Import-ZertoVpg ## SYNOPSIS -{{ Fill in the Synopsis }} +Reads in one or more JSON files and imports each one into a VPG. ## SYNTAX @@ -17,16 +17,16 @@ Import-ZertoVpg [-settingsFile] [] ``` ## DESCRIPTION -{{ Fill in the Description }} +Reads in one or several JSON files and imports each one into a VPG. Currently this method does not support using pre-seed volumes. We are working through a method to get this working, but it may be a while until this happens. ## EXAMPLES ### Example 1 ```powershell -PS C:> {{ Add example code here }} +PS C:> Import-ZertoVpg -settingsFile "C:\ZertoVpgs\My Vpg.json" ``` -{{ Add example description here }} +Reads in "My Vpg.json", creates a new VPG object, applies all the settings and saves the VPG. ## PARAMETERS @@ -58,3 +58,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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#) diff --git a/docs/New-ZertoVpgSettingsIdentifier.md b/docs/New-ZertoVpgSettingsIdentifier.md index 0d42d33..abae8dd 100644 --- a/docs/New-ZertoVpgSettingsIdentifier.md +++ b/docs/New-ZertoVpgSettingsIdentifier.md @@ -1,14 +1,14 @@ --- external help file: ZertoApiWrapper-help.xml Module Name: ZertoApiWrapper -online version: +online version: https://github.com/wcarroll/ZertoApiWrapper/blob/Master/docs/New-ZertoVpgSettingsIdentifier.md schema: 2.0.0 --- # New-ZertoVpgSettingsIdentifier ## SYNOPSIS -{{ Fill in the Synopsis }} +Creates and returns a VPG Settings Identifier either for an existing VPG or a new VPG. ## SYNTAX @@ -23,16 +23,23 @@ New-ZertoVpgSettingsIdentifier [-newVpg] [] ``` ## DESCRIPTION -{{ Fill in the Description }} +Creates and returns a VPG Settings Identifier either for an existing VPG or a new VPG. ## EXAMPLES ### Example 1 ```powershell -PS C:> {{ Add example code here }} +PS C:> New-ZertoVpgSettingsIdentifier -newVpg ``` -{{ Add example description here }} +Creates a Vpg Settings Identifier for a new, blank VPG. + +### Example 2 +```powershell +PS C:> New-ZertoVpgSettingsIdentifier -vpgIdentifier "MyVpgIdentifier" +``` + +Creates a Vpg Settings Identifier for an existing VPG. This settings identifier points to a settings object that contains the current settings of the VPG. ## PARAMETERS @@ -81,3 +88,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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#)