Wes Carroll
9.8 KiB
external help file, Module Name, online version, schema
| external help file | Module Name | online version | schema |
|---|---|---|---|
| ZertoApiWrapper-help.xml | ZertoApiWrapper | https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Get-ZertoVpgSetting.md | 2.0.0 |
Get-ZertoVpgSetting
SYNOPSIS
Returns information when a VPG Settings object is created to create a new or edit an existing VPG.
SYNTAX
main (Default)
Get-ZertoVpgSetting [<CommonParameters>]
volumeIdentifier
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> -vmIdentifier <String> -volumeIdentifier <String>
[<CommonParameters>]
volumes
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> -vmIdentifier <String> [-volumes] [<CommonParameters>]
nicIdentifier
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> -vmIdentifier <String> -nicIdentifier <String>
[<CommonParameters>]
nics
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> -vmIdentifier <String> [-nics] [<CommonParameters>]
vmIdentifier
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> -vmIdentifier <String> [<CommonParameters>]
vms
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> [-vms] [<CommonParameters>]
scripting
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> [-scripting] [<CommonParameters>]
recovery
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> [-rcovery] [<CommonParameters>]
priority
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> [-priority] [<CommonParameters>]
networks
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> [-networks] [<CommonParameters>]
journal
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> [-journal] [<CommonParameters>]
bootGroup
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> [-bootgroup] [<CommonParameters>]
basic
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> [-basic] [<CommonParameters>]
schedulerPeriod
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> [-schedulerPeriod] [<CommonParameters>]
retentionPeriod
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> [-retentionPeriod] [<CommonParameters>]
dayOfWeek
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> [-dayOfWeek] [<CommonParameters>]
backup
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> [-backup] [<CommonParameters>]
vpgSettingsIdentifier
Get-ZertoVpgSetting -vpgSettingsIdentifier <String> [<CommonParameters>]
DESCRIPTION
Returns information when a VPG Settings object is created to create a new or edit an existing VPG. Depending on the parameter set being called, the data returned will either be the entire VPG settings information, or if a specific part of the VPG is requested using a specific parameter set, then only that information will be returned.
It is important to note that only once a VPG settings object has been created, will this function return data.
EXAMPLES
Example 1
PS C:\> Get-ZertoVpgSetting -vpgSettingsIdentifier "MySettingsIdentifier"
Returns all current settings for vpgSettingsIdentifier "MySettingsIdentifier"
Example 2
PS C:\> Get-ZertoVpgSetting -vpgSettingsIdentifier "MySettingsIdentifier" -vmIdentifier "MyVmId"
Returns all current vm level settings for the vmIdentifier "MyVmId" in vpgSettingsIdentifier "MySettingsIdentifier"
Example 3
PS C:\> Get-ZertoVpgSetting -vpgSettingsIdentifier "MySettingsIdentifier" -vmIdentifier "MyVmId" -volumes
Returns current vm level settings for volumes for vmId "MyVmId" in vpgSettingsIdentifier "MySettingsIdentifier"
Example 4
PS C:\> Get-ZertoVpgSetting -vpgSettingsIdentifier "MySettingsIdentifier" -nics
Returns current vm level settings for nics for vmId "MyVmId" in vpgSettingsIdentifier "MySettingsIdentifier"
Example 5
PS C:\> Get-ZertoVpgSetting -vpgSettingsIdentifier "MySettingsIdentifier" -basic
Returns current basic settings for vpgSettingsIdentifier "MySettingsIdentifier"
PARAMETERS
-backup
Return backup information for VPG identifier specified
Type: SwitchParameter
Parameter Sets: backup
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-basic
Get VPG Basic Settings
Type: SwitchParameter
Parameter Sets: basic
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-bootgroup
Get VPG Boot Settings
Type: SwitchParameter
Parameter Sets: bootGroup
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-dayOfWeek
Get the day of week a backup is scheduled
Type: SwitchParameter
Parameter Sets: dayOfWeek
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-journal
Get VPG Journal Settings
Type: SwitchParameter
Parameter Sets: journal
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-networks
Get VPG Network Settings
Type: SwitchParameter
Parameter Sets: networks
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-nicIdentifier
Return NIC information for specified NIC of the specified VM
Type: String
Parameter Sets: nicIdentifier
Aliases: nicId
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-nics
Return NIC information for all NICs of the specified VM
Type: SwitchParameter
Parameter Sets: nics
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-priority
Get VPG Priority Settings
Type: SwitchParameter
Parameter Sets: priority
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-rcovery
Get VPG Recovery Settings
Type: SwitchParameter
Parameter Sets: recovery
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-retentionPeriod
Get the retention period for a backup
Type: SwitchParameter
Parameter Sets: retentionPeriod
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-schedulerPeriod
Get the backup schedule
Type: SwitchParameter
Parameter Sets: schedulerPeriod
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-scripting
Get VPG Recovery Settings
Type: SwitchParameter
Parameter Sets: scripting
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-vmIdentifier
VM Identifier
Type: String
Parameter Sets: volumeIdentifier, volumes, nicIdentifier, nics, vmIdentifier
Aliases: vmId
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-vms
Get all settings for all VMs in a VPG.
Type: SwitchParameter
Parameter Sets: vms
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-volumeIdentifier
Return volume information for the specified volume of the specified VM
Type: String
Parameter Sets: volumeIdentifier
Aliases: volumeId
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-volumes
Return Volume information for all volumes of the specified VM
Type: SwitchParameter
Parameter Sets: volumes
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-vpgSettingsIdentifier
The identifier of the VPG settings object for which information is retrieved.
Type: String
Parameter Sets: volumeIdentifier, volumes, nicIdentifier, nics, vmIdentifier, vms, scripting, recovery, priority, networks, journal, bootGroup
Aliases: vpgSettingsId, settingsId
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
Type: String
Parameter Sets: basic, schedulerPeriod, retentionPeriod, dayOfWeek, backup, vpgSettingsIdentifier
Aliases: vpgSettingsId, settingsId
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
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 (http://go.microsoft.com/fwlink/?LinkID=113216).