Update Help Files
This commit is contained in:
File diff suppressed because it is too large
Load Diff
@@ -68,7 +68,7 @@ Default value is 9669.
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
Aliases: port
|
||||
|
||||
Required: False
|
||||
Position: 1
|
||||
@@ -83,7 +83,7 @@ IP address or FQDN of your Zerto Management Server
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
Aliases: server, zvm
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
|
||||
@@ -110,7 +110,7 @@ Identifier of the VRA to be updated.
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
Aliases: vraId
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
|
||||
@@ -164,7 +164,7 @@ Returns alerts for the specified helpIdentifier
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
Aliases: helpId
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
@@ -239,7 +239,7 @@ Returns alerts for the specified siteIdentifier
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
Aliases: siteId
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
@@ -270,7 +270,7 @@ Returns alerts for the specified vraIdentifier
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
Aliases: vpgId
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
@@ -285,7 +285,7 @@ Returns alerts for the specified zorgIdentifier
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
Aliases: zorgId
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
|
||||
@@ -49,7 +49,7 @@ datastoreIdentifier or array of datastoreIdentifiers to be queried
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: datastoreIdentifier
|
||||
Aliases:
|
||||
Aliases: datastoreId
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
|
||||
+8
-14
@@ -81,7 +81,7 @@ The internal alert identifier for the Event
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
Aliases: alertId
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
@@ -106,9 +106,7 @@ Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -category
|
||||
The type of event to return.
|
||||
This filter behaves in the same way as the eventCategory filter.
|
||||
Possible Values are: Possible Values are: '0' or 'All', '1' or 'Events', '2' or 'Alerts'
|
||||
The type of event to return. This filter behaves in the same way as the eventCategory filter. Possible Values are: Possible Values are: 'All', 'Events', 'Alerts'
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
@@ -155,8 +153,7 @@ Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -entityType
|
||||
The type of entity for which you wish to return results.
|
||||
Possible Values are: '0' or 'VPG', '1' or 'VRA', '2' or 'Unknown', or '3' or 'Site'
|
||||
The type of entity for which you wish to return results. Possible Values are: 'VPG', 'VRA', 'Unknown', or 'Site'
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
@@ -171,10 +168,7 @@ Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -eventCategory
|
||||
This filter behaves in the same way as the category filter.
|
||||
If both category and eventCategory filters are specified, only the category filter value is used and the eventCategory filter value is ignored.
|
||||
The type of event to return.
|
||||
Possible Values are: '0' or 'All', '1' or 'Events', '2' or 'Alerts'
|
||||
This filter behaves in the same way as the category filter. If both category and eventCategory filters are specified, only the category filter value is used and the eventCategory filter value is ignored. The type of event to return. Possible Values are: 'All', 'Events', 'Alerts'
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
@@ -226,7 +220,7 @@ The internal site identifier for which you want to return events.
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
Aliases: siteId
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
@@ -304,7 +298,7 @@ The name of the VPG for which you want to return events.
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
Aliases: vpgName
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
@@ -319,7 +313,7 @@ The identifier of the VPG for which you want to return events.
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
Aliases: vpgId
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
@@ -334,7 +328,7 @@ The identifier of the ZORG, Zerto organization, defined in the Zerto Cloud Manag
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
Aliases: zorgId
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
|
||||
@@ -152,7 +152,7 @@ The identifier(s) of the peer site(s) for which information is to be returned.
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: siteIdentifier
|
||||
Aliases:
|
||||
Aliases: siteId
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
|
||||
@@ -82,8 +82,7 @@ Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -priority
|
||||
The priority specified for the VPG.
|
||||
Possible values are: '0' or 'Low', '1' or 'Medium', '2' or 'High'
|
||||
The priority specified for the VPG. Possible values are: 'Low', 'Medium', or 'High'
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
@@ -103,7 +102,7 @@ The identifier of the protected site where the VPG virtual machines are protecte
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
Aliases: protectedSiteId
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
@@ -134,7 +133,7 @@ The identifier of the recovery site where the VPG virtual machines are recovered
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
Aliases: recoverySiteId
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
@@ -198,7 +197,7 @@ vmIdentifier(s) for which to return information
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: vmIdentifier
|
||||
Aliases:
|
||||
Aliases: vmId
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
|
||||
@@ -62,7 +62,7 @@ The identifier of the site for which service profiles should be returned.
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: siteIdentifier
|
||||
Aliases:
|
||||
Aliases: siteId
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
|
||||
@@ -123,8 +123,7 @@ Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -status
|
||||
The status of the task.
|
||||
Possible values are: '1' or 'InProgress', '3' or 'Paused', '4' or 'Failed', '6' or 'Completed', '7' or 'Cancelling'
|
||||
The status of the task. Possible values are: 'InProgress', 'Paused', 'Failed', 'Completed', or 'Cancelling'
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
@@ -144,7 +143,7 @@ The identifier(s) for which task information is to be returned.
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: taskIdentifier
|
||||
Aliases:
|
||||
Aliases: taskId
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
|
||||
@@ -162,7 +162,7 @@ The identifier of the host at the selected site to return information for only o
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: devices, hosts
|
||||
Aliases:
|
||||
Aliases: hostId
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
@@ -223,7 +223,7 @@ The identifier of the Zerto Virtual Manager site.
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: folders, devices, vms, resourcePools, networks, hosts, hostClusters, datastores, datastoreClusters, siteIdentifier
|
||||
Aliases:
|
||||
Aliases: siteId
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
|
||||
@@ -57,7 +57,7 @@ The identifier of the datastore.
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
Aliases: datastoreId, dsId
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
@@ -72,7 +72,7 @@ The identifier of the owning virtual machine.
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
Aliases: owningVmId
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
@@ -87,7 +87,7 @@ The identifier of the protected virtual machine.
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
Aliases: protectedVmId
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
@@ -118,7 +118,7 @@ The identifier of the VPG.
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: filter
|
||||
Aliases:
|
||||
Aliases: vpgId
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
|
||||
@@ -265,8 +265,7 @@ Accept wildcard characters: False
|
||||
|
||||
### -priority
|
||||
|
||||
The VPG priority.
|
||||
Possible values are: '0' or 'Low', '1' or 'Medium', '2' or 'High'
|
||||
The VPG priority. Possible values are: 'Low', 'Medium', 'High'
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
@@ -321,7 +320,7 @@ The identifier(s) of the Virtual Protection Group to return
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: stats, checkpoints, protectionGroupIdentifier
|
||||
Aliases:
|
||||
Aliases: vpgId, protectionGroupId, pgId
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
|
||||
@@ -249,7 +249,7 @@ Return NIC information for specified NIC of the specified VM
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: nicIdentifier
|
||||
Aliases:
|
||||
Aliases: nicId
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
@@ -354,7 +354,7 @@ VM Identifier
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: volumeIdentifier, volumes, nicIdentifier, nics, vmIdentifier
|
||||
Aliases:
|
||||
Aliases: vmId
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
@@ -384,7 +384,7 @@ Return volume information for the specified volume of the specified VM
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: volumeIdentifier
|
||||
Aliases:
|
||||
Aliases: volumeId
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
@@ -414,7 +414,7 @@ The identifier of the VPG settings object for which information is retrieved.
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: volumeIdentifier, volumes, nicIdentifier, nics, vmIdentifier, vms, scripting, recovery, priority, networks, journal, bootGroup
|
||||
Aliases:
|
||||
Aliases: vpgSettingsId, settingsId
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
@@ -426,7 +426,7 @@ Accept wildcard characters: False
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: basic, schedulerPeriod, retentionPeriod, dayOfWeek, backup, vpgSettingsIdentifier
|
||||
Aliases:
|
||||
Aliases: vpgSettingsId, settingsId
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
|
||||
@@ -201,7 +201,7 @@ Returns information for provided VRA identifier(s)
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: vraIdentifier
|
||||
Aliases:
|
||||
Aliases: vraId
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
|
||||
@@ -49,7 +49,7 @@ Identifier(s) of the ZORG.
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: zorgIdentifier
|
||||
Aliases:
|
||||
Aliases: zorgId
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
|
||||
@@ -42,7 +42,7 @@ ZSSP Session Id(s) to get information.
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: zsspSessionIdentifier
|
||||
Aliases:
|
||||
Aliases: zsspSessionId
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
|
||||
@@ -38,7 +38,7 @@ Checkpoint Identifier to use as the Point-In-Time to rollback to.
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
Aliases: checkpointId
|
||||
|
||||
Required: False
|
||||
Position: 1
|
||||
@@ -48,11 +48,11 @@ Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -commitPolicy
|
||||
0: After the seconds specified in the commitValue setting have elapsed, the failover is rolled back.
|
||||
'Rollback': After the seconds specified in the commitValue setting have elapsed, the failover is rolled back.
|
||||
|
||||
1: After the seconds specified in the commitValue setting have elapsed, the failover continues, committing the virtual machines in the recovery site.
|
||||
'Commit': After the seconds specified in the commitValue setting have elapsed, the failover continues, committing the virtual machines in the recovery site.
|
||||
|
||||
2: The virtual machines in the VPG being failed over remain in the Before Commit state until either they are committed with Commit a failover, or rolled back with Roll back a failover.
|
||||
'None': The virtual machines in the VPG being failed over remain in the Before Commit state until either they are committed with Commit a failover, or rolled back with Roll back a failover.
|
||||
|
||||
Default is the Site Settings setting.
|
||||
|
||||
@@ -143,7 +143,7 @@ Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -vmName
|
||||
Name(s) of VMs in the
|
||||
Name(s) of VMs in the VPG to failover
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
|
||||
@@ -33,10 +33,13 @@ Starts a move operation of VPG "MyVpg"
|
||||
## PARAMETERS
|
||||
|
||||
### -commitPolicy
|
||||
The policy to use after the move enters a 'Before Commit' state.
|
||||
If omitted, the site settings default will be applied.
|
||||
Valid values are: '0' or 'Rollback', '1' or 'Commit', '2' or 'None'.
|
||||
Please see Zerto API Documentation for additional information.
|
||||
'Rollback': After the seconds specified in the commitValue setting have elapsed, the failover is rolled back.
|
||||
|
||||
'Commit': After the seconds specified in the commitValue setting have elapsed, the failover continues, committing the virtual machines in the recovery site.
|
||||
|
||||
'None': The virtual machines in the VPG being failed over remain in the Before Commit state until either they are committed with Commit a failover, or rolled back with Roll back a failover.
|
||||
|
||||
Default is the Site Settings setting.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
||||
@@ -66,7 +66,7 @@ This would be used for creating a new VPG from scratch.
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: existingVpg
|
||||
Aliases:
|
||||
Aliases: vpgId
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
|
||||
@@ -103,7 +103,7 @@ vpgIdentifier(s) of the VPG(s) to delete.
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: vpgIdentifier
|
||||
Aliases:
|
||||
Aliases: vpgId
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
|
||||
@@ -36,7 +36,7 @@ VpgSettings Identifier to save
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
Aliases: vpgSettingsId
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
|
||||
@@ -49,7 +49,7 @@ Alert identifier(s) to be dismissed or undismissed.
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: (All)
|
||||
Aliases: identifier
|
||||
Aliases: alertIdentifier, identifier
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
|
||||
@@ -38,7 +38,7 @@ If unspecified, the latest checkpoint will be used.
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
Aliases: checkpointId
|
||||
|
||||
Required: False
|
||||
Position: 1
|
||||
|
||||
@@ -38,7 +38,7 @@ If unspecified, the latest checkpoint will be used.
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
Aliases: checkpointId
|
||||
|
||||
Required: False
|
||||
Position: 1
|
||||
|
||||
Reference in New Issue
Block a user