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

Update Help Files

Browse Source
This commit is contained in:
Wes Carroll
2019-03-26 15:21:12 -04:00
parent 5ce4bb056a
commit 23d0ffc6ba
25 changed files with 200 additions and 200 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ZertoApiWrapper/Public/en-us/ZertoApiWrapper-help.xml
+142 -136
View File
File diff suppressed because it is too large Load Diff
docs/Connect-ZertoServer.md
+2 -2
View File
@@ -68,7 +68,7 @@ Default value is 9669.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases: port
Required: False Required: False
Position: 1 Position: 1
@@ -83,7 +83,7 @@ IP address or FQDN of your Zerto Management Server
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases: server, zvm
Required: True Required: True
Position: 0 Position: 0
docs/Edit-ZertoVra.md
+1 -1
View File
@@ -110,7 +110,7 @@ Identifier of the VRA to be updated.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases: vraId
Required: True Required: True
Position: Named Position: Named
docs/Get-ZertoAlert.md
+4 -4
View File
@@ -164,7 +164,7 @@ Returns alerts for the specified helpIdentifier
```yaml ```yaml
Type: String Type: String
Parameter Sets: filter Parameter Sets: filter
Aliases: Aliases: helpId
Required: False Required: False
Position: Named Position: Named
@@ -239,7 +239,7 @@ Returns alerts for the specified siteIdentifier
```yaml ```yaml
Type: String Type: String
Parameter Sets: filter Parameter Sets: filter
Aliases: Aliases: siteId
Required: False Required: False
Position: Named Position: Named
@@ -270,7 +270,7 @@ Returns alerts for the specified vraIdentifier
```yaml ```yaml
Type: String Type: String
Parameter Sets: filter Parameter Sets: filter
Aliases: Aliases: vpgId
Required: False Required: False
Position: Named Position: Named
@@ -285,7 +285,7 @@ Returns alerts for the specified zorgIdentifier
```yaml ```yaml
Type: String Type: String
Parameter Sets: filter Parameter Sets: filter
Aliases: Aliases: zorgId
Required: False Required: False
Position: Named Position: Named
docs/Get-ZertoDatastore.md
+1 -1
View File
@@ -49,7 +49,7 @@ datastoreIdentifier or array of datastoreIdentifiers to be queried
```yaml ```yaml
Type: String[] Type: String[]
Parameter Sets: datastoreIdentifier Parameter Sets: datastoreIdentifier
Aliases: Aliases: datastoreId
Required: False Required: False
Position: Named Position: Named
docs/Get-ZertoEvent.md
+8 -14
View File
@@ -81,7 +81,7 @@ The internal alert identifier for the Event
```yaml ```yaml
Type: String Type: String
Parameter Sets: filter Parameter Sets: filter
Aliases: Aliases: alertId
Required: False Required: False
Position: Named Position: Named
@@ -106,9 +106,7 @@ Accept wildcard characters: False
``` ```
### -category ### -category
The type of event to return. 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'
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'
```yaml ```yaml
Type: String Type: String
@@ -155,8 +153,7 @@ Accept wildcard characters: False
``` ```
### -entityType ### -entityType
The type of entity for which you wish to return results. The type of entity for which you wish to return results. Possible Values are: 'VPG', 'VRA', 'Unknown', or 'Site'
Possible Values are: '0' or 'VPG', '1' or 'VRA', '2' or 'Unknown', or '3' or 'Site'
```yaml ```yaml
Type: String Type: String
@@ -171,10 +168,7 @@ Accept wildcard characters: False
``` ```
### -eventCategory ### -eventCategory
This filter behaves in the same way as the category filter. 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'
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'
```yaml ```yaml
Type: String Type: String
@@ -226,7 +220,7 @@ The internal site identifier for which you want to return events.
```yaml ```yaml
Type: String Type: String
Parameter Sets: filter Parameter Sets: filter
Aliases: Aliases: siteId
Required: False Required: False
Position: Named Position: Named
@@ -304,7 +298,7 @@ The name of the VPG for which you want to return events.
```yaml ```yaml
Type: String Type: String
Parameter Sets: filter Parameter Sets: filter
Aliases: Aliases: vpgName
Required: False Required: False
Position: Named Position: Named
@@ -319,7 +313,7 @@ The identifier of the VPG for which you want to return events.
```yaml ```yaml
Type: String Type: String
Parameter Sets: filter Parameter Sets: filter
Aliases: Aliases: vpgId
Required: False Required: False
Position: Named Position: Named
@@ -334,7 +328,7 @@ The identifier of the ZORG, Zerto organization, defined in the Zerto Cloud Manag
```yaml ```yaml
Type: String Type: String
Parameter Sets: filter Parameter Sets: filter
Aliases: Aliases: zorgId
Required: False Required: False
Position: Named Position: Named
docs/Get-ZertoPeerSite.md
+1 -1
View File
@@ -152,7 +152,7 @@ The identifier(s) of the peer site(s) for which information is to be returned.
```yaml ```yaml
Type: String[] Type: String[]
Parameter Sets: siteIdentifier Parameter Sets: siteIdentifier
Aliases: Aliases: siteId
Required: True Required: True
Position: Named Position: Named
docs/Get-ZertoProtectedVm.md
+4 -5
View File
@@ -82,8 +82,7 @@ Accept wildcard characters: False
``` ```
### -priority ### -priority
The priority specified for the VPG. The priority specified for the VPG. Possible values are: 'Low', 'Medium', or 'High'
Possible values are: '0' or 'Low', '1' or 'Medium', '2' or 'High'
```yaml ```yaml
Type: String Type: String
@@ -103,7 +102,7 @@ The identifier of the protected site where the VPG virtual machines are protecte
```yaml ```yaml
Type: String Type: String
Parameter Sets: filter Parameter Sets: filter
Aliases: Aliases: protectedSiteId
Required: False Required: False
Position: Named Position: Named
@@ -134,7 +133,7 @@ The identifier of the recovery site where the VPG virtual machines are recovered
```yaml ```yaml
Type: String Type: String
Parameter Sets: filter Parameter Sets: filter
Aliases: Aliases: recoverySiteId
Required: False Required: False
Position: Named Position: Named
@@ -198,7 +197,7 @@ vmIdentifier(s) for which to return information
```yaml ```yaml
Type: String[] Type: String[]
Parameter Sets: vmIdentifier Parameter Sets: vmIdentifier
Aliases: Aliases: vmId
Required: True Required: True
Position: Named Position: Named
docs/Get-ZertoServiceProfile.md
+1 -1
View File
@@ -62,7 +62,7 @@ The identifier of the site for which service profiles should be returned.
```yaml ```yaml
Type: String Type: String
Parameter Sets: siteIdentifier Parameter Sets: siteIdentifier
Aliases: Aliases: siteId
Required: False Required: False
Position: Named Position: Named
docs/Get-ZertoTask.md
+2 -3
View File
@@ -123,8 +123,7 @@ Accept wildcard characters: False
``` ```
### -status ### -status
The status of the task. The status of the task. Possible values are: 'InProgress', 'Paused', 'Failed', 'Completed', or 'Cancelling'
Possible values are: '1' or 'InProgress', '3' or 'Paused', '4' or 'Failed', '6' or 'Completed', '7' or 'Cancelling'
```yaml ```yaml
Type: String Type: String
@@ -144,7 +143,7 @@ The identifier(s) for which task information is to be returned.
```yaml ```yaml
Type: String[] Type: String[]
Parameter Sets: taskIdentifier Parameter Sets: taskIdentifier
Aliases: Aliases: taskId
Required: False Required: False
Position: Named Position: Named
docs/Get-ZertoVirtualizationSite.md
+2 -2
View File
@@ -162,7 +162,7 @@ The identifier of the host at the selected site to return information for only o
```yaml ```yaml
Type: String Type: String
Parameter Sets: devices, hosts Parameter Sets: devices, hosts
Aliases: Aliases: hostId
Required: False Required: False
Position: Named Position: Named
@@ -223,7 +223,7 @@ The identifier of the Zerto Virtual Manager site.
```yaml ```yaml
Type: String Type: String
Parameter Sets: folders, devices, vms, resourcePools, networks, hosts, hostClusters, datastores, datastoreClusters, siteIdentifier Parameter Sets: folders, devices, vms, resourcePools, networks, hosts, hostClusters, datastores, datastoreClusters, siteIdentifier
Aliases: Aliases: siteId
Required: True Required: True
Position: Named Position: Named
docs/Get-ZertoVolume.md
+4 -4
View File
@@ -57,7 +57,7 @@ The identifier of the datastore.
```yaml ```yaml
Type: String Type: String
Parameter Sets: filter Parameter Sets: filter
Aliases: Aliases: datastoreId, dsId
Required: False Required: False
Position: Named Position: Named
@@ -72,7 +72,7 @@ The identifier of the owning virtual machine.
```yaml ```yaml
Type: String Type: String
Parameter Sets: filter Parameter Sets: filter
Aliases: Aliases: owningVmId
Required: False Required: False
Position: Named Position: Named
@@ -87,7 +87,7 @@ The identifier of the protected virtual machine.
```yaml ```yaml
Type: String Type: String
Parameter Sets: filter Parameter Sets: filter
Aliases: Aliases: protectedVmId
Required: False Required: False
Position: Named Position: Named
@@ -118,7 +118,7 @@ The identifier of the VPG.
```yaml ```yaml
Type: String Type: String
Parameter Sets: filter Parameter Sets: filter
Aliases: Aliases: vpgId
Required: False Required: False
Position: Named Position: Named
docs/Get-ZertoVpg.md
+2 -3
View File
@@ -265,8 +265,7 @@ Accept wildcard characters: False
### -priority ### -priority
The VPG priority. The VPG priority. Possible values are: 'Low', 'Medium', 'High'
Possible values are: '0' or 'Low', '1' or 'Medium', '2' or 'High'
```yaml ```yaml
Type: String Type: String
@@ -321,7 +320,7 @@ The identifier(s) of the Virtual Protection Group to return
```yaml ```yaml
Type: String[] Type: String[]
Parameter Sets: stats, checkpoints, protectionGroupIdentifier Parameter Sets: stats, checkpoints, protectionGroupIdentifier
Aliases: Aliases: vpgId, protectionGroupId, pgId
Required: True Required: True
Position: Named Position: Named
docs/Get-ZertoVpgSetting.md
+5 -5
View File
@@ -249,7 +249,7 @@ Return NIC information for specified NIC of the specified VM
```yaml ```yaml
Type: String Type: String
Parameter Sets: nicIdentifier Parameter Sets: nicIdentifier
Aliases: Aliases: nicId
Required: True Required: True
Position: Named Position: Named
@@ -354,7 +354,7 @@ VM Identifier
```yaml ```yaml
Type: String Type: String
Parameter Sets: volumeIdentifier, volumes, nicIdentifier, nics, vmIdentifier Parameter Sets: volumeIdentifier, volumes, nicIdentifier, nics, vmIdentifier
Aliases: Aliases: vmId
Required: True Required: True
Position: Named Position: Named
@@ -384,7 +384,7 @@ Return volume information for the specified volume of the specified VM
```yaml ```yaml
Type: String Type: String
Parameter Sets: volumeIdentifier Parameter Sets: volumeIdentifier
Aliases: Aliases: volumeId
Required: True Required: True
Position: Named Position: Named
@@ -414,7 +414,7 @@ The identifier of the VPG settings object for which information is retrieved.
```yaml ```yaml
Type: String Type: String
Parameter Sets: volumeIdentifier, volumes, nicIdentifier, nics, vmIdentifier, vms, scripting, recovery, priority, networks, journal, bootGroup Parameter Sets: volumeIdentifier, volumes, nicIdentifier, nics, vmIdentifier, vms, scripting, recovery, priority, networks, journal, bootGroup
Aliases: Aliases: vpgSettingsId, settingsId
Required: True Required: True
Position: Named Position: Named
@@ -426,7 +426,7 @@ Accept wildcard characters: False
```yaml ```yaml
Type: String Type: String
Parameter Sets: basic, schedulerPeriod, retentionPeriod, dayOfWeek, backup, vpgSettingsIdentifier Parameter Sets: basic, schedulerPeriod, retentionPeriod, dayOfWeek, backup, vpgSettingsIdentifier
Aliases: Aliases: vpgSettingsId, settingsId
Required: True Required: True
Position: Named Position: Named
docs/Get-ZertoVra.md
+1 -1
View File
@@ -201,7 +201,7 @@ Returns information for provided VRA identifier(s)
```yaml ```yaml
Type: String[] Type: String[]
Parameter Sets: vraIdentifier Parameter Sets: vraIdentifier
Aliases: Aliases: vraId
Required: False Required: False
Position: Named Position: Named
docs/Get-ZertoZorg.md
+1 -1
View File
@@ -49,7 +49,7 @@ Identifier(s) of the ZORG.
```yaml ```yaml
Type: String[] Type: String[]
Parameter Sets: zorgIdentifier Parameter Sets: zorgIdentifier
Aliases: Aliases: zorgId
Required: False Required: False
Position: Named Position: Named
docs/Get-ZertoZsspSession.md
+1 -1
View File
@@ -42,7 +42,7 @@ ZSSP Session Id(s) to get information.
```yaml ```yaml
Type: String[] Type: String[]
Parameter Sets: zsspSessionIdentifier Parameter Sets: zsspSessionIdentifier
Aliases: Aliases: zsspSessionId
Required: False Required: False
Position: Named Position: Named
docs/Invoke-ZertoFailover.md
+5 -5
View File
@@ -38,7 +38,7 @@ Checkpoint Identifier to use as the Point-In-Time to rollback to.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases: checkpointId
Required: False Required: False
Position: 1 Position: 1
@@ -48,11 +48,11 @@ Accept wildcard characters: False
``` ```
### -commitPolicy ### -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. Default is the Site Settings setting.
@@ -143,7 +143,7 @@ Accept wildcard characters: False
``` ```
### -vmName ### -vmName
Name(s) of VMs in the Name(s) of VMs in the VPG to failover
```yaml ```yaml
Type: String[] Type: String[]
docs/Invoke-ZertoMove.md
+7 -4
View File
@@ -33,10 +33,13 @@ Starts a move operation of VPG "MyVpg"
## PARAMETERS ## PARAMETERS
### -commitPolicy ### -commitPolicy
The policy to use after the move enters a 'Before Commit' state. 'Rollback': After the seconds specified in the commitValue setting have elapsed, the failover is rolled back.
If omitted, the site settings default will be applied.
Valid values are: '0' or 'Rollback', '1' or 'Commit', '2' or 'None'. 'Commit': After the seconds specified in the commitValue setting have elapsed, the failover continues, committing the virtual machines in the recovery site.
Please see Zerto API Documentation for additional information.
'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 ```yaml
Type: String Type: String
docs/New-ZertoVpgSettingsIdentifier.md
+1 -1
View File
@@ -66,7 +66,7 @@ This would be used for creating a new VPG from scratch.
```yaml ```yaml
Type: String Type: String
Parameter Sets: existingVpg Parameter Sets: existingVpg
Aliases: Aliases: vpgId
Required: True Required: True
Position: Named Position: Named
docs/Remove-ZertoVpg.md
+1 -1
View File
@@ -103,7 +103,7 @@ vpgIdentifier(s) of the VPG(s) to delete.
```yaml ```yaml
Type: String[] Type: String[]
Parameter Sets: vpgIdentifier Parameter Sets: vpgIdentifier
Aliases: Aliases: vpgId
Required: True Required: True
Position: Named Position: Named
docs/Save-ZertoVpgSettings.md
+1 -1
View File
@@ -36,7 +36,7 @@ VpgSettings Identifier to save
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases: vpgSettingsId
Required: True Required: True
Position: 0 Position: 0
docs/Set-ZertoAlert.md
+1 -1
View File
@@ -49,7 +49,7 @@ Alert identifier(s) to be dismissed or undismissed.
```yaml ```yaml
Type: String[] Type: String[]
Parameter Sets: (All) Parameter Sets: (All)
Aliases: identifier Aliases: alertIdentifier, identifier
Required: True Required: True
Position: Named Position: Named
docs/Start-ZertoCloneVpg.md
+1 -1
View File
@@ -38,7 +38,7 @@ If unspecified, the latest checkpoint will be used.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases: checkpointId
Required: False Required: False
Position: 1 Position: 1
docs/Start-ZertoFailoverTest.md
+1 -1
View File
@@ -38,7 +38,7 @@ If unspecified, the latest checkpoint will be used.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases: checkpointId
Required: False Required: False
Position: 1 Position: 1