Update Help Files Remove-ZertoPeerSite
This commit is contained in:
Wes Carroll
@@ -10021,6 +10021,279 @@
|
||||
</maml:navigationLink>
|
||||
</command:relatedLinks>
|
||||
</command:command>
|
||||
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
|
||||
<command:details>
|
||||
<command:name>Remove-ZertoPeerSite</command:name>
|
||||
<command:verb>Remove</command:verb>
|
||||
<command:noun>ZertoPeerSite</command:noun>
|
||||
<maml:description>
|
||||
<maml:para>Unpair the current site from another site paired to it.</maml:para>
|
||||
</maml:description>
|
||||
</command:details>
|
||||
<maml:description>
|
||||
<maml:para>Unpair the current site from another site paired to it.</maml:para>
|
||||
</maml:description>
|
||||
<command:syntax>
|
||||
<command:syntaxItem>
|
||||
<maml:name>Remove-ZertoPeerSite</maml:name>
|
||||
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none">
|
||||
<maml:name>hostName</maml:name>
|
||||
<maml:Description>
|
||||
<maml:para>IP address of the peer site to be removed from the connected site</maml:para>
|
||||
</maml:Description>
|
||||
<command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>
|
||||
<dev:type>
|
||||
<maml:name>String[]</maml:name>
|
||||
<maml:uri />
|
||||
</dev:type>
|
||||
<dev:defaultValue>None</dev:defaultValue>
|
||||
</command:parameter>
|
||||
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
||||
<maml:name>keepTargetDisks</maml:name>
|
||||
<maml:Description>
|
||||
<maml:para>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</maml:para>
|
||||
</maml:Description>
|
||||
<dev:type>
|
||||
<maml:name>SwitchParameter</maml:name>
|
||||
<maml:uri />
|
||||
</dev:type>
|
||||
<dev:defaultValue>False</dev:defaultValue>
|
||||
</command:parameter>
|
||||
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf">
|
||||
<maml:name>Confirm</maml:name>
|
||||
<maml:Description>
|
||||
<maml:para>Prompts you for confirmation before running the cmdlet.</maml:para>
|
||||
</maml:Description>
|
||||
<dev:type>
|
||||
<maml:name>SwitchParameter</maml:name>
|
||||
<maml:uri />
|
||||
</dev:type>
|
||||
<dev:defaultValue>False</dev:defaultValue>
|
||||
</command:parameter>
|
||||
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi">
|
||||
<maml:name>WhatIf</maml:name>
|
||||
<maml:Description>
|
||||
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
|
||||
</maml:Description>
|
||||
<dev:type>
|
||||
<maml:name>SwitchParameter</maml:name>
|
||||
<maml:uri />
|
||||
</dev:type>
|
||||
<dev:defaultValue>False</dev:defaultValue>
|
||||
</command:parameter>
|
||||
</command:syntaxItem>
|
||||
<command:syntaxItem>
|
||||
<maml:name>Remove-ZertoPeerSite</maml:name>
|
||||
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
||||
<maml:name>keepTargetDisks</maml:name>
|
||||
<maml:Description>
|
||||
<maml:para>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</maml:para>
|
||||
</maml:Description>
|
||||
<dev:type>
|
||||
<maml:name>SwitchParameter</maml:name>
|
||||
<maml:uri />
|
||||
</dev:type>
|
||||
<dev:defaultValue>False</dev:defaultValue>
|
||||
</command:parameter>
|
||||
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none">
|
||||
<maml:name>peerSiteName</maml:name>
|
||||
<maml:Description>
|
||||
<maml:para>Name of the peer site to be removed from the connected site</maml:para>
|
||||
</maml:Description>
|
||||
<command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>
|
||||
<dev:type>
|
||||
<maml:name>String[]</maml:name>
|
||||
<maml:uri />
|
||||
</dev:type>
|
||||
<dev:defaultValue>None</dev:defaultValue>
|
||||
</command:parameter>
|
||||
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf">
|
||||
<maml:name>Confirm</maml:name>
|
||||
<maml:Description>
|
||||
<maml:para>Prompts you for confirmation before running the cmdlet.</maml:para>
|
||||
</maml:Description>
|
||||
<dev:type>
|
||||
<maml:name>SwitchParameter</maml:name>
|
||||
<maml:uri />
|
||||
</dev:type>
|
||||
<dev:defaultValue>False</dev:defaultValue>
|
||||
</command:parameter>
|
||||
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi">
|
||||
<maml:name>WhatIf</maml:name>
|
||||
<maml:Description>
|
||||
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
|
||||
</maml:Description>
|
||||
<dev:type>
|
||||
<maml:name>SwitchParameter</maml:name>
|
||||
<maml:uri />
|
||||
</dev:type>
|
||||
<dev:defaultValue>False</dev:defaultValue>
|
||||
</command:parameter>
|
||||
</command:syntaxItem>
|
||||
<command:syntaxItem>
|
||||
<maml:name>Remove-ZertoPeerSite</maml:name>
|
||||
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
||||
<maml:name>keepTargetDisks</maml:name>
|
||||
<maml:Description>
|
||||
<maml:para>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</maml:para>
|
||||
</maml:Description>
|
||||
<dev:type>
|
||||
<maml:name>SwitchParameter</maml:name>
|
||||
<maml:uri />
|
||||
</dev:type>
|
||||
<dev:defaultValue>False</dev:defaultValue>
|
||||
</command:parameter>
|
||||
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="siteId">
|
||||
<maml:name>siteIdentifier</maml:name>
|
||||
<maml:Description>
|
||||
<maml:para>Identifier of the site to be removed from the connected site</maml:para>
|
||||
</maml:Description>
|
||||
<command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>
|
||||
<dev:type>
|
||||
<maml:name>String[]</maml:name>
|
||||
<maml:uri />
|
||||
</dev:type>
|
||||
<dev:defaultValue>None</dev:defaultValue>
|
||||
</command:parameter>
|
||||
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf">
|
||||
<maml:name>Confirm</maml:name>
|
||||
<maml:Description>
|
||||
<maml:para>Prompts you for confirmation before running the cmdlet.</maml:para>
|
||||
</maml:Description>
|
||||
<dev:type>
|
||||
<maml:name>SwitchParameter</maml:name>
|
||||
<maml:uri />
|
||||
</dev:type>
|
||||
<dev:defaultValue>False</dev:defaultValue>
|
||||
</command:parameter>
|
||||
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi">
|
||||
<maml:name>WhatIf</maml:name>
|
||||
<maml:Description>
|
||||
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
|
||||
</maml:Description>
|
||||
<dev:type>
|
||||
<maml:name>SwitchParameter</maml:name>
|
||||
<maml:uri />
|
||||
</dev:type>
|
||||
<dev:defaultValue>False</dev:defaultValue>
|
||||
</command:parameter>
|
||||
</command:syntaxItem>
|
||||
</command:syntax>
|
||||
<command:parameters>
|
||||
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none">
|
||||
<maml:name>hostName</maml:name>
|
||||
<maml:Description>
|
||||
<maml:para>IP address of the peer site to be removed from the connected site</maml:para>
|
||||
</maml:Description>
|
||||
<command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>
|
||||
<dev:type>
|
||||
<maml:name>String[]</maml:name>
|
||||
<maml:uri />
|
||||
</dev:type>
|
||||
<dev:defaultValue>None</dev:defaultValue>
|
||||
</command:parameter>
|
||||
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
||||
<maml:name>keepTargetDisks</maml:name>
|
||||
<maml:Description>
|
||||
<maml:para>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</maml:para>
|
||||
</maml:Description>
|
||||
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
|
||||
<dev:type>
|
||||
<maml:name>SwitchParameter</maml:name>
|
||||
<maml:uri />
|
||||
</dev:type>
|
||||
<dev:defaultValue>False</dev:defaultValue>
|
||||
</command:parameter>
|
||||
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none">
|
||||
<maml:name>peerSiteName</maml:name>
|
||||
<maml:Description>
|
||||
<maml:para>Name of the peer site to be removed from the connected site</maml:para>
|
||||
</maml:Description>
|
||||
<command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>
|
||||
<dev:type>
|
||||
<maml:name>String[]</maml:name>
|
||||
<maml:uri />
|
||||
</dev:type>
|
||||
<dev:defaultValue>None</dev:defaultValue>
|
||||
</command:parameter>
|
||||
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="siteId">
|
||||
<maml:name>siteIdentifier</maml:name>
|
||||
<maml:Description>
|
||||
<maml:para>Identifier of the site to be removed from the connected site</maml:para>
|
||||
</maml:Description>
|
||||
<command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>
|
||||
<dev:type>
|
||||
<maml:name>String[]</maml:name>
|
||||
<maml:uri />
|
||||
</dev:type>
|
||||
<dev:defaultValue>None</dev:defaultValue>
|
||||
</command:parameter>
|
||||
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf">
|
||||
<maml:name>Confirm</maml:name>
|
||||
<maml:Description>
|
||||
<maml:para>Prompts you for confirmation before running the cmdlet.</maml:para>
|
||||
</maml:Description>
|
||||
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
|
||||
<dev:type>
|
||||
<maml:name>SwitchParameter</maml:name>
|
||||
<maml:uri />
|
||||
</dev:type>
|
||||
<dev:defaultValue>False</dev:defaultValue>
|
||||
</command:parameter>
|
||||
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi">
|
||||
<maml:name>WhatIf</maml:name>
|
||||
<maml:Description>
|
||||
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
|
||||
</maml:Description>
|
||||
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
|
||||
<dev:type>
|
||||
<maml:name>SwitchParameter</maml:name>
|
||||
<maml:uri />
|
||||
</dev:type>
|
||||
<dev:defaultValue>False</dev:defaultValue>
|
||||
</command:parameter>
|
||||
</command:parameters>
|
||||
<command:inputTypes />
|
||||
<command:returnValues />
|
||||
<maml:alertSet>
|
||||
<maml:alert>
|
||||
<maml:para></maml:para>
|
||||
</maml:alert>
|
||||
</maml:alertSet>
|
||||
<command:examples>
|
||||
<command:example>
|
||||
<maml:title>-------------------------- Example 1 --------------------------</maml:title>
|
||||
<dev:code>PS C:\> Remove-ZertoPeerSite -siteIdentifier "MySiteIdentifier"</dev:code>
|
||||
<dev:remarks>
|
||||
<maml:para>Unpairs the current site for the site with siteIdentifier "MySiteIdentifier"</maml:para>
|
||||
</dev:remarks>
|
||||
</command:example>
|
||||
<command:example>
|
||||
<maml:title>-------------------------- Example 2 --------------------------</maml:title>
|
||||
<dev:code>PS C:\> Remove-ZertoPeerSite -peerSiteName "Recovery Site"</dev:code>
|
||||
<dev:remarks>
|
||||
<maml:para>Unpairs the current site for the site with site name "Recovery Site"</maml:para>
|
||||
</dev:remarks>
|
||||
</command:example>
|
||||
<command:example>
|
||||
<maml:title>-------------------------- Example 1 --------------------------</maml:title>
|
||||
<dev:code>PS C:\> Remove-ZertoPeerSite -hostName "192.168.1.100"</dev:code>
|
||||
<dev:remarks>
|
||||
<maml:para>Unpairs the current site for the site with ip address "192.168.1.100"</maml:para>
|
||||
</dev:remarks>
|
||||
</command:example>
|
||||
</command:examples>
|
||||
<command:relatedLinks>
|
||||
<maml:navigationLink>
|
||||
<maml:linkText>Online Version:</maml:linkText>
|
||||
<maml:uri>https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Remove-ZertoPeerSite.md</maml:uri>
|
||||
</maml:navigationLink>
|
||||
<maml:navigationLink>
|
||||
<maml:linkText>Zerto REST API Peer Site End Point Documentation</maml:linkText>
|
||||
<maml:uri>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</maml:uri>
|
||||
</maml:navigationLink>
|
||||
</command:relatedLinks>
|
||||
</command:command>
|
||||
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
|
||||
<command:details>
|
||||
<command:name>Remove-ZertoVpg</command:name>
|
||||
|
||||
@@ -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 <String[]> [-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)
|
||||
Reference in New Issue
Block a user