Files
ZertoApiWrapper/docs/Start-ZertoCloneVpg.md
T
2020-04-04 10:26:56 -04:00

3.1 KiB

external help file, Module Name, online version, schema
external help file Module Name online version schema
ZertoApiWrapper-help.xml ZertoApiWrapper https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Start-ZertoCloneVpg.md 2.0.0

Start-ZertoCloneVpg

SYNOPSIS

Start a Virtual Protection Group Clone operation

SYNTAX

Start-ZertoCloneVpg [-vpgName] <String> [[-checkpointIdentifier] <String>] [[-datastoreName] <String>]
 [[-vmName] <String[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Start a Virtual Protection Group Clone operation

EXAMPLES

Example 1

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.

Type: String
Parameter Sets: (All)
Aliases: checkpointId

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.

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.

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.

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.

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.

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.

INPUTS

None

OUTPUTS

System.Object

NOTES

Zerto REST API VPG End Point Documentation