Files
ZertoApiWrapper/docs/Get-ZertoVra.md
T
2019-04-28 16:09:43 -04:00

4.9 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-ZertoVra.md 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

PS C:\> Get-ZertoVra

Returns information about all VRAs in the site.

Example 2

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

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

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

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

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

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

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

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

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

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)

Type: String[]
Parameter Sets: vraIdentifier
Aliases: vraId

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-vraName

VRA Name to return information for.

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

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.

INPUTS

None

OUTPUTS

System.Object

NOTES

Zerto REST API VRA End Point Documentation