Files
ZertoApiWrapper/docs/Get-ZertoVolume.md
2020-04-04 10:26:56 -04:00

3.1 KiB

external help file, Module Name, online version, schema
external help file Module Name online version schema
ZertoApiWrapper-help.xml ZertoApiWrapper https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZertoVolume.md 2.0.0

Get-ZertoVolume

SYNOPSIS

Returns information about all volumes in the site processing the API.

SYNTAX

main (Default)

Get-ZertoVolume [<CommonParameters>]

filter

Get-ZertoVolume [-volumeType <String>] [-vpgIdentifier <String>] [-datastoreIdentifier <String>]
 [-protectedVmIdentifier <String>] [-owningVmIdentifier <String>] [<CommonParameters>]

DESCRIPTION

Returns information about all volumes in the site processing the API.

EXAMPLES

Example 1

PS C:\> Get-ZertoVolume

Returns information about all volumes in the site processing the API.

Example 2

PS C:\> Get-ZertoVolume -vpgIdentifier "MyVpgIdentifier"

Returns information about all volumes associated with vpgIdentifier "MyVpgIdentifier" in the site processing the API.

Example 3

PS C:\> Get-ZertoVolume

Returns information about all volumes in the site processing the API.

PARAMETERS

-datastoreIdentifier

The identifier of the datastore.

Type: String
Parameter Sets: filter
Aliases: datastoreId, dsId

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

-owningVmIdentifier

The identifier of the owning virtual machine.

Type: String
Parameter Sets: filter
Aliases: owningVmId

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

-protectedVmIdentifier

The identifier of the protected virtual machine.

Type: String
Parameter Sets: filter
Aliases: protectedVmId

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

-volumeType

The type of volume. Please see Zerto API Documentation for possible values.

Type: String
Parameter Sets: filter
Aliases:

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

-vpgIdentifier

The identifier of the VPG.

Type: String
Parameter Sets: filter
Aliases: vpgId

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 Volumes End Point Documentation