Help system (#4)

* Establish a help system * Continue to update Help System * Update Get-ZertoAlert.md * Update Get-ZertoDatastore.md * Add Link to Zerto API for Datastores * Update Get-ZertoLicense.md * Update Links to Zerto API documentation * Update the Readme Information * Continue to update README * Update README * Update README.md * Update Help Markdown Files * Correct API URL * Update ZertoApiWrapper-help.xml * Update Get-ZertoProtectedVm.md * Update Help Markdown files * Update Get-ZertoVpgSetting.md * Added online url to each help object. * Update Help Markdown Files * Update ZertoApiWrapper-help.xml
2019-03-06 20:50:14 -05:00
parent 8521bec5a8
commit 59a0a53812
86 changed files with 15514 additions and 4 deletions
@@ -0,0 +1,256 @@
+---
+external help file: ZertoApiWrapper-help.xml
+Module Name: ZertoApiWrapper
+online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Get-ZertoVra.md
+schema: 2.0.0
+---
+
+# Get-ZertoVra
+
+## SYNOPSIS
+Returns information about VRAs at the site where the command is being run.
+
+## SYNTAX
+
+### main (Default)
+```
+Get-ZertoVra [<CommonParameters>]
+```
+
+### ipConfigurationTypes
+```
+Get-ZertoVra [-ipconfigurationtypes] [<CommonParameters>]
+```
+
+### statuses
+```
+Get-ZertoVra [-statuses] [<CommonParameters>]
+```
+
+### vraIdentifier
+```
+Get-ZertoVra [-vraIdentifier <String[]>] [<CommonParameters>]
+```
+
+### filter
+```
+Get-ZertoVra [-vraName <String>] [-status <String>] [-vraVersion <String>] [-hostVersion <String>]
+ [-ipAddress <String>] [-vraGroup <String>] [-datastoreName <String>] [-datastoreClusterName <String>]
+ [-networkName <String>] [<CommonParameters>]
+```
+
+## DESCRIPTION
+Returns information about VRAs at the site where the command is being run.
+
+## EXAMPLES
+
+### Example 1
+```powershell
+PS C:\> Get-ZertoVra
+```
+
+Returns information about all VRAs in the site.
+
+### Example 2
+```powershell
+PS C:\> Get-ZertoVra -vraName "Z-VRA-192.168.1.11"
+```
+
+Returns information about vra "Z-VRA-192.168.1.11"
+
+## PARAMETERS
+
+### -datastoreClusterName
+Search for VRAs on a specific datastore cluster
+
+```yaml
+Type: String
+Parameter Sets: filter
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -datastoreName
+Search for VRAs on a specific datastore
+
+```yaml
+Type: String
+Parameter Sets: filter
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -hostVersion
+Search for VRAs paired to a specific host version
+
+```yaml
+Type: String
+Parameter Sets: filter
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -ipAddress
+Search for a VRA with the specified IP address
+
+```yaml
+Type: String
+Parameter Sets: filter
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -ipconfigurationtypes
+Returns Valid VRA IP configuration types
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: ipConfigurationTypes
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -networkName
+Search for VRAs on a specific network
+
+```yaml
+Type: String
+Parameter Sets: filter
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -status
+Search for VRAs in a specific status
+
+```yaml
+Type: String
+Parameter Sets: filter
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -statuses
+Returns Valid VRA statuses
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: statuses
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -vraGroup
+Search for VRAs belonging to a specific group
+
+```yaml
+Type: String
+Parameter Sets: filter
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -vraIdentifier
+Returns information for provided VRA identifier(s)
+
+```yaml
+Type: String[]
+Parameter Sets: vraIdentifier
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -vraName
+VRA Name to return information for.
+
+```yaml
+Type: String
+Parameter Sets: filter
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -vraVersion
+Search for VRAs of a specific version
+
+```yaml
+Type: String
+Parameter Sets: filter
+Aliases:
+
+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 (http://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+### None
+## OUTPUTS
+
+### System.Object
+## NOTES
+
+## RELATED LINKS
+[Zerto REST API VRA 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.117.html#)