Files
ZertoApiWrapper/docs/New-ZertoVpgSettingsIdentifier.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/New-ZertoVpgSettingsIdentifier.md 2.0.0

New-ZertoVpgSettingsIdentifier

SYNOPSIS

Creates and returns a VPG Settings Identifier either for an existing VPG or a new VPG.

SYNTAX

newVpg (Default)

New-ZertoVpgSettingsIdentifier [-newVpg] [-WhatIf] [-Confirm] [<CommonParameters>]

existingVpg

New-ZertoVpgSettingsIdentifier -vpgIdentifier <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Creates and returns a VPG Settings Identifier either for an existing VPG or a new VPG.

EXAMPLES

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.

PARAMETERS

-newVpg

Use this switch when creating a vpgSettingsIdentifier for a new VPG

Type: SwitchParameter
Parameter Sets: newVpg
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: 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.

Type: String[]
Parameter Sets: existingVpg
Aliases: vpgId

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
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

System.String

OUTPUTS

System.Object

NOTES

Zerto REST API VPG Settings End Point Documentation