From be44ad41c49a013ae9f81c7a216d2d184cedb569 Mon Sep 17 00:00:00 2001 From: Wes Carroll Date: Tue, 26 Mar 2019 20:53:45 -0400 Subject: [PATCH] Update Help Files Remove-ZertoPeerSite --- .../Public/en-us/ZertoApiWrapper-help.xml | 273 ++++++++++++++++++ docs/Remove-ZertoPeerSite.md | 27 +- 2 files changed, 296 insertions(+), 4 deletions(-) diff --git a/ZertoApiWrapper/Public/en-us/ZertoApiWrapper-help.xml b/ZertoApiWrapper/Public/en-us/ZertoApiWrapper-help.xml index d47de4f..0ee3eb7 100644 --- a/ZertoApiWrapper/Public/en-us/ZertoApiWrapper-help.xml +++ b/ZertoApiWrapper/Public/en-us/ZertoApiWrapper-help.xml @@ -10021,6 +10021,279 @@ + + + Remove-ZertoPeerSite + Remove + ZertoPeerSite + + Unpair the current site from another site paired to it. + + + + Unpair the current site from another site paired to it. + + + + Remove-ZertoPeerSite + + hostName + + IP address of the peer site to be removed from the connected site + + String[] + + String[] + + + None + + + keepTargetDisks + + Specify this switch to Keep the target replica disks for any VPGs replicating between the sites as the VPGs will be deleted by unpairing the sites. If this switch is not used, the target replica disks will be deleted + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + Remove-ZertoPeerSite + + keepTargetDisks + + Specify this switch to Keep the target replica disks for any VPGs replicating between the sites as the VPGs will be deleted by unpairing the sites. If this switch is not used, the target replica disks will be deleted + + + SwitchParameter + + + False + + + peerSiteName + + Name of the peer site to be removed from the connected site + + String[] + + String[] + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + Remove-ZertoPeerSite + + keepTargetDisks + + Specify this switch to Keep the target replica disks for any VPGs replicating between the sites as the VPGs will be deleted by unpairing the sites. If this switch is not used, the target replica disks will be deleted + + + SwitchParameter + + + False + + + siteIdentifier + + Identifier of the site to be removed from the connected site + + String[] + + String[] + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + + + hostName + + IP address of the peer site to be removed from the connected site + + String[] + + String[] + + + None + + + keepTargetDisks + + Specify this switch to Keep the target replica disks for any VPGs replicating between the sites as the VPGs will be deleted by unpairing the sites. If this switch is not used, the target replica disks will be deleted + + SwitchParameter + + SwitchParameter + + + False + + + peerSiteName + + Name of the peer site to be removed from the connected site + + String[] + + String[] + + + None + + + siteIdentifier + + Identifier of the site to be removed from the connected site + + String[] + + String[] + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Remove-ZertoPeerSite -siteIdentifier "MySiteIdentifier" + + Unpairs the current site for the site with siteIdentifier "MySiteIdentifier" + + + + -------------------------- Example 2 -------------------------- + PS C:\> Remove-ZertoPeerSite -peerSiteName "Recovery Site" + + Unpairs the current site for the site with site name "Recovery Site" + + + + -------------------------- Example 1 -------------------------- + PS C:\> Remove-ZertoPeerSite -hostName "192.168.1.100" + + Unpairs the current site for the site with ip address "192.168.1.100" + + + + + + Online Version: + https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Remove-ZertoPeerSite.md + + + 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 + + + Remove-ZertoVpg diff --git a/docs/Remove-ZertoPeerSite.md b/docs/Remove-ZertoPeerSite.md index 8dd12d0..142d574 100644 --- a/docs/Remove-ZertoPeerSite.md +++ b/docs/Remove-ZertoPeerSite.md @@ -1,7 +1,7 @@ --- external help file: ZertoApiWrapper-help.xml Module Name: ZertoApiWrapper -online version: +online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Remove-ZertoPeerSite.md schema: 2.0.0 --- @@ -9,6 +9,8 @@ schema: 2.0.0 ## SYNOPSIS +Unpair the current site from another site paired to it. + ## SYNTAX ### siteIdentifier (Default) @@ -27,16 +29,31 @@ Remove-ZertoPeerSite -hostName [-keepTargetDisks] [-WhatIf] [-Confirm ``` ## DESCRIPTION -{{Fill in the Description}} + +Unpair the current site from another site paired to it. ## EXAMPLES ### Example 1 ```powershell -PS C:\> {{ Add example code here }} +PS C:\> Remove-ZertoPeerSite -siteIdentifier "MySiteIdentifier" ``` -{{ Add example description here }} +Unpairs the current site for the site with siteIdentifier "MySiteIdentifier" + +### Example 2 +```powershell +PS C:\> Remove-ZertoPeerSite -peerSiteName "Recovery Site" +``` + +Unpairs the current site for the site with site name "Recovery Site" + +### Example 1 +```powershell +PS C:\> Remove-ZertoPeerSite -hostName "192.168.1.100" +``` + +Unpairs the current site for the site with ip address "192.168.1.100" ## PARAMETERS @@ -143,3 +160,5 @@ For more information, see about_CommonParameters (http://go.microsoft.com/fwlink ## 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) \ No newline at end of file