zerto/ZertoApiWrapper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update Default Parameter Set

Browse Source
This commit is contained in:
Wes Carroll
2019-04-28 16:11:52 -04:00
parent b6fd4a57e2
commit 1b3a612795
1 changed files with 122 additions and 122 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/New-ZertoVpgSettingsIdentifier.md
+122 -122
View File
@@ -1,122 +1,122 @@
--- ---
external help file: ZertoApiWrapper-help.xml external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper Module Name: ZertoApiWrapper
online version: https://github.com/wcarroll/ZertoApiWrapper/blob/Master/docs/New-ZertoVpgSettingsIdentifier.md online version: https://github.com/wcarroll/ZertoApiWrapper/blob/Master/docs/New-ZertoVpgSettingsIdentifier.md
schema: 2.0.0 schema: 2.0.0
--- ---
# New-ZertoVpgSettingsIdentifier # New-ZertoVpgSettingsIdentifier
## SYNOPSIS ## SYNOPSIS
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.
## SYNTAX ## SYNTAX
### existingVpg ### newVpg (Default)
``` ```
New-ZertoVpgSettingsIdentifier -vpgIdentifier <String> [-WhatIf] [-Confirm] [<CommonParameters>] New-ZertoVpgSettingsIdentifier [-newVpg] [-WhatIf] [-Confirm] [<CommonParameters>]
``` ```
### newVpg ### existingVpg
``` ```
New-ZertoVpgSettingsIdentifier [-newVpg] [-WhatIf] [-Confirm] [<CommonParameters>] New-ZertoVpgSettingsIdentifier -vpgIdentifier <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]
``` ```
## DESCRIPTION ## DESCRIPTION
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.
## EXAMPLES ## EXAMPLES
### Example 1 ### Example 1
```powershell ```powershell
PS C:> New-ZertoVpgSettingsIdentifier -newVpg PS C:> New-ZertoVpgSettingsIdentifier -newVpg
``` ```
Creates a Vpg Settings Identifier for a new, blank VPG. Creates a Vpg Settings Identifier for a new, blank VPG.
### Example 2 ### Example 2
```powershell ```powershell
PS C:> New-ZertoVpgSettingsIdentifier -vpgIdentifier "MyVpgIdentifier" 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. 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 ## PARAMETERS
### -newVpg ### -newVpg
Use this switch when creating a vpgSettingsIdentifier for a new VPG Use this switch when creating a vpgSettingsIdentifier for a new VPG
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: newVpg Parameter Sets: newVpg
Aliases: Aliases:
Required: True Required: True
Position: Named Position: Named
Default value: None Default value: None
Accept pipeline input: False Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -vpgIdentifier ### -vpgIdentifier
Identifier of the VPG to create a VPG settings identifier. 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. 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. This would be used for creating a new VPG from scratch.
```yaml ```yaml
Type: String Type: String[]
Parameter Sets: existingVpg Parameter Sets: existingVpg
Aliases: vpgId Aliases: vpgId
Required: True Required: True
Position: Named Position: Named
Default value: None Default value: None
Accept pipeline input: True (ByPropertyName, ByValue) Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Confirm ### -Confirm
Prompts you for confirmation before running the cmdlet. Prompts you for confirmation before running the cmdlet.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: cf Aliases: cf
Required: False Required: False
Position: Named Position: Named
Default value: None Default value: None
Accept pipeline input: False Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -WhatIf ### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run. Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: wi Aliases: wi
Required: False Required: False
Position: Named Position: Named
Default value: None Default value: None
Accept pipeline input: False Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### CommonParameters ### 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 (http://go.microsoft.com/fwlink/?LinkID=113216). This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS ## INPUTS
### System.String ### System.String
## OUTPUTS ## OUTPUTS
### System.Object ### System.Object
## NOTES ## NOTES
## RELATED LINKS ## 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#) [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#)